Referanse · Ressurser

Photta API-ressursendepunkter ID-ene hver generering trenger

I én setning

Ressursendepunkter returnerer ID-ene et genereringskall krever: utstillingsdukker, positurer, bakgrunner, fottøy, klesattributter og merkevareetiketter, pluss kontosaldo og forbruk. Å liste koster ingenting.

  • Ressurs-endepunkter: 13 ressurs-endepunkter
  • Autentisering: Bearer-nøkkel
  • Grenser: 600 forespørsler/min

Hvert tall på denne siden er hentet fra dokumentasjonen for Photta-API-et · verifisert

Hvert ressursendepunkt, med kallet som leser det

Hver seksjon lenker til kapabiliteten som bruker disse ID-ene.

GET/api/v1/mannequins

Utstillingsdukker

Lister modellene som er tilgjengelige for try-on av klær: Phottas systemmodeller, dine egne opplastinger og de du har bygget med API-et for dukkegenerering. Gjør en POST til samme sti for å laste opp en tilpasset dukke, som forblir privat for din konto. ID-en sendes inn i `mannequin_id` på et try-on-kall.

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

Smykkemodeller

Laster opp et nærbilde av en modell for try-on av smykker. Smykkearbeid rammes inn på halslinje, øre, håndledd eller hånd, og bruker derfor sitt eget dukkesett i stedet for helkroppssettet for klær.

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 for smykke-try-on
GET/api/v1/poses

Positurer

Lister positurene en try-on kan be om, filtrerbare etter kategori og produkttypen de passer til. Send ID-en som `pose_id`; utelater du den, velger API-et en positur som passer til plagget.

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

Plagglengde og passform

Returnerer nøklene for lengde og passform som godtas av try-on for klær. Send nøkkelen, ikke en fritekstbeskrivelse, slik at samme skjorte gjengis på samme måte gjennom hele katalogen.

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

Bakgrunner

Lister systembakgrunner og dine egne opplastinger for try-on av klær, med markørpaginering. Gjør en POST til samme sti for å laste opp en tilpasset bakgrunn; den forblir privat for din konto.

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

Merkevareetiketter

Laster opp et gjenbrukbart etikettbilde for ghost mannequin-arbeid og returnerer en ID du sender som `brand_label_id`, på både enkeltjobber og batcher. GET lister hva du har lagret; DELETE fjerner en når du når kontogrensen.

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

Fottøy

Lister alternativer for fottøy til try-on for klær, filtrerbare etter type og kjønn, med markørpaginering. Bruk det til å sette sko på samme modell som bærer plagget.

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

Konto

Returnerer saldoen for credits fordelt på kilde, din nåværende plan og neste fornyelse av credits. Les den av før en stor batch i stedet for å oppdage mangelen i en 402.

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

Forbruk

Antall genereringer og forbruk av credits for inneværende kalendermåneds faktureringsvindu, delt inn i vellykkede og feilede jobber. Dette er endepunktet du bør lage grafer av, ikke din egen opptelling av forespørsler.

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

Spørsmål om ressursendepunktene

Hva brukes ressursendepunktene til?

De returnerer ID-ene som genereringskall krever — en utstillingsdukke, en positur, en bakgrunn, en merkevareetikett — pluss kontotilstanden din. Ingenting i denne gruppen oppretter et bilde.

Koster ressurskall credits?

Nei. Listing er gratis, og opplastingene i denne gruppen — en tilpasset dukke, en bakgrunn, en merkevareetikett — er også gratis. Du betaler bare for genereringer.

Hvordan paginerer jeg gjennom en lang liste?

Liste-endepunktene tar en grense og en markør: send den siste ID-en du så som `starting_after` og les neste side. Hurtigbufre det du mottar i stedet for å liste på nytt ved hver forespørsel.

Kan jeg laste opp mine egne utstillingsdukker og bakgrunner?

Ja. POST `/api/v1/mannequins`, POST `/api/v1/mannequins/jewelry`, POST `/api/v1/backgrounds` og POST `/api/v1/brand-labels` godtar alle dine egne bilder, og alt du laster opp forblir privat for din konto.

Hvor disse ID-ene brukes

Hvert tall på denne siden er hentet fra dokumentasjonen for Photta-API-et · verifisert

Prøv API-et på fem minutter

Generer en Photta API-nøkkel, lim inn cURL-kodesnutten ovenfor, og du har ditt første bilde på modell før kaffen er ferdig traktet.

  • 13 ressurs-endepunkter
  • Bearer-nøkkel
  • 600 forespørsler/min