Управление Token API

Обзор API

API управления token позволяет вам управлять полным жизненным циклом ваших API-ключей в коде, вместо того чтобы кликать по консоли по одному key за раз. Наиболее распространенный сценарий использования — массовая выдача: предоставлять каждому члену команды, downstream-клиенту или проекту свой key, у каждого — свои лимиты на сколько он может потратить, к каким моделям он может обращаться, и как долго он остается действительным.

Лимит квоты

remain_quota ограничивает, сколько этот key может потратить в сумме

Лимит модели

models задает allowlist; обращения ко всему, что вне его, отклоняются

Лимит срока действия

expired_time задает временную метку истечения, после которой key перестает работать

Если вам нужен только один или два key, консоль быстрее — см. Как создать API key. Этот API предназначен для автоматизированной выдачи, плановой ротации или интеграции управления key в ваши собственные системы.

Как получить ваш System Token

API для управления token аутентифицируется с помощью системного token, который не то же самое, что ключ API.

Открыть консоль

Перейдите на api.apiyi.com/account/profile, чтобы открыть страницу профиля

Найдите системный token

Найдите раздел «Параметры аккаунта - System Token» в нижней части страницы

Сгенерируйте AccessToken

Введите пароль вашей учетной записи, чтобы получить AccessToken, который можно использовать для последующих запросов к API

Системный token может создавать и удалять API-ключи. Относитесь к нему как к паролю вашей учетной записи.Системный token не может напрямую вызывать модели — использование его с /v1/chat/completions отклоняется — но он может создавать API-ключи, которые могут. Утечка системного token поэтому значительно хуже, чем утечка одного API-ключа. Храните его в secret manager, а не в коде, никогда не добавляйте его в repository и периодически выполняйте его ротацию.

Эндпоинты

Все эндпоинты аутентифицируются одинаково: передавайте необработанный системный token в заголовке Authorization, без префикса Bearer.

Метод	Путь	Назначение
`GET`	`/api/token/?p=0&page_size=100`	Получить список всех tokens в вашей учетной записи
`GET`	`/api/token/{id}`	Получить один token
`POST`	`/api/token/`	Создать token; в ответе ключ возвращается в виде обычного текста
`PUT`	`/api/token/`	Обновить token (требуется полный объект)
`PUT`	`/api/token/?status_only=true`	Только переключать состояние включено/выключено
`DELETE`	`/api/token/{id}`	Удалить token

Базовый URL — https://api.apiyi.com.

Создание token

Пример запроса

export APIYI_SYS_TOKEN='YOUR_SYSTEM_TOKEN'

curl --compressed -s -X POST 'https://api.apiyi.com/api/token/' \
  -H "Authorization: $APIYI_SYS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "team-alice",
    "remain_quota": 500000,
    "unlimited_quota": false,
    "group": "default",
    "models": "gpt-5.6,deepseek-chat",
    "expired_time": -1
  }'

Поля запроса

Field	Type	Description
`name`	String	Имя token для собственной идентификации
`remain_quota`	Integer	Предел квоты в credits; 500,000 = $1.00
`unlimited_quota`	Boolean	Является ли квота безлимитной; по умолчанию — `false`
`group`	String	Идентификатор группы, к которой привязан token, например `default`
`models`	String	Список разрешённых моделей, через запятую; опустите, если ограничений нет
`expired_time`	Integer	Временная метка истечения в Unix-секундах; `-1` означает, что срок действия не истекает

unlimited_quota по умолчанию = false, а remain_quota по умолчанию = 0 — если опустить оба поля, будет создан token с нулевой квотой, который нельзя использовать. Либо явно задайте remain_quota, либо установите unlimited_quota в true.

Используйте поле models для списка разрешённых моделей.Структура ответа также содержит model_limits, model_limits_enabled и allow_ips. Передача этих полей не вызывает ошибку — эндпоинт по-прежнему возвращает 200 — но сейчас они не влияют ни на что, и при повторном чтении token видно, что они не заданы. Используйте models, чтобы ограничить доступные модели. Ограничения по исходному IP пока нужно реализовать на своей стороне.

Пример ответа

