DocTransform

Erreurs et limites

Ce que signifie chaque code d'erreur de l'API et quelles limites de fréquence s'appliquent.

Format de l’erreur

Tout échec de /api/v1 répond avec la même forme de corps :

{
  "error": "TEMPLATE_NOT_FOUND",
  "message": "No Template with this id exists for this account."
}

Branchez-vous sur le champ error, jamais sur le texte du message : le message est destiné à une personne qui lit les journaux.

Codes d’erreur

CodeStatutMessage
API_KEY_INVALID401The API Key is malformed, unknown, revoked, or its account is inactive.
API_KEY_MISSING401Send the API Key as an `Authorization: Bearer` header.
APPEND_LOCALE_DISAGREEMENT200A warning, not a failure: some numbers in a part of an Append read differently from the column's locale, and the Run still succeeded.
CHANGE_COUNT_SWING200A warning, not a failure: a count in the Change Report is far off the Template's last run, and the Run still succeeded.
CHECK_NOT_FOUND410That check is gone. Check the file again to fix it.
COLUMN_MATCHED200A warning, not a failure: a column of the file was matched to a Template column by name, ignoring case, spaces and underscores, and the Run still succeeded.
CONCURRENCY_LIMIT_REACHED429This account already has the maximum number of Runs in flight for its plan.
EXCEL_ROW_LIMIT200Excel holds at most 1,048,575 data rows. Export as CSV instead.
EXCEL_TOO_LARGE200This Excel file is too large to write. Export as CSV instead.
EXPORT_LIMIT_REACHED402This account has used all its exports for this month.
FILE_COUNT_LIMIT_EXCEEDED413The request carries more `file` parts than this plan's Append file limit.
FILE_SPLIT_COLUMN_MISSING200The Template's File Split column is not among the columns the output file writes, so no file was written; the failure's `column` names it.
FILE_SPLIT_TOO_LARGE200The Split Parts are too large to hold in one ZIP, so no file was written. Use a smaller row limit per file or a filter.
FILE_SPLIT_TOO_MANY_PARTS200The Template's File Split would write more Split Parts than the 100-file limit, so no file was written; `parts` says how many it needed.
FILE_TOO_LARGE413The uploaded file exceeds this plan's upload size ceiling.
IDEMPOTENCY_KEY_REUSED409This `Idempotency-Key` was already used for a different request.
INSUFFICIENT_SCOPE403The API Key does not carry the scope this operation requires.
INVALID_COLUMN_MAPPING422`column_mapping` must be a JSON object of strings: each key a column of the file, each value a column the Template reads.
INVALID_IDEMPOTENCY_KEY422`Idempotency-Key` must be 1-255 printable characters.
INVALID_PARSE_PARAMS422`delimiter` must be one printable character; `header_row` must be a non-negative integer within the row ceiling.
JOIN_CLOSE_MATCH_LIMIT200A warning, not a failure: close matching stopped at its limit and the values left over stay unmatched, and the Run still succeeded.
JOIN_CLOSE_MATCHES200A warning, not a failure: some rows were matched to a close spelling in a reference table, and the Run still succeeded.
JOIN_FILE_COLUMNS_MISSING422The `file` part for a Join File lacks columns the Template's Join Step needs.
JOIN_FILE_MISSING422No `file` part was sent for a Join File this Template reads. Send one part for each Join File.
JOIN_FILES_LIMIT_EXCEEDED403This Template reads more files than this plan's joining limit allows.
JOIN_FILES_NOT_AVAILABLE403This plan does not include joining files, which this Template's Join Step needs.
JOIN_REPEATED_KEYS200A warning, not a failure: a reference table repeats some keys, each used its first row, and the Run still succeeded.
JOIN_UNMATCHED_ROWS200A warning, not a failure: some rows found no match in a reference table, and the Run still succeeded.
MALFORMED_FILE400The file could not be read: it is empty, corrupt, or not encoded as expected.
NO_SUBSCRIPTION403This account has no active subscription.
OUTPUT_STORAGE_FULL200Too many output files are waiting to be downloaded; try again after some expire.
PIPELINE_FAILED200The pipeline failed while running the Template.
PIVOT_TOO_MANY_VALUES200A Pivot step's header column has more distinct values than the 100-column limit; filter the rows before that step or choose another header column.
RATE_LIMITED429This account has exceeded its request rate limit for this operation.
REFERENCE_TABLE_COLUMN_IN_USE409The new file drops columns that Templates read. Nothing was replaced; add the columns back, or change those Templates first.
REFERENCE_TABLE_COLUMN_MISSING422A column this Template joins is no longer in its reference table. Open the Template and pick the column again.
REFERENCE_TABLE_ID_NOT_FOUND404No Reference Table with this id exists for this account.
REFERENCE_TABLE_NOT_FOUND422A reference table this Template joins does not exist for this account. Open the Template and pick another table.
REFERENCE_TABLE_REFUSED422The new file is over a cap of Reference Tables or cannot be stored as one. Nothing was replaced.
ROW_LIMIT_EXCEEDED413The uploaded file exceeds this plan's row ceiling.
RUN_FILES_AMBIGUOUS422A `file` part fits two of this Template's input files equally, so it cannot be told apart.
RUN_INTERRUPTED200The Run stopped reporting progress before it finished, including when a deploy replaced the server running it.
RUN_NOT_FOUND404No Run with this id exists for this account, or its output has expired.
RUN_TIMEOUT200The Run did not finish within the time limit.
SERVER_BUSY503This worker is at its memory budget; retry shortly.
SUMMARY_SHEET_BROKEN200The Template's Summary sheet cannot be built from this Run's output, so no file was written; the failure's `column` names the column it needs.
SUMMARY_SHEET_NOT_WRITTEN200A warning, not a failure: the Template has a Summary sheet, but it is only added to Excel files, and the Run still succeeded.
SUMMARY_SHEET_ONE_GROUP_PER_ROW200A warning, not a failure: the Summary sheet has more than half as many groups as the data has rows, and the Run still succeeded.
TEMPLATE_COLUMNS_MISSING422The uploaded file is missing one or more columns this Template's operations require.
TEMPLATE_NOT_FOUND404No Template with this id exists for this account.
TEMPLATE_OP_REFUSED422A step in this Template carries a value its operation no longer accepts. Open the Template and correct that step.
TEMPLATE_OUTPUT_AS_SOURCE422A `file` part is this Template's own output, which a Run never accepts as input.
TEMPLATE_TAKES_ONE_FILE422This Template has no Append Step, so it takes exactly one `file` part.
UNREAD_CELLS200A warning, not a failure: a step could not read some dates or numbers, so its result is empty in those rows, and the Run still succeeded.
UNSUPPORTED_FILE_TYPE415This file type is not supported.

