Документация / API v1
Документация WikiVibe API
Выберите модель, создайте ключ и отправьте первый запрос. Здесь собраны инструкции по подключению клиентов, составным ключам, инструментам и расходам.
- Форматы запросов
- Chat, Responses, Messages, Gemini
- Авторизация
- Bearer-ключ
- Оплата
- За фактическое использование
/v1/models/v1/chat/completions/v1/responses/v1/messages/v1/usageБазовый URL API
https://api.wikivibe.dev/v1Используйте этот адрес для всех запросов. Путь после базового URL — это эндпоинт, например /chat/completions.
Начало работы
Отправьте первый запрос
Понадобятся аккаунт, активный API-ключ и ID модели, доступной этому ключу. Три шага ниже занимают несколько минут.
- 1
Откройте «Ключи API» → «Создать ключ API». Выберите группу модели и сохраните ключ.
- 2
У ключа нажмите «Использовать» или вызовите GET /v1/models. Возьмите точный id модели с поддержкой Chat Completions.
- 3
Задайте WIKIVIBE_API_KEY в терминале. Замените MODEL_ID в примере, выберите язык и выполните запрос.
curl https://api.wikivibe.dev/v1/chat/completions \
-H "Authorization: Bearer $WIKIVIBE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "MODEL_ID",
"messages": [{"role": "user", "content": "Hello!"}]
}'Замените MODEL_ID перед запуском
В macOS и Linux: export WIKIVIBE_API_KEY='ВАШ_КЛЮЧ'. В PowerShell: $env:WIKIVIBE_API_KEY='ВАШ_КЛЮЧ'. Запускайте клиент из того же терминала. MODEL_ID замените значением id из GET /v1/models.
Начало работы
Как устроен API
WikiVibe API — единый шлюз перед множеством провайдеров моделей. Ключ определяет аккаунт и группу, группа решает, какие аккаунты провайдеров могут обслужить запрос, а поле model выбирает модель.
- API-ключ
- Учётные данные для каждого запроса к шлюзу. Ключ принадлежит одному аккаунту, а для обычных ключей — одной группе. Составной ключ может охватывать несколько групп.
- Группа
- Граница маршрутизации и тарификации. В ней заданы платформа, множитель цены и набор доступных моделей и возможностей.
- ID модели
- Точная строка для поля model, например ID из ответа GET /models. Это не отображаемое имя.
- Маршрут
- Путь эндпоинта после базового URL, например /chat/completions, /responses или /messages.
- Запись расхода
- Строка по каждому запросу с токенами, стоимостью и статусом; видна в консоли и в GET /usage.
Начало работы
Как добавить модель в клиент
Каталог помогает сравнить модели и протоколы. GET /v1/models с вашим ключом показывает, какие ID использовать в запросах. Наличие ID в списке не гарантирует свободную ёмкость прямо сейчас.
- 1
Откройте «Модели». Найдите модель по имени или задаче, проверьте её группу, цену и поддерживаемый формат запросов.
- 2
В разделе «API-ключи» создайте ключ для этой группы. Для нескольких групп используйте составной ключ. Если нужной группы нет, проверьте права доступа и подписку.
- 3
У ключа нажмите «Использовать» или вызовите GET /v1/models. Возьмите точный id модели с поддержкой Chat Completions.
- 4
В клиенте укажите базовый URL, ключ и точный ID. В OpenAI-совместимом запросе ID идёт в поле model. Чтобы сменить модель, обычно достаточно заменить это поле; при переходе на другой протокол изменится и путь запроса.

