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