Videos

Create video

post /videos

Create video

Returns

Video object { id, completed_at, created_at, 10 more }

Structured information describing a generated video job.
- id: string
  
  Unique identifier for the video job.
- completed_at: number
  
  Unix timestamp (seconds) for when the job completed, if finished.
- created_at: number
  
  Unix timestamp (seconds) for when the job was created.
- error: VideoCreateError
  
  Error payload that explains why generation failed, if applicable.
  - code: string
    
    A machine-readable error code that was returned.
  - message: string
    
    A human-readable description of the error that was returned.
- expires_at: number
  
  Unix timestamp (seconds) for when the downloadable assets expire, if set.
- model: VideoModel
  
  The video generation model that produced the job.
  - string
  - "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more
    - "sora-2"
    - "sora-2-pro"
    - "sora-2-2025-10-06"
    - "sora-2-pro-2025-10-06"
    - "sora-2-2025-12-08"
- object: "video"
  
  The object type, which is always video.
  - "video"
- progress: number
  
  Approximate completion percentage for the generation task.
- prompt: string
  
  The prompt that was used to generate the video.
- remixed_from_video_id: string
  
  Identifier of the source video if this video is a remix.
- seconds: string or VideoSeconds
  
  Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
  - string
  - VideoSeconds = "4" or "8" or "12"
    - "4"
    - "8"
    - "12"
- size: VideoSize
  
  The resolution of the generated video.
  - "720x1280"
  - "1280x720"
  - "1024x1792"
  - "1792x1024"
- status: "queued" or "in_progress" or "completed" or "failed"
  
  Current lifecycle status of the video job.
  - "queued"
  - "in_progress"
  - "completed"
  - "failed"

Example

curl https://api.openai.com/v1/videos \
    -H 'Content-Type: multipart/form-data' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -F prompt=x

Response

{
  "id": "id",
  "completed_at": 0,
  "created_at": 0,
  "error": {
    "code": "code",
    "message": "message"
  },
  "expires_at": 0,
  "model": "sora-2",
  "object": "video",
  "progress": 0,
  "prompt": "prompt",
  "remixed_from_video_id": "remixed_from_video_id",
  "seconds": "4",
  "size": "720x1280",
  "status": "queued"
}

Example

curl https://api.openai.com/v1/videos \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -F "model=sora-2" \
  -F "prompt=A calico cat playing a piano on stage"

Response

{
  "id": "video_123",
  "object": "video",
  "model": "sora-2",
  "status": "queued",
  "progress": 0,
  "created_at": 1712697600,
  "size": "1024x1792",
  "seconds": "8",
  "quality": "standard"
}

Create a new video generation job by editing a source video or existing generated video.

post /videos/edits

Create a new video generation job by editing a source video or existing generated video.

Returns

Video object { id, completed_at, created_at, 10 more }

Structured information describing a generated video job.
- id: string
  
  Unique identifier for the video job.
- completed_at: number
  
  Unix timestamp (seconds) for when the job completed, if finished.
- created_at: number
  
  Unix timestamp (seconds) for when the job was created.
- error: VideoCreateError
  
  Error payload that explains why generation failed, if applicable.
  - code: string
    
    A machine-readable error code that was returned.
  - message: string
    
    A human-readable description of the error that was returned.
- expires_at: number
  
  Unix timestamp (seconds) for when the downloadable assets expire, if set.
- model: VideoModel
  
  The video generation model that produced the job.
  - string
  - "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more
    - "sora-2"
    - "sora-2-pro"
    - "sora-2-2025-10-06"
    - "sora-2-pro-2025-10-06"
    - "sora-2-2025-12-08"
- object: "video"
  
  The object type, which is always video.
  - "video"
- progress: number
  
  Approximate completion percentage for the generation task.
- prompt: string
  
  The prompt that was used to generate the video.
- remixed_from_video_id: string
  
  Identifier of the source video if this video is a remix.
- seconds: string or VideoSeconds
  
  Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
  - string
  - VideoSeconds = "4" or "8" or "12"
    - "4"
    - "8"
    - "12"
