ข้อมูลอ้างอิง API (OpenAPI 3.1)

AskAIs Customer Service มาพร้อมข้อกำหนด OpenAPI 3.1 ที่สมบูรณ์ ซึ่งอธิบายทุกปลายทางสาธารณะ มันขับเคลื่อน SDK ที่สร้างอัตโนมัติของเรา และทำงานร่วมกับเครื่องมือใด ๆ ในระบบนิเวศ 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 จำกัดขอบเขตไว้ที่ ผู้ติดต่อรายเดียว ใช้โดย SDK บนเว็บ / มือถือ
• 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 ดู วิดเจ็ตเว็บ สำหรับสคีมาเหตุการณ์ฉบับเต็ม