Referenz · Ressourcen

Ressourcen-Endpoints der Photta-API die IDs, die jede Generierung benötigt

In aller Kürze

Ressourcen-Endpoints liefern die IDs zurück, die ein Generierungsaufruf erfordert: Mannequins, Posen, Hintergründe, Schuhe, Kleidungsattribute und Markenlabels, plus Ihren Account-Stand und Verbrauch. Das Auflisten kostet nichts.

  • Ressourcen-Endpoints: 13 Ressourcen-Endpoints
  • Authentifizierung: Bearer-Key
  • Limits: 600 Anfragen/Min.

Jeder Zahlenwert auf dieser Seite stammt aus der Photta-API-Dokumentation · geprüft

Jeder Ressourcen-Endpoint mit dem zugehörigen Leseaufruf

Jeder Abschnitt verlinkt die Funktion, die diese IDs verarbeitet.

GET/api/v1/mannequins

Mannequins

Listet die für Bekleidungs-Try-ons verfügbaren Models auf: Phottas System-Mannequins, Ihre eigenen Uploads und die mit der Mannequin-Generierungs-API erstellten. Senden Sie einen POST an denselben Pfad, um ein benutzerdefiniertes Mannequin hochzuladen, das für Ihren Account privat bleibt. Die ID wird als `mannequin_id` bei einem Try-on-Aufruf übergeben.

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

Schmuck-Mannequins

Lädt ein Nahaufnahme-Modelfoto für Schmuck-Try-ons hoch. Schmuckaufnahmen sind auf Ausschnitt, Ohr, Handgelenk oder Hand fokussiert und erfordern daher ein eigenes Mannequin-Set anstelle des Ganzkörper-Sets für Bekleidung.

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

Posen

Listet die Posen auf, die ein Try-on anfordern kann, filterbar nach Kategorie und passendem Produkttyp. Übergeben Sie die ID als `pose_id`; lassen Sie sie weg, wählt die API eine zum Kleidungsstück passende Pose.

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

Kleidungslänge und Passform

Gibt die Längen- und Passform-Schlüssel zurück, die Bekleidungs-Try-ons akzeptieren. Senden Sie den Schlüssel statt einer Freitextbeschreibung, damit dasselbe Hemd im gesamten Katalog einheitlich gerendert wird.

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

Hintergründe

Listet Systemhintergründe und Ihre eigenen Uploads für Bekleidungs-Try-ons auf, mit Cursor-Paginierung. Senden Sie einen POST an denselben Pfad, um einen eigenen Hintergrund hochzuladen; er bleibt für Ihren Account privat.

curl https://api.photta.app/api/v1/backgrounds \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
API für virtuelles Brillen-Try-on
POST/api/v1/brand-labels

Markenlabels

Lädt ein wiederverwendbares Label-Bild für Ghost-Mannequin-Aufgaben hoch und gibt eine ID zurück, die Sie als `brand_label_id` übergeben – sowohl bei Einzeljobs als auch bei Batches. GET listet Ihre gespeicherten Labels auf; DELETE entfernt eines, wenn Sie das Account-Limit erreichen.

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

Schuhe

Listet Schuhoptionen für Bekleidungs-Try-ons auf, filterbar nach Typ und Geschlecht, mit Cursor-Paginierung. Nutzen Sie dies, um demselben Model, das das Kleidungsstück trägt, Schuhe anzuziehen.

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

Account

Gibt Ihren Guthabenstand an Credits aufgeschlüsselt nach Quelle, Ihren aktuellen Plan und die nächste Credit-Erneuerung zurück. Rufen Sie ihn vor einem großen Batch ab, statt den Engpass erst durch einen 402 festzustellen.

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

Verbrauch

Generierungsanzahl und Credit-Ausgaben für das Abrechnungsfenster des aktuellen Kalendermonats, aufgeteilt in erfolgreiche und fehlgeschlagene Jobs. Dies ist der Endpoint für Auswertungen, nicht Ihre eigene Zählung von Requests.

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

Fragen zu den Ressourcen-Endpoints

Wozu dienen die Ressourcen-Endpoints?

Sie liefern die IDs zurück, die Generierungsaufrufe benötigen – ein Mannequin, eine Pose, ein Hintergrund, ein Markenlabel – plus Ihren Account-Status. Nichts in dieser Gruppe generiert ein Bild.

Kosten Ressourcenaufrufe Credits?

Nein. Das Auflisten ist kostenlos, und auch die Uploads in dieser Gruppe – ein benutzerdefiniertes Mannequin, ein Hintergrund, ein Markenlabel – sind kostenlos. Sie zahlen nur für Generierungen.

Wie paginiere ich durch eine lange Liste?

Die Listen-Endpoints akzeptieren ein Limit und einen Cursor: Übergeben Sie die zuletzt gesehene ID als `starting_after` und rufen Sie die nächste Seite ab. Cachen Sie die Ergebnisse, statt sie bei jedem Request erneut aufzulisten.

Kann ich eigene Mannequins und Hintergründe hochladen?

Ja. POST `/api/v1/mannequins`, POST `/api/v1/mannequins/jewelry`, POST `/api/v1/backgrounds` und POST `/api/v1/brand-labels` akzeptieren alle Ihre eigenen Bilder, und alles, was Sie hochladen, bleibt für Ihren Account privat.

Wo diese IDs verwendet werden

Jeder Zahlenwert auf dieser Seite stammt aus der Photta-API-Dokumentation · geprüft

Testen Sie die API in fünf Minuten

Generieren Sie einen Photta-API-Schlüssel, fügen Sie das obige cURL-Snippet ein, und Sie erhalten Ihr erstes Bild am Model, noch bevor der Kaffee fertig gebrüht ist.

  • 13 Ressourcen-Endpoints
  • Bearer-Key
  • 600 Anfragen/Min.