Workflows — API reference

GET/api/v1/workflows

List the workflow templates a run can be started from

The org's live templates and the platform's system ones, ordered by name unless sort says otherwise (updated_after polls for changed ones). Each param_schema is what params on POST /runs is validated against. A template whose feature the org does not have is not listed; for an OAuth token, a team-private template only for a member of its team.

Scopes: workflows:read

Parameters

updated_afterquery · string (date-time)
Only templates changed strictly after this instant (ISO 8601 with offset), compared to the millisecond — poll with the newest updated_at you have seen (that template does not come back).
sortquery · "name" | "-name" | "updated_at" | "-updated_at"
Sort key; a leading - is descending. Default name. Ties break on id.
limitquery · integer
Page size, default 50. Values above 100 are treated as 100.
cursorquery · string
next_cursor from the previous page, with the other parameters unchanged.

Response 200WorkflowList

dataarray of Workflowrequired
- idstring (uuid)required
  The template's current version. Pass it as workflow_id to POST /api/v1/runs.
- namestringrequired
- descriptionstring or nullrequired
- target_asset_typeobject or nullrequired
  The asset type the template was built for (advisory: a run may be started on any asset).
  - idstring (uuid)required
  - namestringrequired
- action_typestring or nullrequired
  The media action the template runs, when it is a one-action template (e.g. transcode, captions); null for a multi-step process.
- param_schemamap of object or nullrequired
  The launch parameters params on POST /api/v1/runs is validated against, keyed by name; null when the template takes none.
- updated_atstring (date-time)required
  When the template (its current version) last changed — poll on it with GET /api/v1/workflows?updated_after=.
next_cursorstring or nullrequired
Pass as cursor to get the next page; null means this is the last page.

Other responses

401 unauthenticated — no key, or an unknown, revoked or expired one.
403 insufficient-scope — the key lacks a required scope.
404 not-found.
422 validation — a bad updated_after, sort, limit or cursor.
429 rate-limited — the key's request budget is spent; wait Retry-After seconds.
500 internal.

GET/api/v1/workflows/{id}

Get one workflow template

Scopes: workflows:read

Parameters

idpath · string (uuid)required
The template's id, from GET /api/v1/workflows (any version's id resolves to the current version).

Response 200Workflow

A workflow template a run can be started from.

idstring (uuid)required
The template's current version. Pass it as workflow_id to POST /api/v1/runs.
namestringrequired
descriptionstring or nullrequired
target_asset_typeobject or nullrequired
The asset type the template was built for (advisory: a run may be started on any asset).
- idstring (uuid)required
- namestringrequired
action_typestring or nullrequired
The media action the template runs, when it is a one-action template (e.g. transcode, captions); null for a multi-step process.
param_schemamap of object or nullrequired
The launch parameters params on POST /api/v1/runs is validated against, keyed by name; null when the template takes none.
updated_atstring (date-time)required
When the template (its current version) last changed — poll on it with GET /api/v1/workflows?updated_after=.

Other responses

401 unauthenticated — no key, or an unknown, revoked or expired one.
403 insufficient-scope — the key lacks a required scope.
404 not-found.
429 rate-limited — the key's request budget is spent; wait Retry-After seconds.
500 internal.