Документация API
REST API для работы с чат-ботами и RAG-системой. Совместимо с OpenAI Chat Completions.
Authorization. Все запросы используют Bearer-токен. Управление ключами — на странице API Ключи .
Authorization: Bearer YOUR_API_KEY
Запросы строятся на основе массива messages. Каждое сообщение имеет role (system/user/assistant) и content.
curl https://gpt-chat.by/api/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"model": "qwen/turbo",
"messages": [
{"role": "user", "content": "Привет! Как дела?"}
]
}'Пример ответа
{
"id": "chatcmpl-123",
"choices": [{
"message": {
"role": "assistant",
"content": "Привет! У меня всё отлично, чем могу помочь?"
}
}]
}Эндпоинты
https://gpt-chat.by/api/chat/completionsОтправляет сообщения в AI модель и возвращает ответ. Совместимо с OpenAI Chat Completions API.
Параметры запроса
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
messages | array | required | — | Массив сообщений, формирующих диалог. Поддерживает текст, изображения и вызов инструментов. |
model | string | — | qwen/turbo | Слаг модели AI (например, qwen/turbo, anthropic/claude-opus-4.7, kwaipilot/kat-coder-pro). Полный список слагов — на /pricing или через GET /api/ai-models. |
collectionId | uuid | — | — | Идентификатор коллекции RAG для использования ваших документов |
temperature | number | — | 0.1 | Температура генерации (0.1 — 1.0) |
stream | boolean | — | false | Использовать потоковую передачу данных |
thinking | boolean | — | false | Включить режим глубоких размышлений (для поддерживаемых моделей) |
enableSearch | boolean | — | false | Включить поиск в интернете перед ответом (для поддерживаемых моделей) |
assistantId | uuid | — | — | Идентификатор вашего кастомного ассистента (персоны) — подставляет его системный промпт |
useMemory | boolean | — | true | Использовать долговременную память пользователя и сохранённые инструкции в контексте ответа |
imageConfig | object | — | — | Настройки выходной картинки для chat-capable image-моделей. Объект с полями aspect_ratio (1:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 21:9) и image_size (0.5K, 1K, 2K, 4K). modalities выставляются автоматически по модели. |
tools | array | — | — | Список инструментов (функций), которые может вызывать модель |
Ответы
https://gpt-chat.by/api/chat/imageСтоимость ~$0.11 за изображение. Если на балансе недостаточно средств — попытка использовать дневной бесплатный лимит.
Параметры запроса
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
prompt | string | required | — | Текстовое описание желаемого изображения (1—2000 символов) |
model | string | — | google/gemini-2.5-flash-image | Слаг image-модели: google/gemini-2.5-flash-image, google/gemini-3-flash-image, google/gemini-3.1-flash-image-preview, openai/gpt-5.4-image-2 и др. |
aspectRatio | string | — | — | Соотношение сторон: 1:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 21:9. Если не указано — решает модель. |
imageSize | string | — | — | Разрешение: 1K, 2K, 4K. Зависит от модели (для google/gemini-2.5-flash-image доступно только 1K). |
Ответы
https://gpt-chat.by/api/chat/image/editПринимает одно (image) или несколько (images[], до 3) исходных изображений и текстовое описание правки. Стоимость ~$0.11.
Параметры запроса
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
prompt | string | required | — | Описание правки (5—600 символов) |
image | file | на выбор | — | Одно исходное изображение (JPG, PNG, WebP), максимум 10 МБ |
images[] | file[] | на выбор | — | Несколько исходных изображений (JPG, PNG, WebP), до 3 файлов, каждый ≤10 МБ. Используйте вместо image для мультиизображений. |
model | string | — | google/gemini-2.5-flash-image | Слаг image-модели для редактирования |
Ответы
https://gpt-chat.by/api/chat/videoВозвращает taskId для поллинга через GET /api/chat/video/status/{taskId}. Длительность, разрешение и стоимость зависят от выбранной модели.
Параметры запроса
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
prompt | string | required | — | Текстовое описание видео (1—2000 символов) |
model | string | — | alibaba/wan-2.6 | Слаг видео-модели: alibaba/wan-2.6, alibaba/wan-2.7, google/veo-3.1, google/veo-3.1-fast, bytedance/seedance-2.0, bytedance/seedance-2.0-fast, openai/sora-2-pro, kwaivgi/kling-v3.0-pro, kwaivgi/kling-v3.0-std, x-ai/grok-imagine-video. |
resolution | string | — | — | Разрешение: 480p, 720p, 1080p. Набор зависит от модели; если не указано — берётся дефолт модели. |
duration | integer | — | — | Длительность в секундах. Допустимые значения зависят от модели; если не указано — дефолт модели. |
Ответы
https://gpt-chat.by/api/chat/video/imageПринимает исходное изображение и описание движения. Возвращает taskId для поллинга. Стоимость зависит от выбранной модели.
Параметры запроса
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
image | file | required | — | Исходный файл (JPG, PNG, WebP), максимум 10 МБ |
prompt | string | required | — | Описание желаемого движения/анимации (5—600 символов) |
model | string | — | alibaba/wan-2.6 | Слаг видео-модели с поддержкой image-to-video: alibaba/wan-2.6, alibaba/wan-2.7, google/veo-3.1, google/veo-3.1-fast, bytedance/seedance-2.0, openai/sora-2-pro, kwaivgi/kling-v3.0-pro и др. |
resolution | string | — | — | Разрешение: 480p, 720p, 1080p. Набор зависит от модели; если не указано — дефолт модели. |
duration | integer | — | — | Длительность в секундах. Допустимые значения зависят от модели; если не указано — дефолт модели. |
Ответы
https://gpt-chat.by/api/chat/video/status/{taskId}Поллинг задачи. Когда status="done", в первом ответе вернётся base64-видео и обновлённый баланс. Дальше задача считается доставленной.
Параметры запроса
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
taskId | string | required | — | Идентификатор задачи, полученный при вызове /chat/video или /chat/video/image |
Ответы
https://gpt-chat.by/api/chat/voice/transcribeПринимает короткое аудио (≤1 МБ, ~60 секунд). Rate-limited.
Параметры запроса
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
voice | file | required | — | Аудиофайл (webm, ogg, mp3, wav, mp4, m4a), максимум 1 МБ |
Ответы
https://gpt-chat.by/api/chat/audioОзвучивает текст или генерирует аудио по описанию. Возвращает аудио как data-URL и ссылку на файл, а также транскрипт. Списывает баланс согласно длительности и модели.
Параметры запроса
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
prompt | string | required | — | Текст для озвучивания или описание для генерации аудио (от 1 до 4000 символов) |
model | string | — | openai/gpt-audio-mini | Модель генерации: openai/gpt-audio-mini, openai/gpt-audio, openai/gpt-4o-audio-preview, google/lyria-3-pro-preview, google/lyria-3-clip-preview |
voice | string | — | alloy | Голос озвучивания для моделей OpenAI: alloy, ash, ballad, coral, echo, fable, onyx, nova, sage, shimmer, verse. Если не указан — используется alloy |
duration | number | — | 30 | Длительность аудио в секундах (до 300; для каждой модели свой максимум) |
format | string | — | mp3 | Формат выходного аудио: mp3, wav, opus, flac |
imageUrl | url | — | — | Ссылка на изображение-референс (поддерживается только моделями Google Lyria) |
Ответы
https://gpt-chat.by/api/chat/file/extractПринимает документ и возвращает извлечённый текст. Текст обрезается до 200 000 символов.
Параметры запроса
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
file | file | required | — | Документ: txt, csv, pdf, doc, docx, odt, xls, xlsx, html, htm. Максимум 10 МБ |
Ответы
https://gpt-chat.by/api/rag/collectionsСоздает новую коллекцию для возможности дообучения модели на ваших документах
Параметры запроса
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
name | string | required | — | Название коллекции |
Ответы
https://gpt-chat.by/api/rag/collectionsВозвращает список всех коллекций текущего пользователя
Параметры запроса
Параметры отсутствуют
Ответы
https://gpt-chat.by/api/rag/collections/{collectionId}Возвращает информацию о конкретной коллекции
Параметры запроса
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
collectionId | uuid | required | — | Идентификатор коллекции |
Ответы
https://gpt-chat.by/api/rag/collections/{collectionId}Обновляет название коллекции и, при необходимости, привязывает Telegram-бота
Параметры запроса
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
collectionId | uuid | required | — | Идентификатор коллекции |
name | string | — | — | Новое название коллекции |
telegramToken | string | — | — | Токен Telegram-бота вида <bot_id>:<token> для отправки уведомлений |
Ответы
https://gpt-chat.by/api/rag/collections/{collectionId}Удаляет коллекцию и все связанные с ней документы
Параметры запроса
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
collectionId | uuid | required | — | Идентификатор коллекции |
Ответы
https://gpt-chat.by/api/rag/collections/{collectionId}/documentsДобавляет новый документ в указанную коллекцию
Параметры запроса
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
collectionId | uuid | required | — | Идентификатор коллекции |
url | url | на выбор | — | Ссылка на интернет ресурс (имя документа берётся из URL) |
file | file | на выбор | — | Файл: txt, pdf, doc, docx, odt, xls, xlsx, csv, html, htm. Максимум 50 MB (имя документа берётся из имени файла) |
Ответы
https://gpt-chat.by/api/rag/collections/{collectionId}/documents/{documentId}Удаляет конкретный документ из коллекции
Параметры запроса
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
collectionId | uuid | required | — | Идентификатор коллекции |
documentId | uuid | required | — | Идентификатор документа |