Docs
Log inStart free
API referenceGenerations

Cancel a running generation

Stop a render-project job (more job types later; others answer 422).

Queued scenes are dropped, in-flight GPU scene jobs are aborted and the film stitch is skipped. Billing: only scenes already rendered are charged (cached scenes are free); the remaining credits are refunded once through the credit ledger, never twice. Idempotent, and safe on a job that already finished: it returns the final state unchanged. Only the account that owns the generation can cancel it (404 otherwise). GET /generations/{id} then shows status: cancelled, charged_credits and scenes_rendered.

POST
/generations/{id}/cancel

Authorization

bearerAuth
AuthorizationBearer <token>

Typecut API key. Generate one in app.typecut.ai → Settings → API keys. Send as Authorization: Bearer tc_live_….

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/generations/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel"
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "string",
    "status": "string",
    "cancelled": true,
    "already_final": true,
    "settled": true,
    "charged_credits": 0,
    "credits_refunded": 0,
    "scenes_rendered": 0,
    "scenes_total": 0,
    "scenes_cached": 0,
    "output_url": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}

Get a generation GET

Poll ONE credit-spending job by the generation_id the starting call returned (POST /media/generate, POST /scenes/{sceneId}/elements, …): status, error, and for an image the finished asset.

Run a chain of tool calls POST

Several tool calls in ONE request, run server-side: each step's result feeds later steps by $ref (generations are awaited, so "$img.url" is the finished picture), each fans a step out over an array re