Skip to main content
POST
AI Simulation needs an active Pro or Business plan. pause and cancel work on any plan, so a run can be stopped after the plan ends; resume needs Pro or Business and otherwise returns 403 POLICY_DENY.
Pause, resume or cancel a run. Calls that already started finish and are charged. Calls still waiting do not start after a cancel. Control works when the plan is not active, so you can always stop spending.

Request

Headers

string
required
Bearer token with your API key (scope agents)

Path

string
required
The simulation run run_id (UUID) from Start a simulation
string
required
pause, resume or cancel. Any other value returns 404

Response

200 OK.

Errors

Example