Response codes

The following lists the response codes returned by Transloadit, which you can use to handle errors.

An Assembly is running if ok is either ASSEMBLY_UPLOADING or ASSEMBLY_EXECUTING. All other states mean the Assembly has completed. If it completed in error, the error property will be set. More details on ok and error codes can be found below.

OK codes

OK codes are always returned via ok key, like this: { ok: "{OK_CODE}" }.

• ASSEMBLY_CANCELED
  The Assembly was canceled.
• ASSEMBLY_COMPLETED
  The Assembly was completed successfully.
• ASSEMBLY_EXECUTING
  The Assembly is currently being executed.
• ASSEMBLY_NOTIFICATION_REPLAYED
  The Assembly Notification was replayed.
• ASSEMBLY_REPLAYING
  The Assembly is being replayed.
• ASSEMBLY_UPLOADING
  The Assembly is still in the process of being uploaded.
• REQUEST_ABORTED
  The upload connection was closed or timed out before receiving all data.

Error codes

Error codes are always returned via the error key, like this: { error: "{ERROR_CODE}" }.

• ACTIVE_ASSEMBLIES_FETCHED
  Number of active Assemblies fetched.
• ADMIN_PERMISSIONS_REQUIRED
  You require admin permissions to do this.
• ASSEMBLIES_UPDATED
  The Assemblies have been updated.
• ASSEMBLY_ACCOUNT_MISMATCH
  You are not allowed to access this Assembly because it is not yours.
• ASSEMBLY_CANNOT_BE_REPLAYED
  The Assembly cannot be replayed.
• ASSEMBLY_COULD_NOT_BE_CREATED
  The Assembly could not be created.
• ASSEMBLY_CRASHED
  The process managing this Assembly crashed and could not be restored.
• ASSEMBLY_DISALLOWED_ROBOTS_USED
  Your Assembly uses one or more disallowed Robots.
• ASSEMBLY_EMPTY_STEPS
  Your Assembly {steps: ...} parameter is empty.
• ASSEMBLY_EXECUTION_PROGRESS_NOT_ENABLED
  For this Assembly, retrieving execution progress has not been enabled.
• ASSEMBLY_EXPIRED
  The Assembly expired.
• ASSEMBLY_FILE_ACCEPTED
  The Assembly accepted the added file.
• ASSEMBLY_FILE_NOT_RESERVED
  A place for this file must be reserved before adding it.
• ASSEMBLY_FILE_RESERVED
  The Assembly reserved a space for this file.
• ASSEMBLY_INFINITE
  Your Assembly appears to be infinite, the "use" parameters form a loop.
• ASSEMBLY_INVALID_NOTIFY_URL
  The Assembly had a malformed notify_url. They must be strings.
• ASSEMBLY_INVALID_NUM_EXPECTED_UPLOAD_FILES_PARAM
  Your 'num_expected_upload_files' parameter value is invalid. It must be a number greater than or equal zero.
• ASSEMBLY_INVALID_STEPS
  Your Assembly {steps: ...} is a non-object value.
• ASSEMBLY_JOB_ENQUEUE_ERROR
  There was a problem enqueuing a job for your Assembly. Please reach out to support.
• ASSEMBLY_LIST_ERROR
  Bad parameters
• ASSEMBLY_MEMORY_LIMIT_EXCEEDED
  The Assembly memory limit of 8MB was exceeded. Please try to import less files and/or upload a zip file with less files.
• ASSEMBLY_NOTIFICATIONS_LIST_ERROR
  The Assembly notifications could not be listed.
• ASSEMBLY_NOTIFICATION_LIST_ERROR
  Bad parameters
• ASSEMBLY_NOTIFICATION_NOT_PERSISTED
  There was a problem saving the Assembly notification. Please get in touch with support.
• ASSEMBLY_NOTIFICATION_NOT_REPLAYED
  The Assembly notification could not be replayed.
• ASSEMBLY_NOT_CAPABLE
  This Assembly is not capable of handling the requested endpoint.
