Generations

Cancel a generation

Stops a queued or running generation and releases its hold; if the provider finishes it anyway, the result is thrown away and nothing is charged. A generation that already ended comes back as it is. Two kinds can't be stopped once started and answer 409: a run at a provider that bills it either way, and a preset run that has already shown its preview. Each runs to its end and is charged only if it succeeds.

Needs an API key with the generations:write scope.

post/v1/generations/{id}/cancel

Request

  • Base URL: https://api.tryleap.ai
  • URL: https://api.tryleap.ai/v1/generations/{id}/cancel
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

idstring required

The generation's ID, gen_....

Response

The generation, canceled, or as it was if it had already ended.

idstring required

The generation's ID, gen_ and 24 letters and digits.

object'generation' required
modelstring required

The model or preset it runs, with a preset's version.

modality'image' | 'video' | 'audio' | '3d' | 'text' required

What it makes: image, video, audio, 3d or text.

status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required

queued, then running, then one of succeeded, failed or canceled. Only succeeded is charged.

providerstring nullable required

Which upstream ran it, once one did. Informational: the model ID and input stay the same whichever runs it.

revisionstring required

The model's schema and price revision the run used.

inputobject required

The input as it runs, with the defaults filled in.

failure_cause'provider_error' | 'provider_refused' | 'photo_blocked' | 'timeout' | 'outage' | 'input_removed' | 'input_rejected' nullable required

What made a failed run fail, for a program to branch on: provider_error, provider_refused (the model's safety filter said no), photo_blocked (the photo check refused the photo), timeout, outage (the provider had a declared incident or could not serve Leap), input_removed (an input file was gone) or input_rejected (the provider couldn't use an input file: too small, an unreadable format, or no face). Null for any other run, and for a failure from before causes were recorded.

source'studio' | 'api' | 'mcp' nullable required

Where it was started: api, mcp or studio.

batch_idstring nullable required

The batch it belongs to, bat_...; null if none.

created_atstring date-time required

When it was created.

started_atstring date-time nullable required

When it started running; null while queued.

completed_atstring date-time nullable required

When it reached a final status; null before.

slow_atstring date-time nullable required

While a preset runs: when it counts as slow, one and a half times what Leap's runs of it take after started_at, scaled to this run's length, resolution and count. From then on a cancel works whatever the run has done, even once its preview shows. Null for any other run.

deadline_atstring date-time nullable required

While a preset runs: when Leap stops it if it hasn't finished, three times what Leap's runs of it take after started_at, scaled to this run's length, resolution and count, between 5 minutes (2 for a picture) and 12. It then fails with the failure_cause timeout and costs nothing. Null for any other run.

Changes

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