Test Runs

Submit a QA test run

View as Markdown

Submit an async QA test run. Returns immediately with a run ID. Poll GET /v1/runs/{id} for status, or provide a webhookUrl to receive a callback on completion.

Authentication

AuthorizationBearer
API key authentication using Bearer token format

Request

This endpoint expects an object.
promptstringRequired>=1 character
Testing prompt describing what feature to test
webhookUrlstringOptionalformat: "uri"
Optional URL to receive a POST callback when the run completes

Response

Run queued successfully
idstringformat: "uuid"
Unique run identifier
statusenum
Initial status
Allowed values:
createdAtdatetime
When the run was created

Errors

400
Bad Request Error
401
Unauthorized Error
429
Too Many Requests Error
500
Internal Server Error
504
Gateway Timeout Error