Ray3.2

Identifier for the type of task being performed

UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.

Video output type.

Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities.

• `MP4`: Widely supported video container (H.264), recommended for general use.
• `WEBM`: Optimized for web delivery.
• `MOV`: QuickTime format, common in professional workflows (Apple ecosystem).

Compression quality of the output. Higher values preserve quality but increase file size.

Specifies a webhook URL where JSON responses will be sent via HTTP POST when generation tasks complete. For batch requests with multiple results, each completed item triggers a separate webhook call as it becomes available.

Determines how the API delivers task results.

Specifies a URL where the generated content will be automatically uploaded using the HTTP PUT method. The raw binary data of the media file is sent directly as the request body. For secure uploads to cloud storage, use presigned URLs that include temporary authentication credentials.

Common use cases:

• Cloud storage: Upload directly to S3 buckets, Google Cloud Storage, or Azure Blob Storage using presigned URLs.
• CDN integration: Upload to content delivery networks for immediate distribution.

// S3 presigned URL for secure upload
https://your-bucket.s3.amazonaws.com/generated/content.mp4?X-Amz-Signature=abc123&X-Amz-Expires=3600

// Google Cloud Storage presigned URL
https://storage.googleapis.com/your-bucket/content.jpg?X-Goog-Signature=xyz789

// Custom storage endpoint
https://storage.example.com/uploads/generated-image.jpg

The content data will be sent as the request body to the specified URL when generation is complete.

Content safety checking configuration for video generation.

Time-to-live (TTL) in seconds for generated content. Only applies when outputType is URL.

Include task cost in the response.

Number of results to generate. Each result uses a different seed, producing variations of the same parameters.

An array of frame-specific image inputs to guide video generation. Each item can be either a plain image input (UUID, URL, Data URI, or Base64) or an object that pairs an image with a target position in the video.

The frameImages parameter allows you to constrain specific frames within the video sequence, ensuring that particular visual content appears at designated points. Position can be specified using frame (named positions or frame indices) or timestamp (seconds), depending on model support. This is different from referenceImages, which provide overall visual guidance without constraining specific timeline positions.

When the frame parameter is omitted, automatic distribution rules apply:

• 1 image: Used as the first frame.
• 2 images: First and last frames.
• 3+ images: First and last frames, with intermediate images evenly spaced between.

"frameImages": [
  "aac49721-1964-481a-ae78-8a4e29b91402"
]

"frameImages": [
  {
    "image": "aac49721-1964-481a-ae78-8a4e29b91402",
    "frame": "first"
  }
]

"frameImages": [
  "aac49721-1964-481a-ae78-8a4e29b91402",
  {
    "image": "3ad204c3-a9de-4963-8a1a-c3911e3afafe",
    "frame": "last"
  }
]

"frameImages": [
  {
    "image": "aac49721-1964-481a-ae78-8a4e29b91402",
    "frame": "first"
  },
  "c00abf5f-6cdb-4642-a01d-1bfff7bc3cf7",
  {
    "image": "3ad204c3-a9de-4963-8a1a-c3911e3afafe",
    "frame": "last"
  }
]

Source video to edit or reframe (UUID or URL). Editing preserves the source aspect ratio; reframing places it on a new canvas.

Identifier of the model to use for generation.

Text prompt describing elements to include in the generated output.

Width of the generated media in pixels.

Height of the generated media in pixels.

Resolution preset for the output. When used with input media, automatically matches the aspect ratio from the input.

Length of the generated video in seconds. The total number of frames produced is determined by duration multiplied by the model's frame rate (fps).

Conditioning controls applied when editing the source video.

Also export an OpenEXR frame sequence alongside the MP4.

Render in high dynamic range.

Loop the generated video seamlessly.

Placement of the source video within the output canvas, as fractions of the canvas size.