Rivya AI Docs
Model API Pages

Veo3.1 Quality API Integration

Veo3.1 Quality کو Rivya Public API v1 کے ذریعے model id veo3-1-quality، supported inputs، parameters، Files API rules، credits اور response examples کے ساتھ استعمال کریں۔

API کے ذریعے availableText یا URL ready؛ reference modes Files API استعمال کرتے ہیںویڈیو
API model id

veo3-1-quality

Inputs

text, file

Files API

Reference modes کے لیے required

Base credits

150

Capability

ویڈیو

Billing

FIXED

Prompt limit

5000 characters

Request contract

model id کو top level پر بھیجیں۔ Model-specific controls params میں رہتے ہیں۔

KeyTypeRequiredDefaultDescription
modelstringYesveo3-1-qualityveo3-1-quality API model id استعمال کریں۔
promptstringYes-اس model کے لیے زیادہ سے زیادہ 5000 characters۔
paramsobjectNo-Model-specific parameter object۔ allowed keys کے لیے نیچے والی rows استعمال کریں۔
client_request_idstringNo-آپ کے system میں requests trace کرنے کے لیے optional client-side id۔

Model parameters

KeyTypeRequiredDefaultRangeOptionsDescription
aspectRatioselectNo16:9-16:9, 9:16, AutoAspect ratio
watermarktextNo---Watermark text
seedsnumberNo-min 10000 / max 99999 / step 1-ہر بار نیا random result چاہیے ہو تو اسے empty چھوڑیں۔ اسی integer کو دوبارہ use کرنے سے previous result reproduce یا fine-tune کرنا آسان ہوتا ہے۔ Result صرف اسی وقت زیادہ قریب رہتا ہے جب prompt اور دوسرے key settings بھی similar رہیں، اور یہ guaranteed 1:1 match نہیں ہوتا۔
enableTranslationselectNotrue-true, falsePrompt translation

Upload policy

Reference files پہلے upload کریں، پھر returned URL اور duration token کو params.referenceMediaItems کے اندر رکھیں۔

Reference rule

Reference image: Supported image-led project کے لیے 2 image files تک upload کریں۔

Max files

2

Accepted file kinds

image

Duration token

duration verification required ہو تو video اور audio references کو /api/v1/files سے durationToken ساتھ رکھنا چاہیے۔

kindMax sizeMIME types
image10 MBimage/jpeg, image/png, image/webp

Minimal request

{
  "model": "veo3-1-quality",
  "prompt": "A cinematic product reveal with smooth camera movement",
  "params": {
    "aspectRatio": "16:9",
    "watermark": "اختیاری watermark text",
    "seeds": 10000,
    "enableTranslation": "true"
  }
}

Reference-file request

{
  "model": "veo3-1-quality",
  "prompt": "A cinematic product reveal with smooth camera movement",
  "params": {
    "aspectRatio": "16:9",
    "watermark": "اختیاری watermark text",
    "seeds": 10000,
    "enableTranslation": "true",
    "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_veo3_1_quality_example",
  "status": "queued",
  "model": "veo3-1-quality",
  "reserved_credits": 150,
  "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 درکار ہوتے ہیں۔