Search docs

Search the TryOnCloud API docs

Référence de l'API

Erreurs

Chaque code d'erreur, sa signification et s'il faut réessayer.

Les exemples de code, les points de terminaison et les codes d'erreur sont identiques dans tous les langages.

Chaque erreur est au format JSON et comporte un champ error lisible par l'utilisateur ainsi qu'un champ code stable. Baser la prise de décision sur le code, et non sur le message.

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

Générer des erreurs

HTTPcodeQue s'est-il passé ?Réessayer ?
400BAD_INPUTLe corps n'a pas pu être identifiéNon, corrigez la requête.
400NO_PERSONL'image de la personne est manquante, illisible ou n'est pas au format pris en chargeNon, envoyez une image valide
400NO_GARMENTImage du vêtement manquante, illisible ou URL garment_url bloquéeNon, envoyez une image valide ou une URL https publique
401NO_KEYAbsence d'en-tête X-API-KEYNon
401INVALID_KEYClé incorrecte ou révoquéeNon, vérifie la clé dans le tableau de bord.
402NO_CREDITSCrédits achetés épuisésNon, acheter des crédits
402QUOTA_EXCEEDEDLe quota gratuit est épuiséNon, acheter des crédits
402KEY_LIMIT_REACHEDCette clé API a atteint sa limite de crédit mensuelle. Le corps du message contient les champs used et limitNon, attendez le 1er (UTC) ou utilisez une clé avec une limite plus élevée
402FREE_TRIAL_USEDLa période d'essai gratuite a déjà été utilisée sur cet appareil.Non, acheter des crédits
403DEVICE_BANNEDCet appareil a été bloqué pour cause d'utilisation abusiveNon, contactez le service d'assistance
400BAD_IDEMPOTENCY_KEYLa Idempotency-Key est vide, trop longue ou contient des espacesNon, corrige l'en-tête.
409IDEMPOTENCY_IN_PROGRESSUne requête associée à cette clé est toujours en cours d'exécution. Aucun montant n'a été débité.Oui, après Retry-After
409IDEMPOTENCY_REPLAYCette clé a déjà fonctionné. Rien n'a été facturé.Non, c'est la première réponse qui contenait l'image
409IDEMPOTENCY_MISMATCHCette clé a été utilisée avec différentes imagesNon, utilisez une nouvelle clé
413IMAGE_TOO_LARGEUne image fait plus de 15 MoNon, commence par réduire l'échelle
422CONTENT_FILTEREDBloqué par le contrôle des contenus. Crédit rembourséNon, utilise d'autres images
429RATE_LIMITEDTrop de demandesOui, après Retry-After secondes
500GENERATION_FAILEDLe moteur est tombé en panne. Le crédit a été remboursé.Oui, une fois

Tâches asynchrones et traitements par lots

HTTPcodeQue s'est-il passé ?Réessayer ?
400BAD_WEBHOOK_URLwebhook_url n'est pas une URL https publiqueNon, corrige l'URL
400BATCH_TOO_LARGEPlus de 500 articles, soit plus de 10 en mode testNon, divisez le lot
402ASYNC_NEEDS_CREDITSLes tâches asynchrones et les traitements par lots utilisent les crédits achetésNon, achetez des crédits ou utilisez la requête POST /generate
429TOO_MANY_JOBS50 tâches asynchrones sont déjà en cours d'exécution sur le compteOui, après Retry-After
500JOB_CREATE_FAILED, BATCH_CREATE_FAILEDImpossible de le créer. Crédits remboursésOui

Une tâche qui échoue après avoir été acceptée renvoie le code d'erreur error.code, tant au niveau de la tâche que dans le webhook generation.failed : CONTENT_FILTERED, GENERATION_FAILED ou INPUT_FETCH_FAILED (impossible de télécharger l'URL d'une image). Le crédit correspondant est remboursé. Les éléments du lot annulés affichent le statut CANCELLED.

Autres critères d'évaluation

Point d'extrémitéHTTPcodeRéessayer ?
GET /credits500CREDITS_UNAVAILABLEOui
GET /results/:id404NOT_FOUND (inconnu, ne vous appartient pas ou date de plus de 7 jours)Non
DELETE /customers/:id500DELETE_FAILED (rien n'a été supprimé)Oui
DELETE /results/:id404NOT_FOUNDNon
DELETE /results/:id500DELETE_FAILEDOui

Consignes d'utilisation recommandées

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")
}
Avertissement : ne réessayez jamais une erreur 402 dans une boucle. Cela signifie que le compte n'a plus de crédits.