Интерактивный API-эксплорер
Каждый публичный эндпоинт можно просмотреть и вызвать прямо в браузере. Он генерируется из живой OpenAPI-спеки, поэтому никогда не расходится с реальным API.
- Эксплорер: samreshuuu.ru/api/v1/developers/docs
- OpenAPI-спека: samreshuuu.ru/api/v1/developers/openapi.json
Авторизация
Каждый запрос несёт API-ключ как bearer-токен:
Отсутствующий или неверный токен возвращает 401; действительный токен без нужного scope — 403. Полный контракт статус-кодов и кодов ошибок — в разделе Ошибки и лимиты.
Сгенерировать клиент
Спека — это стандартный OpenAPI 3, передайте её любому генератору, чтобы получить типизированный клиент.
Та же спека работает с любым OpenAPI-совместимым тулчейном — поменяйте цель -g на python, go, java и так далее, либо направьте инструменты вроде openapi-typescript прямо на URL.
Что входит в публичную поверхность
Эксплорер охватывает sessions, documents, knowledge, tasks, executions, agents, models и chat-completions. Коннекторы не доступны через REST — обращайтесь к ним через агента (через chat) или инструмент connector_execute по MCP.
Лимиты вкратце
API применяет поминутный лимит запросов, общий на организацию:
| Field | Type | Description |
|---|---|---|
| Free | 10 зап/мин | Общий на организацию. |
| Pro | 30 зап/мин | Общий на организацию. |
| Max | 60 зап/мин | Общий на организацию. |
Каждый ответ включает X-RateLimit-Limit, X-RateLimit-Remaining и X-RateLimit-Reset; 429 добавляет Retry-After. Полное руководство по повторным попыткам — в разделе Ошибки и лимиты.
FAQ
Что охватывает интерактивный API-эксплорер?
Каждый публичный REST-эндпоинт — sessions, documents, knowledge, tasks, executions, agents, models и chat-completions — можно просмотреть и вызвать в браузере; он генерируется из живой OpenAPI-спеки, поэтому не расходится с реальным API. Коннекторы не входят в REST-поверхность; к ним обращаются через ассистента или инструменты коннекторов.
Как авторизовать запрос?
Передайте API-ключ как bearer-токен в заголовке Authorization — Authorization: Bearer YOUR_API_KEY. Отсутствующий или неверный токен возвращает 401; токен без нужного scope — 403.
Можно ли сгенерировать типизированный клиент из API?
Да. Спека по адресу /api/v1/developers/openapi.json — это стандартный OpenAPI 3, передайте её любому генератору (openapi-generator, openapi-typescript, …), чтобы получить типизированный клиент на вашем языке.
Есть ли лимиты на API?
Да — поминутный лимит запросов, общий на организацию (Free 10, Pro 30, Max 60 запросов/мин). Ответы несут заголовки X-RateLimit-*, а 429 включает Retry-After. См. Ошибки и лимиты.
Частые вопросы
Что охватывает интерактивный API-эксплорер?
Каждый публичный REST-эндпоинт — sessions, documents, knowledge, tasks, executions, agents, models и chat-completions — можно просмотреть и вызвать в браузере. Он генерируется из живой OpenAPI-спеки, поэтому не расходится с реальным API. Коннекторы не входят в REST-поверхность; к ним обращаются через ассистента или инструменты коннекторов.
Как авторизовать запрос?
Передайте API-ключ как bearer-токен в заголовке Authorization — Authorization: Bearer YOUR_API_KEY. Отсутствующий или неверный токен возвращает 401; токен без нужного scope — 403.
Можно ли сгенерировать типизированный клиент из API?
Да. Спека по адресу /api/v1/developers/openapi.json — это стандартный OpenAPI 3, передайте её любому генератору (openapi-generator, openapi-typescript и другим), чтобы получить типизированный клиент на вашем языке.
Есть ли лимиты на API?
Да — поминутный лимит запросов, общий на организацию (Free 10, Pro 30, Max 60 запросов/мин). Ответы несут заголовки X-RateLimit-*, а 429 включает Retry-After. Полный контракт — в разделе «Ошибки и лимиты».