تخلیقی درخواست بھیجیں

غیر ہم وقت تصویر، ویڈیو یا آڈیو بنانے کا کام بھیجنے کے لیے POST /api/v1/generations استعمال کریں۔

چیٹ ماڈلز کے لیے Chat API استعمال کریں۔ POST /api/v1/generations چیٹ سیشن یا معاون کے پیغامات نہیں بناتا۔

اینڈ پوائنٹ

POST https://rivya.ai/api/v1/generations

درکار سرخیاں:

Authorization: Bearer rvya_sk_...
Content-Type: application/json

تجویز کردہ سرنامہ یہ ہے:

Idempotency-Key: your-unique-request-key

درخواست کا متن

{
  "model": "z-image",
  "prompt": "A clean editorial product image on a soft studio background",
  "params": {
    "aspect_ratio": "1:1"
  },
  "client_request_id": "order-123-preview"
}

خانے یہ ہیں:

• model: ضروری عوامی ماڈل شناخت

• prompt: پرامپٹ متن، بہت سے ماڈلز کے لیے ضروری

• params: ماڈل کے مخصوص پیرامیٹرز کا مجموعہ

• client_request_id: آپ کے نظام کا اختیاری سراغی شناختی کوڈ

ہر ماڈل کے مخصوص params کے لیے ماڈل API حوالہ پڑھیں۔

params میں حوالہ جاتی فائلیں

اپ لوڈ شدہ حوالہ جاتی میڈیا قبول کرنے والے ماڈلز کے لیے پہلے فائلز API استعمال کریں۔ پھر اپ لوڈ کا نتیجہ ماڈل کے params کے ذریعے بھیجیں؛ تخلیقی درخواست میں بالائی سطح کا files خانہ شامل نہ کریں۔

نئے انضمام کے لیے params.referenceMediaItems استعمال کریں:

{
  "model": "nano-banana-2-lite",
  "prompt": "Restyle this product photo for a clean editorial catalog page",
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://...",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png",
        "width": 1024,
        "height": 1024,
        "sizeBytes": 482314,
        "imageDimensionsToken": "image_dimensions_token_from_files_api"
      }
    ]
  }
}

جن آڈیو یا ویڈیو ابتدائی مواد میں دورانیے کی تصدیق درکار ہو، وہاں /api/v1/files سے واپس آنے والا duration_token متعلقہ referenceMediaItems اندراج میں durationToken کے طور پر شامل کریں۔

ہر Image5 حوالہ جاتی تصویر کے ساتھ اصل ماڈل سے منسلک فائلز API جواب کا width، height، size_bytes اور image_dimensions_token درکار ہے؛ انہیں بالترتیب width، height، sizeBytes اور imageDimensionsToken کے طور پر بھیجیں۔ رمزی نشان غائب، زائد المیعاد، غیر مطابق یا صارف کے نظام کا گھڑا ہوا ہو تو کام بننے اور کریڈٹس مختص ہونے سے پہلے درخواست ناکام ہو جاتی ہے۔ Layer Decomposition کی درج شدہ جیومیٹری حدود میں عین ایک تصویر بھی ضروری ہے۔

Grok Imagine Image 2.0 پر دستخط شدہ تصویری معلومات کی یہی شرط لاگو ہوتی ہے۔ متن سے تصویر کے لیے کوئی حوالہ جاتی اندراج نہ بھیجیں، جبکہ معیاری تصویری ترمیم کے لیے 1 سے 5 منفرد اور دستخط شدہ JPEG، PNG یا WebP حوالہ جاتی اندراج بھیجیں۔ متن سے تصویر میں 1:1، 2:3، 3:2، 16:9 یا 9:16 قبول ہوتے ہیں؛ تصویری ترمیم میں auto بھی قبول ہوتا ہے۔ Segment Map اور Segment Edit عوامی API کے ذریعے استعمال نہیں کیے جا سکتے۔

ہر Video8 حوالہ جاتی ویڈیو کے ساتھ اصل ماڈل سے منسلک جواب کا duration_seconds، duration_token، video_width، video_height، frames_per_second، video_bitrate_mbps، video_file_size_bytes اور video_metadata_token درکار ہے۔ انہیں بالترتیب durationSeconds، durationToken، width، height، framesPerSecond، videoBitrateMbps، sizeBytes اور videoMetadataToken کے طور پر بھیجیں۔ دونوں دستخط شدہ رمزی نشانات کی کام بننے اور کریڈٹس مختص ہونے سے پہلے تصدیق ہوتی ہے۔

Wan 3.0 میں seedance_scene کی تین باہم الگ قدریں استعمال ہوتی ہیں۔ text کوئی اپ لوڈ شدہ میڈیا قبول نہیں کرتا؛ frames میں پہلی تصویر لازمی اور آخری تصویر اختیاری ہے؛ reference دستخط شدہ تصاویر، ویڈیوز اور آڈیو کا مجموعہ قبول کرتا ہے، مگر آڈیو واحد میڈیا نہیں ہو سکتا۔ تمام حوالہ جاتی URL اصل ماڈل سے منسلک فائلز API اپ لوڈ سے آنے چاہییں۔ فائل سے ویڈیو اور ربط سے ویڈیو کے مختصر راستے دستیاب نہیں۔

