Generations

Cancel a generation

Cancel a queued or running generation and refund its charge. Idempotent for an already cancelled one.

post/v1/generations/{id}/cancel

Request

  • Base URL: https://api.martini.film
  • URL: https://api.martini.film/v1/generations/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required

The generation id.

Response

The cancelled generation.

idstring required

Public request id; also the canvas asset the generation lands on.

endpointstring required

The registered alias the request was submitted against.

status'draft' | 'pending' | 'running' | 'completed' | 'failed' | 'cancelled' required
origin'api' required
createdAtstring required
startedAtstring nullable required
completedAtstring nullable required
oliveCostnumber nullable required

Snapshotted charge in olives; null only while a concurrent idempotent submit is still being priced.

outputobject nullable required

The model output in its fal field names once status is completed; otherwise null.

warningsstring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.