Список моделей, доступных этому ключу
curl https://api.wikivibe.dev/v1/models \
-H "Authorization: Bearer $WIKIVIBE_API_KEY"Формат ответа
В списке только идентификаторы и отображаемые метаданные. Точный набор полей зависит от платформы группы: группы в стиле Anthropic возвращают id, type, display_name и created_at, а совместимые добавляют object, created и owned_by. Цены находятся на странице моделей, а не в этом ответе.
{
"object": "list",
"data": [
{
"id": "MODEL_ID",
"object": "model",
"type": "model",
"created": 1704067200,
"owned_by": "token-router",
"display_name": "MODEL_ID"
}
]
}- id
- Точное значение для поля model.
- object
- Всегда model для записи; сам ответ — list.
- type
- Маркер протокола, сохранённый для совместимости с клиентами в стиле Anthropic.
- created
- Фиксированная или upstream-метка создания, полезная для ключей кэша.
- owned_by
- Слой маршрутизации, отдавший запись, а не компания-провайдер.
- display_name
- Читаемое название. Никогда не передавайте его как значение model.
| Ситуация | Что вернёт список | Что делать |
|---|---|---|
| Обычный ключ | Список моделей его группы. | Возьмите точный ID из ответа. |
| Составной ключ | ID с префиксами настроенных групп. | Сохраните префикс в поле model. |
| Не нашли модель | Группа, доступ или список моделей могут отличаться. | Сверьте настройки ключа и протокол в каталоге. |
Какое имя передавать в запросе
Передавайте точный ID из GET /v1/models. Если настроено перенаправление модели на ключе, шлюз применяет его по правилам ключа. Для новой модели в группе см. «Как опубликовать модель».
Начало работы
API-ключи
На странице ключей создаётся ключ и настраиваются его лимиты и маршрутизация. В списке видны ключ, группа, расход, лимиты, последнее использование и статус.
- 1
В кабинете откройте «Ключи API» → «Создать ключ API». Назовите ключ по проекту, например «Бот поддержки — тест».
- 2
Выберите одну группу или включите «Составной ключ». Группа определяет доступные модели и условия их использования.
- 3
Проверьте источник списания. При необходимости задайте общую квоту расходов, лимиты на 5 часов, 1 день и 7 дней, срок действия и разрешённые IP.
- 4
Сохраните ключ. Скопируйте его в хранилище секретов или переменную WIKIVIBE_API_KEY. Откройте «Использовать», чтобы увидеть настройки клиента и модели.
- Группа и маршрутизация
- Обычный ключ использует одну группу. Составной содержит до 20 пар «префикс — группа».
- Источник списания
- Автоматически расходует сначала подписку, затем баланс. «Только баланс» никогда не затрагивает подписку.
- Квота расхода
- Общий потолок расходов для ключа. Ноль означает отсутствие ограничения.
- Лимиты частоты
- Отдельные потолки для окон в 5 часов, 1 день и 7 дней; при редактировании видно расход по каждому окну.
- Правила IP
- Список разрешённых адресов или диапазонов, ограничивающий ключ, и список запрещённых, который их отклоняет.
- Срок действия
- Готовые варианты на типовые сроки или конкретная дата. Просроченный ключ отклоняется с 403.
- Статус
- Ключ может быть активен, отключён, исчерпан, просрочен или заблокирован администратором команды.
- Обычный ключ использует одну группу. Составной содержит до 20 пар «префикс — группа».
- Группу для составного запроса выбирает префикс перед первым слешем в ID.
- Правила перенаправления позволяют сопоставить имя в клиенте с доступной целевой моделью. Используйте точное правило; если нужен шаблон, проверьте подсказку в форме.
- У ключа нажмите «Использовать» для списка доступных моделей и шаблонов настройки клиентов.
Начало работы
Составные ключи и префиксы
Составной ключ объединяет несколько групп. Вы задаёте каждой группе короткий префикс. Первый сегмент в ID модели указывает, через какую группу отправить запрос.
| Режим | Как выбирается группа | Когда использовать |
|---|---|---|
| Обычный ключ | Одна группа в настройках ключа. | Для одного продукта. |
| Составной ключ | От 1 до 20 групп. У каждой свой префикс в этом ключе. | Для нескольких продуктов с одним ключом. |
- 1
Откройте «Ключи API» → «Создать ключ API» и включите «Составной ключ».
- 2
Добавьте нужные группы. Для каждой задайте уникальный префикс длиной до 32 знаков: латиница, цифры, дефис и подчёркивание. Например, work и fast.
- 3
Сохраните ключ, откройте «Использовать» или вызовите GET /v1/models. Скопируйте полный ID, например work/example-model. Если у самой модели есть слеши, сохраните их.
- 4
После запроса откройте «Использование». Проверьте модель, выбранную группу и списание: тариф определяется отдельно для каждой группы.

