Dokumentacja referencyjna · Zasoby

Endpointy zasobów Photta API identyfikatory potrzebne do każdej generacji

W jednym zdaniu

Endpointy zasobów zwracają identyfikatory przyjmowane przez wywołanie generacji: manekiny, pozy, tła, obuwie, atrybuty odzieży i metki marek, a także stan Twojego konta i zużycie. Listowanie nic nie kosztuje.

  • Endpointy zasobów: 13 endpointów zasobów
  • Uwierzytelnianie: Klucz Bearer
  • Limity: 600 requests/min

Każda liczba na tej stronie pochodzi z dokumentacji API Photta · sprawdzono

Każdy endpoint zasobu wraz z wywołaniem, które go odczytuje

Każda sekcja linkuje do funkcjonalności, która wykorzystuje te identyfikatory.

GET/api/v1/mannequins

Manekiny

Zwraca listę modeli dostępnych dla try-on odzieży: manekiny systemowe Photta, Twoje własne przesłane pliki oraz manekiny utworzone za pomocą API do generowania manekinów. Wyślij POST na tę samą ścieżkę, aby przesłać własnego manekina, który pozostanie prywatny na Twoim koncie. Identyfikator przekazuje się w polu `mannequin_id` podczas wywołania try-on.

curl https://api.photta.app/api/v1/mannequins \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
API wirtualnego try-on
POST/api/v1/mannequins/jewelry

Manekiny do biżuterii

Przesyła zdjęcie modelu w zbliżeniu na potrzeby try-on biżuterii. Projekty biżuterii kadrują dekolt, ucho, nadgarstek lub dłoń, dlatego wymagają osobnego zestawu manekinów zamiast modeli całosylwetkowych do odzieży.

RESPONSE=$(curl -s -X POST https://api.photta.app/api/v1/mannequins/jewelry \
  -H "Authorization: Bearer $PHOTTA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "image": "https://cdn.yourstore.com/models/emma-neck.jpg",
  "jewelry_type": "necklace",
  "gender": "female",
  "name": "Emma"
}')
ID=$(echo "$RESPONSE" | jq -r '.data.id')
API try-on biżuterii
GET/api/v1/poses

Pozy

Zwraca listę póz, o które można wnioskować w try-on, z możliwością filtrowania według kategorii oraz typu produktu, do którego pasują. Przekaż identyfikator jako `pose_id`; pomiń go, a API dobierze pozę pasującą do ubrania.

curl https://api.photta.app/api/v1/poses \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
API wirtualnego try-on
GET/api/v1/garment-attributes

Długość i dopasowanie odzieży

Zwraca klucze długości i dopasowania akceptowane przez try-on odzieży. Przesyłaj klucz, a nie opis w tekście jawnym, aby ta sama koszula renderowała się identycznie w całym katalogu.

curl https://api.photta.app/api/v1/garment-attributes \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
API wirtualnego try-on
GET/api/v1/backgrounds

Tła

Zwraca listę teł systemowych i Twoich własnych przesłanych plików dla try-on odzieży, z paginacją kursorową. Wyślij POST na tę samą ścieżkę, aby przesłać własne tło; pozostaje ono prywatne na Twoim koncie.

curl https://api.photta.app/api/v1/backgrounds \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
API wirtualnego try-on okularów
POST/api/v1/brand-labels

Metki marek

Przesyła obraz metki wielokrotnego użytku do prac typu duch (ghost mannequin) i zwraca identyfikator, który przekazujesz jako `brand_label_id`, zarówno w pojedynczych zadaniach, jak i w batchach. GET listuje zapisane metki; DELETE usuwa jedną z nich po osiągnięciu limitu konta.

RESPONSE=$(curl -s -X POST https://api.photta.app/api/v1/brand-labels \
  -H "Authorization: Bearer $PHOTTA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "file": "@/path/to/pribrand-label.png",
  "name": "Pribrand Collar Label"
}')
ID=$(echo "$RESPONSE" | jq -r '.data.id')
Ghost mannequin API
GET/api/v1/footwear

Obuwie

Zwraca listę opcji obuwia dla try-on odzieży, z możliwością filtrowania według typu i płci oraz z paginacją kursorową. Użyj go, aby założyć buty temu samemu modelowi, który prezentuje odzież.

curl https://api.photta.app/api/v1/footwear \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
API wirtualnego try-on
GET/api/v1/account

Konto

Zwraca stan salda credits w rozbiciu na źródła, bieżący plan oraz datę kolejnego odnowienia credits. Sprawdź go przed uruchomieniem dużego batcha, zamiast dowiadywać się o brakach z błędu 402.

curl https://api.photta.app/api/v1/account \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
Workflows API
GET/api/v1/account/usage

Zużycie

Liczba generacji i wydatki credits w bieżącym miesięcznym oknie rozliczeniowym, podzielone na zadania zakończone sukcesem i niepowodzeniem. To ten endpoint należy przedstawiać na wykresach, a nie własne zliczenia żądań.

curl https://api.photta.app/api/v1/account/usage \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
API batch ghost mannequin

Pytania dotyczące endpointów zasobów

Do czego służą endpointy zasobów?

Zwracają identyfikatory przyjmowane przez wywołania generacji — manekina, pozę, tło, metkę marki — oraz stan Twojego konta. Żaden endpoint w tej grupie nie tworzy obrazu.

Czy wywołania zasobów kosztują credits?

Nie. Listowanie jest bezpłatne, a operacje uploadu w tej grupie — własny manekin, tło, metka marki — są również bezpłatne. Płacisz wyłącznie za generacje.

Jak stronicować długą listę?

Endpointy listujące obsługują limit oraz kursor: przekaż ostatnio pobrany identyfikator jako `starting_after` i odczytaj kolejną stronę. Zapisuj pobrane dane w pamięci podręcznej, zamiast listować je ponownie przy każdym żądaniu.

Czy mogę przesłać własne manekiny i tła?

Tak. POST `/api/v1/mannequins`, POST `/api/v1/mannequins/jewelry`, POST `/api/v1/backgrounds` oraz POST `/api/v1/brand-labels` akceptują Twoje własne obrazy, a wszystkie przesłane pliki pozostają prywatne na Twoim koncie.

Gdzie używane są te identyfikatory

Każda liczba na tej stronie pochodzi z dokumentacji API Photta · sprawdzono

Wypróbuj API w 5 minut

Wygeneruj klucz Photta API, wklej powyższy snippet cURL, a otrzymasz swoje pierwsze zdjęcie na modelu, zanim zaparzy się kawa.

  • 13 endpointów zasobów
  • Klucz Bearer
  • 600 requests/min