Stop a run

POST 
/runs/:runId/stop

No new items start. Items already in progress finish, and are charged only if they produce a creative. Answers 202 with the run, which reads STOPPING until it settles.

Request

Responses

202

Stop accepted.

401

Unauthorized. Missing, malformed, unknown, revoked or expired bearer token — or the key owner no longer holds the Create API entitlement (CREATE_API_ENTITLEMENT_LOST).

403

Forbidden. The key lacks the required scope (API_TOKEN_SCOPE_DENIED): reads need runs:read, creating and stopping need runs:write.

404

Not Found (RUN_NOT_FOUND). No run with this id belongs to the key's account.

409

Conflict (RUN_ALREADY_FINAL). The run has already finished.

429

Too Many Requests (RATE_LIMITED). More than 20 requests per minute on this key.

Response Headers

Retry-After

Seconds to wait before retrying.