API reference / Generations

Cancel generation

POST/v1/generations/{id}/cancel

Cancel a generation that is still queued. Once a worker has picked up the job and the backend has started rendering, cancel returns 409 not_cancelable.

Path parameters

Parameters

idstringRequired

The id of the generation to cancel.

Behavior

Credit refund

Canceling a queued job releases the credit hold immediately — the call costs nothing. Canceling is idempotent: calling it twice on the same job returns the same payload.

Request

POSTCancel generation/v1/generations/{id}/cancel

curl -X POST https://api.kiara-api.com/v1/generations/gen_01HV.../cancel \
  -H "Authorization: Bearer $KIARA_API_KEY"

Response · canceled

{
  0: 1,
  2: 3,
  4: 5,
  6: 7,
  8: null,
  9: {
    10: 11
  }
}

Response · conflict

{
  0: {
    1: 2,
    3: 4,
    5: 6
  }
}