Skip to main content
POST
Start a run
Creates a run for a LIVE workspace and reserves the planned credit cost. Estimate the run first to inspect usable targets and cost. Creating the run revalidates both. Requires an active Business, Agency Business or Enterprise plan. Use an API token with write access enabled. See Writing data for idempotency, conditional requests and error handling.
string
required
Bearer token for your team.
string
required
Unique key for this operation. Completed responses replay for 24 hours.
string
required
Workspace identifier. The workspace must belong to the token’s team.
string[]
Up to 50 active prompt UUIDs. Omit to select all active prompts. If that would exceed 50, explicitly select a smaller set.
string[]
Up to 20 Qwairy model codes. Omit or send [] to use the workspace’s selected monitoring models; prompts with their own models keep them. Premium models need a plan that includes them, and stored premium selections your plan no longer includes are skipped, as in the dashboard.

Response

Returns 202 Accepted with a Location header pointing to Get a run, plus: Generation is asynchronous. The usable prompt/model combination is planned atomically; insufficient balance or a concurrent target change rejects the request.

Synthetic request and response

Follow progress

Get a run returns planning details. List runs includes overall status, outcome counts and progress. There are no public cancel, retry or refund endpoints.

Errors

See Error codes for authentication, plan, idempotency and server errors. On 429, honor Retry-After; writes can return 503 SERVICE_UNAVAILABLE if the write limiter is unavailable.