Skip to main content
Страницы эндпоинтов в этом разделе (схемы запросов и ответов, плейграунд) генерируются из 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 на общий экран или в запись. Если это случилось — обновите его в приложении.