- size: VideoSize
  
  The resolution of the generated video.
  - "720x1280"
  - "1280x720"
  - "1024x1792"
  - "1792x1024"
- status: "queued" or "in_progress" or "completed" or "failed"
  
  Current lifecycle status of the video job.
  - "queued"
  - "in_progress"
  - "completed"
  - "failed"

Example

curl https://api.openai.com/v1/videos/edits \
    -H 'Content-Type: multipart/form-data' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -F prompt=x \
    -F video='Example data'

Response

{
  "id": "id",
  "completed_at": 0,
  "created_at": 0,
  "error": {
    "code": "code",
    "message": "message"
  },
  "expires_at": 0,
  "model": "sora-2",
  "object": "video",
  "progress": 0,
  "prompt": "prompt",
  "remixed_from_video_id": "remixed_from_video_id",
  "seconds": "4",
  "size": "720x1280",
  "status": "queued"
}

Create an extension of a completed video.

post /videos/extensions

Create an extension of a completed video.

Returns

Video object { id, completed_at, created_at, 10 more }

Structured information describing a generated video job.
- id: string
  
  Unique identifier for the video job.
- completed_at: number
  
  Unix timestamp (seconds) for when the job completed, if finished.
- created_at: number
  
  Unix timestamp (seconds) for when the job was created.
- error: VideoCreateError
  
  Error payload that explains why generation failed, if applicable.
  - code: string
    
    A machine-readable error code that was returned.
  - message: string
    
    A human-readable description of the error that was returned.
- expires_at: number
  
  Unix timestamp (seconds) for when the downloadable assets expire, if set.
- model: VideoModel
  
  The video generation model that produced the job.
  - string
  - "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more
    - "sora-2"
    - "sora-2-pro"
    - "sora-2-2025-10-06"
    - "sora-2-pro-2025-10-06"
    - "sora-2-2025-12-08"
- object: "video"
  
  The object type, which is always video.
  - "video"
- progress: number
  
  Approximate completion percentage for the generation task.
- prompt: string
  
  The prompt that was used to generate the video.
- remixed_from_video_id: string
  
  Identifier of the source video if this video is a remix.
- seconds: string or VideoSeconds
  
  Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
  - string
  - VideoSeconds = "4" or "8" or "12"
    - "4"
    - "8"
    - "12"
- size: VideoSize
  
  The resolution of the generated video.
  - "720x1280"
  - "1280x720"
  - "1024x1792"
  - "1792x1024"
- status: "queued" or "in_progress" or "completed" or "failed"
  
  Current lifecycle status of the video job.
  - "queued"
  - "in_progress"
  - "completed"
  - "failed"

Example

curl https://api.openai.com/v1/videos/extensions \
    -H 'Content-Type: multipart/form-data' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -F prompt=x \
    -F seconds=4 \
    -F video='Example data'

Response

{
  "id": "id",
  "completed_at": 0,
  "created_at": 0,
  "error": {
    "code": "code",
    "message": "message"
  },
  "expires_at": 0,
  "model": "sora-2",
  "object": "video",
  "progress": 0,
  "prompt": "prompt",
  "remixed_from_video_id": "remixed_from_video_id",
  "seconds": "4",
  "size": "720x1280",
  "status": "queued"
}

Create a character from an uploaded video.

post /videos/characters

Create a character from an uploaded video.

Returns

id: string

Identifier for the character creation cameo.
created_at: number

Unix timestamp (in seconds) when the character was created.
name: string

Display name for the character.

Example

curl https://api.openai.com/v1/videos/characters \
    -H 'Content-Type: multipart/form-data' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -F name=x \
    -F 'video=@/path/to/video'

Response

{
  "id": "id",
  "created_at": 0,
  "name": "name"
}

Fetch a character.

get /videos/characters/{character_id}

Fetch a character.

Path Parameters

character_id: string

Returns

id: string

Identifier for the character creation cameo.
created_at: number

Unix timestamp (in seconds) when the character was created.
name: string

Display name for the character.

Example

curl https://api.openai.com/v1/videos/characters/$CHARACTER_ID \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Response

{
  "id": "id",
  "created_at": 0,
  "name": "name"
}

get /videos

List videos

