Rivya AI Docs

API Credits

سمجھیں کہ Rivya API calls account credits، balance checks، reserved credits، failed task refunds، اور credit troubleshooting کیسے استعمال کرتی ہیں۔

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

Rivya API وہی account credit wallet استعمال کرتی ہے جو Studio استعمال کرتا ہے۔

API key کے account کا current balance read کرنے کے لیے GET /api/v1/credits استعمال کریں۔

Endpoint

GET https://rivya.ai/api/v1/credits

Required header:

Authorization: Bearer rvya_sk_...

Response

{
  "current_credits": 123
}

Generation Billing

جب آپ generation submit کرتے ہیں تو Rivya check کرتا ہے کہ account کے پاس کافی credits ہیں یا نہیں۔

Image، video، اور audio jobs کے لیے credits عموماً task start پر reserved یا consumed ہوتے ہیں۔ Generation response میں شامل ہوتا ہے:

  • reserved_credits
  • final_credits

جب job ابھی queued یا processing میں ہو تو final_credits اب بھی 0 رہ سکتا ہے۔

Failed Jobs

اگر task Rivya کے existing failure rules کے تحت fail ہو جائے تو refund handling Studio جیسی product policy follow کرتی ہے۔

Final status confirm کرنے کے لیے Generation Status استعمال کریں، اور product-level failure model کے لیے Failed Tasks and Credit Refunds دیکھیں۔

Common Credit Errors

  • insufficient_credits: account کے پاس کافی credits نہیں ہیں
  • api_key_invalid: API key account identify نہیں کر سکتی
  • public_api_disabled: public API temporarily disabled ہے

فہرست