Cancel a video generation

POST 
/v1/videos/:video_id/cancel

Cancels a video generation. A queued one ends canceled at once. One already rendering is asked to stop and stays running until that is settled: it ends canceled, or completed — delivered and charged as usual — when the video was finished first. A generation that has ended is returned unchanged.

Request

Responses

200

Successful Response

401

Authentication failed: the credential is missing, malformed, expired, or revoked.

• invalid_token — The access token is invalid.
• project_disabled — This project is not active.
• token_expired — The access token has expired.
• user_disabled — This user is not active.

404

The requested resource does not exist, or is not visible to the caller.

• generation_not_found — The requested generation was not found.

422

A request value failed validation; the details array names each offending field.

• validation_failed — The request payload failed validation.

429

Either too many requests (a Retry-After header says when to retry) or the billing account is out of credits (no Retry-After — top up to continue); the code field tells the two apart.

• rate_limited — Too many requests. Please slow down.

500

An unexpected server-side error occurred.

• internal — An unexpected error occurred.