Förmåga · Apparel

API för virtuell try-on för apparel

I en mening

Phottas API för virtuell try-on tar en flat-lay-klädbild, ett mannekäng-ID och ett pos-ID och returnerar ett foto på modell i 2K eller 4K. POST:a jobbet, polla var 3–5:e sekund, ladda ner när status är completed.

  • Typisk tid: 1.5–4 min
  • Credits: 5 credits vid 2K · 6 credits vid 4K
  • Bearbetning: asynkron, polling
  • Gränser: 600 requests/min
  • Autentisering: Bearer-nyckel

Varje siffra på den här sidan kommer från Photter API-dokumentationen · kontrollerad

POST/api/v1/tryon/apparel
RESPONSE=$(curl -s -X POST https://api.photta.app/api/v1/tryon/apparel \
  -H "Authorization: Bearer $PHOTTA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "product_type": "top",
  "product_images": [
    "https://cdn.yourstore.com/products/shirt-front.jpg"
  ],
  "product_back_image": "https://cdn.yourstore.com/products/shirt-back.jpg",
  "product_category": "t_shirt",
  "mannequin_id": "mnk_f3a9b1",
  "pose_id": "pose_c2d4e5",
  "background": "https://cdn.yourstore.com/backgrounds/studio-loft.jpg",
  "lock_background": true,
  "resolution": "2K",
  "aspect_ratio": "3:4",
  "body_size": "M",
  "expression": "neutral",
  "user_instruction": "Keep the collar pattern crisp and centered."
}')
ID=$(echo "$RESPONSE" | jq -r '.data.id')
A garment rendered on an AI model by the apparel try-on API
Exempelutdata

I korthet

I korthet

Endpoint
POST /api/v1/tryon/apparel
Autentisering
Bearer API-nyckel
Bearbetning
Asynkron — polla status-endpointen
Typisk tid
1.5–4 min
Credits
5 credits vid 2K · 6 credits vid 4K
Bildförhållanden
3:4 · 1:1 · 4:3 · 9:16 · 16:9
Indatagränser
Upp till 10 MB per bild; JPEG, PNG, WebP
Idempotent
Nej

Request och response

Request

RESPONSE=$(curl -s -X POST https://api.photta.app/api/v1/tryon/apparel \
  -H "Authorization: Bearer $PHOTTA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "product_type": "top",
  "product_images": [
    "https://cdn.yourstore.com/products/shirt-front.jpg"
  ],
  "product_back_image": "https://cdn.yourstore.com/products/shirt-back.jpg",
  "product_category": "t_shirt",
  "mannequin_id": "mnk_f3a9b1",
  "pose_id": "pose_c2d4e5",
  "background": "https://cdn.yourstore.com/backgrounds/studio-loft.jpg",
  "lock_background": true,
  "resolution": "2K",
  "aspect_ratio": "3:4",
  "body_size": "M",
  "expression": "neutral",
  "user_instruction": "Keep the collar pattern crisp and centered."
}')
ID=$(echo "$RESPONSE" | jq -r '.data.id')

202 Accepted / Completed

{
  "data": {
    "id": "try_abc123",
    "status": "processing",
    "product_type": "top",
    "mannequin_id": "mnk_f3a9b1",
    "pose_id": "pose_c2d4e5",
    "lock_background": true,
    "resolution": "2K",
    "aspect_ratio": "3:4",
    "credits_used": 5,
    "created_at": "2026-04-10T12:00:00Z"
  },
  "request_id": "req_xyz789"
}

Request-parametrar

product_type

Typ: stringObligatorisk

Type of garment.

Värden: topbottomtop_and_bottomone_piece
product_images

Typ: array[string]Obligatorisk

Array of image URLs or base64 data URIs. The first entry is the FRONT image and is required. Not used when product_type is "top_and_bottom".

product_back_image

Typ: string

Optional URL or base64 data URI for the BACK of the garment. When supplied, the pipeline auto-switches to the back image whenever the selected pose is back-facing (Back / BackCloseUp). Not used when product_type is "top_and_bottom".

top_image