{
  "success": true,
  "message": "",
  "data": {
    "id": 119431,
    "user_id": 80778,
    "key": "K1RPzapuXLfBU4kDC5D9C0E70b1841AeAa542186B2F54b75",
    "status": 1,
    "name": "team-alice",
    "group": "default",
    "models": "gpt-5.6,deepseek-chat",
    "remain_quota": 500000,
    "unlimited_quota": false,
    "used_quota": 0,
    "expired_time": -1,
    "created_time": 1785599000
  }
}

key в ответе представлен в виде обычного текста и не включает префикс sk-. Вам нужно добавить его самостоятельно — в примере выше фактический API key — это sk-K1RPzapu….Сохраняйте и передавайте key сразу после создания и не оставляйте тела ответов, содержащие key, в файлах журналов.

Пакетное создание

На стороне сервера нет batch-эндпоинта — передача чего-то вроде count в теле запроса не оказывает эффекта и все равно создает один token. Пакетная выдача выполняется циклом на стороне клиента.

Python
Node.js
cURL

import json
import os
import time

import requests

BASE = "https://api.apiyi.com"
HEADERS = {"Authorization": os.environ["APIYI_SYS_TOKEN"],
           "Content-Type": "application/json"}
QUOTA_PER_USD = 500_000


def create_token(name, quota_usd=None, group="default", models=None, days=0):
    """Create one token. quota_usd=None means unlimited; days=0 means never expires."""
    body = {
        "name": name,
        "group": group,
        "unlimited_quota": quota_usd is None,
        "remain_quota": 0 if quota_usd is None else int(quota_usd * QUOTA_PER_USD),
        "expired_time": -1 if not days else int(time.time()) + days * 86400,
    }
    if models:
        body["models"] = models

    resp = requests.post(f"{BASE}/api/token/", headers=HEADERS, json=body, timeout=30)
    resp.raise_for_status()
    data = resp.json()["data"]
    return {"id": data["id"], "name": data["name"], "key": "sk-" + data["key"]}


if __name__ == "__main__":
    names = ["team-alice", "team-bob", "team-carol"]
    created = [
        create_token(n, quota_usd=1, group="default", models="gpt-5.6", days=30)
        for n in names
    ]
    for row in created:
        print(f"{row['name']:16s} id={row['id']} {row['key']}")

    # the plaintext key is only returned at creation time, so store it carefully
    with open("keys.json", "w") as f:
        json.dump(created, f, ensure_ascii=False, indent=1)

const BASE = "https://api.apiyi.com";
const HEADERS = {
  Authorization: process.env.APIYI_SYS_TOKEN,
  "Content-Type": "application/json",
};
const QUOTA_PER_USD = 500_000;

async function createToken(name, { quotaUsd = null, group = "default",
                                   models = null, days = 0 } = {}) {
  const body = {
    name,
    group,
    unlimited_quota: quotaUsd === null,
    remain_quota: quotaUsd === null ? 0 : Math.round(quotaUsd * QUOTA_PER_USD),
    expired_time: days ? Math.floor(Date.now() / 1000) + days * 86400 : -1,
  };
  if (models) body.models = models;

  const resp = await fetch(`${BASE}/api/token/`, {
    method: "POST",
    headers: HEADERS,
    body: JSON.stringify(body),
  });
  if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
  const { data } = await resp.json();
  return { id: data.id, name: data.name, key: `sk-${data.key}` };
}

const names = ["team-alice", "team-bob", "team-carol"];
for (const name of names) {
  const row = await createToken(name, { quotaUsd: 1, models: "gpt-5.6", days: 30 });
  console.log(row.name, row.id, row.key);
}

export APIYI_SYS_TOKEN='YOUR_SYSTEM_TOKEN'

for NAME in team-alice team-bob team-carol; do
  curl --compressed -s -X POST 'https://api.apiyi.com/api/token/' \
    -H "Authorization: $APIYI_SYS_TOKEN" \
    -H 'Content-Type: application/json' \
    -d "{\"name\":\"$NAME\",\"remain_quota\":500000,\"unlimited_quota\":false,\"group\":\"default\",\"expired_time\":-1}" \
    | jq -r '"\(.data.name)\tsk-\(.data.key)"'
done

Использование трех лимитов

Лимит квоты

