API Reference

Videos

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

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

videos.edit(**kwargs) -> Video { id, completed_at, created_at, 10 more }

POST/videos/edits

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

ParametersExpand Collapse

prompt: String

Text prompt that describes how to edit the source video.

maxLength32000

minLength1

video: String | { id}

Reference to the completed video to edit.

One of the following:

String

Reference to the completed video to edit.

class VideoReferenceInputParam { id }

Reference to the completed video.

id: String

The identifier of the completed video.

ReturnsExpand Collapse

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

Structured information describing a generated video job.

id: String

Unique identifier for the video job.

completed_at: Integer

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

created_at: Integer

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

error: VideoCreateError { code, message }

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: Integer

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

model: VideoModel

The video generation model that produced the job.

One of the following:

String

:"sora-2" | :"sora-2-pro" | :"sora-2-2025-10-06" | 2 more

One of the following:

:"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.

progress: Integer

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 | VideoSeconds

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

One of the following:

String

VideoSeconds = :"4" | :"8" | :"12"

One of the following:

:"4"

:"8"

:"12"

size: VideoSize

The resolution of the generated video.

One of the following:

:"720x1280"

:"1280x720"

:"1024x1792"

:"1792x1024"

status: :queued | :in_progress | :completed | :failed

Current lifecycle status of the video job.

One of the following:

:queued

:in_progress

:completed

:failed

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

Ruby

HTTP

TypeScript

Python

Java

Go

Ruby

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

video = openai.videos.edit(prompt: "x", video: StringIO.new("Example data"))

puts(video)

200 example

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

Returns Examples

200 example

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