Typ: string

Front image of the top garment. Required when product_type is "top_and_bottom".

top_back_image

Typ: string

Optional back image of the top garment. Auto-selected on back-facing poses when present.

bottom_image

Typ: string

Front image of the bottom garment. Required when product_type is "top_and_bottom".

bottom_back_image

Typ: string

Optional back image of the bottom garment. Auto-selected on back-facing poses when present.

mannequin_id

Typ: stringObligatorisk

ID of the mannequin to wear the garment. Use GET /api/v1/mannequins to list available options.

pose_id

Typ: stringObligatorisk

ID of the pose. Use GET /api/v1/poses to list available options. The pose dictates the framing of the output — what's in frame, whether the face/feet are visible, full body vs half body, etc.

background

Typ: string

Optional URL or base64 data URI to a background photo. Anything that is not a URL or data: URI is rejected with HTTP 400. When omitted, an editorial neutral backdrop is used.

lock_background

Typ: boolean

When true, the supplied background image is reproduced faithfully (locked) instead of being treated as loose inspiration. Requires the background field — returns 400 if set without a background. Echoed back in the response object.

= false

resolution

Typ: string

Output resolution. 4K cannot be combined with aspect_ratio 1:1 — that combination returns 400.

= 2K

Värden: 2K4K
aspect_ratio

Typ: string

Output aspect ratio. 1:1 cannot be combined with resolution 4K — that combination returns 400.

= 3:4

Värden: 3:41:14:39:1616:9
body_size

Typ: string

Body size of the mannequin.

= M

Värden: XSSMLXLXXL
expression

Typ: string

Facial expression.

= neutral

Värden: neutralhappyserioussmiling
footwear_url

Typ: string

URL or base64 of a custom footwear image. The pipeline always stages the footwear when supplied; the prompt's pose-authority block decides whether to render it (poses that don't show feet drop it cleanly).

user_instruction

Typ: string

Free-form refinement, e.g. "preserve the seam pattern across the shoulder", "keep the collar contrast strong". Capped at 500 characters server-side; longer strings are silently truncated. Useful for brand-specific details that need an extra nudge.

product_category

Typ: string

Optional silhouette anchor for the garment (e.g. "t_shirt", "jeans", "blazer", "midi_dress"). Helps disambiguate the structure of the garment when the silhouette is ambiguous from the photo alone. Used for product_type "top", "bottom", and "one_piece".

top_category

Typ: string

Silhouette anchor for the top half. Only valid when product_type is "top_and_bottom".

bottom_category

Typ: string

Silhouette anchor for the bottom half. Only valid when product_type is "top_and_bottom".

length

Typ: string

Garment length key for product_type "top", "bottom", or "one_piece". List available values with GET /api/v1/garment-attributes?type=length&garment_type={product_type}.

fit

Typ: string

Garment fit key for product_type "top", "bottom", or "one_piece". List available values with GET /api/v1/garment-attributes?type=fit&garment_type={product_type}.

top_length

Typ: string

Top length key. Only valid when product_type is "top_and_bottom". List with GET /api/v1/garment-attributes?type=length&garment_type=top.

top_fit

Typ: string

Top fit key. Only valid when product_type is "top_and_bottom". List with GET /api/v1/garment-attributes?type=fit&garment_type=top.

bottom_length

Typ: string

Bottom length key. Only valid when product_type is "top_and_bottom". List with GET /api/v1/garment-attributes?type=length&garment_type=bottom.

bottom_fit

Typ: string

Bottom fit key. Only valid when product_type is "top_and_bottom". List with GET /api/v1/garment-attributes?type=fit&garment_type=bottom.

Fel

400invalid_request_error
The request is malformed or contains invalid parameters.
401authentication_error
The API key is missing, invalid, or expired.
402insufficient_credits_error
Your account does not have enough credits.
404not_found_error
The requested resource does not exist.
409conflict_error
The request conflicts with current state — e.g. your concurrent-batch cap is reached.
429rate_limit_error
Too many requests. Slow down and retry.Retry-After: 30
500api_error
An internal server error occurred. Retry later.

