Rivya AI Docs

Generation status

Public task ID کے ذریعے Rivya API generation jobs poll کریں، queued، processing، succeeded، اور failed states پڑھیں، پھر result URLs استعمال کریں۔

2026/05/10 کو آخری review

Asynchronous generation job check کرنے کے لیے GET /api/v1/generations/{taskId} استعمال کریں۔

اینڈ پوائنٹ

GET https://rivya.ai/api/v1/generations/{taskId}

درکار header:

Authorization: Bearer rvya_sk_...

curl مثال

curl https://rivya.ai/api/v1/generations/task_public_id \
  -H "Authorization: Bearer rvya_sk_..."

Status values

Public status values یہ ہیں:

  • queued: task accepted ہے، ابھی complete نہیں ہوا
  • processing: generation چل رہی ہے
  • succeeded: result available ہے
  • failed: task failed ہے اور public error object شامل کر سکتا ہے

Succeeded response

{
  "id": "task_public_id",
  "status": "succeeded",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 1,
  "created_at": "2026-05-10T00:00:00.000Z",
  "updated_at": "2026-05-10T00:01:00.000Z",
  "result": {
    "primary_url": "https://media.example/result.png",
    "urls": ["https://media.example/result.png"]
  },
  "error": null
}

primary_url سہولت کے لیے پہلا result URL ہے۔ دستیاب ہو تو urls میں public result URL list ہوتی ہے۔

Failed response

{
  "id": "task_public_id",
  "status": "failed",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "created_at": "2026-05-10T00:00:00.000Z",
  "updated_at": "2026-05-10T00:01:00.000Z",
  "result": null,
  "error": {
    "code": "generation_failed",
    "message": "The generation failed."
  }
}

Polling guidance

مختصر delay سے شروع کریں، پھر polling intervals بڑھائیں۔ بہت تنگ loops سے بچیں۔

Recommended pattern یہ ہے:

  • submission کے بعد 2-3 seconds انتظار کریں
  • normal jobs کے لیے ہر 5-10 seconds بعد poll کریں
  • long video اور audio jobs کے لیے polling کی رفتار کم رکھیں
  • جب status succeeded یا failed ہو جائے تو polling روک دیں

Ownership boundary

Task اسی Rivya account سے تعلق رکھنا چاہیے جس کے پیچھے API key ہے۔ اگر task نہ ملے یا account کی ملکیت نہ ہو تو endpoint not_found return کرتا ہے۔

فہرست