Sora 2 API Integration
Sora 2 کو Rivya Public API v1 کے ذریعے model id sora-2، supported inputs، parameters، Files API rules، credits اور response examples کے ساتھ استعمال کریں۔
sora-2
text, file
Reference modes کے لیے required
6
ویڈیو
FIXED
10000 characters
Request contract
model id کو top level پر بھیجیں۔ Model-specific controls params میں رہتے ہیں۔
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| model | string | Yes | sora-2 | sora-2 API model id استعمال کریں۔ |
| prompt | string | Yes | - | اس model کے لیے زیادہ سے زیادہ 10000 characters۔ |
| params | object | No | - | Model-specific parameter object۔ allowed keys کے لیے نیچے والی rows استعمال کریں۔ |
| client_request_id | string | No | - | آپ کے system میں requests trace کرنے کے لیے optional client-side id۔ |
Model parameters
| Key | Type | Required | Default | Range | Options | Description |
|---|---|---|---|---|---|---|
| n_frames | select | No | 10 | - | 10, 15 | دورانیہ |
| aspect_ratio | select | No | landscape | - | landscape, portrait | فریم تناسب |
| remove_watermark | select | No | false | - | false, true | Watermark ہٹائیں |
| upload_method | select | No | s3 | - | s3, oss | Upload ہدف |
Upload policy
Reference files پہلے upload کریں، پھر returned URL اور duration token کو params.referenceMediaItems کے اندر رکھیں۔
ریفرنس تصویر: Image projects کے لیے 1 image file تک upload کریں۔
1
image
duration verification required ہو تو video اور audio references کو /api/v1/files سے durationToken ساتھ رکھنا چاہیے۔
| 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
create endpoint ایک public task id واپس کرتا ہے۔ task succeeded یا failed ہونے تک status endpoint poll کریں۔
{
"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
کچھ modes کو Files API reference uploads درکار ہوتے ہیں۔