Transloadit

App · 13 actions

Start file processing assemblies and read their results, templates and workspace usage.

Actions

ActionWhat it does
Cancel an assemblyStop a running assembly.
Create an assemblyStart a file processing assembly from an existing template or your own processing steps.
Get a templateRead the settings and processing steps in a selected template.
Get assembly statisticsRead assembly statistics for the connected workspace.
Get assembly statusRead the status, uploads and results of a selected assembly.
Get job slot usageRead job slot usage for the connected workspace.
Get priority job slot statisticsRead priority job slot statistics for the connected workspace.
List assembliesRead one page of file processing assemblies.
List assembly notificationsRead webhook delivery attempts for an assembly.
List template credential typesRead template credential types for the connected workspace.
List template scheduled runsRead run history for a scheduled template.
List templatesRead one page of file processing templates.
Replay an assemblyRun an existing assembly again.

Cancel an assembly

Stop a running assembly.

Inputs

Assemblyassembly_idtextRequired
Assembly id.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "assembly_id": "example",
    "assembly_ssl_url": "example",
    "ok": "example",
    "results": {},
    "uploads": []
  }
}

Create an assembly

Start a file processing assembly from an existing template or your own processing steps.

Inputs

Templatetemplate_idtext
Template id.
Stepsstepsobject
Steps.
Fieldsfieldsobject
Fields.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "assembly_id": "example",
    "assembly_ssl_url": "example",
    "ok": "example",
    "results": {},
    "uploads": []
  }
}

Get a template

Read the settings and processing steps in a selected template.

Inputs

Templatetemplate_idtextRequired
Template id.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "assembly_status_expiry": "example",
    "cron_auth_key_id": "example",
    "cron_enabled": false,
    "cron_max_concurrent_runs": 1,
    "cron_region": "ap-southeast-1",
    "cron_schedule_with_seconds": "example",
    "id": "example",
    "message": "example",
    "name": "example",
    "ok": "example",
    "require_signature_auth": 0,
    "transcoding_result_expiry": "example"
  }
}

Get assembly statistics

Read assembly statistics for the connected workspace.

Inputs

None.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "errorStats": [],
    "errorStatsGranularity": 1,
    "errorStatsTotals": [],
    "granularity": 1,
    "ok": "example",
    "stats": [],
    "totalAssemblies": 1,
    "totalBytesProcessed": 1,
    "totalBytesUploaded": 1,
    "totalExecutionDuration": 1.0,
    "totalFilesProcessed": 1,
    "totalLiveQueueDuration": 1.0,
    "totalOutputBytesProcessed": 1,
    "totalOutputFilesProcessed": 1,
    "totalUploadDuration": 1.0,
    "totalUsage": 1
  }
}

Get assembly status

Read the status, uploads and results of a selected assembly.

Inputs

Assemblyassembly_idtextRequired
Assembly id.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "assembly_id": "example",
    "assembly_ssl_url": "example",
    "ok": "example",
    "results": {},
    "uploads": []
  }
}

Get job slot usage

Read job slot usage for the connected workspace.

Inputs

None.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "message": "example",
    "ok": "example",
    "priority_job_slots": {
      "count": 1,
      "slots": {}
    }
  }
}

Get priority job slot statistics

Read priority job slot statistics for the connected workspace.

Inputs

None.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "aggregation": "avg",
    "avgSlotCount": 1.0,
    "granularity": 1,
    "maxSlotCount": 1,
    "ok": "example",
    "stats": []
  }
}

List assemblies

Read one page of file processing assemblies.

Inputs

Pagepagenumber
Page.At least 1.
Page sizepage_sizenumber
Page size.From 1 to 100.
Start timestart_timedate and time
Start time.
End timeend_timedate and time
End time.
Templatetemplate_idtext
Template id.
Orderordertext
Order.One of: asc, desc.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "count": 1,
    "items": []
  }
}

List assembly notifications

Read webhook delivery attempts for an assembly.

Inputs

Assemblyassembly_idtextRequired
Assembly id.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "notifications": [],
    "ok": "example"
  }
}

List template credential types

Read template credential types for the connected workspace.

Inputs

None.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "message": "example",
    "ok": "example",
    "types": {}
  }
}

List template scheduled runs

Read run history for a scheduled template.

Inputs

Templatetemplate_idtextRequired
Template id.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "cron_disabled_reason": "auth_key_unavailable",
    "message": "example",
    "next_before": "example",
    "ok": "example",
    "runs": [],
    "template_id": "example"
  }
}

List templates

Read one page of file processing templates.

Inputs

Pagepagenumber
Page.At least 1.
Page sizepage_sizenumber
Page size.From 1 to 100.
Start timestart_timedate and time
Start time.
End timeend_timedate and time
End time.
Keywordskeywordstext
Keywords.
Include builtininclude_builtintext
Include builtin.One of: none, latest, all, exclusively-latest, exclusively-all.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "count": 1,
    "items": []
  }
}

Replay an assembly

Run an existing assembly again. Uses processing credits.

Inputs

Assemblyassembly_idtextRequired
Assembly id.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "assembly_id": "example",
    "assembly_ssl_url": "example",
    "ok": "example",
    "results": {},
    "uploads": []
  }
}

On this page