Skip to main content
Саҳифаҳои эндпоинтҳо дар ин бахши Маълумотномаи API (схемаҳои дархост ва ҷавоб ва майдони озмоиш) аз схемаи OpenAPI тавлид мешаванд ва танҳо ба забони англисӣ дастрасанд. Роҳнамоҳо ба ин забон ҳамон рафторро тавсиф мекунанд.

​
URL-и асосӣ

Ҳамаи эндпоинтҳо дар зери https://api.chattler.ai/v1 ҷойгиранд. Танҳо HTTPS хизмат расонида мешавад.

​
Аутентификатсия

Ҳар дархост калиди API-ро дар сарлавҳаи Authorization бо схемаи Bearer талаб мекунад. Калид дар барномаи Chattler сохта мешавад; ниг. Калиди API-ро гиред.
Калидҳо ба як агент баста шудаанд ва иҷозат доранд: read-only барои ду эндпоинти GET, full барои онҳо ва илова бар ин ду эндпоинти чати POST.

​
Қоидаҳо

  • Баданҳои дархост ва ҷавоб JSON мебошанд (Content-Type: application/json), ба истиснои эндпоинти ҷараёнӣ, ки бо text/event-stream ҷавоб медиҳад.
  • Ҳарду эндпоинти чат сарлавҳаи Idempotency-Key-ро талаб мекунанд, 1-255 аломат, беназир барои ҳар дархости мантиқӣ. Ниг. Идемпотентӣ.
  • Ҳар ҷавоб X-Request-ID-ро мебарад. Сарлавҳаҳои маҳдудият X-RateLimit-Limit, X-RateLimit-Remaining ва X-RateLimit-Reset дар ҷавобҳои JSON-и 200 ва дар 429 ҳастанд; ҷараёни SSE ва ҷавобҳои дигари хато онҳоро намебаранд. Ниг. Маҳдудияти дархостҳо.
  • Ҳар нокомӣ {"error": {"code", "message", "request_id"}} аст. Ниг. Хатоҳо.
  • Рӯйхатҳо {"data": [...], "next_cursor": "..." | null} мебошанд; limit 1-100 аст, пешфарз 20.
  • Вақтҳо ISO-8601 дар UTC мебошанд. Филтрҳо қиматҳои бо минтақаи вақт ё бе он қабул мекунанд (қимати бе минтақа ҳамчун UTC хонда мешавад); date_to истисноӣ аст.

​
Дар майдони озмоиш санҷед

Саҳифаҳои эндпоинтҳо майдони озмоиш доранд. Калиди ҳақиқиро ҳамчун токени bearer гузоред ва идентификатори агентеро истифода баред, ки калид ба он тааллуқ дорад; дархостҳо бевосита ба https://api.chattler.ai мераванд ва мисли ҳар даъвати дигар пардохт мешаванд.
Калиди full-ро ба экрани муштарак ё сабти видео нагузоред. Агар гузошта бошед, онро дар барнома навсозӣ кунед.