Skip to content
API Reference
Videos

Remix video

client.videos.remix(stringvideoID, VideoRemixParams { prompt } body, RequestOptionsoptions?): Video { id, completed_at, created_at, 10 more }
POST/videos/{video_id}/remix

Create a video remix

ParametersExpand Collapse
videoID: string
body: VideoRemixParams { prompt }
prompt: string

Updated text prompt that directs the remix generation.

maxLength32000
minLength1
ReturnsExpand Collapse
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: number | null

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

created_at: number

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

error: VideoCreateError { code, message } | null

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

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

model: VideoModel

The video generation model that produced the job.

Accepts one of the following:
(string & {})
"sora-2" | "sora-2-pro" | "sora-2-2025-10-06" | 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.

progress: number

Approximate completion percentage for the generation task.

prompt: string | null

The prompt that was used to generate the video.

remixed_from_video_id: string | null

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

seconds: VideoSeconds

Duration of the generated clip in seconds.

Accepts one of the following:
"4"
"8"
"12"
size: VideoSize

The resolution of the generated video.

Accepts one of the following:
"720x1280"
"1280x720"
"1024x1792"
"1792x1024"
status: "queued" | "in_progress" | "completed" | "failed"

Current lifecycle status of the video job.

Accepts one of the following:
"queued"
"in_progress"
"completed"
"failed"

Remix video

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted
});

const video = await client.videos.remix('video_123', { prompt: 'x' });

console.log(video.id);
{
  "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": "4",
  "size": "720x1280",
  "status": "queued"
}
Returns Examples
{
  "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": "4",
  "size": "720x1280",
  "status": "queued"
}