DocTransform

Errores y límites

Qué significa cada código de error de la API y qué límites de frecuencia aplica.

Formato del error

Todo fallo de /api/v1 responde con la misma forma de cuerpo:

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

Decide según el campo error, nunca según el texto del mensaje: el mensaje es para una persona que lee registros.

Códigos de error

CódigoEstadoMensaje
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.

Frecuencia y concurrencia

  • Agotar las exportaciones mensuales de tu plan responde 402 EXPORT_LIMIT_REACHED, con un objeto quota (usadas, límite, cuándo se reinicia).
  • Iniciar más ejecuciones a la vez de las que permite la concurrencia de tu plan responde 429 CONCURRENCY_LIMIT_REACHED.
  • Enviar peticiones más rápido que la frecuencia de tu cuenta responde un segundo 429 RATE_LIMITED, distinto del anterior.
  • Un servidor en su límite de memoria responde 503 SERVER_BUSY: reintenta en breve.

Toda respuesta de /api/v1 lleva las cabeceras X-RateLimit-Limit, X-RateLimit-Remaining y X-RateLimit-Reset de la ventana contra la que se comprobó, para que un script pueda frenar antes de que lo rechacen.

Tablas de referencia y uniones

  • Una tabla de referencia admite hasta 50000 filas, nunca más filas de las que tu plan permite por archivo, en un archivo de como máximo 5 MB con celdas de como máximo 1000 caracteres. Un archivo que pasa un tope, o que no se puede guardar como tabla, responde REFERENCE_TABLE_REFUSED y no reemplaza nada. Cuántas tablas puedes guardar depende de tu plan, mira Planes y límites.
  • Un paso de unión empareja por 1 a 3 columnas clave. Las grafías parecidas funcionan solo con una columna clave. La búsqueda de parecidas se detiene en el presupuesto de coincidencias parecidas de 25,000,000 pares (valores distintos sin pareja por claves distintas de la tabla): los valores restantes quedan sin pareja, no se rechaza nada y la ejecución termina bien con JOIN_CLOSE_MATCH_LIMIT en sus avisos.
  • Reemplazar las filas de una tabla responde REFERENCE_TABLE_COLUMN_IN_USE cuando el archivo nuevo quita una columna que lee una plantilla, y lista esas plantillas, y REFERENCE_TABLE_ID_NOT_FOUND para un id que no es tuyo. En ambos casos no se reemplaza nada.

Listar las tablas de referencia y reemplazar sus filas nunca gasta tu cuota mensual ni un hueco de concurrencia de ejecuciones. Tienen su propia tasa de solicitudes, que responde 429 RATE_LIMITED al superarse.

Qué no cuenta para tu cuota

Listar plantillas y consultar el estado o la salida de una ejecución nunca gasta tu cuota mensual. Solo cuenta una ejecución que termina y devuelve un archivo. Una ejecución rechazada, fallida, agotada, interrumpida o repetida por idempotencia nunca se cobra. Los límites de cada plan están en Planes y límites.

Una división en archivos escribe como máximo 100 partes. Una ejecución que necesitaría más falla con FILE_SPLIT_TOO_MANY_PARTS, no escribe ningún archivo y nunca se cobra: envía el archivo en trozos de como máximo max_parts × max_rows filas, una ejecución por trozo. Una división por los valores de una columna no tiene max_rows que subir: elige una columna con menos valores o filtra antes las filas.

Una división en archivos por una columna que el archivo de salida no escribe (excluida o eliminada) falla con FILE_SPLIT_COLUMN_MISSING, no escribe ningún archivo y nunca se cobra: mantén la columna en la salida o cambia la división.

Una división cuyos archivos son demasiado grandes para un ZIP falla con FILE_SPLIT_TOO_LARGE, no escribe ningún archivo y nunca se cobra: usa menos filas por archivo o filtra las filas.