Funcionalidade · Roupas

API de try-on virtual para roupas

Em uma frase

A API de try-on virtual do Photta recebe uma imagem flat-lay de roupa, um ID de manequim e um ID de pose e retorna uma foto de modelo em 2K ou 4K. Envie o job via POST, faça polling a cada 3–5 segundos, baixe quando o status for completed.

Obter uma chave de API Ler a documentação

Tempo típico: 1.5–4 min
Credits: 5 credits em 2K · 6 credits em 4K
Processamento: assíncrono, polling
Limites: 600 requisições/min
Autenticação: Chave Bearer

Todos os números nesta página vêm de a documentação da API da Photta · verificado 2026-09-10

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')

const res = await fetch("https://api.photta.app/api/v1/tryon/apparel", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PHOTTA_API_KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "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."
  }),
});
const { data } = await res.json(); // data.id, data.status

import os, requests

res = requests.post(
    "https://api.photta.app/api/v1/tryon/apparel",
    headers={"Authorization": f"Bearer {os.environ['PHOTTA_API_KEY']}"},
    json={
      "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."
    },
)
data = res.json()["data"]  # data["id"], data["status"]

A garment rendered on an AI model by the apparel try-on API — Exemplo de saída

Visão geral

Endpoint: POST /api/v1/tryon/apparel
Autenticação: API key Bearer
Processamento: Assíncrono — faça polling no endpoint de status
Tempo típico: 1.5–4 min
Credits: 5 credits em 2K · 6 credits em 4K
Proporções de tela: 3:4 · 1:1 · 4:3 · 9:16 · 16:9
Limites de entrada: Até 10 MB por imagem; JPEG, PNG, WebP
Idempotente: Não

Requisição e resposta

Requisição

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')

const res = await fetch("https://api.photta.app/api/v1/tryon/apparel", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PHOTTA_API_KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "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."
  }),
});
const { data } = await res.json(); // data.id, data.status

import os, requests

res = requests.post(
    "https://api.photta.app/api/v1/tryon/apparel",
    headers={"Authorization": f"Bearer {os.environ['PHOTTA_API_KEY']}"},
    json={
      "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."
    },
)
data = res.json()["data"]  # data["id"], data["status"]

202 Accepted / Concluído

{
  "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"
}

{
  "data": {
    "id": "try_abc123",
    "status": "completed",
    "product_type": "top",
    "mannequin_id": "mnk_f3a9b1",
    "pose_id": "pose_c2d4e5",
    "resolution": "2K",
    "aspect_ratio": "3:4",
    "output_url": "https://cdn.photta.app/generated/try_abc123.jpg",
    "thumbnail_url": "https://cdn.photta.app/generated/try_abc123-thumb.jpg",
    "credits_used": 5,
    "created_at": "2026-04-10T12:00:00Z",
    "completed_at": "2026-04-10T12:01:15Z",
    "duration_ms": 75000
  },
  "request_id": "req_abc001"
}

Parâmetros da requisição

CampoDescrição

product_type

Tipo: stringObrigatório

Type of garment.

topbottomtop_and_bottomone_piece

product_images

Tipo: array[string]Obrigatório

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

Tipo: 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

Tipo: string

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

top_back_image

Tipo: string

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

bottom_image

Tipo: string

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

bottom_back_image

Tipo: string

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

mannequin_id

Tipo: stringObrigatório

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

pose_id

Tipo: stringObrigatório

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

Tipo: 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

Tipo: 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

Tipo: string

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

= 2K

2K4K

aspect_ratio

Tipo: string

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

= 3:4

3:41:14:39:1616:9

body_size

Tipo: string

Body size of the mannequin.

= M

XSSMLXLXXL

expression

Tipo: string

Facial expression.

= neutral

neutralhappyserioussmiling

footwear_url

Tipo: 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

Tipo: 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

Tipo: 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

Tipo: string

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

bottom_category

Tipo: string

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

length

Tipo: 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

Tipo: 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

Tipo: 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

Tipo: 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

Tipo: 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

Tipo: 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.

Erros

StatusTipoSignificado

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.

Limites

600 requisições por minuto por API key (Janela fixa; o limite é o mesmo em todos os planos)
Um 429 retorna Retry-After: 30 segundos
Até 10 MB por imagem
Formatos: JPEG, PNG, WebP
Batches concorrentes por plano: Free 1 · Hobby 2 · Seller 3 · Brand 4 · Studio 6
Apenas polling — a API não envia webhooks.