• ASSEMBLY_NOT_FINISHED
  The Assembly is not finished yet and thus cannot be replayed yet.
• ASSEMBLY_NOT_FOUND
  The Assembly you requested crashed or does not exist.
• ASSEMBLY_NOT_REPLAYED
  The Assembly could not be replayed
• ASSEMBLY_NO_CHARGEABLE_STEP
  An Assembly must have at least one transcoding or Step.
• ASSEMBLY_NO_NOTIFY_URL
  The Assembly had not configured any notify_url.
• ASSEMBLY_NO_STEPS
  Your Assembly does not include a {steps: ...} parameter.
• ASSEMBLY_PROGRESS_UPDATED
  The Assembly's upload progress has been updated.
• ASSEMBLY_ROBOT_MISSING
  This Assembly must make use of specific robots as per the contract.
• ASSEMBLY_SATURATED
  This Assembly has already received all expected file uploads.
• ASSEMBLY_STATS_INVALID_TIME
  since time is missing or incorrect
• ASSEMBLY_STATS_MISSING_REGION
  Must provide a specific region, or "all"
• ASSEMBLY_STATUS_FETCHING_RATE_LIMIT_REACHED
  You are fetching status for the same Assembly too often. Please slow down.
• ASSEMBLY_STATUS_NOT_FOUND
  The status for the Assembly you requested could not be found.
• ASSEMBLY_STATUS_PARSE_ERROR
  There was a problem parsing the status json of the Assembly.
• ASSEMBLY_STEP_INVALID
  One of your {steps: ...} parameters is a non-object value.
• ASSEMBLY_STEP_INVALID_ROBOT
  One of your step parameters includes an non-string {robot: ...} value.
• ASSEMBLY_STEP_INVALID_USE
  One of your step parameters either includes a non-array {use: ...} value or the members of the "use" array are not strings or objects. If they are objects, they must contain a "name" property.
• ASSEMBLY_STEP_NO_ROBOT
  One of your step parameters did not include a {robot: ...} key.
• ASSEMBLY_STEP_UNKNOWN_ROBOT
  One of your step parameters is referencing an unknown {robot: ...}.
• ASSEMBLY_STEP_UNKNOWN_USE
  One of your step parameters references an unknown {use: ...} value.
• ASSEMBLY_URL_TRANSFORM_MISSING
  This Assembly must use the UrlTransform feature as per the contract.
• AUTH_EXPIRED
  The given auth expires parameter is in the past.
• AUTH_KEYS_FOUND
  Your auth keys were successfully found.
• AUTH_KEYS_NOT_FOUND
  Your auth keys could not be found.
• AUTH_KEY_CREATED
  Your Auth Key was successfully created.
• AUTH_KEY_DELETED
  Your Auth Key was successfully deleted.
• AUTH_KEY_NOT_CREATED
  Your Auth Key could not be created.
• AUTH_KEY_NOT_DELETED
  Your Auth Key could not be deleted.
• AUTH_KEY_NOT_UPDATED
  Your Auth Key could not be updated.
• AUTH_KEY_SCOPES_FOUND
  The Auth Key scopes were successfully found.
• AUTH_KEY_SCOPES_NOT_FOUND
  The Auth Key scopes could not be found.
• AUTH_KEY_UPDATED
  Your Auth Key was successfully updated.
• AUTH_SECRET_NOT_RETRIEVED
  Your auth secret could not be shown.
• AUTH_SECRET_RETRIEVED
  Your auth secret could be retrieved.
• BAD_PRICING
  Something is wrong with the pricing record attached to your workspace, please contact support.
• BILL_LIMIT_EXCEEDED
  The bill limit that was configured for this workspace is exceeded this month.
• CANNOT_ACCEPT_NEW_ASSEMBLIES
  The uploader is not accepting new Assemblies.
• CANNOT_FETCH_ACTIVE_ASSEMBLIES
  Got an error fetching the number of active Assemblies.
• CDN_REQUIRED
  We recommend URL Transform is only used in combination with a CDN to cache results. Otherwise each hit is transcoded which may ramp up bills fast for popular pages. That's why you should (have your CDN) set the query parameter or header key: 'cdn' with the value: 'required'.
