Steer a running playbook

POST

/spaces/:spaceId/playbook-runs/:runId/steer

Injects a free-text steering message into a running playbook to nudge the agent mid-run. Authorization: space:contribute (org admins bypass); missing → 403. Body: message (required, 1–4000 chars). Returns 200 { data } with the run’s updated status.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

spaceIdstringRequired

runIdstringRequired

Request

This endpoint expects an object.

messagestringRequired1-4000 characters

Response

The run state after steering.

dataobject

$	curl -X POST https://api.cloudraker.com/spaces/spaceId/playbook-runs/runId/steer \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"message": "Please prioritize the security audit task and update the compliance checklist accordingly."
>	}'

1	{
2	"data": {
3	"status": "running",
4	"taskProgress": {
5	"total": 5,
6	"completed": 3
7	},
8	"pendingApproval": {
9	"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
10	"kind": "pre",
11	"actionName": "Security Audit Review",
12	"requestedAt": "2024-01-15T09:30:00Z"
13	},
14	"currentActivity": "Reviewing compliance documentation",
15	"result": "No issues detected so far",
16	"error": ""
17	}
18	}