Errors
Error handling of API responses
Error format
Failed requests return application/problem+json:
{
"title": "Unauthorized",
"status": 401,
"code": "invalid_api_key",
"detail": "The API key is missing, malformed, expired or revoked.",
"requestId": "3f1c2a8e-5b7d-4c1e-9a0f-2d6b8e4c7a11"
}Branch on code, not on detail: codes are stable, messages may change.
requestId matches the Request-Id response header. Please include it when
you contact support@tabula.de.
Error codes
| Status | Code | Detail | What to do |
|---|---|---|---|
| 400 | validation_failed | The request is invalid. | Check the form fields against the API reference. |
| 401 | invalid_api_key | The API key is missing, malformed, expired or revoked. | Check that the key is sent in the Authorization header and is still active. |
| 404 | not_found | No endpoint matches this method and path. | Check the method and path against the API reference. |
| 404 | upload_not_found | No upload with this ID exists for the company. | Check the upload ID and the API key's company. |
| 409 | external_id_conflict | An earlier upload with this externalId has a different file or document type. | Send the file with a new externalId. |
| 409 | company_not_ready | The company is not activated yet. | Finish activating the company in Tabula. |
| 413 | file_too_large | The file exceeds the size limit. | Split the document or archive. |
| 415 | unsupported_media_type | The file type is not supported. | Send a PDF or XML document, or a ZIP archive to the batch endpoint. |
| 422 | invalid_archive | The ZIP archive can't be read or holds no files. | Check the archive. |
| 429 | rate_limited | Too many requests. Retry after the number of seconds in the Retry-After header. | Wait the number of seconds in Retry-After, then retry. |
| 500 | internal_error | Something went wrong on our side. Please try again. | Retry later. If it keeps failing, contact support@tabula.de with the requestId. |
| 503 | service_unavailable | The API is temporarily unavailable. Please try again shortly. | Retry with exponential backoff. |