Быстрый старт
Buran API реализует спецификацию OpenAI Chat Completions. Если у вас уже есть код для OpenAI — замените базовый URL и ключ. Все модели каталога, включая Claude, Gemini и Grok, вызываются в одном формате.
| Параметр | Значение |
|---|---|
| Base URL | https://api.buranapi.com/v1 |
| Авторизация | Authorization: Bearer sk-buran-… |
| Формат | OpenAI Chat Completions, JSON, SSE для стриминга |
provider/model. Полный список — в каталоге или через GET /v1/models.Аутентификация
Создайте ключ в личном кабинете в разделе «API-ключи». Для каждого ключа можно задать лимит расходов в рублях и список разрешённых моделей.
Передавайте ключ в заголовке Authorization. Никогда не размещайте ключ в клиентском коде (браузер, мобильное приложение) — запросы должны идти через ваш сервер.
Authorization: Bearer sk-buran-xxxxxxxxxxxxxxxxxxxxxxxx
Chat Completions
POST /v1/chat/completions — основной метод. Поддерживаются стандартные параметры OpenAI.
| Параметр | Тип | Описание |
|---|---|---|
model | string | Идентификатор модели, например gpt-6.1-sol |
messages | array | История диалога: system, user, assistant, tool |
temperature | number | 0–2, по умолчанию зависит от модели |
max_tokens | integer | Ограничение длины ответа |
stream | boolean | Потоковая передача ответа через SSE |
tools | array | Описание функций для function calling |
response_format | object | {"type":"json_schema", …} для структурированного вывода |
Ответ
{
"id": "chatcmpl-9f2c…",
"model": "claude-sonnet-5-5",
"choices": [{
"index": 0,
"message": { "role": "assistant", "content": "Привет! …" },
"finish_reason": "stop"
}],
"usage": { "prompt_tokens": 14, "completion_tokens": 42, "total_tokens": 56 }
}Стриминг
Передайте "stream": true, чтобы получать ответ по мере генерации в формате Server-Sent Events. Последнее событие — data: [DONE].
Function calling
Опишите функции в параметре tools — модель вернёт tool_calls с аргументами. Формат одинаков для всех моделей с меткой Tools в каталоге, включая Claude и Gemini.
tools = [{
"type": "function",
"function": {
"name": "get_weather",
"description": "Текущая погода в городе",
"parameters": {
"type": "object",
"properties": { "city": { "type": "string" } },
"required": ["city"]
}
}
}]Изображения на входе
Модели с меткой Vision принимают изображения в сообщениях пользователя — по URL или в base64.
{
"role": "user",
"content": [
{ "type": "text", "text": "Что на картинке?" },
{ "type": "image_url", "image_url": { "url": "https://…/photo.jpg" } }
]
}Список моделей
GET /v1/models возвращает все модели, доступные вашему ключу, в формате OpenAI.
curl https://api.buranapi.com/v1/models -H "Authorization: Bearer $BURAN_API_KEY"
Коды ошибок
Ошибки возвращаются в формате OpenAI: {"error": {"message", "type", "code"}}.
| HTTP | Причина | Что делать |
|---|---|---|
400 | Некорректный запрос | Проверьте параметры и формат messages |
401 | Неверный или отозванный ключ | Проверьте ключ в кабинете |
402 | Недостаточно средств | Пополните баланс или увеличьте лимит ключа |
403 | Модель недоступна для ключа | Добавьте модель в список разрешённых |
404 | Модель не найдена | Сверьте идентификатор с /v1/models |
429 | Превышен лимит запросов | Повторите с экспоненциальной задержкой |
5xx | Ошибка провайдера после всех резервных каналов | Повторите запрос; не тарифицируется |
Лимиты
Rate limits применяются на уровне аккаунта и зависят от тарифа. Текущие значения возвращаются в заголовках каждого ответа:
x-ratelimit-limit-requests— лимит запросов в минутуx-ratelimit-remaining-requests— осталось в текущем окнеx-ratelimit-reset-requests— время до сброса
Нужны лимиты выше — напишите на support@buranapi.com.