Automations

View Markdown

Overview

Automations combine tasks into powerful workflows, which can then be triggered by events in your project.

For example, you can create an automation that runs whenever a new video is uploaded to your project, to automatically create a thumbnail, subtitles, and description.


Automation Objects

automation.json
{
  "id": "auto_abcdefgh1234",
  "object": "automation",
  "name": "My Automation Example",
  "description": "This workflow will run whenever new media is created.",
  "trigger": {
    "kind": "event",
    "event": "media.created"
  },
  "workflow": [
    {
      "kind": "description",
    },
    {
      "kind": "image",
      "width": 320,
      "format": "png",
      "ref": "thumbnail"
    },
    {
      "kind": "conditions",
      "conditions": [{ 
        "prop": "kind", 
        "value": "video" 
      }],
      "next": [
        {
          "kind": "subtitle",
          "ref": "subtitle"
        }
      ]
    }
  ],
  "created": "2025-01-01T01:23:45Z",
  "updated": "2025-01-01T01:23:45Z",
  "status": "active"
}

See Automations for detailed coverage of all available props and values.


Endpoints

You can use the /automations and /automations/{id} endpoints to manage your automations.

GET

List Automations

POST

Create Automation

GET

Get Automation

PUT

Update Automation

DELETE

Delete Automation

On this page