POST /v1/runs/{id}/cancel
Cancel a run
Stops a run. What it already made stays; credits held for the rest are released.
Permission
A key with chosen permissions needs generation.write. A key made with every permission may always call it.
Parameters
id (path)string · requireduuid
Response: Run
200 · One run of a `run` recipe: several steps, several generations.
object"run"idstringuuid
statusstring`succeeded`, `failed` and `canceled` are final. `awaiting_approval` and `paused` wait on you in the app (`app_url`). New values may be added.
one of "queued", "running", "awaiting_approval", "paused", "succeeded", "failed", "canceled"
errorobject | nullgenerationsGeneration[]Everything the run has made so far, in order.
created_atstringdate-time
completed_atstring | nulldate-time
app_urlstringuri
Example
The required fields only, each a placeholder. Replace them before sending.
curl -X POST "https://api.meetkuro.com/v1/runs/<id>/cancel" \
-H "Authorization: Bearer $KURO_API_KEY"import { Kuro } from "@meetkuro/sdk";
const kuro = new Kuro(); // reads KURO_API_KEY
await kuro.runs.cancel("<id>");