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

Returns up to 5 test ideas that the app's existing tests don't cover yet. Nothing is saved. Add the ones you want with Create test, then call Save test generation checkpoint.

If the app changed since the last checkpoint, the ideas focus on what changed. Otherwise, or when the app has no checkpoint yet, they cover gaps across the whole app.

This makes AI calls and costs credits for the ideas it returns. It runs while you wait, usually for 30 seconds to a minute and sometimes longer. The call is refused when the workspace is out of credits, or when the app has more than 245 tests.

This is limited to 20 requests per minute per caller for each app. Some workspaces have a different limit.

<Note>This endpoint accepts a personal API key belonging to a user with editor access to the app. Read-only keys and workspace API keys are refused.</Note>

<Warning>The response includes fields beyond the ones documented here. Don't rely on undocumented response fields, as they can change at any time.</Warning>

{
  "flows": [
    {
      "goal": "Open the orders page, filter by Shipped, and check that only shipped orders are listed.",
      "name": "Filter orders by status",
      "role": "admin"
    }
  ]
}