Query Parameters

after: optional string

Identifier for the last item from the previous pagination request
limit: optional number

Number of items to retrieve
order: optional "asc" or "desc"

Sort order of results by timestamp. Use asc for ascending order or desc for descending order.
- "asc"
- "desc"

Returns

data: array of Video

A list of items
- id: string
  
  Unique identifier for the video job.
- completed_at: number
  
  Unix timestamp (seconds) for when the job completed, if finished.
- created_at: number
  
  Unix timestamp (seconds) for when the job was created.
- error: VideoCreateError
  
  Error payload that explains why generation failed, if applicable.
  - code: string
    
    A machine-readable error code that was returned.
  - message: string
    
    A human-readable description of the error that was returned.
- expires_at: number
  
  Unix timestamp (seconds) for when the downloadable assets expire, if set.
- model: VideoModel
  
  The video generation model that produced the job.
  - string
  - "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more
    - "sora-2"
    - "sora-2-pro"
    - "sora-2-2025-10-06"
    - "sora-2-pro-2025-10-06"
    - "sora-2-2025-12-08"
- object: "video"
  
  The object type, which is always video.
  - "video"
- progress: number
  
  Approximate completion percentage for the generation task.
- prompt: string
  
  The prompt that was used to generate the video.
- remixed_from_video_id: string
  
  Identifier of the source video if this video is a remix.
- seconds: string or VideoSeconds
  
  Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
  - string
  - VideoSeconds = "4" or "8" or "12"
    - "4"
    - "8"
    - "12"
- size: VideoSize
  
  The resolution of the generated video.
  - "720x1280"
  - "1280x720"
  - "1024x1792"
  - "1792x1024"
- status: "queued" or "in_progress" or "completed" or "failed"
  
  Current lifecycle status of the video job.
  - "queued"
  - "in_progress"
  - "completed"
  - "failed"
first_id: string

The ID of the first item in the list.
has_more: boolean

Whether there are more items available.
last_id: string

The ID of the last item in the list.
object: "list"

The type of object returned, must be list.
- "list"

Example

curl https://api.openai.com/v1/videos \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Response

