SpyBara
Go Premium

java/resources/videos/methods/create/index.md 2026-06-10 15:48 UTC to 2026-06-12 00:01 UTC

228 added, 0 removed.

2026
Wed 17 18:02 Tue 16 21:57 Fri 12 00:01 Wed 10 15:48 Tue 9 06:34 Fri 5 06:45 Thu 4 06:52 Tue 2 06:51

Create video

Video videos().create(VideoCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post /videos

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

Parameters

  • VideoCreateParams params

    • String prompt

      Text prompt that describes the video to generate.

    • Optional<InputReference> inputReference

      Optional reference asset upload or reference object that guides generation.

      • String

      • class ImageInputReferenceParam:

        • Optional<String> fileId

        • Optional<String> imageUrl

          A fully qualified URL or base64-encoded data URL.

    • Optional<VideoModel> model

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

    • Optional<VideoSeconds> seconds

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

    • Optional<VideoSize> size

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

Returns

  • class Video:

    Structured information describing a generated video job.

    • String id

      Unique identifier for the video job.

    • Optional<Long> completedAt

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

    • long createdAt

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

    • Optional<VideoCreateError> error

      Error payload that explains why generation failed, if applicable.

      • String code

        A machine-readable error code that was returned.

      • String message

        A human-readable description of the error that was returned.

    • Optional<Long> expiresAt

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

    • VideoModel model

      The video generation model that produced the job.

      • SORA_2("sora-2")

      • SORA_2_PRO("sora-2-pro")

      • SORA_2_2025_10_06("sora-2-2025-10-06")

      • SORA_2_PRO_2025_10_06("sora-2-pro-2025-10-06")

      • SORA_2_2025_12_08("sora-2-2025-12-08")

    • JsonValue; object_ "video"constant

      The object type, which is always video.

      • VIDEO("video")

    • long progress

      Approximate completion percentage for the generation task.

    • Optional<String> prompt

      The prompt that was used to generate the video.

    • Optional<String> remixedFromVideoId

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

    • VideoSeconds seconds

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

      • _4("4")

      • _8("8")

      • _12("12")

    • VideoSize size

      The resolution of the generated video.

      • _720X1280("720x1280")

      • _1280X720("1280x720")

      • _1024X1792("1024x1792")

      • _1792X1024("1792x1024")

    • Status status

      Current lifecycle status of the video job.

      • QUEUED("queued")

      • IN_PROGRESS("in_progress")

      • COMPLETED("completed")

      • FAILED("failed")

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.videos.Video;
import com.openai.models.videos.VideoCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        VideoCreateParams params = VideoCreateParams.builder()
            .prompt("x")
            .build();
        Video video = client.videos().create(params);
    }
}

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

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.videos.Video;
import com.openai.models.videos.VideoCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        VideoCreateParams params = VideoCreateParams.builder()
            .prompt("A calico cat playing a piano on stage")
            .build();
        Video video = client.videos().create(params);
    }
}

Response

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