Scenerie

Lista i generowanie scenerii oraz teł do fotografii produktowej.

GET /api/external/sceneries

Zwraca listę dostępnych scenerii i teł.

Nagłówki

NagłówekWymaganyOpis
X-Api-KeyTakTwój API key w formacie mk_live_xxx.secret

Parametry zapytania

PoleTypWymaganyOpis
statusFilterstringNieFiltruj po statusie: all (domyślnie) lub approved

Odpowiedź

{
  "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
}

Odpowiedzi z błędem

KodZnaczenie
401Brakujący lub nieprawidłowy API key
500Wewnętrzny błąd serwera

Uwagi

  • Ten endpoint nie zużywa kredytów.

Przykład

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

POST /api/external/sceneries/register-ideas

Rejestruje nowe zadanie generowania scenerii. Kredyty są rezerwowane natychmiast i zużywane po zakończeniu przetwarzania.

Nagłówki

NagłówekWymaganyOpis
X-Api-KeyTakTwój API key w formacie mk_live_xxx.secret
Content-TypeTakapplication/json

Treść zapytania

PoleTypWymaganyOpis
preferencesstringTakTekstowy opis pożądanej scenerii lub tła
countnumberNieLiczba scenerii do wygenerowania (domyślnie: 10, maks.: 20)

Odpowiedź

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

Odpowiedzi z błędem

KodZnaczenie
400Nieprawidłowa treść zapytania lub brak pola preferences
401Brakujący lub nieprawidłowy API key
402Niewystarczające kredyty
500Wewnętrzny błąd serwera

Uwagi

  • Przetwarzanie jest asynchroniczne. Zadanie jest publikowane w kolejce komunikatów i przetwarzane przez worker.
  • Śledź status wygenerowanych scenerii za pomocą endpointu GET.
  • Kredyty są rezerwowane przy tworzeniu, zużywane po pomyślnym przetworzeniu i zwracane w przypadku niepowodzenia.
  • Każde zapytanie generuje correlationId do śledzenia w logach.
  • Maksymalnie 20 scenerii na zapytanie.

Przykład

curl -X POST "https://app.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
  }'