API endpoints
We offer ready-to-use SDKs for most major programming languages and platforms and generally recommend using those. However, if there is no suitable SDK for your situation, or perhaps you are building one, we explain all the details of our bare bones REST API here.
Transloadit provides a JSON REST API that can be used for:
- Creating, checking up on, or deleting Assemblies
- Replaying Assembly Notifications
- Creating, updating, checking up on, or deleting Templates
- Checking up on Billing
Here’s a complete overview of the available endpoints:
Authentication
- Create a bearer tokenPOST
/token - Create a new Auth KeyPOST
/auth_keys - Retrieve list of Auth KeysGET
/auth_keys - Retrieve Auth Key scopesGET
/auth_keys/scopes - Edit an Auth KeyPUT
/auth_keys/{authKeyId} - Delete an Auth KeyDELETE
/auth_keys/{authKeyId} - Retrieve an Auth Key secretPOST
/auth_keys/show_secret/{authKeyId}
Assemblies
- Create a new AssemblyPOST
/assemblies - Retrieve an Assembly StatusGET
/assemblies/{assemblyId} - Create an Assembly with a supplied IDPUT
/assemblies/{assemblyId} - Stream Assembly changes liveGET
{UPDATE_STREAM_URL} - Cancel a running AssemblyDELETE
/assemblies/{assemblyId} - Replay an AssemblyPOST
/assemblies/{assemblyId}/replay - Retrieve list of AssembliesGET
/assemblies - Retrieve Assembly statisticsGET
/assembly_stats
Webhooks
- Retrieve Assembly NotificationsGET
/assembly_notifications/{assemblyId} - Replay Assembly NotificationPOST
/assembly_notifications/{assemblyId}/replay
Billing
- Retrieve a month’s billGET
/bill/{billYearMonth}
Queues
- Retrieve currently used priority job slotsGET
/queues/job_slots - Retrieve priority job slot statisticsGET
/priority_job_slot_stats
Resumable Uploads
- Discover tus capabilitiesOPTIONS
{TUS_URL} - Create a tus uploadPOST
{TUS_URL} - Retrieve a tus upload offsetHEAD
{UPLOAD_URL} - Upload tus file bytesPATCH
{UPLOAD_URL} - Terminate a tus uploadDELETE
{UPLOAD_URL} - Download a tus uploadGET
{UPLOAD_URL}
Template Credentials
- Create a new Template CredentialPOST
/template_credentials - Retrieve a Template CredentialGET
/template_credentials/{templateCredentialId} - Edit a Template CredentialPUT
/template_credentials/{templateCredentialId} - Delete a Template CredentialDELETE
/template_credentials/{templateCredentialId} - Retrieve list of Template CredentialsGET
/template_credentials - Retrieve Template Credential typesGET
/template_credentials/types
Templates
- Create a new TemplatePOST
/templates - Retrieve a TemplateGET
/templates/{templateIdOrName} - Edit a TemplatePUT
/templates/{templateIdOrName} - Delete a TemplateDELETE
/templates/{templateIdOrName} - Retrieve list of TemplatesGET
/templates - Retrieve Cron Template run history alphaGET
/templates/{templateIdOrName}/cron-runs
Digital Asset Management
- Move or rename a DAM asset alphaPATCH
/dam/assets/{assetId} - Delete a DAM asset alphaDELETE
/dam/assets/{assetId} - Move DAM assets in bulk alphaPOST
/dam/assets/bulk/move - Delete DAM assets in bulk alphaPOST
/dam/assets/bulk/delete - Move a Storage file or folder alphaPOST
/dam/entries/move - Retrieve a Storage assetGET
/dam/assets/{assetId} - List Storage assetsGET
/dam/assets