Videos

Create a video

Changed on

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

post/videos

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/videos
  • Auth
    HTTP bearer

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.

errorError2 required(unresolved $ref)

Changes

  • 4b9b8a0a6f3dRevision changes
    • info

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

    • info

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

  • e2f8d8cbc41fRevision changes
    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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