Секрет своего API-ключа

GEThttps://api.souz.ai/v1/keys/{id}/secret

Отдаёт сырой ключ, чтобы скопировать его повторно, — только автору ключа (created_by), в кабинете или его ключом управления. Остальным — 403 с detail[].reason not_key_author; разработчику чужой ключ — 404, как несуществующий; наблюдателю — 403 по роли. Секрет, который показать нельзя, — 409 secret_unavailable: создайте новый ключ. Секрет ключа управления — только в кабинете.

Авторизация

ManagementKey

Ключ управления из кабинета souz.ai (выдают владелец и администратор аккаунта — себе или участнику). Даёт ровно то, что его держатель видит и может в кабинете: баланс, историю операций и запросов, расходы, обычные ключи, настройки аккаунта — с той же ролью, лимитами и цифрами. Модели не запускает. Обычный API-ключ здесь не подходит: 403 forbidden с detail[].reason: requires_management_key.

ClientSession

Сессия кабинета souz.ai в браузере — те же ручки, что у ключа управления.

Параметры пути

idstringобязательно

Id ключа

Ответы

200OK

application/json

Схема RevealAPIKeyResponse

keystringобязательно

Пример: "sk_9f8e7d6c5b4a39281706f5e4d3c2b1a0"

401Нет ключа или ключ недействителен.

application/json

Error

403Нельзя: у ключа не тот вид (модели запускает API-ключ, аккаунт — ключ управления), у роли

Нельзя: у ключа не тот вид (модели запускает API-ключ, аккаунт — ключ управления), у роли участника нет права или подпись ссылки на файл не сходится. detail[].reason говорит, что именно: requires_api_key, requires_management_key, cabinet_only (только в кабинете), insufficient_role (в allowed — роли, которым можно), not_key_author (секрет ключа открывает только тот, кто его создал).

application/json

Error

404Нет такого объекта у этого аккаунта.

application/json

Error

409Тот же `Idempotency-Key` с другим телом.

application/json

Error

429Слишком часто — повторите через `Retry-After` секунд. Запуск моделей, задачи и файлы результатов частотой не ограничены (их ограничивают баланс и лимиты трат); здесь 429 — на поток запросов с ключом, который сервер не знает, с одного адреса, и на потоки сверх 1000 одновременных на аккаунт (события задачи, чат с `stream: true`). Пределы — раздел «Лимиты» руководства.

application/json

Error

Запрос

curl -X GET 'https://api.souz.ai/v1/keys/{id}/secret' \
  -H "Authorization: Bearer $SOUZ_MANAGEMENT_KEY"

import os
import requests

response = requests.get(
    "https://api.souz.ai/v1/keys/{id}/secret",
    headers={"Authorization": f"Bearer {os.environ['SOUZ_MANAGEMENT_KEY']}"},
)
print(response.json())

const response = await fetch("https://api.souz.ai/v1/keys/{id}/secret", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.SOUZ_MANAGEMENT_KEY}` },
});
console.log(await response.json());

Ответ

{
  "error": {
    "code": "forbidden",
    "detail": [
      {
        "reason": "requires_api_key"
      }
    ],
    "message": "this endpoint takes an API key; a management key manages the account only",
    "type": "permission_error"
  }
}