Search docs

Search the TryOnCloud API docs

Referência da API

Erros

Cada código de erro, o que significa e se se deve tentar novamente.

Os exemplos de código, os pontos de extremidade e os códigos de erro são os mesmos em todas as línguas.

Cada erro é um JSON com uma mensagem legível por humanos error e um code estável. Baseie-se no code, e não na mensagem.

json
{ "error": "No credits left. Top up your developer wallet to continue.", "code": "NO_CREDITS" }

Gerar erros

HTTPcódigoO que aconteceuTentar novamente?
400BAD_INPUTNão foi possível ler o corpo do textoNão, corrige o pedido
400NO_PERSONA imagem da pessoa está em falta, é ilegível ou não está num formato suportadoNão, envie uma imagem válida
400NO_GARMENTA imagem da peça de roupa está em falta, é ilegível ou o garment_url está bloqueadoNão, envie uma imagem válida ou um URL público em https
401NO_KEYSem cabeçalho X-API-KEYNão
401INVALID_KEYChave incorreta ou revogadaNão, verifica a chave no painel de instrumentos
402NO_CREDITSCréditos adquiridos esgotadosNão, comprar créditos
402QUOTA_EXCEEDEDA franquia gratuita foi esgotadaNão, comprar créditos
402KEY_LIMIT_REACHEDEsta chave API atingiu o seu limite de crédito mensal. O corpo da mensagem inclui used e limitNão, espera até ao dia 1 (UTC) ou usa uma chave com um limite mais elevado
402FREE_TRIAL_USEDO período de avaliação gratuita já foi utilizado neste dispositivoNão, comprar créditos
403DEVICE_BANNEDEste dispositivo foi bloqueado devido a uso indevidoNão, contacte o apoio ao cliente
400BAD_IDEMPOTENCY_KEYA Idempotency-Key está vazia, é demasiado longa ou contém espaçosNão, corrige o cabeçalho
409IDEMPOTENCY_IN_PROGRESSUma solicitação com esta chave ainda está em execução. Não foi cobrado nadaSim, após o Retry-After
409IDEMPOTENCY_REPLAYEsta chave já funcionou. Não foi cobrado nada.Não, a primeira resposta incluía a imagem
409IDEMPOTENCY_MISMATCHEsta chave foi utilizada com diferentes imagensNão, usa uma chave nova
413IMAGE_TOO_LARGEUma imagem tem mais de 15 MBNão, primeiro reduz a escala
422CONTENT_FILTEREDBloqueado devido à moderação de conteúdos. Crédito reembolsadoNão, usa imagens diferentes
429RATE_LIMITEDDemasiados pedidosSim, após Retry-After segundos
500GENERATION_FAILEDO motor avariou. O crédito foi reembolsadoSim, uma vez

Tarefas assíncronas e lotes

HTTPcódigoO que aconteceuTentar novamente?
400BAD_WEBHOOK_URLwebhook_url não é um URL https públicoNão, corrige o URL
400BATCH_TOO_LARGEMais de 500 itens, ou mais de 10 no modo de testeNão, divide o lote
402ASYNC_NEEDS_CREDITSAs tarefas assíncronas e os lotes utilizam os créditos adquiridosNão, compra créditos ou utiliza POST /generate
429TOO_MANY_JOBSJá existem 50 tarefas assíncronas a ser executadas na contaSim, após Retry-After
500JOB_CREATE_FAILED, BATCH_CREATE_FAILEDNão foi possível criá-lo. Os créditos foram reembolsadosSim

Uma tarefa que falha após ter sido aceite apresenta o código de erro error.code, tanto na própria tarefa como no webhook generation.failed: CONTENT_FILTERED, GENERATION_FAILED ou INPUT_FETCH_FAILED (não foi possível descarregar o URL de uma imagem). O crédito correspondente é reembolsado. Os itens do lote cancelados apresentam o estado CANCELLED.

Outros parâmetros de avaliação

Ponto finalHTTPcódigoTentar novamente?
GET /credits500CREDITS_UNAVAILABLESim
GET /results/:id404NOT_FOUND (desconhecido, não é seu ou tem mais de 7 dias)Não
DELETE /customers/:id500DELETE_FAILED (não foi apagado nada)Sim
DELETE /results/:id404NOT_FOUNDNão
DELETE /results/:id500DELETE_FAILEDSim

Manuseamento recomendado

js
async function tryOn(form) {
  for (let attempt = 1; attempt <= 2; attempt++) {
    const res = await fetch("https://www.tryoncloud.com/api/v1/generate", {
      method: "POST",
      headers: { "X-API-KEY": process.env.TRYONCLOUD_API_KEY },
      body: form,
      signal: AbortSignal.timeout(120_000),
    })
    if (res.ok) return Buffer.from(await res.arrayBuffer())

    const { code, error } = await res.json()
    if (code === "RATE_LIMITED") {
      await new Promise((r) => setTimeout(r, Number(res.headers.get("Retry-After") || 5) * 1000))
      continue
    }
    if (code === "GENERATION_FAILED" && attempt === 1) continue // refunded, retry once
    throw new Error(`${code}: ${error}`) // 4xx: fix input or buy credits, do not loop
  }
  throw new Error("GENERATION_FAILED twice")
}
Aviso: Nunca volte a tentar um código de erro 402 num ciclo. Isso significa que a conta ficou sem créditos.