Sign in
Videos

Create a video

Create a new video generation job from a prompt and optional reference assets.

post/videos

Request body

promptstring required

Text prompt that describes the video to generate.

seconds'4' | '8' | '12'
size'720x1280' | '1280x720' | '1024x1792' | '1792x1024'

Example request

{
  "input_reference": {
    "file_id": "file-123"
  }
}

Response

Success

idstring required

Unique identifier for the video job.

object'video' required

The object type, which is always video.

status'queued' | 'in_progress' | 'completed' | 'failed' required
progressinteger required

Approximate completion percentage for the generation task.

created_atinteger required

Unix timestamp (seconds) for when the job was created.

completed_atinteger nullable required

Unix timestamp (seconds) for when the job completed, if finished.

expires_atinteger nullable required

Unix timestamp (seconds) for when the downloadable assets expire, if set.

promptstring nullable required

The prompt that was used to generate the video.

size'720x1280' | '1280x720' | '1024x1792' | '1792x1024' required
secondsstring required

Duration of the generated clip in seconds. For extensions, this is the stitched total duration.

remixed_from_video_idstring nullable required

Identifier of the source video if this video is a remix.

Changes

Changed in 7 of the 163 revisions of this API.10

  • d86203de41ae3See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 26bd6202a0ad1See the full diff
    • ○

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

      response-optional-property-added

  • 245c08912c1c1See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 9430b00d75b42See 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

  • 5f6acbcbb9191See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 596a83c32a9e1See the full diff
    • ○

      endpoint deprecated

      endpoint-deprecated

  • 74cbcf73838f1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog