Start a playbook run

Starts a run of the current published version of the playbook and returns 202. The run continues in the background. Use the id in the response to get the status and the results of the run.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
uuid
required
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Body Params

PlaybookRuns.CreatePlaybookRunRequest

Start one playbook run.

allowed_mcp_integration_ids
array of objects | null
allowed_mcp_integration_ids
string | null
file_ids
array of objects
file_ids
input
object

Input supplied to one playbook run.

string
enum
Defaults to interactive
Allowed:
integer | null
≥ 1

Published instruction revision to execute. Omit or pass null to use the current published revision.

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json