Referenssi · Resurssit

Photta API -resurssipäätepisteet tunnisteet, joita jokainen generointi tarvitsee

Yhdellä lauseella

Resurssipäätepisteet palauttavat tunnisteet, joita generointikutsu käyttää: mallinuket, asennot, taustat, jalkineet, vaatteiden attribuutit ja tuotemerkit sekä tilisi saldon ja käytön. Listaaminen ei maksa mitään.

  • Resurssien endpointit: 13 resurssien endpointia
  • Autentikointi: Bearer-avain
  • Rajoitukset: 600 pyyntöä/min

Jokainen luku tällä sivulla on peräisin Photta-rajapinnan dokumentaatiosta · tarkistettu

Jokainen resurssipäätepiste ja sitä lukeva kutsu

Jokainen osio linkittää ominaisuuteen, joka käyttää kyseisiä tunnisteita.

GET/api/v1/mannequins

Mallinuket

Listaa saatavilla olevat mallit vaatteiden try-on-toiminnolle: Photta-järjestelmän mallinuket, omat latauksesi ja mallinukkejen generointi-API:lla luodut mallit. Lähetä POST samaan polkuun ladataksesi mukautetun mallinuken, joka pysyy yksityisenä tililläsi. Tunniste asetetaan try-on-kutsussa kenttään `mannequin_id`.

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

Korumallinuket

Lataa lähikuvan mallista korujen try-on-toimintoa varten. Korut rajataan kaula-aukkoon, korvaan, ranteeseen tai käteen, joten ne vaativat oman mallinukesettinsä koko vartalon vaatemallien sijaan.

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

Asennot

Listaa asennot, joita try-on voi pyytää, suodatettavissa kategorian ja sopivan tuotetyypin mukaan. Välitä tunniste parametrina `pose_id`; jos jätät sen pois, API valitsee vaatteeseen sopivan asennon.

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

Vaatteen pituus ja istuvuus

Palauttaa vaatteiden try-on-toiminnon hyväksymät pituus- ja istuvuusavaimet. Lähetä avain vapaamuotoisen tekstikuvauksen sijaan, jotta sama paita renderöityy samalla tavalla koko katalogissa.

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

Taustat

Listaa järjestelmätaustat ja omat latauksesi vaatteiden try-on-toimintoa varten kohdistinsivutuksella (cursor pagination). Lähetä POST samaan polkuun ladataksesi mukautetun taustan; se pysyy yksityisenä tililläsi.

curl https://api.photta.app/api/v1/backgrounds \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
Silmälasien virtuaalisen try-on-toiminnon API
POST/api/v1/brand-labels

Tuotemerkit

Lataa uudelleenkäytettävän etikettikuvan näkymättömän mallinuken (ghost mannequin) kuvauksia varten ja palauttaa tunnisteen, jonka välität parametrina `brand_label_id` niin yksittäisissä töissä kuin eräajoissa. GET listaa tallentamasi kohteet; DELETE poistaa kohteen, kun saavutat tilirajan.

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

Jalkineet

Listaa jalkinevaihtoehdot vaatteiden try-on-toimintoa varten, suodatettavissa tyypin ja sukupuolen mukaan, kohdistinsivutuksella (cursor pagination). Käytä tätä laittaaksesi kengät samalle mallille, jolla on vaate yllään.

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

Tili

Palauttaa credits-saldosi eriteltynä lähteittäin, nykyisen tilauksesi sekä seuraavan credits-uusinnan. Lue se ennen suurta eräajoa sen sijaan, että havaitsisit puutteen 402-virheestä.

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

Käyttö

Generointimäärät ja credits-kulutus nykyiselle kalenterikuukauden laskutusjaksolle jaettuna onnistuneisiin ja epäonnistuneisiin töihin. Tämä on päätepiste, josta tilastot tulee piirtää kaavioon, ei oma pyyntökirjanpitosi.

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

Kysymyksiä resurssipäätepisteistä

Mitä varten resurssipäätepisteet ovat?

Ne palauttavat tunnisteet, joita generointikutsut käyttävät — mallinukke, asento, tausta, tuotemerkki — sekä tilisi tilan. Mikään tässä ryhmässä ei luo kuvaa.

Maksavatko resurssikutsut credits-yksiköitä?

Ei. Listaaminen on ilmaista, ja tämän ryhmän lataukset — mukautettu mallinukke, tausta, tuotemerkki — ovat myös ilmaisia. Maksat vain generoinneista.

Miten sivutan pitkän listan?

Listapäätepisteet ottavat vastaan limit- ja cursor-parametrit: välitä viimeisin näkemäsi tunniste parametrina `starting_after` ja lue seuraava sivu. Välimuistita saamasi tiedot sen sijaan, että listaisit ne uudelleen jokaisella pyynnöllä.

Voinko ladata omia mallinukkeja ja taustoja?

Kyllä. POST `/api/v1/mannequins`, POST `/api/v1/mannequins/jewelry`, POST `/api/v1/backgrounds` ja POST `/api/v1/brand-labels` hyväksyvät kaikki omia kuviasi, ja kaikki lataamasi pysyy yksityisenä tililläsi.

Missä näitä tunnisteita käytetään

Jokainen luku tällä sivulla on peräisin Photta-rajapinnan dokumentaatiosta · tarkistettu

Kokeile APIa viidessä minuutissa

Luo Photta-API-avain, liitä yllä oleva cURL-koodinpätkä, ja sinulla on ensimmäinen mallikuva ennen kuin kahvi ehtii tippua.

  • 13 resurssien endpointia
  • Bearer-avain
  • 600 pyyntöä/min