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:

Assemblies

Create a new Assembly
POST/assemblies
Retrieve an Assembly Status
GET/assemblies/{ASSEMBLY_ID}
Stream Assembly changes live
GET{UPDATE_STREAM_URL}
Cancel a running Assembly
DELETE/assemblies/{ASSEMBLY_ID}
Replay an Assembly
POST/assemblies/{ASSEMBLY_ID}/replay
Retrieve list of Assemblies
GET/assemblies?signature={SIGNATURE}&params={PARAMS}

Webhooks

Replay Assembly Notification
POST/assembly_notifications/{ASSEMBLY_ID}/replay

Billing

Retrieve a month’s bill
GET/bill/{DATE}?signature={SIGNATURE}

Queue

Retrieve currently used priority job slots
GET/queues/job_slots?signature={SIGNATURE}

Template Credentials

Create a new Template Credential
POST/template_credentials
Retrieve a Template Credential
GET/template_credentials/{CREDENTIALS_ID_OR_NAME}?signature={SIGNATURE}&params={PARAMS}
Edit a Template Credential
PUT/template_credentials/{CREDENTIALS_ID_OR_NAME}?signature={SIGNATURE}
Delete a Template Credential
DELETE/template_credentials/{CREDENTIALS_ID_OR_NAME}
Retrieve list of Template Credentials
GET/template_credentials?signature={SIGNATURE}&params={PARAMS}

Templates

Create a new Template
POST/templates
Retrieve a Template
GET/templates/{TEMPLATE_ID}?signature={SIGNATURE}&params={PARAMS}
Edit a Template
PUT/templates/{TEMPLATE_ID}
Delete a Template
DELETE/templates/{TEMPLATE_ID}
Retrieve list of Templates
GET/templates?signature={SIGNATURE}&params={PARAMS}