Cinco etapas, uma foto de produto

Escolha um manequim, envie o job, faça polling até concluir, baixe o resultado.

Passo 1
Gere uma chave de API
Cadastre-se em ai.photta.app, abra a aba Desenvolvedores e clique em Gerar chave de API. As chaves ativas começam com `photta_live_`. Coloque a chave em `PHOTTA_API_KEY` — nunca faça commit dela.
Passo 2
Escolha um manequim e uma pose
GET `/api/v1/mannequins` para listar as opções disponíveis. GET `/api/v1/poses` para o enquadramento. Ambos os IDs vão na requisição de try-on.
Passo 3
Faça o POST do job de try-on
Envie um POST para `/api/v1/tryon/apparel` com `product_type`, `product_images`, `mannequin_id`, `pose_id` e os opcionais `resolution` e `aspect_ratio`. A API retorna 202 Accepted com um ID de geração.
Passo 4
Faça polling até o job ser concluído
GET `/api/v1/tryon/apparel/:id` a cada 3 segundos. Quando `data.status` mudar para `completed`, o payload incluirá `output_url` e `thumbnail_url`. Defina um limite máximo para que um job travado não prenda sua requisição.
Passo 5
Baixe e mantenha os dados persistidos
Faça o fetch dos bytes de `output_url` e armazene-os no seu próprio object storage. A URL da CDN é estável, mas seu produto não deve depender dela para renderização.

O mesmo endpoint em Node.js, Python e cURL

Dúvidas frequentes de desenvolvedores antes de colocar o try-on de roupas em produção

O que é a API de virtual try-on da Photta?

Um endpoint REST que recebe uma foto do produto em flat-lay e um ID de manequim, retornando uma imagem fotorrealista no modelo. O mesmo pipeline do app para consumidores da Photta. Suporta quatro tipos de produto: top, bottom, top+bottom e one-piece.

Quanto custa por chamada?

5 credits para um resultado em 2K, 6 credits para 4K. Os credits vêm na sua assinatura e podem ser recarregados. Gerações que falham não gastam credits — são reembolsadas.

Quanto tempo leva uma geração?

A conclusão típica leva de 1.5 a 4 minutos, medidos de ponta a ponta. O POST retorna um ID de geração em menos de um segundo; o processamento em GPU acontece em segundo plano enquanto você faz o polling.

Quais tipos de produto são suportados?

Quatro: `top`, `bottom`, `top_and_bottom`, `one_piece`. Cada um exige um formato diferente de `product_images` — por exemplo, `top_and_bottom` requer URLs tanto para `top_image` quanto para `bottom_image`.

Posso usar meu próprio manequim?

Sim. Faça o upload de uma foto de manequim com `POST /api/v1/mannequins` ou gere um novo manequim por IA com `POST /api/v1/mannequins/generate`. O ID retornado é inserido diretamente na requisição de try-on.

Como faço o polling pelo resultado?

GET `/api/v1/tryon/apparel/:id` a cada 3 a 5 segundos até que `data.status` seja `completed` ou `failed`. Defina um limite máximo de tentativas — 120 × 3s cobre a janela documentada com margem de sobra.

Recursos relacionados

Todos os números nesta página vêm de a documentação da API da Photta · verificado 2026-09-10

Experimente a API em cinco minutos

Gere uma chave de API do Photta, cole o snippet de cURL acima e você terá sua primeira imagem com modelo antes que o café termine de passar.

Criar uma conta e obter uma chave de API Ler a documentação

1.5–4 min
5 credits em 2K · 6 credits em 4K
assíncrono, polling
600 requisições/min
Chave Bearer

API de try-on virtual para roupas

Visão geral

Requisição e resposta

Parâmetros da requisição

Erros

Cinco etapas, uma foto de produto

Gere uma chave de API

Escolha um manequim e uma pose

Faça o POST do job de try-on

Faça polling até o job ser concluído

Baixe e mantenha os dados persistidos

O mesmo endpoint em Node.js, Python e cURL

Dúvidas frequentes de desenvolvedores antes de colocar o try-on de roupas em produção

Recursos relacionados

Experimente a API em cinco minutos