You are logged in to a frozen account. Most API related features like the Getting started wizard, Template testing, etc. will not work! Please contact support to unfreeze your account.
Assembly Status response
Transloadit uses a single response format for creating and querying Assemblies, appending responses to upload forms, and sending Notifications.
The following is a full example of a Transloadit response. Since files are processed in parallel, the ordering for results does not necessarily follow the same order as uploads. There could also be multiple results for a single upload. To match results with uploads, you can use the original_id field, which is present in both items.
Explanation of fields
Indicates a successful status. If the Assembly encountered an error, the error key below is used instead of this key.
Indicates an error status. This key is only present if the Assembly failed.
A human-readable message explaining the state of this Assembly. This is not always present.
The unique ID of this Assembly. You can store this in a database when an Assembly is created, and use it to match incoming Notifications.
The unique URL used to query the current status of this Assembly.
The unique URL used to query the current status of this Assembly, but ready to be used over SSL/HTTPS. All API requests that are sent to the assembly_url can also be sent to the assembly_ssl_url.
The URL to the Companion server that this Assembly may communicate with.
The URL to a Websocket (uses Socket.IO) server from which you can get realtime status updates of this Assembly.
The URL to the tus server used by this Assembly.
The number of bytes that have been uploaded to this Assembly so far. This is primarily used by clients to display upload progress.
The number of bytes that this Assembly expects to be uploaded.
The total number of bytes that this Assembly processed that count towards your usage bill. The sum of bytes_usage of all of your Assemblies equal your total monthly usage.
The user agent (browser) used by the uploader.
The IP address of the uploader.
The referrer URL of the uploader.
The date and time at which upload started for this Assembly.
The time taken by the uploader to upload files, in seconds.
The time taken by Transloadit to execute this Assembly, in seconds.
A key/value map of any additional fields present in your form, for integrations can not use <form> encapsulation (like Uppy).
An array of files uploaded for this Assembly. For more information, see the metadata docs.
The result files that Transloadit has produced so far. Each key of this object is the name of the Step that produced a particular file. As storage robots do not produce files, their Step names are not included here. In case of an error may contain partial results.