{
  "data": [
    {
      "id": "id",
      "completed_at": 0,
      "created_at": 0,
      "error": {
        "code": "code",
        "message": "message"
      },
      "expires_at": 0,
      "model": "sora-2",
      "object": "video",
      "progress": 0,
      "prompt": "prompt",
      "remixed_from_video_id": "remixed_from_video_id",
      "seconds": "4",
      "size": "720x1280",
      "status": "queued"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id",
  "object": "list"
}

Example

curl https://api.openai.com/v1/videos \
  -H "Authorization: Bearer $OPENAI_API_KEY"

Response

{
  "data": [
    {
      "id": "video_123",
      "object": "video",
      "model": "sora-2",
      "status": "completed"
    }
  ],
  "object": "list"
}

Retrieve video

get /videos/{video_id}

Retrieve video

Path Parameters

video_id: string

Returns

Video object { id, completed_at, created_at, 10 more }

Structured information describing a generated video job.
- id: string
  
  Unique identifier for the video job.
- completed_at: number
  
  Unix timestamp (seconds) for when the job completed, if finished.
- created_at: number
  
  Unix timestamp (seconds) for when the job was created.
- error: VideoCreateError
  
  Error payload that explains why generation failed, if applicable.
  - code: string
    
    A machine-readable error code that was returned.
  - message: string
    
    A human-readable description of the error that was returned.
- expires_at: number
  
  Unix timestamp (seconds) for when the downloadable assets expire, if set.
- model: VideoModel
  
  The video generation model that produced the job.
  - string
  - "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more
    - "sora-2"
    - "sora-2-pro"
    - "sora-2-2025-10-06"
    - "sora-2-pro-2025-10-06"
    - "sora-2-2025-12-08"
- object: "video"
  
  The object type, which is always video.
  - "video"
- progress: number
  
  Approximate completion percentage for the generation task.
- prompt: string
  
  The prompt that was used to generate the video.
- remixed_from_video_id: string
  
  Identifier of the source video if this video is a remix.
- seconds: string or VideoSeconds
  
  Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
  - string
  - VideoSeconds = "4" or "8" or "12"
    - "4"
    - "8"
    - "12"
- size: VideoSize
  
  The resolution of the generated video.
  - "720x1280"
  - "1280x720"
  - "1024x1792"
  - "1792x1024"
- status: "queued" or "in_progress" or "completed" or "failed"
  
  Current lifecycle status of the video job.
  - "queued"
  - "in_progress"
  - "completed"
  - "failed"

Example

curl https://api.openai.com/v1/videos/$VIDEO_ID \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Response

{
  "id": "id",
  "completed_at": 0,
  "created_at": 0,
  "error": {
    "code": "code",
    "message": "message"
  },
  "expires_at": 0,
  "model": "sora-2",
  "object": "video",
  "progress": 0,
  "prompt": "prompt",
  "remixed_from_video_id": "remixed_from_video_id",
  "seconds": "4",
  "size": "720x1280",
  "status": "queued"
}

Delete video

delete /videos/{video_id}

Delete video

Path Parameters

video_id: string

Returns

id: string

Identifier of the deleted video.
deleted: boolean

Indicates that the video resource was deleted.
object: "video.deleted"

The object type that signals the deletion response.
- "video.deleted"

Example

curl https://api.openai.com/v1/videos/$VIDEO_ID \
    -X DELETE \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Response

{
  "id": "id",
  "deleted": true,
  "object": "video.deleted"
}

Remix video

post /videos/{video_id}/remix

Remix video

Path Parameters

video_id: string

Body Parameters

prompt: string

Updated text prompt that directs the remix generation.

Returns

Video object { id, completed_at, created_at, 10 more }

Structured information describing a generated video job.
- id: string
  
  Unique identifier for the video job.
- completed_at: number
  
  Unix timestamp (seconds) for when the job completed, if finished.
- created_at: number
  
  Unix timestamp (seconds) for when the job was created.
- error: VideoCreateError
  
  Error payload that explains why generation failed, if applicable.
  - code: string
    
    A machine-readable error code that was returned.
  - message: string
    
    A human-readable description of the error that was returned.
- expires_at: number
  
  Unix timestamp (seconds) for when the downloadable assets expire, if set.
- model: VideoModel
  
  The video generation model that produced the job.
  - string
  - "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more
    - "sora-2"
    - "sora-2-pro"
    - "sora-2-2025-10-06"
    - "sora-2-pro-2025-10-06"
    - "sora-2-2025-12-08"
- object: "video"
  
  The object type, which is always video.
  - "video"
- progress: number
  
  Approximate completion percentage for the generation task.
- prompt: string
  
  The prompt that was used to generate the video.
- remixed_from_video_id: string
  
  Identifier of the source video if this video is a remix.
- seconds: string or VideoSeconds
  
  Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
  - string
  - VideoSeconds = "4" or "8" or "12"
    - "4"
    - "8"
    - "12"
- size: VideoSize
  
  The resolution of the generated video.
  - "720x1280"
  - "1280x720"
  - "1024x1792"
  - "1792x1024"
- status: "queued" or "in_progress" or "completed" or "failed"
  
  Current lifecycle status of the video job.
  - "queued"
  - "in_progress"
  - "completed"
  - "failed"

Example

curl https://api.openai.com/v1/videos/$VIDEO_ID/remix \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -d '{
          "prompt": "x"
        }'

Response

{
  "id": "id",
  "completed_at": 0,
  "created_at": 0,
  "error": {
    "code": "code",
    "message": "message"
  },
  "expires_at": 0,
  "model": "sora-2",
  "object": "video",
  "progress": 0,
  "prompt": "prompt",
  "remixed_from_video_id": "remixed_from_video_id",
  "seconds": "4",
  "size": "720x1280",
  "status": "queued"
}

Example

curl -X POST https://api.openai.com/v1/videos/video_123/remix \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Extend the scene with the cat taking a bow to the cheering audience"
  }'

Response

{
  "id": "video_456",
  "object": "video",
  "model": "sora-2",
  "status": "queued",
  "progress": 0,
  "created_at": 1712698600,
  "size": "720x1280",
  "seconds": "8",
  "remixed_from_video_id": "video_123"
}

