Перейти к основному содержанию
Когда вы создаёте или читаете API-ключ через консоль или REST API, шлюз возвращает объект токена — JSON-запись, которая содержит идентичность ключа, его лимиты и две привязки политик, управляющие его трафиком. Эта страница — справочник поле-за-полем для этого объекта: что означает каждое поле, его тип и сигнальные значения (0, -1), которые несут особый смысл. О почему за этими полями — модели минимальных полномочий — начните с обзора ограниченных ключей. Эта страница — таблица поиска, которую вы держите открытой, пока скриптуете создание ключа.

1. Справочник объекта токена с одного взгляда

Свежесозданный ключ для запланированного агента суммаризации выглядит так:
{
  "id": 4812,
  "name": "support-summarizer-prod",
  "status": 1,
  "key": "sk-orca-a1b2****yz90",
  "created_time": 1733616000,
  "accessed_time": 1733702400,
  "expired_time": -1,
  "unlimited_quota": false,
  "remain_quota": 500000,
  "used_quota": 12340,
  "model_limits_enabled": true,
  "model_limits": "openai/gpt-4o-mini",
  "credit_limit_usd": 25,
  "allow_ips": "203.0.113.7",
  "environment": "prod",
  "guardrail_id": 17,
  "firewall_policy_id": 9,
  "is_firewall_gateway": false,
  "group": "default"
}
Поле key маскировано на каждом чтении — вы видите брендовый префикс и последние четыре символа, никогда полный секрет. Открытый текст показывается один раз, при создании. См. Маскирование ключей.

2. Поля идентичности и жизненного цикла

Они описывают, какой это ключ и где он в своём жизненном цикле.
Стабильный числовой идентификатор ключа. Используйте его, чтобы адресовать ключ в вызовах обновления и удаления. Только для чтения.
Человеческая метка для ключа, показываемая в консоли и в логах. Называйте ключи в честь агента, который их держит — один ключ, один агент.
Состояние включён / отключён. 1 означает активен; отключённый ключ отклоняется при аутентификации без удаления, так что вы можете поставить ключ на паузу и снова включить его.
Bearer-секрет, возвращаемый маскированным (sk-orca-…****…). Полное значение показывается только один раз, при создании. Относитесь к нему как к паролю.
Временные метки Unix (секунды) для того, когда ключ был выпущен и когда в последний раз обслужил запрос. accessed_time — ваш сигнал для устаревшего или неиспользуемого ключа, стоящего отзыва.
Абсолютный срок действия как временная метка Unix. Сигнальное значение -1 означает, что ключ никогда не истекает. Задайте реальную временную метку, чтобы ключ автоистекал — правильный default для прогонов CI и эфемерных агентов. См. Истекающие ключи.

3. Поля расходов и квоты

Они ограничивают, сколько может потребить ключ, прежде чем перестанет работать.
ПолеТипЗначение
credit_limit_usdnumberПожизненный лимит расходов в USD. 0 = без ограничения.
unlimited_quotabooleanКогда true, ключ не тарифицируется против баланса квоты.
remain_quotanumberКвота, оставшаяся на ключе.
used_quotanumberКвота, потреблённая до сих пор.
Ключ с credit_limit_usd: 0 и unlimited_quota: true и expired_time: -1 не имеет потолка расходов и никогда не истекает — худший радиус поражения, если он утечёт. См. безлимитные vs ограниченные о том, когда безлимитный ключ оправдан.

4. Поля досягаемости и области

Они ограничивают, чего может достичь ключ — каких моделей, с каких адресов.
model_limits — это список моделей, которые ключ может вызывать; model_limits_enabled — переключатель вкл/выкл. С включённым лимитом вызов к любой модели вне списка отклоняется до того, как покинет шлюз — агент не может переключиться на более дорогую или способную модель. См. Лимиты моделей.
Список разрешённых IP / CIDR, по одной записи на строку. Запрос, предъявляющий ключ с любого не указанного в списке адреса, отклоняется на уровне аутентификации; пустое значение означает, что разрешены все адреса. См. Список разрешённых IP.
Свободная метка деплоя (prod, staging, dev или любая на ваш выбор) для организации ключей и фильтрации логов. Чисто организационная — она не меняет применение. См. Окружения.
Группа маршрутизации, через которую ключ разрешает модели. Оставьте её на default рабочего пространства, если только вам не дали конкретную группу.

5. Поля привязки политик

Два самых мощных поля на ключе. Каждое привязывает ключ к политике в рамках рабочего пространства, управляющей его трафиком — измените политику, и каждый привязанный к ней ключ подхватит изменение на следующем запросе, без передеплоя.
ПолеТипПривязывает ключ к
guardrail_idnumberКонтентному guardrail, который проверяет текст запроса и ответа.
firewall_policy_idnumberПолитике firewall, которая управляет вызовами инструментов, выпускаемыми ключом.
is_firewall_gatewaybooleanПомечает ключ как токен с областью шлюза для маршрутов Firewall MCP / evaluate (не для инференса).
Сигнальное значение для обеих привязок — 0 (не привязано). Но две плоскости разрешают отключённую привязку по-разному:
  • Отключённый guardrail_id — это выключатель — ключ получает никакого guardrail, без отката к default рабочего пространства.
  • Отключённый firewall_policy_id откатывается к default-политике firewall рабочего пространства.
Полный порядок разрешения живёт на Привязке политик и Области и ключах.
is_firewall_gateway: true выпускает ключ с областью шлюза только для маршрутов /api/v1/firewall/* — никогда не ставьте его на ключ инференса. Включение флага и чтение открытого текста ключа шлюза оба требуют Admin+.

6. Установка этих полей

Каждое поле выше настраивается в редакторе ключа консоли (/console/token) — не через ключ ретрансляции. Создание или редактирование ключа требует роли Developer или выше; флаг is_firewall_gateway требует Admin+.
Объект токена — это поверхность конфигурации. Открытый текст ключа (sk-orca-…) — это то, что ваш агент предъявляет на вызовах ретрансляции /v1/*. Настройте ключ в консоли; агент всегда видит только секрет.
Конкретный ключ минимальных полномочий — заданный в редакторе, прочитанный обратно как объект выше — ограничивает одну модель, один диапазон IP источника, недельный потолок USD, срок действия и один guardrail плюс одну политику firewall. Если агент, держащий его, захвачен через prompt-инъекцию, радиус поражения останавливается ровно на этих границах.

7. Связанные справочники

Обзор ограниченных ключей

Модель минимальных полномочий и хаб для каждого поля ключа.

Привязка политик

Как guardrail_id и firewall_policy_id разрешаются в активную политику.

Квота, лимит и срок действия

credit_limit_usd, expired_time и поля квоты в глубину.

Чек-лист минимальных полномочий

Прогоните каждый ключ через один и тот же проход усиления.
Новичок в модели? Прочитайте Область, ключи, политики и рабочие пространства о том, как объект токена вписывается в иерархию рабочее пространство → политика → ключ.