Reference · Ressourcer

Photta API-ressource-endpoints de id'er enhver generering har brug for

I én sætning

Ressource-endpoints returnerer de id'er, et genereringskald modtager: giner, poseringer, baggrunde, fodtøj, beklædningsattributter og brandlabels, plus din kontosaldo og dit forbrug. Oplistning koster ingenting.

  • Ressource-endpoints: 13 ressource-endpoints
  • Autentifikation: Bearer key
  • Grænser: 600 requests/min

Hvert tal på denne side stammer fra Photta API-dokumentationen · tjekket

Hvert ressource-endpoint med kaldet, der læser det

Hver sektion linker til den feature, der benytter disse id'er.

GET/api/v1/mannequins

Giner

Oplister de modeller, der er tilgængelige for try-on af tøj: Phottas systemginer, dine egne uploads og dem, du har bygget med mannequin generation API'et. Lav et POST til samme sti for at uploade en brugerdefineret gine, som forbliver privat for din konto. Id'et indsættes i `mannequin_id` på et try-on-kald.

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

Smykkeginer

Uploader et nærbillede af en model til try-on af smykker. Smykkearbejde er beskåret til en halsudskæring, et øre, et håndled eller en hånd, så det kræver sit eget sæt af giner frem for fuldkropsmodellerne til tøj.

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')
Try-on-API til smykker
GET/api/v1/poses

Poseringer

Oplister de poseringer, et try-on kan anmode om, filtrerbare efter kategori og efter den produkttype, de passer til. Send id'et som `pose_id`; udelad det, og API'et vælger en posering, der passer til tøjet.

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

Beklædningslængde og pasform

Returnerer de længde- og pasformsnøgler, som try-on af tøj accepterer. Send nøglen, ikke en fritekstbeskrivelse, så den samme skjorte gengives ensartet på tværs af et katalog.

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

Baggrunde

Oplister systembaggrunde og dine egne uploads til try-on af tøj, med cursor-paginering. Lav et POST til samme sti for at uploade en brugerdefineret baggrund; den forbliver privat for din konto.

curl https://api.photta.app/api/v1/backgrounds \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
API til virtuel try-on af briller
POST/api/v1/brand-labels

Brandlabels

Uploader et genanvendeligt labelbillede til ghost mannequin-arbejde og returnerer et id, du sender som `brand_label_id`, på både enkeltstående jobs og batches. GET oplister, hvad du har gemt; DELETE fjerner et, 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

Fodtøj

Oplister fodtøjsmuligheder til try-on af tøj, filtrerbare efter type og køn, med cursor-paginering. Brug det til at give den samme model, der bærer tøjet, sko på.

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

Konto

Returnerer din credits-saldo opdelt efter kilde, din nuværende plan og den næste credits-fornyelse. Læs den før et stort batch i stedet for at opdage manglen via en 402.

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

Forbrug

Antal genereringer og credits-forbrug for den aktuelle kalendermåneds faktureringsperiode, opdelt i fuldførte og mislykkede jobs. Dette er det endpoint, du skal grafe, ikke din egen optælling af requests.

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

Spørgsmål om ressource-endpoints

Hvad bruges ressource-endpoints til?

De returnerer de id'er, som genereringskald modtager — en gine, en posering, en baggrund, et brandlabel — plus din kontostatus. Intet i denne gruppe genererer et billede.

Koster ressourcekald credits?

Nej. Oplistning er gratis, og uploads i denne gruppe — en brugerdefineret gine, en baggrund, et brandlabel — er også gratis. Du betaler kun for genereringer.

Hvordan bladrer jeg igennem en lang liste?

Liste-endpoints tager en limit og en cursor: send det seneste id, du så, som `starting_after`, og læs den næste side. Cache det, du modtager, frem for at hente listen igen ved hver request.

Kan jeg uploade mine egne giner og baggrunde?

Ja. POST `/api/v1/mannequins`, POST `/api/v1/mannequins/jewelry`, POST `/api/v1/backgrounds` og POST `/api/v1/brand-labels` accepterer alle dine egne billeder, og alt, hvad du uploader, er privat for din konto.

Hvor disse id'er bruges

Hvert tal på denne side stammer fra Photta API-dokumentationen · tjekket

Prøv API'et på fem minutter

Generér en Photta API-nøgle, indsæt cURL-kodestykket ovenfor, og du har dit første billede på en model, før kaffen er færdigbrygget.

  • 13 ressource-endpoints
  • Bearer key
  • 600 requests/min