Use Sora 2 through Rivya Public API v1 with model id sora-2, supported inputs, parameters, Files API rules, credits, and response examples.

Available via APIText or URL ready; reference modes use Files APIVideo

API model id

sora-2

Inputs

text, file

Files API

Required for reference modes

Base credits

Capability

Video

Billing

FIXED

Prompt limit

10000 characters

Request contract

Send the model id at the top level. Model-specific controls belong in params.

Key	Type	Required	Default	Description
model	string	Yes	sora-2	Use the sora-2 API model id.
prompt	string	Yes	-	Maximum 10000 characters for this model.
params	object	No	-	Model-specific parameter object. Use the rows below for allowed keys.
client_request_id	string	No	-	Optional client-side id for tracing requests in your system.

Model parameters

Key	Type	Required	Default	Range	Options	Description
n_frames	select	No	10	-	10, 15	Duration
aspect_ratio	select	No	landscape	-	landscape, portrait	Aspect ratio
remove_watermark	select	No	false	-	false, true	Remove watermark
upload_method	select	No	s3	-	s3, oss	Upload target

Upload policy

Upload reference files first, then place the returned URL and duration token inside params.referenceMediaItems.

Reference rule

Reference image: Upload up to 1 image file for image projects.

Max files

Accepted file kinds

image

Duration token

Video and audio references should carry durationToken from /api/v1/files when duration verification is required.

kind	Max size	MIME types
image	10 MB	image/jpeg, image/png, image/webp

Minimal request

{
  "model": "sora-2",
  "prompt": "A cinematic product reveal with smooth camera movement",
  "params": {
    "n_frames": "10",
    "aspect_ratio": "landscape",
    "remove_watermark": "false",
    "upload_method": "s3"
  }
}

Reference-file request

{
  "model": "sora-2",
  "prompt": "A cinematic product reveal with smooth camera movement",
  "params": {
    "n_frames": "10",
    "aspect_ratio": "landscape",
    "remove_watermark": "false",
    "upload_method": "s3",
    "referenceMediaItems": [
      {
        "url": "https://cdn.example.com/reference-image.png",
        "kind": "image",
        "name": "reference-image.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Create response

The create endpoint returns a public task id. Poll the status endpoint until the task succeeds or fails.

{
  "id": "task_sora_2_example",
  "status": "queued",
  "model": "sora-2",
  "reserved_credits": 6,
  "final_credits": 0,
  "created_at": "2026-05-11T00:00:00.000Z",
  "updated_at": "2026-05-11T00:00:00.000Z",
  "result": null,
  "error": null
}

Common errors

validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found

Some modes require Files API reference uploads.

Sora 2 API Integration