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 इवेंट सुनें। पूर्ण इवेंट स्कीमा के लिए वेब विजेट देखें।