• COMPANION_BASIC_AUTH_UNSET
  Unable to validate Basic Auth credentials
• COMPANION_CREDENTIALS_REQUEST_INVALID
  Companion credentials request contains invalid data
• COMPANION_OSS_SUPPORT_PING_REQUEST_INVALID
  Companion OSS support ping request contains invalid data
• DO_NOT_REUSE_ASSEMBLY_IDS
  Do not reuse Assembly IDs.
• FILE_DOWNLOAD_ERROR
  Transloadit was unable to download an external file.
• FILE_META_DATA_ERROR
  There was a problem extracting meta data information from your file.
• FILE_SERVE_NO_RESULT
  The /file/serve Step has no result to serve. Possibly your Instructions do not support the input file type.
• GET_ACCOUNT_DB_ERROR
  Could not get workspace, there was a database error.
• GET_ACCOUNT_UNKNOWN_AUTH_KEY
  Could not get workspace, this is an unknown Auth Key.
• GRAFANA_WEBHOOK_ERROR
  Grafana webhook error
• GRAFANA_WEBHOOK_WRITE_ERROR
  Grafana webhook write error
• IMPORT_FILE_ERROR
  Transloadit was unable to import a file.
• INCOMPLETE_PRICING
  Something is wrong with the pricing record attached to your workspace, please contact support.
• INSUFFICIENT_AUTH_SCOPE
  The Auth Key you used for the operation does not have the required scope.
• INTERNAL_COMMAND_ERROR
  One of our commands reported an error.
• INTERNAL_COMMAND_TIMEOUT
  One of our commands timed out.
• INVALID_ASSEMBLY_STATUS
  This is an invalid Assembly status.
• INVALID_AUTH_EXPIRES_PARAMETER
  Invalid auth expires parameter provided - we could not parse it.
• INVALID_AUTH_KEY_PARAMETER
  Invalid Auth Key parameter provided - the value is not a string.
• INVALID_AUTH_MAX_SIZE_PARAMETER
  Invalid auth referer parameter provided, could not parse it.
• INVALID_AUTH_REFERER_PARAMETER
  Invalid auth referer parameter given, could not parse it.
• INVALID_FILE_META_DATA
  We could not parse the meta data for the file #file#.
• INVALID_FORM_DATA
  The form contained bad data, which cannot be parsed.
• INVALID_INPUT_ERROR
  The files could not be processed, the provided file format is not supported by this Robot.
• INVALID_PARAMS_FIELD
  Bad params field provided, it contains invalid json.
• INVALID_SIGNATURE
  The given signature does not match ours. Maybe your Auth Key demands to use sha384 instead of sha1?
• INVALID_STEP_NAME
  You must not name a step ":original" that is not using the /upload/handle Robot. This will lead to bad job spawning like duped jobs or infinite Assemblies.
• INVALID_TEMPLATE_FIELD
  Bad Template field provided, it contains invalid json.
• INVALID_UPLOAD_HANDLE_STEP_NAME
  When using the /upload/handle robot, its step name must be ":original".
• MAX_SIZE_EXCEEDED
  The uploaded file exceeded the file size limit.
• NO_AUTH_EXPIRES_PARAMETER
  No auth expires parameter was provided.
• NO_AUTH_KEY_PARAMETER
  No Auth Key parameter provided.
• NO_AUTH_PARAMETER
  No auth parameter provided.
• NO_COUNTRY
  Your workspace has no country record attached to it, please contact support or update your workspace information.
• NO_OBJECT_AUTH_PARAMETER
  Bad auth parameter provided, it is not an object.
• NO_OBJECT_PARAMS_FIELD
  Bad params field provided, it is not an object.
• NO_PARAMS_FIELD
  No params field provided.
• NO_PRICING
  Your workspace has no pricing record attached to it, please contact support.
• NO_RESULT_STEP_FOUND
  Invalid or no result Step defined, which is mandatory for URL Transform Assemblies.
