Stop a run you started

Stop an eligible run using the idempotency key it was started with.

POST/v1/query/cancel

Stops the run that was started with this Idempotency-Key and X-Fous-Stoppable: 1 (a Studio run). A stop recorded before the run is charged wins: the run ends, uncharged, and its own stream says so; one recorded after loses.

Requires Authorization: Bearer $FOUS_API_KEY. Create a key.

Request body

Required. JSON.

idempotency_keystringrequired

Response 202

Stop recorded

successtruerequired
dataobjectrequired
Show child attributesHide child attributes
- status"stopping"required

Errors

Every failure is an Error: branch on error.code. The errors guide lists each code.

400
401WWW-Authenticate
402
403
404
408
409
410
413
422
429Retry-After
500
502
503Retry-After
504

POST/v1/query/cancel
Terminal
$curl 'https://api.fous.com/v1/query/cancel' \
>  -H "Authorization: Bearer $FOUS_API_KEY" \
>  -H 'Content-Type: application/json' \
>  -d '{"idempotency_key":"your-original-run-key"}'