Что значит «Автоматически» в форме ключа
Это настройка источника оплаты. Группу составного ключа выбирает префикс модели. При совпадении имени модели в нескольких группах используйте полный ID. Если короткое имя однозначно, шлюз может принять его, но полный ID устойчивее.
Протоколы и инструменты
Проверьте протокол в карточке модели. Начните с обычного HTTP-запроса. Если клиент отдельно поддерживает WebSocket или голос, включайте их только когда они доступны для выбранной модели и ключа.
Агенты и SDK
Подключить агента
Выберите агент, протокол и модель. Получите конфиг с лимитами из каталога. Затем сверьте ID с ключом и запустите агент из терминала.
Сначала откройте «Ключи API» → «Использовать» или запросите GET /v1/models. Если ключ составной, вставьте ID с префиксом. Если в поле указан другой ID, параметры модели не подставляются.
- Окно контекста
- —
- Максимум на входе
- —
- Максимум на выходе
- —
Окно — сколько токенов помещается вместе с историей и ответом. Вход и выход имеют свои пределы. «—» означает, что для этого протокола предел не опубликован. Клиентский лимит не повышает лимит сервера. Выбирайте medium для начала, если уровень доступен; high и выше могут увеличить задержку и расход. Тарифная граница контекста в «Подробных ценах» — отдельная настройка. Она может быть ниже технического окна модели.
- 1Проверьте opencode --version. Этот JSON предназначен для OpenCode 1.x. Если у вас 2.x, используйте схему провайдера из документации этой версии.
- 2Сохраните блок в указанный opencode.json. Если файл уже есть, добавьте wikivibe внутрь provider, сохранив остальные записи.
- 3Подставьте свой ключ в команду терминала, запустите opencode и выберите WikiVibe API через /models. Попросите агента ответить OK.
{
"$schema": "https://opencode.ai/config.json",
"model": "wikivibe/MODEL_ID",
"provider": {
"wikivibe": {
"npm": "@ai-sdk/openai",
"name": "WikiVibe API",
"options": {
"baseURL": "https://api.wikivibe.dev/v1",
"apiKey": "{env:WIKIVIBE_API_KEY}"
},
"models": {
"MODEL_ID": {
"name": "MODEL_ID"
}
}
}
}
}export WIKIVIBE_API_KEY='YOUR_KEY'
opencodeResponses использует @ai-sdk/openai, Chat Completions — @ai-sdk/openai-compatible. Опции reasoning в примере подставляются для Responses. limit.context и limit.output помогают OpenCode учитывать окно и резерв ответа.
Официальная документация клиента ↗Агенты и SDK
Настройка SDK и приложений
Для подключения нужны три значения: адрес API, секрет ключа и полный ID модели. Названия полей в клиентах отличаются, смысл один и тот же.
| Поле | Что указать |
|---|---|
| Base URL / API Endpoint | Для OpenAI-совместимого клиента — базовый URL из шапки с /v1. Если клиент сам дописывает /v1, укажите только адрес сервера. |
| API Key | Ключ, созданный в кабинете. В форме клиента вставьте сам ключ; префикс Bearer нужен только для ручной установки заголовка Authorization. |
| Model / Model ID | Полный id из списка моделей этого ключа. Название, которое отображается в каталоге, в запрос не подставляется. |
- 1
Откройте «API-ключи» → «Использовать». Выберите клиента и операционную систему, если они доступны для вашей группы.
- 2
Скопируйте готовую конфигурацию или заполните три поля вручную. Для Codex нужна модель с Responses API; для Claude Code — группа с Messages API. Используйте адрес из шаблона для этого клиента.
- 3
Сохраните настройки и отправьте короткий запрос. При ошибке сначала проверьте GET /v1/models и формат запросов, затем посмотрите «Расход» или раздел «Ошибки».
Пример для OpenAI SDK на Python
Установите пакет openai. Выберите модель с поддержкой Chat Completions.
# pip install openai
import os
from openai import OpenAI
client = OpenAI(base_url="https://api.wikivibe.dev/v1", api_key=os.environ["WIKIVIBE_API_KEY"])
reply = client.chat.completions.create(
model="MODEL_ID",
messages=[{"role": "user", "content": "Hello!"}],
)
print(reply.choices[0].message.content)Справочник API
Авторизация
Каждый запрос к шлюзу должен содержать API-ключ. Ключ — это учётные данные аккаунта: обращайтесь с ним как с паролем и не встраивайте его в браузерный код, мобильное приложение или публичный репозиторий.
Заголовок Bearer
Стандартная форма для любого совместимого клиента. Запросы без действующего ключа отклоняются до обращения к провайдеру.
curl https://api.wikivibe.dev/v1/models \
-H "Authorization: Bearer $WIKIVIBE_API_KEY"Принимаемые заголовки
Шлюз также принимает заголовки, которые используют другие клиенты. Передавайте один из них в запросе и никогда не указывайте ключ в строке запроса.
Authorization: Bearer sk-...
x-api-key: sk-...
x-goog-api-key: sk-...- Шлюз читает ключ из Authorization: Bearer, x-api-key или x-goog-api-key. Пути, совместимые с Gemini, дополнительно принимают ключ в параметре запроса.
- Неизвестный, отключённый, просроченный ключ и неактивный аккаунт отклоняются с разными кодами ошибки. Читайте сообщение, чтобы их различить.
- Ключ можно ограничить общей квотой расхода, окнами за 5 часов, 1 день и 7 дней, списками разрешённых и запрещённых IP, а также сроком действия.
- У ключа также есть настройки доступа: группа или режим маршрутизации, источник списания, срок действия и лимиты.
- 1
Используйте отдельные ключи для разработки, staging и production, чтобы утечка затрагивала минимум.
- 2
Задайте квоту или лимит частоты для ключей автоматизации и срок действия для временных работ.
- 3
Ограничьте серверный ключ своими IP-адресами, если у вызывающей стороны стабильный исходящий адрес.
- 4
Сразу заменяйте ключ, если он попал в лог, скриншот, коммит или общий чат. Сначала создайте новый ключ, разверните его, затем отключите старый.
- 5
Никогда не передавайте пароль от консоли как API-учётные данные.
Справочник API
Эндпоинты
Все эндпоинты ниже указываются относительно базового URL и используют один и тот же ключ. Берите эндпоинт под свою клиентскую библиотеку: шлюз переводит совместимые форматы, если группа это поддерживает.
| Метод | Путь | Для чего |
|---|---|---|
GET | /v1/models | Модели, доступные именно этому ключу, с ID для поля model. |
POST | /v1/chat/completions | Формат OpenAI Chat Completions, включая потоковую выдачу и вызов инструментов. |
POST | /v1/responses | Формат OpenAI Responses, включая инструмент image_generation и фоновые задания. |
POST | /v1/responses/input_tokens | Подсчёт токенов для полезной нагрузки Responses до отправки. |
POST | /v1/messages | Формат Anthropic Messages для клиентов, совместимых с Claude, включая потоковую выдачу. |
POST | /v1/messages/count_tokens | Подсчёт токенов для полезной нагрузки Anthropic Messages. |
POST | /v1/embeddings | Векторные представления текста, если платформа группы их поддерживает. |
POST | /v1/images/generations | Прямая генерация изображения по промпту. |
POST | /v1/images/edits | Редактирование изображения с входным файлом. |
POST | /v1/images/batches | Пакетные задания изображений со статусом, элементами и скачиванием. |
POST | /v1/videos/generations | Задания генерации видео, затем статус и скачивание результата. |
POST | /v1/videos/edits | Задания редактирования видео там, где провайдер это поддерживает. |
POST | /v1/web_search | Инструмент веб-поиска для платформ, которые его предоставляют. |
POST | /v1/x_search | Инструмент поиска по соцсети для платформ, которые его предоставляют. |
GET | /v1/usage | Текущий баланс, подписка и состояние лимитов этого ключа. |
GET | /v1beta/models | Нативный список моделей Gemini для клиентов Gemini SDK. |
Chat Completions
curl https://api.wikivibe.dev/v1/chat/completions \
-H "Authorization: Bearer $WIKIVIBE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "MODEL_ID",
"messages": [{"role": "user", "content": "Hello!"}]
}'Responses
curl https://api.wikivibe.dev/v1/responses \
-H "Authorization: Bearer $WIKIVIBE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "MODEL_ID",
"input": "Summarise the release notes in three bullets."
}'Anthropic Messages
curl https://api.wikivibe.dev/v1/messages \
-H "Authorization: Bearer $WIKIVIBE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "MODEL_ID",
"max_tokens": 256,
"messages": [{"role": "user", "content": "Hello!"}]
}'Подсчёт токенов
curl https://api.wikivibe.dev/v1/messages/count_tokens \
-H "Authorization: Bearer $WIKIVIBE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model": "MODEL_ID", "messages": [{"role": "user", "content": "Hello!"}]}'Эмбеддинги
curl https://api.wikivibe.dev/v1/embeddings \
-H "Authorization: Bearer $WIKIVIBE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model": "EMBEDDING_MODEL_ID", "input": "Hello!"}'Не каждый эндпоинт существует для каждой группы
Эмбеддинги, изображения, видео, голос и поиск ограничены платформой группы. Если маршрут недоступен группе, шлюз отвечает 404 с сообщением о неподдерживаемой возможности, а не отправляет запрос провайдеру.
Справочник API
Вызов функций и инструментов
Модель может попросить ваше приложение вызвать функцию: например, узнать статус заказа. Приложение выполняет действие и возвращает результат модели, после чего модель пишет ответ пользователю.
- 1
Выберите модель с поддержкой инструментов. В Chat Completions передайте tools: имя функции, описание и JSON Schema её параметров.
- 2
Прочитайте choices[0].message.tool_calls. Проверьте имя функции и её аргументы по своему списку разрешённых действий. Если tool_calls нет, модель уже вернула обычный ответ.
- 3
Добавьте в историю исходное сообщение ассистента с tool_calls и по сообщению role: tool на каждый вызов. Значение tool_call_id должно совпадать с id вызова.
- 4
Отправьте историю повторно с той же моделью. Если она попросит ещё один инструмент, повторите цикл, ограничив число шагов.
Chat Completions: узнать статус заказа
Рабочий пример Python с условным локальным справочником. Замените MODEL_ID и задайте WIKIVIBE_API_KEY.
# pip install openai
import json
import os
from openai import OpenAI
client = OpenAI(base_url="https://api.wikivibe.dev/v1", api_key=os.environ["WIKIVIBE_API_KEY"])
model = "MODEL_ID"
orders = {"A-42": "shipped"}
messages = [{"role": "user", "content": "Where is order A-42?"}]
tools = [{
"type": "function",
"function": {
"name": "order_status",
"description": "Look up an order in the sample catalogue",
"parameters": {
"type": "object",
"properties": {"order_id": {"type": "string"}},
"required": ["order_id"],
"additionalProperties": False,
},
},
}]
for _ in range(4):
reply = client.chat.completions.create(
model=model, messages=messages, tools=tools,
)
assistant = reply.choices[0].message
if not assistant.tool_calls:
print(assistant.content)
break
messages.append(assistant.model_dump(exclude_none=True))
for call in assistant.tool_calls:
result = {"error": "Unsupported tool or invalid arguments"}
if call.type == "function" and call.function.name == "order_status":
try:
args = json.loads(call.function.arguments)
if isinstance(args, dict) and isinstance(args.get("order_id"), str):
result = {"status": orders.get(args["order_id"], "not found")}
except json.JSONDecodeError:
pass
messages.append({
"role": "tool",
"tool_call_id": call.id,
"content": json.dumps(result),
})
else:
raise RuntimeError("Tool call limit reached")Инструмент выполняет ваше приложение
Аргументы от модели — входные данные. Проверяйте типы, права пользователя и допустимость действия перед вызовом. В Responses API для результата функции используется другой формат: function_call_output с call_id.
Справочник API
Потоковая выдача
Передайте stream: true, чтобы получить события server-sent events вместо одного JSON-тела. Шлюз передаёт фрагменты провайдера по мере поступления и удерживает соединение во время пауз.
Запрос с включённой потоковой выдачей
curl -N https://api.wikivibe.dev/v1/chat/completions \
-H "Authorization: Bearer $WIKIVIBE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "MODEL_ID",
"stream": true,
"messages": [{"role": "user", "content": "Hello!"}]
}'Формат потока
Фрагменты приходят строками data, во время пауз провайдера приходят поддержки соединения, а поток завершается терминальным событием выбранного протокола.
data: {"choices":[{"delta":{"content":"Hel"}}]}
data: {"choices":[{"delta":{"content":"lo!"}}]}
data: {"choices":[{"delta":{},"finish_reason":"stop"}]}
data: [DONE]- Потоки Chat Completions завершаются маркером data: [DONE], как ожидают совместимые клиенты.
- Потоки Anthropic Messages завершаются событием message_stop, а потоки Responses — событием completed или failed.
- Пока провайдеру нечего отправить, приходит поддержка соединения, чтобы промежуточные узлы не закрыли простаивающее соединение.
- Ошибки после начала потока передаются событием внутри потока, потому что HTTP-статус уже отправлен.
- Чтение потока как обычного JSON ломается на первом событии: для потоковых запросов нужен клиент с поддержкой SSE.
Поток и оплата независимы
Потоковый запрос тарифицируется так же, как обычный. Сбой в середине потока сообщается внутри потока и не отменяет расход по уже доставленным токенам.
Справочник API
Совместимые протоколы
Шлюз говорит на нескольких клиентских протоколах. Какие из них приняты, зависит от настроек группы, поэтому маршрут, работающий для одного ключа, может вернуть ошибку доступа для другого.
| Протокол | Типичные эндпоинты | Особенности |
|---|---|---|
OpenAI Chat Completions | /v1/chat/completions | Самый распространённый формат. Потоковая выдача, инструменты и изображения следуют формату выбранной модели. |
OpenAI Responses | /v1/responses | Добавляет серверные инструменты, например генерацию изображений и работу с кодом, где модель это поддерживает. |
Anthropic Messages | /v1/messages | Для клиентов, совместимых с Claude. Один аккаунт может обслуживать запросы Messages и Responses, если группа разрешает оба. |
Gemini native | /v1beta/models | Для клиентов Gemini SDK, включая действия generateContent, streamGenerateContent и countTokens. |
Псевдонимы клиентов | /responses, /chat/completions, /models | Часть клиентов вызывает шлюз без префикса версии. Эти псевдонимы работают как версионированные аналоги. |
- Если группа запрещает протокол, шлюз отвечает 403 в формате ошибки этого протокола — до выбора провайдера и списания.
- Протокол — это форма запроса, а не гарантия модели: запрос в формате Claude обрабатывает та модель, на которую группа его маршрутизирует.
- Список моделей никогда не блокируется протокольным шлюзом, поэтому GET /models продолжает работать для диагностики.
Медиа и задания
Изображения
Медиа-эндпоинты используют тот же ключ, что и текстовые запросы. Прямая генерация доступна, если в группе есть модель для изображений; иначе тот же результат даёт запрос Responses с инструментом генерации изображений.
Сгенерируйте изображение
Замените IMAGE_MODEL_ID на модель изображений, доступную этому ключу.
curl https://api.wikivibe.dev/v1/images/generations \
-H "Authorization: Bearer $WIKIVIBE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "IMAGE_MODEL_ID",
"prompt": "A paper-cut tiger walking through an autumn forest",
"size": "1024x1024"
}'Генерация изображения через Responses API
Инструмент image_generation вместе с tool_choice заставляет модель вернуть изображение вместо текста.
curl https://api.wikivibe.dev/v1/responses \
-H "Authorization: Bearer $WIKIVIBE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "IMAGE_MODEL_ID",
"input": "A paper-cut tiger walking through an autumn forest",
"tools": [{"type": "image_generation", "action": "generate", "output_format": "png"}],
"tool_choice": {"type": "image_generation"}
}'Жизненный цикл видео-задания
Генерация видео асинхронна: создайте задание, опрашивайте статус, затем скачайте готовый результат отдельным запросом.
curl https://api.wikivibe.dev/v1/videos/generations \
-H "Authorization: Bearer $WIKIVIBE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model": "VIDEO_MODEL_ID", "prompt": "A short cinematic sunrise"}'
curl https://api.wikivibe.dev/v1/videos/generations/REQUEST_ID \
-H "Authorization: Bearer $WIKIVIBE_API_KEY"
curl -o sunrise.mp4 https://api.wikivibe.dev/v1/videos/generations/REQUEST_ID/content \
-H "Authorization: Bearer $WIKIVIBE_API_KEY"Запрошенный размер не гарантирован
Параметр size соблюдается в пределах выбранной модели и её провайдера. Провайдер может вернуть другое разрешение, а при соответствующей настройке модели — больше одного изображения за вызов.
Медиа и задания
Голос и realtime
Голосовые маршруты доступны группам с поддержкой этих функций. Синтез и распознавание работают по HTTP, realtime — по WebSocket.
| Метод | Путь | Для чего |
|---|---|---|
POST | /v1/tts | Синтез речи по HTTP. |
POST | /v1/stt | Распознавание речи по HTTP. |
GET | /v1/custom-voices | Список пользовательских голосов аккаунта. |
POST | /v1/custom-voices | Создать или обновить пользовательский голос. |
GET | /v1/realtime | Сессия реального времени через соединение WebSocket. |
WebSocket только для realtime
Для /v1/realtime нужен Upgrade: websocket. Открытая сессия занимает слот параллелизма. Закрывайте соединение, когда работа закончена.
Расход и оплата
Лимиты и квоты
Запрос могут остановить несколько независимых лимитов. Они проверяются до обращения к провайдеру, поэтому отклонённый запрос ничего не стоит.
| Лимит | Где настраивается | Ответ при достижении |
|---|---|---|
| Баланс | Баланс аккаунта и бонусные средства | 403 INSUFFICIENT_BALANCE, когда баланс не положительный |
| Квота расхода ключа | Для каждого ключа | 429 API_KEY_QUOTA_EXHAUSTED |
| Скользящие окна расхода | Для ключа: 5 часов, 1 день и 7 дней | 429 rate_limit_exceeded с Retry-After |
| Запросы в минуту | Для аккаунта и для группы | 429 rate_limit_exceeded с Retry-After |
| Окна подписки | Суточный, недельный и месячный лимиты расхода | 429 USAGE_LIMIT_EXCEEDED |
| Параллелизм | Для аккаунта и для аккаунта провайдера | 429 rate_limit_error |
| Списки IP | Для каждого ключа | 403 ACCESS_DENIED |
| Срок действия ключа | Для каждого ключа | 403 API_KEY_EXPIRED |
| Доступность группы | Состояние группы и привязка аккаунта | 403 GROUP_DISABLED или GROUP_NOT_ALLOWED |
Прочитайте текущее состояние
Эндпоинт расхода сообщает режим, источник списания, баланс, квоту и каждое скользящее окно, чтобы интеграция успела отреагировать до отказа запроса.
curl "https://api.wikivibe.dev/v1/usage?days=7" \
-H "Authorization: Bearer $WIKIVIBE_API_KEY"Формат ответа
{
"mode": "quota_limited",
"isValid": true,
"status": "active",
"billing": { "mode": "auto", "source": "balance", "available": true, "unit": "USD" },
"balance": 12.34,
"quota": { "limit": 50, "used": 7.5, "remaining": 42.5, "unit": "USD" },
"rate_limits": [
{ "window": "1d", "limit": 10, "used": 3.2, "remaining": 6.8 }
],
"today": { "requests": 128, "total_tokens": 245678, "cost": 1.42 }
}Расход и оплата
Оплата и баланс
Запросы тарифицируются по записанному расходу той модели, которая фактически ответила. Цены указаны на страницах моделей и тарифов; не зашивайте их в клиент.
- 1
Подписка, если ключ её использует, списывается первой в пределах своих суточных, недельных и месячных окон.
- 2
Бонусные средства расходуются раньше основного баланса, начиная с самых ранних по сроку, чтобы промо-баланс не сгорел.
- 3
Остаток покрывает основной баланс. Если нет ни положительного баланса, ни рабочей подписки, запросы отклоняются, а не ставятся в очередь.
- Цены токенов указаны за миллион токенов. Модели изображений тарифицируются за изображение или за размер, если группа это публикует.
- Цены в каталоге учитывают ставку группы. Персональный коэффициент, диапазон контекста и режим обработки могут менять расчёт. Фактическую сумму проверяйте в «Использовании».
- Чтение и запись кэша, длинный контекст и reasoning-токены могут иметь собственные ставки поверх базовых цен входа и выхода.
- Запись расхода хранит и стандартную стоимость, и фактически списанную сумму, что и позволяет проверять счёт.
Расход и оплата
Ошибки и диагностика
Тело ошибки соответствует протоколу запроса: клиент Anthropic получает ошибку в своём формате, совместимый клиент — в своём. Всегда сохраняйте request ID и точный ID модели перед обращением в поддержку.
| Статус | Что обычно означает | Что проверить первым |
|---|---|---|
400 | Тело запроса, поле model или параметр запроса некорректны. | ID модели, тело JSON и путь эндпоинта. |
401 | Ключ отсутствует, неизвестен, отключён или аккаунт неактивен. | Заголовок Authorization и статус ключа в консоли. |
403 | Ключ, группа или баланс запрещают запрос. | Баланс, срок действия ключа, ограничение по IP, доступ к группе и список моделей. |
404 | Маршрута или возможности нет для этой группы. | Платформу группы и список поддерживаемых возможностей. |
413 | Тело запроса превышает лимит для этого маршрута. | Размер полезной нагрузки, особенно встроенные base64-изображения. |
429 | Достигнута квота, лимит частоты или лимит параллелизма. | Retry-After, квоту ключа и скользящие окна в GET /usage. |
5xx | Сбой шлюза или провайдера. | Повторите с backoff и сообщите request ID, если ошибка повторяется. |
Тело ошибки
Точная форма зависит от протокола. Модель, которую группа не разрешает, даёт ошибку доступа ещё до обращения к провайдеру.
{
"error": {
"message": "The current group does not support the requested model",
"type": "permission_error",
"param": null,
"code": "protocol_not_allowed"
}
}Заголовки корреляции
Передавайте идентификатор запроса клиента, чтобы связать свои логи с записями расхода, и сохраняйте request ID из ответа шлюза.
X-Client-Request-ID: 6f0f0c1e-...
X-Request-ID: <gateway or upstream request id>- Укажите примерное время в UTC, эндпоинт, точный ID модели, HTTP-статус и request ID.
- Добавьте, был ли запрос потоковым и случился ли сбой до первого фрагмента.
- Никогда не отправляйте API-ключ, пароль от консоли, cookies сессии или промпт с приватными данными.
Консоль
Панель управления
Панель собирает состояние аккаунта: баланс, ключи, активность, расход и объявления, а также быстрые переходы к основным действиям.
- Баланс, число ключей, запросы и расход за сегодня, а также итоги за всё время.
- Тепловая карта активности и графики трендов по моделям, группам и платформам.
- Быстрые действия: создать ключ, посмотреть расход, пополнить баланс и активировать код.
- Сводка активности: токены за всё время, пиковый день, самая длинная сессия и серии.
Консоль
Расход, рейтинг и выгрузки
Данные о расходе доступны по аккаунту, по ключу и по модели, и их можно выгрузить для анализа вне консоли.
- Страница расхода показывает запросы, токены, работу кэша, задержку, эндпоинт, группу и стандартную и фактическую стоимость.
- Вкладка ошибок перечисляет отклонённые запросы со статусом и категорией, когда администратор её включил.
- Страница расхода ключа работает без входа и показывает кольца квоты, скользящие окна, окна подписки и таблицу по дням.
- Страница рейтинга сравнивает расход токенов между пользователями за выбранный период; от показа можно отказаться в профиле.
- Выгрузка CSV учитывает активные фильтры, поэтому в файл попадает именно отфильтрованный вид.
Консоль
Инструменты для изображений
Работа с изображениями, где нужно несколько попыток, быстрее в студии, чем в цикле прямых запросов: холст, параметры и оценка стоимости собраны в одном месте.
- Генерация, редактирование и дорисовка кистью, маской, рамкой выделения и кадрированием.
- Управление размером, соотношением сторон, качеством, фоном и уровнем reasoning для каждого запроса.
- Оценка стоимости до отправки и фактическая стоимость после.
- Локальная история, отправка результата обратно на холст и скачивание.
Консоль
Личные аккаунты GPT
Подключите свой GPT-аккаунт, чтобы обращаться к нему через WikiVibe API из своего приложения.
- 1
Откройте «Личные аккаунты». Добавьте свой аккаунт GPT доступным способом и проверьте его состояние.
- 2
В «Ключах API» выберите группу для своего GPT или добавьте её в составной ключ.
- 3
Для запроса используйте ключ WikiVibe и точный ID из GET /v1/models. Данные входа провайдера остаются в кабинете.
- Доступные способы подключения и настройки маршрутизации показаны в кабинете.
- Проверяйте состояние подключённого аккаунта в разделе «Личные аккаунты».
Консоль
Командная работа
Команда использует общий баланс, подписку и права групп владельца, при этом у каждого участника свои ключи и свои лимиты.
- Владелец приглашает участников по email, задаёт вместимость команды и лимиты по умолчанию для новых участников.
- Участники принимают или отклоняют приглашение в консоли; приглашения можно отправить заново, отозвать, они истекают.
- У каждого участника есть суточный, недельный и месячный лимиты, которые владелец может изменить и сбросить по периоду.
- Командные ключи списывают средства владельца, а удаление участника сразу отключает все его командные ключи.
- Приостановка команды останавливает все командные ключи сразу; позже владелец может её возобновить.
- Владение можно передать другому участнику, который должен подтвердить передачу в отведённое время.
- Владелец может открыть команде доступ к личным аккаунтам провайдеров, чтобы запросы участников шли через них.
- 1
Владелец создаёт команду, задаёт вместимость и лимиты по умолчанию.
- 2
Участники присоединяются, принимая приглашение по email.
- 3
Участники создают командные ключи, которые расходуют права владельца.
Консоль
Рефералы и рулетка
Пригласите нового пользователя, дождитесь подтверждения аккаунта — и обе стороны получат спин рулетки. Награды можно перевести в баланс аккаунта.
- Пригласительная ссылка персональна и регистрирует приглашённого по вашему коду.
- Для участия в рулетке реферал должен подтвердить Telegram.
- Каждые десять подтверждённых рефералов дают ещё один спин в день, максимум три спина в день.
- Суточные спины доступны ограниченное время, поэтому не стоит оставлять их неиспользованными надолго.
- Пополнение баланса тоже даёт спины, поэтому активные аккаунты накапливают их быстрее.
- Награды и результаты спинов определяются на сервере, а шансы опубликованы в консоли.
- Проверка на злоупотребления может не засчитать реферал, если приглашения приходят из той же сети или слишком быстро.
- Возврат с платежей приглашённых нужно перевести в баланс, прежде чем его можно будет расходовать.
- Пригласите
- Отправьте персональную ссылку новому пользователю.
- Подтверждение
- Приглашённый регистрируется по ссылке и подключает Telegram.
- Спин
- Оба аккаунта получают спин; результат и выигрыш фиксируются в консоли.
Консоль
Профиль и вход
В профиле управляются личность, безопасность и уведомления аккаунта, к которому относится ключ.
- Меняйте отображаемое имя и аватар и проверяйте источник каждого из них.
- Меняйте пароль, настраивайте приложение-аутентификатор для двухфакторной аутентификации и регистрируйте passkeys.
- Подключайте и отключайте способы входа: GitHub, Telegram и другие поддерживаемые провайдеры.
- Подтвердите адрес электронной почты для кодов и уведомлений и добавьте дополнительные адреса получателей.
- Настройте уведомления о балансе и их порог, а также показывать ли аккаунт в рейтинге использования.
- Чувствительные операции, например передача владения командой, требуют повторного подтверждения.
Для администратора
Как опубликовать модель
Инструкция для администратора: как добавить модель в список группы. Если модель уже видна в каталоге, используйте раздел «Как добавить модель в клиент».
- 1
В «Администрирование → Аккаунты» проверьте, что активный аккаунт провайдера поддерживает модель и входит в нужную группу.
- 2
В «Группах» откройте настройки этой группы. Включите список моделей для GET /v1/models, выберите нужные модели из кандидатов и проверьте их протоколы.
- 3
Проверьте доступ к группе и тарифы модели. Сохраните настройки.
- 4
Создайте ключ для этой группы и вызовите GET /v1/models. Отправьте короткий запрос с ID из ответа и проверьте запись в «Использовании».
Где появляется модель
Для обычного ключа используйте ID из его списка. Составной ключ добавляет префикс выбранной группы. Доступ к группе и видимость в каталоге проверяются отдельно.
Помощь
Частые вопросы
- Где создать API-ключ?
- На странице API-ключей в консоли. Ключ, его группа, лимиты и маршрутизация находятся в одном месте, а из таблицы ключ можно скопировать или открыть для редактирования.
- Почему модель есть на странице моделей, но недоступна моему ключу?
- Публичный каталог показывает, что поддерживает платформа, а GET /models — что этот ключ может запросить прямо сейчас. Сравните оба списка, затем проверьте группу, состояние баланса и работоспособность провайдера.
- Запрос завершился ошибкой баланса, хотя у меня есть подписка.
- Проверьте источник списания ключа и оставшиеся окна подписки. Ключ «только баланс» игнорирует подписки, а исчерпанное окно подписки отклоняет запросы до сброса.
- Потоковая выдача работает с любой моделью?
- Она работает, когда её поддерживают протокол и выбранная модель. Передайте stream: true, читайте ответ как server-sent events и учитывайте поддержки соединения, пока модель думает.
- Можно ли использовать один ключ с нескольких серверов?
- Да, но лимиты параллелизма и частоты делятся между ключом, группой и аккаунтом. Для независимых нагрузок используйте разные ключи, чтобы одна нагрузка не исчерпала лимиты другой.
- Как оценить стоимость запроса?
- Возьмите количество токенов из похожего запроса в истории расхода и текущие цены на странице тарифов. Затем запись расхода покажет фактически списанную сумму.
- Что отправить в поддержку?
- Время в UTC, эндпоинт, точный ID модели, HTTP-статус и request ID. Никогда не отправляйте API-ключ или промпт с приватными данными.