Retrieve video content

get /videos/{video_id}/content

Retrieve video content

Path Parameters

video_id: string

Query Parameters

variant: optional "video" or "thumbnail" or "spritesheet"

Which downloadable asset to return. Defaults to the MP4 video.
- "video"
- "thumbnail"
- "spritesheet"

Example

curl https://api.openai.com/v1/videos/$VIDEO_ID/content \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Domain Types

Image Input Reference Param

ImageInputReferenceParam object { file_id, image_url }
- file_id: optional string
- image_url: optional string
  
  A fully qualified URL or base64-encoded data URL.

Video

Video object { id, completed_at, created_at, 10 more }

Structured information describing a generated video job.
- id: string
  
  Unique identifier for the video job.
- completed_at: number
  
  Unix timestamp (seconds) for when the job completed, if finished.
- created_at: number
  
  Unix timestamp (seconds) for when the job was created.
- error: VideoCreateError
  
  Error payload that explains why generation failed, if applicable.
  - code: string
    
    A machine-readable error code that was returned.
  - message: string
    
    A human-readable description of the error that was returned.
- expires_at: number
  
  Unix timestamp (seconds) for when the downloadable assets expire, if set.
- model: VideoModel
  
  The video generation model that produced the job.
  - string
  - "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more
    - "sora-2"
    - "sora-2-pro"
    - "sora-2-2025-10-06"
    - "sora-2-pro-2025-10-06"
    - "sora-2-2025-12-08"
- object: "video"
  
  The object type, which is always video.
  - "video"
- progress: number
  
  Approximate completion percentage for the generation task.
- prompt: string
  
  The prompt that was used to generate the video.
- remixed_from_video_id: string
  
  Identifier of the source video if this video is a remix.
- seconds: string or VideoSeconds
  
  Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
  - string
  - VideoSeconds = "4" or "8" or "12"
    - "4"
    - "8"
    - "12"
- size: VideoSize
  
  The resolution of the generated video.
  - "720x1280"
  - "1280x720"
  - "1024x1792"
  - "1792x1024"
- status: "queued" or "in_progress" or "completed" or "failed"
  
  Current lifecycle status of the video job.
  - "queued"
  - "in_progress"
  - "completed"
  - "failed"

Video Create Error

VideoCreateError object { code, message }

An error that occurred while generating the response.
- code: string
  
  A machine-readable error code that was returned.
- message: string
  
  A human-readable description of the error that was returned.

Video Model

VideoModel = string or "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more
- string
- "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more
  - "sora-2"
  - "sora-2-pro"
  - "sora-2-2025-10-06"
  - "sora-2-pro-2025-10-06"
  - "sora-2-2025-12-08"

Video Seconds

VideoSeconds = "4" or "8" or "12"
- "4"
- "8"
- "12"

Video Size

VideoSize = "720x1280" or "1280x720" or "1024x1792" or "1792x1024"
- "720x1280"
- "1280x720"
- "1024x1792"
- "1792x1024"

Video Create Character Response

VideoCreateCharacterResponse object { id, created_at, name }
- id: string
  
  Identifier for the character creation cameo.
- created_at: number
  
  Unix timestamp (in seconds) when the character was created.
- name: string
  
  Display name for the character.

Video Get Character Response

VideoGetCharacterResponse object { id, created_at, name }
- id: string
  
  Identifier for the character creation cameo.
- created_at: number
  
  Unix timestamp (in seconds) when the character was created.
- name: string
  
  Display name for the character.

Video Delete Response

VideoDeleteResponse object { id, deleted, object }

Confirmation payload returned after deleting a video.
- id: string
  
  Identifier of the deleted video.
- deleted: boolean
  
  Indicates that the video resource was deleted.
- object: "video.deleted"
  
  The object type that signals the deletion response.
  - "video.deleted"

resources/videos/index.md +98 −134

4 4

5**post** `/videos`5**post** `/videos`

6 6

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

~~9### Body Parameters~~

~~11- `prompt: string`~~

~~13 Text prompt that describes the video to generate.~~