variant کو standard یا prime، resolution کو 480P، 720P یا 1080P اور aspect_ratio کو adaptive، 16:9، 4:3، 1:1، 3:4 یا 9:16 پر مقرر کریں۔ duration میں 2 سے 30 تک صحیح اعداد یا ذہین دورانیے کے لیے -1 قبول ہوتا ہے؛ audio ماڈل کی بنائی ہوئی آڈیو کو قابو کرتا ہے اور seed میں 0 سے 2147483647 تک قدریں قبول ہوتی ہیں۔ تراشے گئے پرامپٹ میں 1–20,000 حروف ہونا ضروری ہے۔

Wan 3.0 کا standard طریقہ 480P، 720P یا 1080P پر مطلوبہ نتیجے کے ہر سیکنڈ کے لیے بالترتیب 8، 16 یا 32 کریڈٹس مختص کرتا ہے۔ prime طریقہ ہر سیکنڈ کے لیے 12.2، 25.2 یا 50.4 کریڈٹس مختص کرتا ہے۔ Rivya مجموعی مقدار کو ایک بار اوپر کی طرف گول کرتا ہے؛ ذہین دورانیہ 30 سیکنڈ مختص کرتا ہے۔ درست حقیقی استعمال مختص مقدار کے برابر یا اس سے کم ہو تو حساب مکمل ہوتا اور فرق واپس ملتا ہے۔ حقیقی استعمال غائب، غلط یا مختص مقدار سے زیادہ ہو تو مختص رقم برقرار رہتی اور معاملہ تطبیق کے لیے جاتا ہے، مگر کوئی پوشیدہ اضافی کٹوتی نہیں ہوتی۔

Wan 3.0 کے حوالہ جاتی طریقے میں زیادہ سے زیادہ 10 تصاویر، 5 ویڈیوز اور 5 آڈیو کلپس بھیجیں۔ ہر ویڈیو اور آڈیو کلپ کا دورانیہ 1 سے 15 سیکنڈ ہے اور ہر قسم کی الگ مجموعی حد 15 سیکنڈ ہے۔ حوالہ جاتی ویڈیو کے ساتھ duration=-1 استعمال نہیں کیا جا سکتا؛ ویڈیو ابتدائی مواد کی صورت میں تصدیق شدہ ابتدائی ویڈیو اور مطلوبہ نتیجے کے سیکنڈز کا مجموعہ 30 سے زیادہ نہیں ہونا چاہیے۔

Video8 کے ویڈیو اور آڈیو میں ہونٹوں کی ہم آہنگی والے کام کی مثال:

{
  "model": "volcengine-video-lip-sync",
  "prompt": "",
  "params": {
    "mode": "lite",
    "separate_vocal": "false",
    "open_scenedet": "false",
    "referenceMediaItems": [
      {
        "url": "https://.../source.mov",
        "kind": "video",
        "name": "source.mov",
        "mimeType": "video/quicktime",
        "durationSeconds": 12.4,
        "durationToken": "duration_token_from_files_api",
        "width": 1920,
        "height": 1080,
        "framesPerSecond": 30,
        "videoBitrateMbps": 8.5,
        "sizeBytes": 26214400,
        "videoMetadataToken": "video_metadata_token_from_files_api"
      },
      {
        "url": "https://.../dialogue.wav",
        "kind": "audio",
        "name": "dialogue.wav",
        "mimeType": "audio/wav",
        "durationSeconds": 12.4,
        "durationToken": "audio_duration_token_from_files_api"
      }
    ]
  }
}

curl مثال

curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: product-preview-001" \
  -d '{
    "model": "z-image",
    "prompt": "A clean editorial product image on a soft studio background",
    "params": {
      "aspect_ratio": "1:1"
    }
  }'

JavaScript مثال

const response = await fetch("https://rivya.ai/api/v1/generations", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RIVYA_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": "product-preview-001"
  },
  body: JSON.stringify({
    model: "z-image",
    prompt: "A clean editorial product image on a soft studio background",
    params: { aspect_ratio: "1:1" }
  })
});

const generation = await response.json();
console.log(generation.id, generation.status);

Python مثال

import os
import requests

response = requests.post(
    "https://rivya.ai/api/v1/generations",
    headers={
        "Authorization": f"Bearer {os.environ['RIVYA_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": "product-preview-001",
    },
    json={
        "model": "z-image",
        "prompt": "A clean editorial product image on a soft studio background",
        "params": {"aspect_ratio": "1:1"},
    },
    timeout=30,
)

generation = response.json()
print(generation["id"], generation["status"])

جواب

{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "created_at": "2026-05-10T00:00:00.000Z",
  "updated_at": "2026-05-10T00:00:00.000Z",
  "result": null,
  "error": null
}

id محفوظ کریں اور تخلیق کی حالت معلوم کریں۔ اگر آپ API Webhooks ترتیب دیتے ہیں تو کام کے اختتامی حالت تک پہنچنے پر Rivya دستخط شدہ generation.succeeded یا generation.failed واقعہ بھی بھیج سکتا ہے۔

یکساں درخواست کی حفاظت

دوبارہ کوشش کے لیے Idempotency-Key استعمال کریں۔ اگر وہی کلید اور وہی درخواست دوبارہ بھیجی جائے تو Rivya دوسرا کام بنانے کے بجائے محفوظ عوامی جواب واپس کر سکتا ہے۔

اگر وہی کلید مختلف ابتدائی مواد کے ساتھ دوبارہ استعمال ہو تو API idempotency_conflict واپس کرتی ہے۔

متعلقہ صفحات

• تخلیق کی حالت

• API webhooks

• API کریڈٹس

• API خرابیاں اور حدود

• ماڈل API حوالہ