Бу API белешмәсе бүлегендәге эндпоинт битләре (сорау һәм җавап схемалары, уен мәйданчыгы) OpenAPI схемасыннан ясала һәм инглиз телендә генә бар. Татарча кулланмалар шул ук эшләү тәртибен тасвирлый.
Төп URL
Барлык эндпоинтларhttps://api.chattler.ai/v1 астында урнашкан. HTTPS кына хезмәт күрсәтелә.
Аутентификация
Һәр сораугаBearer схемалы Authorization башламында API ачкычы кирәк. Ачкыч Chattler кушымтасында ясала; API ачкычын алу битен карагыз.
GET эндпоинты өчен read-only, шулар өстенә ике POST чат эндпоинты өчен full.
Килешүләр
- Сорау һәм җавап тәннәре — JSON (
Content-Type: application/json),text/event-streamбелән җавап бирүче агымлы эндпоинттан тыш. - Ике чат эндпоинты да һәр логик сорау өчен уникаль, 1-255 символлы
Idempotency-Keyбашламын таләп итә. Идемпотентлык битен карагыз. - Һәр җавапта
X-Request-IDбар.X-RateLimit-Limit,X-RateLimit-RemainingһәмX-RateLimit-Resetлимит башламнары JSON200җавапларында һәм429җавабында бар; SSE агымы һәм башка хата җаваплары аларны йөртми. Сораулар лимитлары битен карагыз. - Һәр уңышсызлык —
{"error": {"code", "message", "request_id"}}. Хаталар битен карагыз. - Исемлекләр —
{"data": [...], "next_cursor": "..." | null};limit1-100, килешү буенча 20. - Вакыт тамгалары — UTC-да ISO-8601. Фильтрлар вакыт поясы күрсәтелгән дә, күрсәтелмәгән дә кыйммәтләрне кабул итә (күрсәтелмәгәне UTC дип укыла);
date_toкерми (эксклюзив).
Уен мәйданчыгында сынап карагыз
Эндпоинт битләрендә уен мәйданчыгы бар. Bearer токены буларак чын ачкычны куегыз һәм ачкыч караган агент идентификаторын кулланыгыз; сораулар турыдан-турыhttps://api.chattler.ai адресына китә һәм башка теләсә нинди чакыру кебек түләнә.