Файл по id

GEThttps://api.souz.ai/v1/files/{id}

Авторизация

BearerAuth

API-ключ из кабинета souz.ai — запускает модели. Ключ управления здесь не подходит: 403 forbidden с detail[].reason: requires_api_key.

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

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

Id файла.

Шаблон: ^file_

Пример: "file_9f8e7d6c5b4a"

Ответы

200Описание файла.

application/json

Схема File

bytesinteger · int64обязательно

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

Пример: "image/png"

created_atstring · date-timeобязательно

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

expires_atstring · date-timeобязательно

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

heightinteger

Только у картинок.

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

Пример: "file_9f8e7d6c5b4a"

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

Значения: upload, reference, result

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

Значение: "file"

urlstring · uri

widthinteger

Только у картинок.

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

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

application/json

Error

Бесплатно, со своим ключом

Запрос

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

import os
import requests

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

const response = await fetch("https://api.souz.ai/v1/files/{id}", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.SOUZ_API_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"
  }
}