Возможности платформы
Корпоративные аккаунты
Как ведут себя ключи API, бюджеты участников, ошибки и журналы, когда команда пользуется одним корпоративным балансом.
Корпоративный аккаунт позволяет всей команде тратить из одного баланса. Баланс аккаунта владельца становится балансом компании, каждый участник вызывает API своим ключом, и каждое списание идёт из этого общего баланса. Эндпоинты, тела запросов и настройка клиентов такие же, как у личного аккаунта; на этой странице описано только то, что меняется, когда вызывающий принадлежит компании.
Участник отправляет запрос
acme-…Своим ключом, который начинается с префикса компании.
Проверка бюджета
Оценочная стоимость должна поместиться в остаток бюджета участника.
Списывается с компании
По ценам, группам и подписке аккаунта владельца.
Записывается на участника
Владелец и администраторы могут разбить его по участникам, моделям, ключам и датам.
| Роль | Аккаунт | Что может делать |
|---|---|---|
| Владелец | Аккаунт, подавший заявку | Его баланс — это баланс компании. Управляет всеми, пополняет баланс и видит использование всей компании. Не может быть отключён. |
| Администратор | Создан по приглашению | Вызывает API в рамках бюджета, приглашает участников и управляет ими, пополняет баланс и видит использование всей компании. |
| Участник | Создан по приглашению | Использует API, рабочее пространство для изображений и видео и Castaly в рамках бюджета. Не может пополнять баланс. |
Администраторы и участники — это новые аккаунты, созданные по приглашению на электронную почту. Приглашённый адрес не должен быть уже зарегистрирован, поэтому существующий личный аккаунт не может присоединиться к компании. Эти аккаунты не участвуют в бонусных программах платформы.
Владелец и администраторы могут отключить аккаунт в любой момент, и его сеансы и ключи сразу перестают работать. Аккаунты только отключаются, но не удаляются, поэтому история использования сохраняется.
Ключи API
Заголовок раздела «Ключи API»Корпоративные ключи начинаются с префикса ключей компании, например acme-, за которым следуют 48 букв и цифр. Префикс вы выбираете при подаче заявки; он закрепляется при одобрении и потом не меняется. Префикс содержит от 2 до 16 строчных латинских букв и цифр и начинается с буквы.
Тот же ключ работает и с sk- вместо префикса. Используйте эту форму для клиентов, которые принимают только ключи, начинающиеся с sk-: обе формы — это один и тот же ключ с теми же правами и той же оплатой.
Authorization: Bearer acme-<48 characters>Authorization: Bearer sk-<48 characters>Ключ, переданный с префиксом, который не принадлежит его собственной компании, отклоняется как недействительный ключ со статусом 401.
Ключи, созданные владельцем до одобрения заявки, тоже отображаются с префиксом компании. Их форма с sk- продолжает работать, поэтому существующие интеграции менять не нужно.
Администраторы и участники создают и видят в консоли только собственные ключи. Владелец и администраторы могут управлять всеми ключами компании в корпоративной консоли с фильтром по участникам.
Бюджеты участников
Заголовок раздела «Бюджеты участников»У каждого администратора и участника есть бюджет. Деньги им не переводятся; бюджет — это максимум, который они могут потратить из баланса компании.
| Режим | Поведение |
|---|---|
| Без ограничений | Ограничен только балансом компании. |
| Разово | Фиксированная сумма, которая сама не обнуляется. |
| Ежемесячно | Обнуляется в 00:00 UTC 1-го числа каждого месяца. |
Если изменить только лимит, уже израсходованная сумма сохраняется. При переключении на другой режим отсчёт начинается с нуля.
Перед выполнением запроса шлюз резервирует его оценочную стоимость из оставшегося бюджета участника и отклоняет запрос, если она не помещается. Затем запрос рассчитывается по фактической стоимости. При расчёте запрос не отклоняется, поэтому последний запрос может вывести участника немного за лимит; отклонён будет следующий. Если запрос завершился ошибкой или по нему был возврат, сумма возвращается и в бюджет участника.
Участники получают письмо, когда израсходуют 80 % бюджета, и ещё одно, когда он закончится.
Оплата, группы и ограничения частоты
Заголовок раздела «Оплата, группы и ограничения частоты»Для шлюза запрос участника — это запрос аккаунта владельца. Всё, кроме бюджета, определяется владельцем:
- Списания идут с баланса компании так же, как для самого владельца, включая подписку владельца.
- Цены, группы и модели, которые может вызывать ключ, определяются аккаунтом владельца.
- Ограничения частоты считаются для всей компании. Владелец и все участники делят одну квоту, поэтому
429может быть вызван чужим трафиком.
Когда баланс компании заканчивается, запросы всех в компании завершаются ошибкой 403 с кодом insufficient_user_quota, как и у личного аккаунта. Владелец и администраторы могут пополнить баланс в корпоративной консоли, участники — нет. Если настроено оповещение о балансе, владелец и администраторы получают письмо, когда баланс опускается ниже порога.
| Ситуация | Статус | Как распознать |
|---|---|---|
| У ключа префикс другой компании | 401 |
Отклоняется как недействительный ключ |
| Бюджет участника исчерпан | 403 |
code равен enterprise_member_budget_exhausted |
| Участник отключён или компания приостановлена | 403 |
message сообщает, что аккаунт отключён |
| Баланс компании исчерпан | 403 |
code равен insufficient_user_quota |
| Компания в целом достигла ограничения частоты | 429 |
Так же, как у личного аккаунта |
Повторные попытки не устраняют случаи 401 и 403. Ошибка бюджета исчезает, когда администратор повышает лимит или, для ежемесячного бюджета, когда начинается следующий месяц; ошибка баланса исчезает после пополнения.
Асинхронные задачи
Заголовок раздела «Асинхронные задачи»Задачу, отправленную с ключом участника, можно запросить только ключами этого участника. Запрос с ключом другого участника возвращает тот же результат, что и для несуществующей задачи. Ключи владельца могут запрашивать задачи, отправленные кем угодно в компании.
Использование и журналы
Заголовок раздела «Использование и журналы»- В каждой записи журнала запросов указано, какой участник отправил запрос.
- В своей консоли администраторы и участники видят только собственные запросы.
- Страница журналов владельца показывает запросы всей компании с дополнительным столбцом «Участник».
- Владелец и администраторы могут разбить расходы по участникам, моделям, ключам и датам в корпоративной консоли и открыть отдельные запросы любого участника.
- Глубина истории зависит от срока хранения журналов аккаунта владельца, см. Хранение данных. Если владелец сократит его, отчёты компании сократятся тоже.
Как получить корпоративный аккаунт
Заголовок раздела «Как получить корпоративный аккаунт»Подайте заявку в консоли Modelflare, указав название компании, желаемый префикс ключей и контактный адрес электронной почты. После одобрения заявки ваш аккаунт становится владельцем, его баланс — балансом компании, а команду вы приглашаете из корпоративной консоли. Полное описание тарифа — на странице Для бизнеса.