Gränser

  • 600 anrop per minut per API-nyckel (Fast fönster; gränsen är densamma på alla planer)
  • En 429 innehåller Retry-After: 30 sekunder
  • Upp till 10 MB per bild
  • Format: JPEG, PNG, WebP
  • Samtidiga batcher per plan: Free 1 · Hobby 2 · Seller 3 · Brand 4 · Studio 6
  • Endast polling — API:et skickar inga webhooks.

Fem steg, ett produktfoto

Välj en provdocka, skicka jobbet, polla tills det är klart, ladda ned resultatet.

  1. Steg 1

    Generera en API-nyckel

    Skapa konto på ai.photta.app, öppna fliken Developers, klicka på Generate API key. Produktionsnycklar börjar med `photta_live_`. Sätt nyckeln i `PHOTTA_API_KEY` — committa den aldrig.

  2. Steg 2

    Välj provdocka och pose

    GET `/api/v1/mannequins` för att lista tillgängliga alternativ. GET `/api/v1/poses` för inramningen. Båda ID:na skickas med i try-on-anropet.

  3. Steg 3

    Gör en POST med try-on-jobbet

    Skicka en POST till `/api/v1/tryon/apparel` med `product_type`, `product_images`, `mannequin_id`, `pose_id` samt valfria `resolution` och `aspect_ratio`. API:et returnerar 202 Accepted med ett genererings-ID.

  4. Steg 4

    Polla tills jobbet är klart

    GET `/api/v1/tryon/apparel/:id` var 3:e sekund. När `data.status` slår om till `completed` innehåller payloaden `output_url` och `thumbnail_url`. Sätt en övre gräns så att ett låst jobb inte hänger din request.

  5. Steg 5

    Ladda ned och spara

    Hämta byten från `output_url` och lagra dem i din egen objektlagring. CDN-URL:en är stabil, men din produkt bör inte förlita sig på den för rendering.

Frågor utvecklare ställer innan de driftsätter apparel try-on

Vad är Phottas API för virtuell try-on?

En REST-endpoint som tar en flat-lay-produktbild och ett provdocke-ID och returnerar en fotorealistisk bild på modell. Samma pipeline som Phottas konsumentapp. Fyra produkttyper stöds: top, bottom, top+bottom, one-piece.

Vad kostar det per anrop?

5 credits för ett 2K-resultat, 6 credits för 4K. Credits ingår i din prenumeration och kan fyllas på. Misslyckade genereringar kostar inga credits — de återbetalas.

Hur lång tid tar en generering?

Normal svarstid är 1,5 till 4 minuter, mätt från start till mål. POST-anropet returnerar ett genererings-ID på under en sekund; GPU-arbetet sker i bakgrunden medan du pollar.

Vilka produkttyper stöds?

Fyra: `top`, `bottom`, `top_and_bottom`, `one_piece`. Var och en förväntar sig en specifik struktur på `product_images` — till exempel kräver `top_and_bottom` URL:er för både `top_image` och `bottom_image`.

Kan jag använda min egen provdocka?

Ja. Ladda upp ett foto på en provdocka med `POST /api/v1/mannequins` eller generera en ny AI-provdocka med `POST /api/v1/mannequins/generate`. Det returnerade ID:t används direkt i try-on-anropet.

Hur pollar jag efter resultatet?

GET `/api/v1/tryon/apparel/:id` var 3:e till 5:e sekund tills `data.status` är `completed` eller `failed`. Sätt en övre gräns för antalet försök — 120 × 3s täcker det dokumenterade tidsfönstret med god marginal.

Relaterade funktioner

Varje siffra på den här sidan kommer från Photter API-dokumentationen · kontrollerad

Testa API:et på fem minuter

Generera en Photta API-nyckel, klistra in cURL-kodfragmentet ovan, och du har din första bild på en modell innan kaffet har bryggts klart.

  • 1.5–4 min
  • 5 credits vid 2K · 6 credits vid 4K
  • asynkron, polling
  • 600 requests/min
  • Bearer-nyckel