Get agent setup suggestions

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns up to 3 agents worth adding to the app, based on its name, description, data entities, and the agents it already has. They're the suggestions the builder shows on the app's Agents page.

Each suggestion carries a prompt you can send to the app's AI chat to build that agent. Nothing is created by this call.

Suggestions are generated by AI and kept for 24 hours for each app and page, so changes to the app show up in them after that. Generating them doesn't use the workspace's credits.

This is limited to 10 requests a minute per app for each workspace's personal API keys, so every key in a workspace shares one allowance. Some workspaces have a different limit.

<Note>This endpoint accepts a full-access personal API key from anyone with access to the app, viewers included. Read-only keys and workspace API keys are not authorized for it, because a call can start AI generation.</Note>

{
  "suggestions": [
    {
      "title": "Order Tracker",
      "description": "Tells customers where their order is and when it should arrive.",
      "prompt": "Create an agent that answers customers' questions about their Order status and delivery date."
    }
  ]
}