API حوالہ (OpenAPI 3.1)

AskAIs Customer Service ایک مکمل OpenAPI 3.1 تفصیلات کے ساتھ آتا ہے جو ہر عوامی اینڈ پوائنٹ کی وضاحت کرتی ہے۔ یہ ہماری خودکار طور پر تیار کردہ SDKs کو چلاتی ہے اور OpenAPI ماحول کے کسی بھی ٹول (Insomnia، Postman، Swagger UI، Hoppscotch وغیرہ) کے ساتھ کام کرتی ہے۔

تفصیلات حاصل کریں

# Live (cached 5 min, CORS open)
curl https://cs.askais.com/api/v1/openapi.json

# Save to disk
curl https://cs.askais.com/api/v1/openapi.json -o singlink-openapi.json

بنیادی URL

• کلاؤڈ: https://cs.askais.com/api/v1
• سیلف ہوسٹ: وہ پتہ جس پر آپ کا APP_URL حل ہوتا ہے، آخر میں /api/v1 کے ساتھ

تصدیق

دو طریقے، دونوں Authorization: Bearer <value> کے ذریعے:

• رابطہ JWT — POST /auth/identify کے ذریعے جاری ہوتا ہے۔ صرف ایک رابطے تک محدود۔ web / موبائل SDKs استعمال کرتے ہیں۔
• ورک اسپیس API key — sk_live_...، جو ترتیبات → API Keys میں تیار ہوتی ہے۔ پورے ورک اسپیس کا احاطہ کرتی ہے۔ سرور سے سرور کے لیے۔

اینڈ پوائنٹس ایک نظر میں

• POST /auth/identify — رابطہ JWT جاری کریں
• POST /conversations — نئی چیٹ شروع کریں
• GET /conversations — اپنی فہرست دیکھیں
• GET /conversations/{id}
• GET /conversations/{id}/messages?before=&limit=
• POST /conversations/{id}/messages
• POST /upload — presigned S3 POST URL حاصل کریں
• POST /upload/{id}/confirm

خرابیاں

تمام غیر 2xx جوابات ایک مستحکم ساخت استعمال کرتے ہیں:

{
  "error": {
    "code": "validation_error",
    "message": "content or attachments required",
    "field": "content"
  }
}

کوڈز: validation_error، unauthorized، forbidden، not_found، conflict، unprocessable، rate_limit_exceeded، internal_error۔

ریئل ٹائم ساتھی

REST یک بار کی کالز کے لیے ٹھیک ہے۔ لائیو پیغامات کے لیے، wss://<wsUrl>/v1/ws?token=<jwt> سے جڑیں اور message:new، ai:stream:delta، ai:stream:end، typing، اور presence ایونٹس سنیں۔ مکمل ایونٹ اسکیما کے لیے ویب وجٹ دیکھیں۔