Перейти к содержимому
API Reference

Управление ключами

Создание и отзыв API-ключей в консоли разработчика, схемы аутентификации Bearer/Key/X-Api-Key и области доступа.

API-ключи создаются и отзываются в консоли разработчика clipia.ai (раздел /developer, вкладка «API-ключи»). Полный ключ показывается один раз при создании — сохраните его сразу. Ключ передаётся в каждом запросе одной из трёх схем (Bearer, Key или X-Api-Key) и привязан к scope-областям доступа.

Создание и отзыв

  1. Откройте консоль разработчика — раздел /developer, вкладка «API-ключи».
  2. Создайте ключ; задайте имя и среду (боевая clipia_live_… или песочница clipia_test_…).
  3. Скопируйте полный ключ из ответа — он показывается единственный раз.
  4. Чтобы отключить ключ, нажмите «Отозвать» — отзыв вступает в силу моментально.

Ключ — серверный секрет

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

Схемы аутентификации

Передавайте ключ в одном из трёх вариантов — выбирайте удобный:

Authorization: Bearer clipia_live_xxxxxxxxxxxxxxxxxxxxxx
Authorization: Key clipia_live_xxxxxxxxxxxxxxxxxxxxxx
X-Api-Key: clipia_live_xxxxxxxxxxxxxxxxxxxxxx

При использовании Authorization передавайте полную строку, включая префикс схемы (Bearer или Key ) и пробел.

Области доступа (scopes)

У ключа есть scope-ограничения. Допустимые значения — ровно generate и read; по умолчанию ключ получает оба (["generate", "read"]).

Prop

Type

  • Создание генераций требует scope generate.
  • Чтение статуса и результата своей генерации, каталог моделей (GET /v1/models) и баланс (GET /v1/account) доступны любому валидному ключу — scope не требуется.
  • Запрос без нужного scope → 403 insufficient_scope.

Песочница для отладки

Ключ с префиксом clipia_test_… работает в тестовом режиме: запрос не уходит в реальную генерацию, кредиты не списываются, а submit сразу возвращает детерминированный sample-результат. Когда интеграция готова, замените ключ на clipia_live_… — код менять не нужно.