Run commands
POST/v1/outputs/{id}/commands
Send an API key as a bearer token.
Runs a batch of commands on an output, in order. They all run under one revision, and all or nothing: if one can't run, nothing changes on air.
Path parameters
idstringRequired
The output's id. It's the last part of the output's browser source URL.
Body
commandsCommand[]Required
Response
revisioninteger
The output's revision after the batch. It goes up with every change, so you can tell which state came after which.
Errors
| Status | Code | When |
|---|---|---|
| 400 | invalid_request | A command isn't one of the shapes above, or the batch is empty or over 100. |
| 403 | forbidden | The key doesn't control this output. |
| 404 | not_found | No such output. |
| 422 | command_failed | A command couldn't run. index says which. Nothing changed. |
| 429 | rate_limited | Too many batches from this key. Retry after Retry-After seconds. |