~~15- `input_reference: optional ImageInputReferenceParam`~~

~~17 Optional reference object that guides generation. Provide exactly one of `image_url` or `file_id`.~~

~~19 - `file_id: optional string`~~

~~21 - `image_url: optional string`~~

~~23 A fully qualified URL or base64-encoded data URL.~~

~~25- `model: optional VideoModel`~~

~~27 The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults to `sora-2`.~~

~~29 - `string`~~

~~31 - `"sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more`~~

~~33 - `"sora-2"`~~

~~35 - `"sora-2-pro"`~~

~~37 - `"sora-2-2025-10-06"`~~

~~39 - `"sora-2-pro-2025-10-06"`~~

~~41 - `"sora-2-2025-12-08"`~~

~~43- `seconds: optional VideoSeconds`~~

~~45 Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds.~~

~~47 - `"4"`~~

~~49 - `"8"`~~

~~51 - `"12"`~~

~~53- `size: optional VideoSize`~~

~~55 Output resolution formatted as width x height (allowed values: 720x1280, 1280x720, 1024x1792, 1792x1024). Defaults to 720x1280.~~

~~57 - `"720x1280"`~~

~~59 - `"1280x720"`~~

~~61 - `"1024x1792"`~~

~~63 - `"1792x1024"`~~

64 8

65### Returns9### Returns

66 10

132 76

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

134 78

135 - `seconds: string`79 - `seconds: string or VideoSeconds`

136 80

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

138 82

83 - `string`

85 - `VideoSeconds = "4" or "8" or "12"`

87 - `"4"`

89 - `"8"`

91 - `"12"`

139 - `size: VideoSize`93 - `size: VideoSize`

140 94

141 The resolution of the generated video.95 The resolution of the generated video.

164 118

165```http119```http

166curl https://api.openai.com/v1/videos \120curl https://api.openai.com/v1/videos \

167 -H 'Content-Type: application/json' \121 -H 'Content-Type: multipart/form-data' \

168 -H "Authorization: Bearer $OPENAI_API_KEY" \122 -H "Authorization: Bearer $OPENAI_API_KEY" \

169 -d '{123 -F prompt=x

170 "prompt": "x"

171 }'

172```124```

173 125

174#### Response126#### Response

188 "progress": 0,140 "progress": 0,

189 "prompt": "prompt",141 "prompt": "prompt",

190 "remixed_from_video_id": "remixed_from_video_id",142 "remixed_from_video_id": "remixed_from_video_id",

191 "seconds": "seconds",143 "seconds": "4",

192 "size": "720x1280",144 "size": "720x1280",

193 "status": "queued"145 "status": "queued"

194}146}

225 177

226Create a new video generation job by editing a source video or existing generated video.178Create a new video generation job by editing a source video or existing generated video.

227 179

228### Body Parameters

~~229~~

230- `prompt: string`

~~231~~

232 Text prompt that describes how to edit the source video.

~~233~~

234- `video: object { id }`

~~235~~

236 Reference to the completed video to edit.

~~237~~

238 - `id: string`

~~239~~

240 The identifier of the completed video.

~~241~~

242### Returns180### Returns

243 181

244- `Video object { id, completed_at, created_at, 10 more }`182- `Video object { id, completed_at, created_at, 10 more }`

309 247

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

311 249

312 - `seconds: string`250 - `seconds: string or VideoSeconds`

313 251

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

315 253

254 - `string`

255

256 - `VideoSeconds = "4" or "8" or "12"`

257

258 - `"4"`

259

260 - `"8"`

261

262 - `"12"`

263

316 - `size: VideoSize`264 - `size: VideoSize`

317 265

318 The resolution of the generated video.266 The resolution of the generated video.

341 289

342```http290```http

343curl https://api.openai.com/v1/videos/edits \291curl https://api.openai.com/v1/videos/edits \

344 -H 'Content-Type: application/json' \292 -H 'Content-Type: multipart/form-data' \

345 -H "Authorization: Bearer $OPENAI_API_KEY" \293 -H "Authorization: Bearer $OPENAI_API_KEY" \

346 -d '{294 -F prompt=x \