remain_quota ограничивает, сколько token может потратить. Конвертация соответствует API запроса баланса:

Правило конвертации

500,000 квот = $1.00 USD

Например, чтобы выдать downstream-клиенту ключ с лимитом $10, установите remain_quota в 5000000 с unlimited_quota, установленным в false. Потребление на текущий момент можно прочитать в поле used_quota token.

Лимит модели

models — это список разрешенных значений, разделенный запятыми. После задания вызов модели вне списка отклоняется:

{
  "error": {
    "message": "This token is not authorized to use model: deepseek-chat"
  }
}

Ответом будет HTTP 403, и плата не взимается. Если не указывать models, ограничение отсутствует.

Лимит срока действия

expired_time — это Unix-метка времени в секундах, при этом -1 означает «никогда». Например, ключ, срок действия которого истекает через 30 дней:

import time
expired_time = int(time.time()) + 30 * 86400

Список токенов

curl --compressed -s 'https://api.apiyi.com/api/token/?p=0&page_size=100' \
  -H "Authorization: $APIYI_SYS_TOKEN" | jq '.data[] | {id, name, status, remain_quota, used_quota, models}'

Основные поля:

Поле	Описание
`id`	ID токена, используется для обновления и удаления
`key`	Ключ в виде обычного текста, без префикса `sk-`
`status`	`1` = включено, `2` = отключено
`remain_quota` / `used_quota`	Оставшаяся / использованная квота
`unlimited_quota`	Является ли квота неограниченной
`models`	Список разрешенных моделей; пустое значение означает отсутствие ограничений
`expired_time`	Метка времени истечения; `-1` означает «никогда»

Обновление token

Эндпоинт обновления требует полный объект — это не патч.Правильная последовательность: GET полный объект token, измените поля, которые хотите поменять, затем PUT весь объект обратно. Отправка только измененных полей очистит остальные.

import os
import requests

BASE = "https://api.apiyi.com"
HEADERS = {"Authorization": os.environ["APIYI_SYS_TOKEN"],
           "Content-Type": "application/json"}

# 1. fetch the complete object
token = requests.get(f"{BASE}/api/token/119431", headers=HEADERS, timeout=30).json()["data"]

# 2. change only what you need, leaving everything else as-is
token["remain_quota"] = 2_500_000     # raise the cap to $5
token["models"] = "gpt-5.6,gemini-3-pro"

# 3. PUT the whole object back
resp = requests.put(f"{BASE}/api/token/", headers=HEADERS, json=token, timeout=30)
print(resp.json()["success"])

Отключение и удаление

Отключение (сохраняет запись)

После отключения ключ сразу перестает работать — запросы с ним возвращают 401 — но запись token и история его использования сохраняются.

token = requests.get(f"{BASE}/api/token/119431", headers=HEADERS, timeout=30).json()["data"]
token["status"] = 2      # 1 = enabled, 2 = disabled

requests.put(f"{BASE}/api/token/", headers=HEADERS,
             params={"status_only": "true"}, json=token, timeout=30)

Удаление (необратимо)

curl --compressed -s -X DELETE 'https://api.apiyi.com/api/token/119431' \
  -H "Authorization: $APIYI_SYS_TOKEN"

Пакетное удаление также выполняется в виде цикла на стороне клиента:

for token_id in [119431, 119432, 119433]:
    requests.delete(f"{BASE}/api/token/{token_id}", headers=HEADERS, timeout=30)

Удаление нельзя отменить. Если вы хотите лишь временно приостановить key, вместо этого отключите его — история использования останется доступной для сверки.

Часто задаваемые вопросы

Почему у только что созданного token отображается недостаточная квота?

Значение key в ответе не включает префикс sk-. Добавьте его сами: рабочий API key — это sk-, за которым следует возвращенное значение.

Почему у только что созданного token отображается недостаточная квота?

Скорее всего, при создании не было задано ни remain_quota, ни unlimited_quota не было установлено в true. Такая комбинация по умолчанию создает token с нулевой квотой. Создайте его заново, явно указав одно из двух значений.

Почему model_limits или allow_ips не работают?

Эти поля — вместе с model_limits_enabled — сейчас не применяются. При их передаче ошибка не возникает, но ничего не сохраняется. Используйте models, чтобы ограничить доступные модели; ограничения по исходному IP пока нужно реализовывать у себя.

