Sign in
v1

Get the result of a deferred video generation request.

Returns the current status of a video generation job. When the job completes successfully the response contains the generated video URL. When the job fails the response contains a structured error object with a machine-readable code and a human-readable message.

Both successful and failed completions return HTTP 200 — use the status field ("done" or "failed") to distinguish between the two.

get/v1/videos/{request_id}

Path parameters

request_idstring required

The deferred request id returned by a previous video generation request.

Response

Video generation completed or failed. Check the status field to determine the outcome.

modelstring nullable

The model used to generate the video. Omitted when status is "failed".

progressinteger nullable

Approximate completion percentage for the video generation task (0-100).

  • When status is "pending": progress is between 0-99, indicating current completion.
  • When status is "done": progress is 100.
  • When status is "failed": progress is omitted.
statusstring required

Status of the video generation: "done" when the video is ready.

Changes

Changed in 1 of the 9 revisions of this API.5

  • 8f60142721135See the full diff
    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added