Directives

Trigger a directive run

Changed on

Starts a v1 run for a v1 directive. A directive owned by v0 returns 404.

post/robots/v1/directives/{DIRECTIVE_ID}/runs

Request

  • Base URL
    https://api.mux.com
  • Auth
    • HTTP basic
    • or HTTP bearer

Path parameters

DIRECTIVE_IDstring required

Directive ID returned by directive creation or listing (drv_...).

Request body

asset_idstring required

The bare Mux asset ID to run the directive against, as returned by the Mux Video API.

Example request

{
  "asset_id": "abc123def456"
}

Response

V1 directive run started

Example response

{
  "data": {
    "id": "drvrun_example",
    "directive_id": "drv_example",
    "subject_id": "asset_example",
    "status": "pending",
    "node_states": [],
    "started_at": 1746403300,
    "completed_at": null
  }
}

Changes