Fréquence et concurrence

  • Épuiser les exportations mensuelles de votre forfait répond 402 EXPORT_LIMIT_REACHED, avec un objet quota (utilisées, limite, date de réinitialisation).
  • Lancer plus d’exécutions à la fois que la concurrence de votre forfait ne le permet répond 429 CONCURRENCY_LIMIT_REACHED.
  • Envoyer des requêtes plus vite que la fréquence de votre compte répond un second 429 RATE_LIMITED, distinct du précédent.
  • Un serveur à sa limite de mémoire répond 503 SERVER_BUSY : réessayez sous peu.

Toute réponse de /api/v1 porte les en-têtes X-RateLimit-Limit, X-RateLimit-Remaining et X-RateLimit-Reset de la fenêtre contre laquelle elle a été vérifiée, pour qu’un script puisse ralentir avant d’être refusé.

Tables de référence et jonctions

  • Une table de référence contient jusqu’à 50000 lignes, jamais plus de lignes que votre forfait n’en permet par fichier, dans un fichier d’au plus 5 MB avec des cellules d’au plus 1000 caractères. Un fichier au-delà d’un plafond, ou qui ne peut pas être stocké comme table, répond REFERENCE_TABLE_REFUSED et ne remplace rien. Le nombre de tables que vous pouvez enregistrer dépend de votre forfait, voir Forfaits et limites.
  • Une étape de jonction associe sur 1 à 3 colonnes clés. Les orthographes proches ne fonctionnent que sur une colonne clé. La recherche s’arrête au budget de correspondances proches de 25,000,000 paires (valeurs distinctes sans correspondance fois clés distinctes de la table) : les valeurs restantes restent sans correspondance, rien n’est refusé et l’exécution réussit avec JOIN_CLOSE_MATCH_LIMIT dans ses avertissements.
  • Remplacer les lignes d’une table répond REFERENCE_TABLE_COLUMN_IN_USE quand le nouveau fichier retire une colonne qu’un modèle lit, en listant ces modèles, et REFERENCE_TABLE_ID_NOT_FOUND pour un id qui n’est pas le vôtre. Dans les deux cas, rien n’est remplacé.

Lister les tables de référence et remplacer leurs lignes ne dépensent jamais votre quota mensuel ni une place de concurrence d’exécutions. Elles ont leur propre cadence de requêtes, qui répond 429 RATE_LIMITED quand elle est dépassée.

Ce qui ne compte pas dans votre quota

Lister les modèles et interroger le statut ou la sortie d’une exécution ne consomme jamais votre quota mensuel. Seule compte une exécution qui se termine et renvoie un fichier. Une exécution refusée, échouée, expirée, interrompue ou rejouée par idempotence n’est jamais facturée. Les limites de chaque forfait sont sur Forfaits et limites.

Une division en fichiers écrit au plus 100 parties. Une exécution qui en demanderait plus échoue avec FILE_SPLIT_TOO_MANY_PARTS, n’écrit aucun fichier et n’est jamais facturée : envoyez le fichier par morceaux d’au plus max_parts × max_rows lignes, une exécution par morceau. Une division par les valeurs d’une colonne n’a pas de max_rows à augmenter : choisissez une colonne avec moins de valeurs ou filtrez d’abord les lignes.

Une division en fichiers par une colonne que le fichier de sortie n’écrit pas (exclue ou supprimée) échoue avec FILE_SPLIT_COLUMN_MISSING, n’écrit aucun fichier et n’est jamais facturée : gardez la colonne dans la sortie ou changez la division.

Une division dont les fichiers sont trop volumineux pour un ZIP échoue avec FILE_SPLIT_TOO_LARGE, n’écrit aucun fichier et n’est jamais facturée : utilisez moins de lignes par fichier ou filtrez les lignes.