Przejdź do treści

Декорації

Перегляд та генерація декорацій і фонів для продуктової фотографії.

GET /api/external/sceneries

Повертає список доступних декорацій та фонів.

Заголовки

ЗаголовокОбов'язковийОпис
X-Api-KeyТакВаш API key у форматі mk_live_xxx.secret

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

ПолеТипОбов'язковийОпис
statusFilterstringНіФільтр за статусом: all (за замовчуванням) або approved

Відповідь

{
  "sceneries": [
    {
      "id": "scenery_abc123",
      "name": "Modern Studio - White Background",
      "thumbnail": "https://cdn.example.com/sceneries/thumb_abc123.jpg",
      "status": "DONE",
      "voting": "APPROVED",
      "createdAt": "2026-03-20T13:00:00.000Z"
    }
  ],
  "count": 1
}

Відповіді з помилками

КодЗначення
401Відсутній або недійсний API key
500Внутрішня помилка сервера

Примітки

  • Цей ендпоінт не витрачає кредити.

Приклад

curl -X GET "https://qamera.ai/api/external/sceneries?statusFilter=approved" \
  -H "X-Api-Key: mk_live_abc123.secret456"

POST /api/external/sceneries/register-ideas

Реєструє нове завдання генерації декорації. Кредити резервуються негайно та витрачаються після завершення обробки.

Заголовки

ЗаголовокОбов'язковийОпис
X-Api-KeyТакВаш API key у форматі mk_live_xxx.secret
Content-TypeТакapplication/json

Тіло запиту

ПолеТипОбов'язковийОпис
preferencesstringТакТекстовий опис бажаної декорації або фону
countnumberНіКількість декорацій для генерації (за замовчуванням: 10, максимум: 20)

Відповідь

{
  "createdRecordIds": ["scenery_001", "scenery_002", "scenery_003"],
  "batchId": "batch_abc123",
  "orderId": "order_xyz789",
  "reservationId": "res_def456",
  "creditsReserved": 30
}

Відповіді з помилками

КодЗначення
400Недійсне тіло запиту або відсутній preferences
401Відсутній або недійсний API key
402Недостатньо кредитів
500Внутрішня помилка сервера

Примітки

  • Обробка відбувається асинхронно. Завдання публікується в чергу повідомлень та обробляється воркером.
  • Відстежуйте статус згенерованих декорацій за допомогою GET-ендпоінта.
  • Кредити резервуються при створенні, витрачаються після успішної обробки та повертаються у разі невдачі.
  • Кожен запит генерує correlationId для трасування логів.
  • Максимум 20 декорацій за запит.

Приклад

curl -X POST "https://qamera.ai/api/external/sceneries/register-ideas" \
  -H "X-Api-Key: mk_live_abc123.secret456" \
  -H "Content-Type: application/json" \
  -d '{
    "preferences": "Minimalist Scandinavian living room with natural light and wooden furniture",
    "count": 5
  }'