347 "prompt": "x",295 -F video='Example data'

348 "video": {

349 "id": "video_123"

350 }

351 }'

352```296```

353 297

354#### Response298#### Response

368 "progress": 0,312 "progress": 0,

369 "prompt": "prompt",313 "prompt": "prompt",

370 "remixed_from_video_id": "remixed_from_video_id",314 "remixed_from_video_id": "remixed_from_video_id",

371 "seconds": "seconds",315 "seconds": "4",

372 "size": "720x1280",316 "size": "720x1280",

373 "status": "queued"317 "status": "queued"

374}318}

380 324

381Create an extension of a completed video.325Create an extension of a completed video.

382 326

383### Body Parameters

~~384~~

385- `prompt: string`

~~386~~

387 Updated text prompt that directs the extension generation.

~~388~~

389- `seconds: VideoSeconds`

~~390~~

391 Length of the newly generated extension segment in seconds (allowed values: 4, 8, 12, 16, 20).

~~392~~

393 - `"4"`

~~394~~

395 - `"8"`

~~396~~

397 - `"12"`

~~398~~

399- `video: object { id }`

~~400~~

401 Reference to the completed video to extend.

~~402~~

403 - `id: string`

~~404~~

405 The identifier of the completed video.

~~406~~

407### Returns327### Returns

408 328

409- `Video object { id, completed_at, created_at, 10 more }`329- `Video object { id, completed_at, created_at, 10 more }`

474 394

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

476 396

477 - `seconds: string`397 - `seconds: string or VideoSeconds`

478 398

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

480 400

401 - `string`

402

403 - `VideoSeconds = "4" or "8" or "12"`

404

405 - `"4"`

406

407 - `"8"`

408

409 - `"12"`

410

481 - `size: VideoSize`411 - `size: VideoSize`

482 412

483 The resolution of the generated video.413 The resolution of the generated video.

506 436

507```http437```http

508curl https://api.openai.com/v1/videos/extensions \438curl https://api.openai.com/v1/videos/extensions \

509 -H 'Content-Type: application/json' \439 -H 'Content-Type: multipart/form-data' \

510 -H "Authorization: Bearer $OPENAI_API_KEY" \440 -H "Authorization: Bearer $OPENAI_API_KEY" \

511 -d '{441 -F prompt=x \

512 "prompt": "x",442 -F seconds=4 \

513 "seconds": "4",443 -F video='Example data'

514 "video": {

515 "id": "video_123"

516 }

517 }'

518```444```

519 445

520#### Response446#### Response

534 "progress": 0,460 "progress": 0,

535 "prompt": "prompt",461 "prompt": "prompt",

536 "remixed_from_video_id": "remixed_from_video_id",462 "remixed_from_video_id": "remixed_from_video_id",

537 "seconds": "seconds",463 "seconds": "4",

538 "size": "720x1280",464 "size": "720x1280",

539 "status": "queued"465 "status": "queued"

540}466}

625 551

626**get** `/videos`552**get** `/videos`

627 553

628List recently generated videos for the current project.554List videos

629 555

630### Query Parameters556### Query Parameters

631 557

715 641

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

717 643

718 - `seconds: string`644 - `seconds: string or VideoSeconds`

719 645

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

721 647

648 - `string`

649

650 - `VideoSeconds = "4" or "8" or "12"`

651

652 - `"4"`

653

654 - `"8"`

655

656 - `"12"`

657

722 - `size: VideoSize`658 - `size: VideoSize`

723 659

724 The resolution of the generated video.660 The resolution of the generated video.

787 "progress": 0,723 "progress": 0,

788 "prompt": "prompt",724 "prompt": "prompt",

789 "remixed_from_video_id": "remixed_from_video_id",725 "remixed_from_video_id": "remixed_from_video_id",

790 "seconds": "seconds",726 "seconds": "4",

791 "size": "720x1280",727 "size": "720x1280",

792 "status": "queued"728 "status": "queued"

793 }729 }

826 762

827**get** `/videos/{video_id}`763**get** `/videos/{video_id}`

828 764

829Fetch the latest metadata for a generated video.765Retrieve video

