Referens · Resurser

Photta API-resursendpoints de id:n varje generering behöver

I en mening

Resursendpoints returnerar de id:n som ett genereringsanrop tar: mannekänger, poser, bakgrunder, skor, plaggattribut och varumärkesetiketter, plus ditt kontosaldo och din användning. Att lista kostar ingenting.

  • Resursendpoints: 13 resurs-endpoints
  • Autentisering: Bearer-nyckel
  • Gränser: 600 requests/min

Varje siffra på den här sidan kommer från Photter API-dokumentationen · kontrollerad

Varje resursendpoint, med anropet som läser den

Varje sektion länkar till den förmåga som använder dessa id:n.

GET/api/v1/mannequins

Mannekänger

Listar de modeller som är tillgängliga för try-on av kläder: Phottas systemmannekänger, dina egna uppladdningar och de du skapat med API:et för mannekänggenerering. Gör en POST till samma sökväg för att ladda upp en anpassad mannekäng, som förblir privat för ditt konto. Detta id skickas i `mannequin_id` vid ett try-on-anrop.

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

Smyckesmannekänger

Laddar upp ett närbildsfoto av en modell för try-on av smycken. Smyckesjobb ramas in mot en halsringning, ett öra, en handled eller en hand, så det kräver en egen uppsättning mannekänger snarare än helkroppsvarianten för kläder.

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 för smyckes-try-on
GET/api/v1/poses

Poser

Listar de poser som en try-on kan begära, filtrerbara efter kategori och vilken produkttyp de passar för. Skicka med detta id som `pose_id`; utelämnas det väljer API:et en pose som passar plagget.

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

Plagglängd och passform

Returnerar de nycklar för längd och passform som try-on för kläder accepterar. Skicka nyckeln, inte en fritextbeskrivning, så att samma skjorta renderas på samma sätt över hela katalogen.

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

Bakgrunder

Listar systembakgrunder och dina egna uppladdningar för try-on av kläder, med cursor-paginering. Gör en POST till samma sökväg för att ladda upp en anpassad bakgrund; den förblir privat för ditt konto.

curl https://api.photta.app/api/v1/backgrounds \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
API för virtuell try-on av glasögon
POST/api/v1/brand-labels

Varumärkesetiketter

Laddar upp en återanvändbar etikettbild för ghost mannequin-jobb och returnerar ett id som du skickar som `brand_label_id`, på såväl enstaka jobb som batcher. GET listar vad du har sparat; DELETE tar bort en när du når kontogränsen.

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

Skor

Listar skoalternativ för try-on av kläder, filtrerbara efter typ och kön, med cursor-paginering. Används för att sätta skor på samma modell som bär plagget.

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

Konto

Returnerar ditt credits-saldo uppdelat efter källa, din nuvarande plan och nästa förnyelse av credits. Läs av detta före en stor batch i stället för att upptäcka underskottet i en 402.

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

Användning

Antal genereringar och förbrukade credits för den aktuella kalendermånadens faktureringsperiod, uppdelat på lyckade och misslyckade jobb. Detta är endpointen du ska visualisera i grafer, inte din egen sammanräkning av förfrågningar.

curl https://api.photta.app/api/v1/account/usage \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
API för batch-ghost-mannekäng

Frågor om resursendpoints

Vad används resursendpoints till?

De returnerar de id:n som genereringsanrop tar emot — en mannekäng, en pose, en bakgrund, en varumärkesetikett — plus din kontostatus. Inget i denna grupp skapar en bild.

Kostar resursanrop credits?

Nej. Att lista är gratis, och uppladdningarna i denna grupp — en anpassad mannekäng, en bakgrund, en varumärkesetikett — är också gratis. Du betalar bara för genereringar.

Hur bläddrar jag igenom en lång lista?

List-endpoints tar en limit och en cursor: skicka det senaste id:t du såg som `starting_after` och läs nästa sida. Cacha det du hämtar i stället för att lista om vid varje anrop.

Kan jag ladda upp mina egna mannekänger och bakgrunder?

Ja. POST `/api/v1/mannequins`, POST `/api/v1/mannequins/jewelry`, POST `/api/v1/backgrounds` och POST `/api/v1/brand-labels` accepterar alla dina egna bilder, och allt du laddar upp är privat för ditt konto.

Var dessa id:n används

Varje siffra på den här sidan kommer från Photter API-dokumentationen · kontrollerad

Testa API:et på fem minuter

Generera en Photta API-nyckel, klistra in cURL-kodfragmentet ovan, och du har din första bild på en modell innan kaffet har bryggts klart.

  • 13 resurs-endpoints
  • Bearer-nyckel
  • 600 requests/min