Могу ли я создать несколько token в одном запросе?

На стороне сервера нет batch-эндпоинта, и передача чего-то вроде count в теле запроса не имеет эффекта. Вместо этого вызывайте create в цикле на клиенте — см. раздел пакетного создания выше.

После обновления у меня очистились другие поля

Эндпоинт обновления требует полный объект. GET полный объект сначала, измените его, затем PUT весь объект обратно, а не только измененные поля.

В чем разница между отключением и удалением?

Отключение (status: 2) немедленно прекращает работу ключа, но сохраняет запись и историю использования, и вы можете в любой момент вернуть его в 1. Удаление необратимо и удаляет запись. Для временной приостановки лучше использовать отключение.

Как посмотреть, сколько потратил каждый ключ?

Поле used_quota token — это совокупные расходы этого ключа (÷ 500,000 = USD). Для разбивки по периодам или детализации на уровне вызовов используйте API для запроса логов с фильтром token_name.

Важные примечания

Системный token не является API-ключом, и эти два типа нельзя взаимозаменять

API-ключ (начинается с sk-) предназначен для /v1/* inference-эндпоинтов
Системный token (обычная строка без префикса) предназначен для /api/* management-эндпоинтов

При их путанице возвращаются 401 и ошибка invalid-token соответственно.

Обращайтесь с ключами в открытом виде осторожноИ ответ на создание, и список token возвращают ключи в открытом виде. Поэтому:

Не записывайте тела ответов, содержащие key, в файлы логов и не коммитьте их в репозиторий
Передавайте ключи участникам команды по защищенным каналам, а не в групповых чатах
Эти данные в открытом виде не содержат префикс sk-, поэтому типовые сканеры секретов могут их не обнаружить — не полагайтесь на автоматические проверки, чтобы они нашли их за вас

Операционные рекомендации

При массовом создании добавляйте небольшую задержку между вызовами, чтобы не создавать слишком высокую мгновенную параллельность запросов
Присваивайте каждому ключу осмысленный name (например, team-alice или prod-webhook), чтобы позже можно было сопоставлять использование по token_name в логах
Для ротации: создайте новый ключ, переведите на него трафик, отключите старый ключ, понаблюдайте некоторое время и удаляйте его только после того, как убедитесь, что вызовов больше нет

Связанная документация

Log Query API — детали вызовов по каждому ключу и тарификация
Balance Query API — оставшийся кредит аккаунта
Как создать API-ключ — ручное создание в консоли
Tokens и группы — что делают группы и как выбрать нужную

Основы

Базовый API

Image API (официальный)

Video API (официальный)

API мультимодального понимания

Генерация текста

Поиск и безопасность

Обзор API

Лимит квоты

Лимит модели

Лимит срока действия

Как получить ваш System Token

Эндпоинты

Создание token

Пример запроса

Поля запроса

Пример ответа

Пакетное создание

Использование трех лимитов

Лимит квоты

Правило конвертации

Лимит модели

Лимит срока действия

Список токенов

Обновление token

Отключение и удаление

Отключение (сохраняет запись)

Удаление (необратимо)

Часто задаваемые вопросы

Важные примечания

Связанная документация

​Обзор API

Лимит квоты

Лимит модели

Лимит срока действия

​Как получить ваш System Token

​Эндпоинты

​Создание token

​Пример запроса

​Поля запроса

​Пример ответа

​Пакетное создание

​Использование трех лимитов

​Лимит квоты

Правило конвертации

​Лимит модели

​Лимит срока действия

​Список токенов

​Обновление token

​Отключение и удаление

​Отключение (сохраняет запись)

​Удаление (необратимо)

​Часто задаваемые вопросы

​Важные примечания

Связанная документация

Обзор API

Как получить ваш System Token

Эндпоинты

Создание token

Пример запроса

Поля запроса

Пример ответа

Пакетное создание

Использование трех лимитов

Лимит квоты

Лимит модели

Лимит срока действия

Список токенов

Обновление token

Отключение и удаление

Отключение (сохраняет запись)

Удаление (необратимо)

Часто задаваемые вопросы

Важные примечания