Перейти к основному содержимому

Доступ к API Caila

Чтобы отправлять запросы через API, сгенерируйте API-ключ и указывайте его в каждом запросе.

Caila предоставляет возможность гибко управлять API-ключами: назначать им различные права доступа и лимиты, ограничивать время жизни, редактировать и удалять.

Создание API-ключа​

  1. Перейдите в Моё пространство → API-ключи.

  2. Нажмите Создать ключ.

  3. Чтобы настроить права доступа, выберите нужные опции:

    • Чтение данных — получение информации об объектах в аккаунте (ML-сервисах, датасетах, ресурс-группах и др.), выгрузка отчетов.
    • Изменение данных — включает чтение данных, а также управление сервисами и настройками.
    • Запросы к моделям — запросы к ML-сервисам на инференс и обучение, запросы к моделям через OpenAI adapter.

  4. Чтобы ограничить использование ключа, установите лимиты:

    • Максимальный размер запроса в байтах.
    • Количество запросов в минуту.
    • Лимит расходов. Одновременно можно установить несколько лимитов, например 100 рублей в час и 1 000 рублей в день. Подробнее смотрите в подразделе Как работает лимит расходов ниже.
    • Сервисы, к которым можно делать запросы.
    • LLM, к которым можно делать запросы через OpenAI adapter.

    Запросы, превышающие лимит, будут отклонены.

  5. Чтобы обеспечить конфиденциальность персональных данных при работе с ML-моделями, включите маскирование и укажите ключ доступа Jay Guard. Подробнее об интеграции с Jay Guard читайте в статье Защита данных в запросах.

  6. Чтобы ограничить время жизни ключа, включите опцию Временный ключ и укажите срок. Добавьте адреса электронной почты для уведомлений о том, что время жизни ключа скоро истекает. Это поможет вовремя перевыпустить ключ и избежать внезапного прекращения работы приложений.

  7. Нажмите Сгенерировать.

После создания ключ можно скопировать сразу же или посмотреть позже.

Как работает лимит расходов​

Лимит расходов реализован по принципу Token Bucket. Он определяет скорость возобновления доступного остатка и его максимальный размер.

Например, лимит 24 000 ₽ в день означает, что:

  • если доступный остаток меньше лимита, он восполняется непрерывно и равномерно со скоростью 1 000 ₽ в час (~16 ₽ в минуту), пока не сравняется с лимитом;
  • если доступный остаток равен 0 (лимит полностью израсходован), через минуту станет доступно ~16 ₽, через полчаса 500 ₽ и т. д.
предупреждение

Фактически за выбранный период может быть потрачена двойная сумма.

Предположим, текущий доступный остаток равен лимиту — 24 000 ₽. Такое возможно, например, если за предыдущие 24 часа не было расходов.

  1. Эти 24 000 ₽ можно потратить очень быстро, даже за минуту.
  2. Доступный остаток тут же начнет пополняться со скоростью ~16 ₽ в минуту, 1 000 ₽ в час. Эти деньги тоже можно тратить. За 24 часа добавится 24 000 ₽ — значит, за это время можно потратить еще 24 000 ₽.

В этом случае за сутки будет израсходовано:

  • 24 000 ₽ — первоначальный доступный остаток;
  • еще 24 000 ₽, которые постепенно становятся доступны в течение 24 часов после того, как первоначальный доступный остаток полностью израсходован.

Чтобы обеспечить более равномерное распределение затрат, установите несколько лимитов, например на час, на день и на месяц.

Как работает опция «Новый лимит доступен сразу»​

Опция Новый лимит доступен сразу влияет на доступный остаток при увеличении лимита расходов или добавлении нового лимита расходов.

Если опция включена:

  • При увеличении лимита мгновенно увеличится доступный остаток. Например, если лимит в час изменить с 1 000 ₽ до 1 200 ₽, то остаток тоже возрастет на 200 ₽.
  • Новый лимит полностью доступен с момента создания. Например, сумма дневного лимита может быть израсходована в первые минуты.

Если опция выключена:

  • В момент увеличения лимита доступный остаток не меняется, возрастает только скорость восполнения.
  • Новый лимит создается с нулевым доступным остатком.