Referentie · Resources

Photta API resource-endpoints de id's die elke generatie nodig heeft

In één zin

Resource-endpoints retourneren de id's die een generatie-call accepteert: paskoppen, poses, achtergronden, schoeisel, kledingkenmerken en merklabels, plus je accountsaldo en verbruik. Lijsten opvragen kost niets.

  • Resource-endpoints: 13 resource endpoints
  • Authenticatie: Bearer key
  • Limieten: 600 requests/min

Elk getal op deze pagina is afkomstig uit de Photta-API-documentatie · gecontroleerd

Elk resource-endpoint, met de call die het uitleest

Elke sectie linkt naar de functionaliteit die deze id's gebruikt.

GET/api/v1/mannequins

Paskoppen

Toont de modellen die beschikbaar zijn voor try-on van kleding: de systeempaskoppen van Photta, je eigen uploads en de modellen die je hebt gemaakt met de paskop-generatie-API. POST naar hetzelfde pad om een aangepaste paskop te uploaden, die privé blijft binnen je account. De id geef je mee in `mannequin_id` bij een try-on call.

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

Sieradenpaskoppen

Uploadt een close-up modelfoto voor het passen van sieraden. Sieradenwerk wordt gekadreerd op een halslijn, een oor, een pols of een hand, en vereist daarom een eigen set paskoppen in plaats van de full-body kledingvariant.

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')
Sieraden try-on API
GET/api/v1/poses

Poses

Toont de poses die een try-on kan aanvragen, filterbaar op categorie en het type product waar ze bij passen. Geef de id mee als `pose_id`; laat je dit weg, dan kiest de API een pose die bij het kledingstuk past.

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

Kledinglengte en pasvorm

Retourneert de lengte- en pasvorm-keys die kleding-try-on accepteert. Stuur de key mee, geen vrije tekst, zodat hetzelfde shirt over een hele catalogus op identieke wijze wordt gerenderd.

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

Achtergronden

Toont systeemachtergronden en je eigen uploads voor kleding-try-on, met cursor-paginering. POST naar hetzelfde pad om een aangepaste achtergrond te uploaden; deze blijft privé binnen je account.

curl https://api.photta.app/api/v1/backgrounds \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
API voor virtuele try-on van brillen
POST/api/v1/brand-labels

Merklabels

Uploadt een herbruikbare labelafbeelding voor ghost mannequin-verwerking en retourneert een id die je meegeeft als `brand_label_id`, voor zowel losse taken als batches. GET toont wat je hebt opgeslagen; DELETE verwijdert een label wanneer je de accountlimiet bereikt.

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

Schoeisel

Toont schoeiselopties voor kleding-try-on, filterbaar op type en geslacht, met cursor-paginering. Gebruik dit om schoenen te tonen op hetzelfde model dat de kleding draagt.

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

Account

Retourneert je creditsaldo uitgesplitst naar bron, je huidige abonnement en de volgende creditverlenging. Lees dit uit vóór een grote batch in plaats van een tekort te ontdekken via een 402.

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

Verbruik

Aantallen generaties en creditverbruik voor de huidige factuurperiode per kalendermaand, uitgesplitst in geslaagde en mislukte taken. Dit is het endpoint om te plotten in grafieken, niet je eigen telling van requests.

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

Vragen over de resource-endpoints

Waar dienen de resource-endpoints voor?

Ze retourneren de id's die generatie-calls vereisen — een paskop, een pose, een achtergrond, een merklabel — plus je accountstatus. Niets in deze groep genereert een afbeelding.

Kosten resource-calls credits?

Nee. Lijsten opvragen is gratis, en uploads binnen deze groep — een eigen paskop, achtergrond of merklabel — zijn dat ook. Je betaalt uitsluitend voor generaties.

Hoe pagineer ik door een lange lijst?

De lijst-endpoints accepteren een limiet en een cursor: geef de laatst geziene id mee als `starting_after` en haal de volgende pagina op. Cache de resultaten in plaats van bij elk request opnieuw de lijst op te vragen.

Kan ik mijn eigen paskoppen en achtergronden uploaden?

Ja. POST `/api/v1/mannequins`, POST `/api/v1/mannequins/jewelry`, POST `/api/v1/backgrounds` en POST `/api/v1/brand-labels` accepteren allemaal je eigen afbeeldingen, en alles wat je uploadt blijft privé binnen je account.

Waar deze id's worden gebruikt

Elk getal op deze pagina is afkomstig uit de Photta-API-documentatie · gecontroleerd

Probeer de API in vijf minuten

Genereer een Photta API-sleutel, plak het bovenstaande cURL-fragment en je hebt je eerste afbeelding op een model voordat de koffie klaar is.

  • 13 resource endpoints
  • Bearer key
  • 600 requests/min