• NO_RPC_RESULT_FROM_IMAGE_RESIZER
  No rpc result from image-resizer
• NO_SIGNATURE_FIELD
  No signature field was provided.
• NO_TEMPLATE_ID
  This workspace demands that a Template ID is provided. None was provided, though.
• PLAN_LIMIT_EXCEEDED
  You have exceeded the usage limit of your Transloadit plan. Please upgrade your plan to make this error message go away, or get in touch with support.
• POSSIBLY_MALICIOUS_FILE_FOUND
  One of your files is possibly malicious and cannot be processed.
• PRIORITY_JOB_SLOTS_FOUND
  Your priority job slots were successfully found.
• PRIORITY_JOB_SLOTS_NOT_FOUND
  Your priority job slots could not be found.
• QUEUES_LIST_ERROR
  There was an error fetching the queue stats
• QUEUE_ACTORS_ERROR
  Fetching or resetting the queue actors failed
• RATE_LIMIT_REACHED
  Request limit reached
• REFERER_MISMATCH
  This request comes from a location that is not allowed.
• REQUEST_PREMATURE_CLOSED
  The original request was closed prematurely.
• SERVER_401
  Authorization required
• SERVER_403
  Forbidden
• SERVER_404
  Unknown method / url
• SERVER_500
  Unexpected error
• SIGNATURE_REUSE_DETECTED
  The request was denied for security reasons. If you think this is in error, please get in touch with support.
• SYNC_ERROR
  Database failed to sync
• TEMPLATE_CREATED
  Your Template was successfully created.
• TEMPLATE_CREDENTIALS_CREATED
  Your Template Credentials were successfully created.
• TEMPLATE_CREDENTIALS_DELETED
  Your Template Credentials were successfully deleted.
• TEMPLATE_CREDENTIALS_FOUND
  Your Template Credentials were successfully found.
• TEMPLATE_CREDENTIALS_INJECTION_ERROR
  Your Template Credentials could not be injected.
• TEMPLATE_CREDENTIALS_NOT_CREATED
  Your Template Credentials could not be created.
• TEMPLATE_CREDENTIALS_NOT_DELETED
  Your Template Credentials could not be deleted.
• TEMPLATE_CREDENTIALS_NOT_FOUND
  Your Template Credentials could not be found.
• TEMPLATE_CREDENTIALS_NOT_READ
  Your Template Credentials could not be read.
• TEMPLATE_CREDENTIALS_NOT_UPDATED
  Your Template Credentials could not be updated.
• TEMPLATE_CREDENTIALS_READ
  Your Template Credentials were successfully read.
• TEMPLATE_CREDENTIALS_TYPES_FOUND
  The Template Credentials types were successfully found.
• TEMPLATE_CREDENTIALS_TYPES_NOT_FOUND
  The Template Credentials types could not be found.
• TEMPLATE_CREDENTIALS_UPDATED
  Your Template Credentials were successfully updated.
• TEMPLATE_DB_ERROR
  The Template for this request could not be fetched due to a db error.
• TEMPLATE_DELETED
  Your Template was successfully deleted.
• TEMPLATE_DENIES_STEPS_OVERRIDE
  This Template had the allow_steps_override option set to false, so clients are not allowed to temper with its steps.
• TEMPLATE_FOUND
  Your Template was successfully found.
• TEMPLATE_INVALID_JSON
  Your Template contained invalid JSON.
• TEMPLATE_LIST_ERROR
  Bad parameters
• TEMPLATE_NOT_FOUND
  There was no Template found for the given template_id and workspace.
• TEMPLATE_UPDATED
  Your Template was successfully updated.
• TEMPLATE_VALIDATION_ERROR
  Your Template didn't pass validation.
• TMP_FILE_DOWNLOAD_ERROR
  Transloadit was unable to download a file from our temporary location.
• USER_COMMAND_ERROR
  An invalid file or setting caused a command to fail.
• VERIFIED_EMAIL_REQUIRED
  You need to first verify your email address before you can do this.
• WORKER_JOB_ERROR
  Transloadit was unable to process this Assembly.