Документация
APIEX.CLOUD предоставляет единый OpenAI-совместимый API для GPT, Claude, Gemini и других моделей, а также живой чат со всеми моделями: один кошелёк, ключи с лимитами и отчёт по каждому запросу. В этом руководстве описаны API, живой чат, оплата, ключи, лимиты и пользовательская панель.
Как это работает
- Вы отправляете стандартный запрос в стиле OpenAI на шлюз с вашим API-ключом.
- Шлюз проверяет ключ, его лимиты, ваш доступ к моделям и ваш баланс, а также резервирует максимально возможную стоимость запроса.
- Запрос перенаправляется вышестоящему сервису. Если он завершится сбоем, автоматически будет опробован следующий сервис для этой модели.
- Вы получаете ответ, с вас списывается реальная стоимость, а остаток холста размораживается. Запрос появляется в ваших логах использования.
API совместим с SDK OpenAI. Укажите существующему клиенту OpenAI базовый URL ниже и используйте ключ шлюза: всё работает без других изменений в коде — будь то GPT, Claude, Gemini или другая модель.
Аутентификация
Каждый запрос, кроме GET /ping и GET /models, должен содержать ваш API-ключ в заголовке Authorization с использованием схемы Bearer. Ключи начинаются с apx-.
Authorization: Bearer YOUR_API_KEY
Никогда не раскрывайте свой API-ключ в клиентском коде (JavaScript в браузере, мобильные приложения). Всегда вызывайте шлюз со своего собственного бэкенда.
- Полный секрет отображается только один раз при создании ключа. Сохраняется только хеш, поэтому утерянный ключ восстановить невозможно; вместо этого создайте новый.
- Ключ может быть отозван, может иметь срок действия и может быть ограничен определенными IP-адресами. Ограниченный ключ отклоняет запросы с любых других адресов.
- Ключи никогда не нужно передавать в URL или теле запроса.
Создавайте ключи и управляйте ими из своей панели: Раздел API-ключей
Быстрый старт
- Создайте аккаунт и войдите в свою панель управления.
- Используйте бесплатную модель сразу или пополните кошелек для остальных.
- Создайте API-ключ на вкладке API-ключи и скопируйте секретный код.
- Отправьте запрос на выбранном вами языке программирования. Замените YOUR_API_KEY на свой ключ.
curl https://apiex.cloud/api/v1/chat/completions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "openai/gpt-5.6-terra-pro",
"messages": [
{ "role": "user", "content": "Hello!" }
]
}'
from openai import OpenAI
client = OpenAI(
base_url="https://apiex.cloud/api/v1/",
api_key="YOUR_API_KEY",
)
response = client.chat.completions.create(
model="openai/gpt-5.6-terra-pro",
messages=[{"role": "user", "content": "Hello!"}],
)
print(response.choices[0].message.content)
import OpenAI from "openai";
const client = new OpenAI({
baseURL: "https://apiex.cloud/api/v1/",
apiKey: "YOUR_API_KEY",
});
const response = await client.chat.completions.create({
model: "openai/gpt-5.6-terra-pro",
messages: [{ role: "user", content: "Hello!" }],
});
console.log(response.choices[0].message.content);
$ch = curl_init( "https://apiex.cloud/api/v1/chat/completions" );
curl_setopt_array( $ch, array(
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer YOUR_API_KEY',
'Content-Type: application/json',
),
CURLOPT_POSTFIELDS => json_encode( array(
'model' => 'openai/gpt-5.6-terra-pro',
'messages' => array(
array( 'role' => 'user', 'content' => 'Hello!' ),
),
) ),
) );
$response = json_decode( curl_exec( $ch ), true );
echo $response['choices'][0]['message']['content'];
Не хотите писать код? Откройте вкладку «Живой чат» в панели, выберите любую модель и начните общение. Используются тот же кошелёк и тот же биллинг, что и для API.
Ошибки
API использует стандартные коды состояния HTTP: 2xx означает успех, 4xx означает проблему с запросом или вашей учетной записью, 5xx означает проблему на нашей стороне или с вышестоящим сервисом. Ошибки используют конверт ошибок OpenAI, поэтому официальные SDK читают их без дополнительного кода.
{
"error": {
"message": "Insufficient wallet balance for this request. ...",
"type": "insufficient_quota",
"param": null,
"code": "insufficient_balance"
}
}
Типы ошибок
| Статус | type | Значение |
|---|---|---|
| 400 | invalid_request_error | Отсутствует обязательный параметр или значение имеет неверный формат. |
| 401 | authentication_error | Ключ API отсутствует, недействителен, отозван или срок его действия истек. |
| 402 | insufficient_quota | Ваш баланс, лимит расходов по ключу, тарифный план или бесплатный лимит не покрывают этот запрос. |
| 403 | permission_error | Ключу может быть запрещено использовать эту модель, адрес не разрешен или учетная запись заблокирована. |
| 404 | not_found_error | Модель не существует или не активна. |
| 429 | rate_limit_error | Был достигнут лимит частоты запросов, одновременных подключений или дневных расходов. Подождите и повторите попытку. |
| 5xx | api_error | Что-то пошло не так с нашей стороны или на стороне провайдера. Повторить запрос безопасно, особенно при использовании Idempotency-Key. |
Коды ошибок
Поле кода точно сообщает, что произошло, чтобы ваше приложение могло на это отреагировать.
| Статус | code | Значение |
|---|---|---|
| 400 | missing_model |
Поле «model» обязательно для заполнения. |
| 400 | invalid_request |
Параметр недействителен, отсутствуют "messages" или "input", либо "n" не равно 1. |
| 400 | invalid_idempotency_key |
Заголовок Idempotency-Key не содержит от 1 до 255 печатных символов. |
| 401 | invalid_key |
Ключ отсутствует или не начинается с apx-. |
| 401 | unknown_key |
Ключ не был опознан. |
| 401 | key_revoked |
Ключ был отозван. |
| 401 | key_expired |
Срок действия ключа истек. |
| 402 | insufficient_balance |
Стоимость запроса в худшем случае превышает ваш доступный баланс. Уменьшите max_tokens или пополните счет. |
| 402 | spend_limit |
Ключ исчерпал собственный лимит расходов. |
| 402 | plan_budget_exhausted |
Источником оплаты является «тариф», и его кредит не может покрыть запрос (исчерпан или слишком мал для худшего сценария этого запроса). Переключитесь на кошелек, купите новый тариф или уменьшите max_tokens. С кошелька ничего не списывается. |
| 402 | model_not_in_plan |
Источником оплаты является «тариф», и тариф не включает эту модель. Переключитесь на кошелек, чтобы использовать ее. |
| 402 | request_limit_reached |
Лимит запросов по вашему тарифному плану исчерпан. |
| 402 | free_tier_quota_exhausted |
Ваш бесплатный лимит на этот период исчерпан. Он обновится автоматически, либо вы можете пополнить счет. |
| 403 | model_not_allowed |
Этому ключу или вашей учетной записи может быть запрещено использовать эту модель. |
| 403 | ip_not_allowed |
Ключ ограничен другими IP-адресами. |
| 403 | ip_blocked |
Адрес запроса заблокирован. |
| 403 | account_suspended |
Доступ к API для этого аккаунта приостановлен. Обратитесь в службу поддержки. |
| 404 | unknown_model |
Модель неизвестна или неактивна. |
| 409 | idempotency_in_progress |
Запрос с данным Idempotency-Key все еще выполняется. Повторите попытку через несколько секунд. |
| 422 | idempotency_key_reused |
Ключ Idempotency-Key уже использовался с другим телом запроса. |
| 429 | rate_limited |
Ключ превысил лимит запросов в минуту. |
| 429 | too_many_concurrent |
Для вашей учетной записи уже выполняется слишком много запросов. |
| 429 | daily_cap |
Вы исчерпали дневной лимит расходов для своего аккаунта. |
| 429 | model_daily_cap |
Вы исчерпали дневной лимит расходов для этой модели. |
| 429 | free_tier_rate_limited |
Достигнут лимит запросов бесплатного тарифа. Сбавьте обороты и повторите попытку. |
| 502 | upstream_error |
Вышестоящий сервис дал сбой, и ни один резервный сервис не смог ответить. |
| 503 | service_unavailable |
В настоящее время для этой модели нет доступных услуг. |
| 503 | billing_unavailable |
Биллинг временно недоступен. Повторите попытку в ближайшее время. |
| 503 | api_paused |
API временно приостановлено администратором. |
| 503 | maintenance |
Сервис обновляется. Повторите попытку после задержки Retry-After. |
Базовый URL и конечные точки
Все запросы выполняются по этому базовому URL:
https://apiex.cloud/api/v1/
| Метод | Конечная точка | Описание | Требуется ключ |
|---|---|---|---|
| POST | /chat/completions |
Создайте чат-компиляцию. Поддерживаются потоковая передача, инструменты и визуальный ввод. | Да |
| POST | /embeddings |
Создание векторных представлений (эмбеддингов) для текста. | Да |
| POST | /audio/speech |
Преобразование текста в речь. Результатом является аудиофайл. | Да |
| POST | /audio/transcriptions |
Преобразование аудиофайла в текст. | Да |
| POST | /videos |
Начать генерацию видео. Возвращает задачу, за которой можно следить. | Да |
| GET | /videos/{id} |
Статус задачи генерации видео. После завершения также предоставляется ссылка для скачивания. | Да |
| GET | /videos/{id}/content |
Скачать готовый файл видео. | Да |
| DELETE | /videos/{id} |
Отменить видео, которое еще не завершено. | Да |
| POST | /cost/estimate |
Узнайте максимальную стоимость запроса, не отправляя его. | Да |
| GET | /usage/me |
Ваш баланс, заблокированная сумма, состояние расходов по ключу и статистика использования. | Да |
| GET | /models |
Каталог моделей с ценами. При наличии ключа отображаются только те модели, которые этот ключ может использовать. | Необязательно |
| GET | /models/count |
Сколько моделей подходит под фильтр output_modalities. | Необязательно |
| GET | /models/user |
Тот же каталог, но только с моделями, которые разрешены вашему ключу. Ключ обязателен. | Да |
| GET | /embeddings/models |
Только модели эмбеддингов, в том же формате, что и /models. | Необязательно |
| GET | /images/models |
Только модели генерации изображений, в том же формате, что и /models. | Необязательно |
| GET | /videos/models |
Только видеомодели: с прайс-листом (за секунду или за видеотокен) и поддерживаемыми длительностями, разрешениями и соотношениями сторон. | Необязательно |
| GET | /ping |
Проверка работоспособности, возвращающая статус и версию шлюза. | Нет |
Речь, транскрипция и генерация видео работают через API, а также во вкладке «Живой чат» панели, с теми же ценами и тем же кошельком. Генерация изображений доступна во вкладке «Живой чат».
Завершения чата
Создает ответ модели для заданного диалога. Форматы запроса и ответа соответствуют API OpenAI Chat Completions.
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
model
обязательно
|
string | Идентификатор используемой модели. См. раздел «Модели и провайдеры», чтобы узнать, как получить список доступных значений. |
messages
обязательно
|
array | Диалог на данный момент. Каждый элемент должен содержать роль и контент. Контент может включать изображения, аудио, видео и файлы для моделей, которые их поддерживают. |
temperature
|
number | Температура выборки. Более высокие значения делают вывод более случайным. |
top_p
|
number | Порог ядерной выборки (nucleus sampling). Обычно оставляют значение по умолчанию 1. |
max_tokens
|
integer | Максимальное количество генерируемых токенов. Необязательно: если не указано, применяется значение по умолчанию для сайта, а большие значения уменьшаются до максимума сайта. Меньшее значение также уменьшает сумму, удерживаемую на вашем кошельке. |
max_completion_tokens
|
integer | Альтернатива max_tokens с теми же лимитами для моделей, которые используют это название. |
stop
|
string | array | До 4 последовательностей, на которых генерация останавливается. |
presence_penalty
|
number | Штрафует токены, которые уже появлялись. |
frequency_penalty
|
number | Штрафует токены в зависимости от частоты их появления. |
logit_bias
|
object | Регулирует вероятность появления определенных токенов. |
seed
|
integer | Запрашивает более повторяемый вывод, где это поддерживается моделью. |
response_format
|
object | Запрашивайте JSON или структурированный вывод, если модель это поддерживает. |
tools
|
array | Функции, которые модель может вызывать. До 128 инструментов. |
tool_choice
|
string | object | Определяет, вызывается ли инструмент и какой именно. |
parallel_tool_calls
|
boolean | Разрешить несколько вызовов инструментов за один ход. |
functions / function_call
|
array / mixed | Старые параметры вызова функций, которые по-прежнему принимаются. |
logprobs / top_logprobs
|
boolean / integer | Возвращать логарифмы вероятностей, где это поддерживается моделью. |
reasoning_effort
|
string | Усилие рассуждения для моделей, которые это поддерживают. |
user
|
string | Идентификатор вашего конечного пользователя, длиной до 256 символов. |
n
|
integer | Должно быть равно 1 или опущено. Поддерживается только один вариант завершения на запрос, поскольку каждый дополнительный выбор будет тарифицироваться как вывод. |
stream
|
boolean | Если установлено значение true, ответ отправляется в виде событий, генерируемых сервером. См. раздел «Потоковые ответы». |
stream_options.include_usage
|
boolean | При потоковой передаче добавьте финальное событие с информацией об использовании токенов. |
Пересылаются только указанные выше параметры. Все остальное, например маршрутизация провайдера или параметры поиска в интернете, игнорируется, поэтому запрос никогда не сможет добавить непредвиденные расходы.
Пример ответа
{
"id": "chatcmpl-...",
"object": "chat.completion",
"model": "openai/gpt-5.6-terra-pro",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "Hello! How can I help you today?"
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 9,
"completion_tokens": 10,
"total_tokens": 19
}
}
Потоковые ответы
Установите "stream": true для получения ответа в формате серверных событий (SSE) в формате OpenAI, завершающегося строкой [DONE]. Все официальные SDK OpenAI считывают это автоматически.
data: {"choices":[{"delta":{"role":"assistant","content":"Hello"}}]}
data: {"choices":[{"delta":{"content":"!"}}]}
data: [DONE]
- Если включена прямая трансляция, токены пересылаются по мере их генерации, а расчет с вашим кошельком происходит по окончании трансляции.
- В противном случае шлюз сначала завершает генерацию и выставляет счет, а затем доставляет ее в том же формате событий. Текст поступает сразу целиком, а не слово за словом.
- Ничего не отправляется вам до тех пор, пока вышестоящий узел не создаст первое валидное событие, поэтому сбойный вышестоящий узел заменяется следующим еще до того, как вы что-либо увидите.
- Добавьте "stream_options": { "include_usage": true }, чтобы получить финальное событие с информацией об использовании токенов, как в OpenAI.
Если ваш обратный прокси-сервер буферизует ответы, отключите буферизацию для пути API, чтобы токены доходили до клиентов немедленно.
Встраивания
Создает векторные представления текста для поиска, кластеризации и извлечения. Используйте модель встраивания из каталога моделей.
| Параметр | Тип | Описание |
|---|---|---|
model обязательно | string | Идентификатор модели эмбеддингов. |
input обязательно | string | array | Текст для встраивания (embedding): непустая строка или массив размером до 2048 элементов. |
encoding_format | string | Формат возвращаемых векторов, например float или base64. |
dimensions | integer | Количество измерений для моделей, поддерживающих сокращение. |
user | string | Идентификатор вашего конечного пользователя. |
curl https://apiex.cloud/api/v1/embeddings \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "EMBEDDING_MODEL_ID",
"input": "The quick brown fox"
}'
Список моделей эмбеддингов
Каждая модель категории «Встраивание» отображается в GET /embeddings/models, а в качестве выхода у неё указано embeddings. GET /models по умолчанию их не показывает; добавьте ?output_modalities=embeddings, чтобы увидеть их и там.
curl https://apiex.cloud/api/v1/embeddings/models \ -H "Authorization: Bearer YOUR_API_KEY"
{
"data": [
{
"id": "EMBEDDING_MODEL_ID",
"name": "...",
"architecture": {
"input_modalities": ["text"],
"output_modalities": ["embeddings"]
}
}
]
}
Речь и транскрипция
Превращайте текст в разговорную речь или аудиозапись в текст. Выберите модель речи или транскрипции из каталога моделей. Плата за оба варианта списывается с вашего баланса, как и за любой другой запрос.
POST /audio/speech
| Параметр | Тип | Описание |
|---|---|---|
model обязательно | string | ID речевой модели из каталога моделей. |
input обязательно | string | Текст для озвучивания. До 4000 символов. |
voice | string | Используемый голос. Доступные голоса зависят от модели. |
Ответом является сам аудиофайл, а не JSON. Плата взимается за количество символов.
curl https://apiex.cloud/api/v1/audio/speech \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "SPEECH_MODEL_ID",
"input": "Hello! This is a test of the text-to-speech API.",
"voice": "alloy"
}' \
--output speech.mp3
POST /audio/transcriptions
| Параметр | Тип | Описание |
|---|---|---|
model обязательно | string | ID модели транскрипции из каталога моделей. |
file обязательно | file | Аудио для расшифровки, отправленное в виде мультипартиционного файла. До 25 МБ; mp3, mp4, mpeg, mpga, m4a, wav, webm, ogg, flac, aac или opus. |
language | string | Язык речи в виде короткого кода, например en или fa. Определяется автоматически, если не указан. |
Вместо загрузки файла вы можете отправить JSON с input_audio: объект, содержащий данные base64 и формат. Плата взимается за продолжительность аудио.
curl https://apiex.cloud/api/v1/audio/transcriptions \ -H "Authorization: Bearer YOUR_API_KEY" \ -F model=TRANSCRIPTION_MODEL_ID \ -F file=@recording.mp3
{
"text": "The transcribed text appears here.",
"usage": { "type": "duration", "seconds": 12.4 }
}
Создание видео
Создание видео занимает некоторое время, поэтому оно работает в три этапа: запуск видео, проверка его прогресса, а затем загрузка файла. Запустите видео с помощью POST /videos, проверьте его с помощью GET /videos/{id} и загрузите из content_url, как только статус изменится на completed.
| Параметр | Тип | Описание |
|---|---|---|
model обязательно | string | ID видеомодели из каталога моделей. |
prompt обязательно | string | Опишите нужное вам видео. До 4000 символов. |
duration | integer | Длина клипа в секундах. Оставьте пустым, чтобы модель выбрала сама. |
aspect_ratio | string | Одно из значений: 16:9, 9:16, 1:1, 4:3, 3:4 или 21:9. По умолчанию — 16:9. |
resolution | string | Например, 720p или 1080p. Принимаются только разрешения, поддерживаемые этой моделью. |
generate_audio | boolean | Попросить модель генерировать аудио вместе с видео, когда это возможно. |
image | string | Первый кадр для начала клипа: URL данных PNG, JPEG или WebP, либо ссылка https. |
Плата взимается только после доставки готового видео. Выполните DELETE по URL опроса видео, чтобы отменить его до завершения. Готовые видео хранятся в течение двух дней.
# 1. Start the video
curl https://apiex.cloud/api/v1/videos \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "VIDEO_MODEL_ID",
"prompt": "A calm sunrise over snowy mountains, slow aerial shot.",
"duration": 5
}'
# 2. Check until "status" is "completed"
curl https://apiex.cloud/api/v1/videos/vid_123 \
-H "Authorization: Bearer YOUR_API_KEY"
# 3. Download the file
curl https://apiex.cloud/api/v1/videos/vid_123/content \
-H "Authorization: Bearer YOUR_API_KEY" \
-o video.mp4
{
"id": "vid_123",
"object": "video",
"model": "VIDEO_MODEL_ID",
"status": "queued",
"created_at": 1767225600,
"polling_url": "https://apiex.cloud/api/v1/videos/vid_123"
}
Оценка стоимости и использование
Оценить запрос
POST /cost/estimate принимает то же тело запроса, что и запрос, который вы планируете отправить, и возвращает максимальную возможную стоимость без отправки данных вышестоящим провайдерам и без списания средств. Добавьте "endpoint": "embeddings" для оценки запроса эмбеддингов.
{
"object": "cost_estimate",
"model": "openai/gpt-5.6-terra-pro",
"endpoint": "chat/completions",
"input_tokens": 24,
"max_output_tokens": 4096,
"max_cost": 0.0,
"currency": "IRT",
"free": false,
"available_balance": 0.0,
"sufficient_balance": true
}
max_cost — это сумма, удерживаемая во время выполнения запроса. Окончательное списание представляет собой реальную стоимость и обычно оказывается ниже. Значения выше являются заполнителями; в ответе указаны ваши реальные цифры в валюте кошелька.
Проверить баланс и использование
GET /usage/me возвращает баланс вашего кошелька, сумму, заблокированную текущими запросами, доступную сумму, статистику использования, а также состояние расходов самого ключа (лимит, период, потрачено, осталось и время сброса в UTC).
curl https://apiex.cloud/api/v1/usage/me \ -H "Authorization: Bearer YOUR_API_KEY"
Идемпотентные запросы
Ошибки сети случаются. Добавьте заголовок Idempotency-Key к запросу чата или эмбеддингов, чтобы повторная попытка никогда не привела к двойному списанию средств.
Idempotency-Key: 5e7d3f8a-order-1042
- Ключ может содержать от 1 до 255 печатных символов. Используйте что-то уникальное для каждой логической операции, например UUID.
- Повторная отправка того же ключа с тем же телом в течение 24 часов возвращает сохраненный ответ и не списывает средства повторно.
- Повторное использование ключа с другим телом возвращает ошибку 422 idempotency_key_reused.
- Если первый запрос все еще выполняется, повторная попытка возвращает ошибку 409 idempotency_in_progress с заголовком Retry-After равным 2 секундам.
- Запросы потоковой передачи (streaming) не поддерживают идемпотентность.
Ограничения скорости
Лимиты обеспечивают стабильную работу шлюза для всех и защищают ваш баланс. К запросу может применяться несколько лимитов; каждый из них имеет свой код ошибки.
| Лимит | Область действия | При превышении |
|---|---|---|
| Запросов в минуту | На ключ API. Каждый ключ имеет собственное значение в пределах максимума сайта. | 429 rate_limited |
| Параллельные запросы | На аккаунт. | 429 too_many_concurrent |
| Дневной лимит расходов | Для каждого аккаунта и, опционально, для каждой модели. | 429 daily_cap / 429 model_daily_cap |
| Лимит расходов по ключу | На ключ API, общие, дневные или месячные. | 402 spend_limit |
| Лимит запросов тарифа | На активную подписку. | 402 request_limit_reached |
| Ли по бесплатном тарифе и скорость | На аккаунт, только для бесплатных моделей. | 429 free_tier_rate_limited / 402 free_tier_quota_exhausted |
Аутентифицированные ответы включают заголовки, описывающие лимит запросов для вашего ключа:
| Заголовок | Описание |
|---|---|
X-RateLimit-Limit-Requests | Максимальное количество запросов, разрешенное в текущем окне. |
X-RateLimit-Remaining-Requests | Запросы, оставшиеся в текущем окне. |
X-RateLimit-Reset-Requests | Время до сброса окна, например 12s. |
Retry-After | Передается с ответом 429: количество секунд ожидания перед повторной попыткой. |
При превышении лимита API возвращает ошибку 429. Перед повторной попыткой подождите время Retry-After или используйте экспоненциальную задержку.
Надежность с нашей стороны
Модель может обслуживаться несколькими вышестоящими сервисами. Если один из них дает сбой, идентичный запрос повторяется на следующем. Автоматический выключатель пропускает сервис, который дает сбой 5 раз(а) в течение 60 секунд, в течение 30 секунд, а затем пропускает один запрос для его проверки, чтобы один сбой не замедлял каждый запрос.
Кошелек и биллинг
Каждый аккаунт имеет предоплаченный кошелек, который работает со всеми моделями. Цены указаны за токен (в каталоге — за 1000 токенов), а списание за запрос происходит на основе реально использованных данных.
Как тарифицируется запрос
- Перед перенаправлением запроса шлюз резервирует его стоимость по худшему сценарию: размер входных данных плюс максимальное количество выходных токенов по цене модели.
- Если ваш доступный баланс не покрывает сумму холдинга, запрос отклоняется с ошибкой 402 insufficient_balance, и плата не взимается. Уменьшите значение max_tokens или пополните счет.
- Когда приходит ответ, с вас списывается реальная стоимость, а оставшаяся сумма холста сразу же размораживается. При сбое запроса размораживается вся сумма.
- Доступный баланс — это ваш баланс за вычетом суммы, зарезервированной запросами, которые все еще выполняются.
Способы пополнения баланса
Оплатите через шлюз Zarinpal; средства поступают на кошелек после подтверждения платежа. Для этого метода требуется иранский IP-адрес, поэтому сначала отключите VPN.
Переведите средства на карту, указанную в вашей панели, приложите чек, и кошелек будет пополнен после одобрения администратором.
Отправьте поддерживаемую криптовалюту на указанный адрес, при желании добавьте хэш транзакции, и средства поступят на кошелек после подтверждения.
Действительный код мгновенно зачисляет средства на ваш кошелек. Код может иметь собственный лимит использования и срок действия.
Платный план дает вам кредит, равный его стоимости. Он тратится только из плана, отдельно от вашего кошелька, и сгорает вместе с планом. См. «Тарифы и подписки».
Заходите в свой профиль один раз в день, чтобы заработать кредиты. Более длинные серии достигают вех с более высоким множителем.
Поделитесь своей реферальной ссылкой и зарабатывайте 10% от каждого пополнения баланса пользователями, зарегистрировавшимися по ней. Средства зачисляются на ваш кошелек. Некоторые вознаграждения могут удерживаться до тех пор, пока привлеченный пользователь не начнет использовать API.
Каждый запрос регистрируется с указанием токенов, стоимости, длительности и статуса. Откройте любую строку в журналах использования для получения полного отчета.
Валюта
Кошелек работает в валюте сайта. Панель может отображать тот же баланс в туманах или долларах, используя обменный курс, установленный администратором. Это изменяет только способ отображения сумм.
Бесплатный тариф
Модели, помеченные как бесплатные, можно использовать без баланса кошелька или тарифного плана в рамках лимита, который обновляется автоматически.
| Лимит | Значение |
|---|---|
| Доступны бесплатные модели | 6 |
| Токены | 10,000,000 за день |
| Запросы | 500 за день |
| Скорость | 6 запросов в минуту, 100 в час |
- Бесплатное использование подсчитывается отдельно от вашего кошелька. Когда лимит исчерпан, вы получаете ошибку 402 free_tier_quota_exhausted до его обновления, либо вы можете пополнить счет, чтобы продолжить.
- Вы получите одноразовое уведомление, когда ваше использование превысит порог предупреждения за период.
Живой чат
Помимо API, в каждый аккаунт входит живой чат. Вместо оплаты отдельной платформы для каждой модели вы можете общаться со всеми платными и бесплатными моделями в одном месте и переключаться между ними когда угодно.
Выбирайте любую платную или бесплатную модель из одного списка и переключайтесь на другую когда угодно. Цены показываются рядом с моделями, если это включено на сайте.
Каждый диалог сохраняется с полной историей. Любой из них можно искать, закреплять, переименовывать и продолжать в любое время.
Создавайте изображения, превращайте текст в речь, расшифровывайте аудио и генерируйте видео с помощью моделей, которые это поддерживают.
Прикрепляйте файлы к сообщению, задавайте пользовательские инструкции для каждого диалога и используйте настройку рассуждения у моделей с рассуждением, если это включено на сайте.
Живой чат оплачивается из того же кошелька и по тем же ценам на модели, что и API, а бесплатные модели остаются бесплатными в рамках бесплатного лимита.
Пока действует тарифный план с кредитом, в чате доступен собственный переключатель «Тариф | Кошелек», расположенный над полем ввода сообщения. Он работает независимо от API: ваш выбор в чате не влияет на то, откуда списываются средства для API-ключей, и наоборот.
API-ключи
Ключи аутентифицируют ваши запросы, и каждый из них может иметь собственные лимиты. Используйте один ключ на приложение или среду, чтобы вы могли ограничивать, заменять или отзывать его, не затрагивая остальные.
Что можно настроить для ключа
| Настройка | Что это делает |
|---|---|
| Имя | Метка для распознавания ключа в списках и журналах использования. |
| Лимит расходов | Максимальная сумма, которую может потратить ключ: в общей сложности, в день или в месяц. Запрос принимается только в том случае, если его стоимость в худшем случае все еще укладывается в остаток. Или оставьте без ограничений. |
| Срок действия | Дата и время, после которых ключ перестает работать. |
| Ограничение по IP | Разрешенные адреса IPv4, IPv6 или диапазоны CIDR, по одному на строку. Запросы с любых других адресов отклоняются. |
| Разрешенные модели | Оставьте поле пустым, чтобы ключ мог использовать всё, к чему у вас есть доступ, либо выберите модели, чтобы ограничить его только ими. |
| Лимит запросов | Запросов в минуту для этого ключа, вплоть до максимума, разрешенного сайтом. |
- Создайте несколько ключей одновременно; к имени добавляется пронумерованный суффикс.
- Изменяйте лимиты ключа, обновляйте его секретный код или отзывайте его в любое время. Изменения применяются немедленно.
- Аккаунт может содержать до 20 ключей.
- Ключ может использовать только те модели, на которые у вашего аккаунта есть права. Если тарифный план или код изменяет ваш доступ, каждый ключ сразу же адаптируется без необходимости что-либо сохранять заново.
Тарифные планы и подписки
Тарифный план представляет собой подписку фиксированной продолжительности. В зависимости от настроек, она может открывать доступ к определенным моделям, включать лимит запросов и добавлять бонусный кредит на ваш кошелек. Вы также можете пропускать тарифные планы и просто оплачивать по мере использования с кошелька.
| Тарифный план | Цена | Длительность | Лимит запросов | Кредит по плану | Скидка на использование | Покрываемое реальное использование |
|---|---|---|---|---|---|---|
| Gemini | 1,600,000 Томан | 30 дней | Без ограничений | 1,600,000 Томан | 5% | 1,684,211 Томан |
| Gemini | 4,700,000 Томан | 90 дней | Без ограничений | 4,700,000 Томан | 6,50% | 5,026,738 Томан |
| Gemini | 9,150,000 Томан | 180 дней | Без ограничений | 9,150,000 Томан | 9% | 10,054,945 Томан |
| Chat GPT | 4,400,000 Томан | 30 дней | Без ограничений | 4,400,000 Томан | 5% | 4,631,579 Томан |
| Chat GPT | 13,000,000 Томан | 90 дней | Без ограничений | 13,000,000 Томан | 6,50% | 13,903,743 Томан |
| Chat GPT | 25,200,000 Томан | 180 дней | Без ограничений | 25,200,000 Томан | 9% | 27,692,308 Томан |
Как работает кредитование по плану
- Каждая покупка платного плана дает кредит, равный стоимости плана. Кредит принадлежит этой покупке.
- Кошелек и тарифный план — это раздельные балансы.
- Неиспользованный кредит сгорает вместе с тарифным планом и не может быть возвращен или перенесен в кошелек.
- Когда кредит заканчивается, запросы по этому тарифному плану прекращаются; переключитесь на кошелек или купите новый тарифный план.
- Скидка на использование, если она предусмотрена планом, уменьшает сумму, списываемую с кредита за каждый запрос. При скидке 10% каждые 100 единиц реального использования списывают 90 с кредита.
- Скидка позволяет кредиту покрывать больший объем реального использования, чем вы оплатили: при 20% каждые 100 единиц использования списывают 80 из кредита, поэтому 1 000 000 оплаченных покрывают 1 250 000 использования. См. колонку «Покрываемое реальное использование» выше.
- Более длительные планы имеют большую скидку, поэтому их цена за месяц ниже. План для одного провайдера обычно имеет большую скидку, чем план для всех моделей.
- Одновременно действует только один план; план, купленный во время работы другого, ждет и запускается по окончании первого. Если вы используете несколько провайдеров, выберите план для всех моделей или оплачивайте остальные модели со своего кошелька.
- План для выбранных моделей может оплачивать только эти модели. Бесплатный план не имеет кредита: он задает только продолжительность, доступ к моделям и лимит запросов.
- На тарифе с кредитом лимит запросов учитывает только запросы, оплаченные с тарифа. Запросы, оплаченные из вашего кошелька, не расходуют его.
Выбор источника оплаты
Пока действует тарифный план с кредитом, вы можете выбирать источник оплаты запросов: Тариф или Кошелек. По умолчанию используется Тариф. Для ваших API-ключей этот параметр называется «Оплата API-запросов из», и его можно изменить на вкладках «Обзор» и «Кошелек» в вашей панели. В чате имеется собственный параметр «Оплата чата из» над полем ввода сообщения, который работает независимо от API: ваши чаты могут оплачиваться с тарифа, в то время как ваши API-ключи используют кошелек, или наоборот. До тех пор пока вы не измените этот параметр в самом чате, чат следует настройке для API. Никакие средства никогда не переводятся автоматически с кошелька на тариф и наоборот.
Предупреждения
Вы получаете уведомление один раз для каждого из следующих случаев — на панели, по электронной почте или в Telegram при их использовании: кредит подходит к концу, почти исчерпан, израсходован полностью, срок действия тарифного плана скоро истекает (с указанием суммы, которая сгорит) и срок действия тарифного плана истек (с указанием сгоревшей суммы).
Ошибки API для кредита по плану
| Статус | code | Значение |
|---|---|---|
| 402 | plan_budget_exhausted | Источником оплаты является «тариф», и его кредит не может покрыть запрос (исчерпан или слишком мал для худшего сценария этого запроса). Переключитесь на кошелек, купите новый тариф или уменьшите max_tokens. С кошелька ничего не списывается. |
| 402 | model_not_in_plan | Источником оплаты является «тариф», и тариф не включает эту модель. Переключитесь на кошелек, чтобы использовать ее. |
Заголовки ответа
| Заголовок | Значение |
|---|---|
X-Plan-Remaining | Остаток кредита тарифа в томанах, с 2 знаками после запятой. |
X-Plan-Expires-At | Когда тарифный план заканчивается, ISO 8601 в UTC. |
Они добавляются к успешным ответам, когда срок действия тарифного плана оплачен и подходит к концу: кредит равен или ниже пороговой доли, либо срок действия тарифного плана истекает в течение дней предупреждения. Потоковые ответы сохраняют значения, существовавшие до запроса.
Вопросы о тарифах
Чем план отличается от кошелька?
Кошелек хранит пополненные вами деньги; они никогда не сгорают и подходят для любой модели, которую вы можете использовать. Тариф предоставляет вам кредит, равный его стоимости, на фиксированный период, и этот кредит расходуется только на запросы, оплачиваемые с тарифа. Эти два баланса разделены и никогда не суммируются.
Что происходит, когда кредит тарифного плана исчерпан?
Запросы, оплачиваемые за счет тарифа, останавливаются. С вашего кошелька ничего не списывается автоматически. Переключите источник оплаты на кошелек или приобретите новый тариф, чтобы продолжить.
Что происходит с неиспользованным кредитом по окончании срока действия тарифного плана?
Неиспользованный кредит сгорает вместе с тарифным планом и не может быть возвращен или перенесен в кошелек.
Что если я куплю план снова до окончания срока его действия?
Новый тариф встает в очередь и начинается после окончания текущего. Каждая покупка имеет собственный кредит и дату окончания, и расходуется кредит только действующего тарифа.
Как выбрать, чем оплачивать мои запросы?
Во время работы тарифного плана вы можете выбирать источник оплаты для ваших API-запросов с помощью переключателя «Тариф | Кошелек» на вкладке «Обзор» и на вкладке «Кошелек». В чате есть собственный переключатель «Тариф | Кошелек» над полем ввода сообщения, поэтому чат и ваши API-ключи работают независимо друг от друга.
Сколько дополнительного использования дает мне скидка?
План со скидкой на использование в размере 20% позволяет за каждые 100 единиц реального использования списывать 80 с вашего баланса, поэтому кредит покрывает на 25% больше использования, чем вы оплатили. Например, оплата 1 000 000 туманов покрывает использование на 1 250 000 туманов. Более длительные планы имеют большую скидку, поэтому цена за месяц ниже.
Какой план мне выбрать?
Если вы в основном используете одного провайдера (например, только Gemini), выберите план этого провайдера: он обычно имеет большую скидку. Если вы используете нескольких провайдеров, выберите план для всех моделей. Выбирайте длительность в зависимости от вашего реального использования: неиспользованный кредит сгорает вместе с планом.
Какие модели я могу использовать с кредитом тарифного плана?
План для всех моделей может оплачивать любую используемую вами модель. План для конкретных моделей может оплачивать только их; для любой другой модели переключитесь на свой кошелек.
Ваша панель и живой чат
Вся информация о вашей учетной записи находится в панели пользователя.
Баланс, расходы, запросы и токены за выбранный вами период, от последних 12 часов до года.
Рабочее пространство с сохраненными, доступными для поиска и закрепления диалогами, вложениями файлов, пользовательскими инструкциями, настройкой мышления для моделей рассуждения, генерацией изображений, преобразованием текста в речь, транскрипцией и генерацией видео. Всё оплачивается с одного кошелька.
Ищите по каталогу, фильтруйте по возможностям и открывайте страницу для каждой модели с указанием цен, длины контекста и недавней производительности.
Аналитика использования каждой модели и ключа, а также каждый запрос с фильтрами, поиском и полным отчетом для каждой строки.
Откройте тикет в службу поддержки, следите за ответами и получайте уведомления, когда мы ответим.
Привяжите свой аккаунт Telegram в профиле. Ссылка проверяется через сам Telegram, после чего вы будете получать уведомления (например, о пополнении средств, низком балансе и объявлениях) на вашем родном языке.
Модели и провайдеры
В каталоге в настоящее время содержится 474 активных моделей. Используйте название модели точно так же, как оно указано в каталоге, в качестве значения параметра "model" в вашем запросе.
Список моделей
curl https://apiex.cloud/api/v1/models \ -H "Authorization: Bearer YOUR_API_KEY"
{
"data": [
{
"id": "openai/gpt-5.6-terra-pro",
"name": "...",
"architecture": {
"input_modalities": ["text", "image"],
"output_modalities": ["text"]
},
"context_length": 128000,
"pricing": { "prompt": "0.0000010", "completion": "0.0000040" }
}
]
}
Идентификаторы моделей имеют вид vendor/model, например openai/gpt-5. Можно отправлять либо эту форму, либо просто имя модели. GET /models по умолчанию возвращает текстовые модели; добавьте ?output_modalities=all или список через запятую, например image,video, чтобы увидеть остальные.
Без ключа вы получаете полный публичный каталог. С ключом вы получаете только те модели, которые этот ключ может использовать, в соответствии с тем, что принимает эндпоинт чата. Блок pricing указан в долларах США за токен (цена продажи с учётом наценки); price_input_per_1k и price_output_per_1k — за 1000 токенов в валюте кошелька.
Параметры запроса
GET /models принимает эти необязательные параметры запроса, те же, что и в OpenRouter. Фильтры можно комбинировать.
| Параметр | Тип | Описание |
|---|---|---|
output_modalities | string | Типы вывода через запятую: text, image, video, audio, speech, transcription, embeddings или all. По умолчанию text. |
input_modalities | string | Типы ввода через запятую, которые модель должна принимать: text, image, audio, file. |
supported_parameters | string | Параметры запроса через запятую, которые модель должна поддерживать, например tools. |
endpoints | string | Пути запросов через запятую, которые модель должна обслуживать, например /api/v1/embeddings. |
q | string | Поиск по идентификатору, названию или описанию модели. |
arch | string | Только модели этого семейства, например GPT, Claude или Gemini. |
model_authors | string | Названия производителей через запятую, например openai,anthropic. |
context | integer | Минимальная длина контекста в токенах. |
min_price, max_price | number | Минимальная или максимальная цена входа (prompt) в долларах за миллион токенов. Используйте min_price и max_price. |
min_output_price, max_output_price | number | Минимальная или максимальная цена выхода (completion) в долларах за миллион токенов. Используйте min_output_price и max_output_price. |
min_age_days, max_age_days | integer | Самая новая или самая старая модель, в днях с момента добавления. Используйте min_age_days и max_age_days. |
sort | string | Порядок списка: pricing-low-to-high, pricing-high-to-low, context-high-to-low или newest. Модели без значения идут в конце. |
offset | integer | Сколько моделей пропустить. |
limit | integer | Максимум моделей в ответе, от 1 до 1 000. Если не указаны ни offset, ни limit, возвращается весь список. |
Ответ содержит data (модели), total_count (все подходящие модели до применения offset и limit) и links.next (путь к следующей странице или null на последней). GET /embeddings/models, /images/models и /videos/models тоже принимают offset и limit и отвечают в том же формате.
У каждой модели также есть endpoints (пути запросов, которые её обслуживают, например /api/v1/embeddings), supported_voices, knowledge_cutoff и hugging_face_id; если значение неизвестно, они равны null.
Провайдеры
Модели от этих провайдеров доступны в каталоге прямо сейчас.
Лучшие практики
- Создавайте отдельный ключ для каждого приложения или среды (production, staging, local).
- Храните ключи в переменных окружения или менеджере секретов, но никогда в системе контроля версий или клиентском коде.
- Установите для каждого ключа лимит расходов и, по возможности, белый список IP-адресов и моделей.
- Взвешенно устанавливайте max_tokens. Это ограничивает как стоимость запроса, так и сумму, удерживаемую на вашем кошельке.
- Передавайте Idempotency-Key и повторяйте только ответы 429 и 5xx с экспоненциальной задержкой и задержкой из заголовка Retry-After.
- Используйте /cost/estimate перед дорогими запросами и /usage/me, чтобы отслеживать свой баланс из кода.
- Немедленно отозвите ключ, если подозреваете, что он был скомпрометирован, а затем создайте новый.
Часто задаваемые вопросы
Можно ли общаться с моделями без написания кода?
Да. Откройте живой чат в своей панели, чтобы общаться со всеми платными и бесплатными моделями в одном месте и переключаться между ними. Диалоги и их история сохраняются, оплата идёт из того же кошелька.
Совместим ли API с официальными SDK OpenAI?
Да. Просто установите базовый URL SDK на адрес шлюза и используйте свой API-ключ шлюза — никаких других изменений в коде не требуется.
Что происходит, если мой баланс слишком мал?
Перед перенаправлением запроса шлюз резервирует максимально возможную стоимость. Если ваш доступный баланс не покрывает ее, запрос отклоняется с ошибкой 402 insufficient_balance, и плата не взимается. Уменьшите значение max_tokens или пополните кошелек. В противном случае взимается только реальная стоимость, а остальная часть зарезервированной суммы разблокируется.
Почему с моего запроса списали меньше, чем оценивалось?
Оценка представляет собой худший сценарий: весь ввод плюс полные max_tokens вывода. С вас взимается плата за реальное использование, которое обычно ниже.
Какие параметры запроса передаются?
Только стандартные параметры чата, перечисленные в разделе дополнений чата. Любые другие параметры игнорируются.
Могу ли я ограничить ключ только определенными моделями?
Да. Выберите разрешенные модели при создании или редактировании ключа. Оставьте список пустым, чтобы разрешить использование любой модели, доступной вашему аккаунту.
Могу ли я установить лимит расходов для ключа?
Да. Установите лимит расходов для ключа: общий, на день или на месяц. Как только он будет исчерпан, запросы начнут возвращать ошибку 402 spend_limit.
Сгорают ли неиспользованные кредиты кошелька?
Деньги, добавленные в кошелек путем пополнения, не сгорают. Кредит тарифа отличается: он действует столько же, сколько тариф, а затем сгорает. Его нельзя вернуть или перенести в кошелек.
Сохраняются ли мои промпты?
Журнал использования записывает метаданные о каждом запросе, такие как модель, количество токенов, стоимость, статус, длительность, IP-адрес и ID запроса. Сведения об обработке данных см. в Политике конфиденциальности.
Откройте тикет из панели управления или отправьте нам сообщение. Наша команда с радостью поможет.