830 766

831### Path Parameters767### Path Parameters

832 768

902 838

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

904 840

905 - `seconds: string`841 - `seconds: string or VideoSeconds`

906 842

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

908 844

845 - `string`

846

847 - `VideoSeconds = "4" or "8" or "12"`

848

849 - `"4"`

850

851 - `"8"`

852

853 - `"12"`

854

909 - `size: VideoSize`855 - `size: VideoSize`

910 856

911 The resolution of the generated video.857 The resolution of the generated video.

954 "progress": 0,900 "progress": 0,

955 "prompt": "prompt",901 "prompt": "prompt",

956 "remixed_from_video_id": "remixed_from_video_id",902 "remixed_from_video_id": "remixed_from_video_id",

957 "seconds": "seconds",903 "seconds": "4",

958 "size": "720x1280",904 "size": "720x1280",

959 "status": "queued"905 "status": "queued"

960}906}

964 910

965**delete** `/videos/{video_id}`911**delete** `/videos/{video_id}`

966 912

967Permanently delete a completed or failed video and its stored assets.913Delete video

968 914

969### Path Parameters915### Path Parameters

970 916

1008 954

1009**post** `/videos/{video_id}/remix`955**post** `/videos/{video_id}/remix`

1010 956

1011Create a remix of a completed video using a refreshed prompt.957Remix video

1012 958

1013### Path Parameters959### Path Parameters

1014 960

1090 1036

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

1092 1038

1093 - `seconds: string`1039 - `seconds: string or VideoSeconds`

1094 1040

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

1096 1042

1043 - `string`

1044

1045 - `VideoSeconds = "4" or "8" or "12"`

1046

1047 - `"4"`

1048

1049 - `"8"`

1050

1051 - `"12"`

1052

1097 - `size: VideoSize`1053 - `size: VideoSize`

1098 1054

1099 The resolution of the generated video.1055 The resolution of the generated video.

1146 "progress": 0,1102 "progress": 0,

1147 "prompt": "prompt",1103 "prompt": "prompt",

1148 "remixed_from_video_id": "remixed_from_video_id",1104 "remixed_from_video_id": "remixed_from_video_id",

1149 "seconds": "seconds",1105 "seconds": "4",

1150 "size": "720x1280",1106 "size": "720x1280",

1151 "status": "queued"1107 "status": "queued"

1152}1108}

1183 1139

1184**get** `/videos/{video_id}/content`1140**get** `/videos/{video_id}/content`

1185 1141

1186Download the generated video bytes or a derived preview asset.1142Retrieve video content

~~1187~~

1188Streams the rendered video content for the specified video job.

1189 1143

1190### Path Parameters1144### Path Parameters

1191 1145

1292 1246

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

1294 1248

1295 - `seconds: string`1249 - `seconds: string or VideoSeconds`

1296 1250

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

1298 1252

1253 - `string`

1254

1255 - `VideoSeconds = "4" or "8" or "12"`

1256

1257 - `"4"`

1258

1259 - `"8"`

1260

1261 - `"12"`

1262

1299 - `size: VideoSize`1263 - `size: VideoSize`

1300 1264

1301 The resolution of the generated video.1265 The resolution of the generated video.

resources/videos/index.md 2026-07-07 08:02 UTC to 2026-07-09 20:58 UTC

Videos

Create video

Returns

Example

Response

Example

Response

Create a new video generation job by editing a source video or existing generated video.

Returns

Example

Response

Create an extension of a completed video.

Returns

Example

Response

Create a character from an uploaded video.

Returns

Example

Response

Fetch a character.

Path Parameters

Returns

Example

Response

List videos

Query Parameters

Returns

Example

Response

Example

Response

Retrieve video

Path Parameters

Returns

Example

Response

Delete video

Path Parameters

Returns

Example

Response

Remix video

Path Parameters

Body Parameters

Returns

Example

Response

Example

Response

Retrieve video content

Path Parameters

Query Parameters

Example

Domain Types

Image Input Reference Param

Video

Video Create Error

Video Model

Video Seconds

Video Size

Video Create Character Response

Video Get Character Response

Video Delete Response