Refine test description
<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>
Turns a rough description into a test name and a goal the testing agent can follow. Nothing is saved. Pass the result to Create test to add it.
This makes an AI call and usually answers within a few seconds. It's billed by the length of description, so it usually costs a fraction of a credit. The call is refused when the workspace is out of credits.
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>
Path parameters
ID of the app.
ID of the app.
Request body
Example request
{
"description": "check that new projects show up on the dashboard"
}Response
The suggested name and goal.
Example response
{
"name": "Create a project",
"goal": "Sign up, create a project called Launch, and check that it appears on the dashboard."
}Changes
Changed in 1 of the 28 revisions of this API.1
- ○
endpoint added
endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
Of the 28 revisions, 1 has no diff computed.