Skip to content

Pause agent

POST
/api/v1/agents/{role}/pause

Set an agent’s status to paused, halting autonomous execution.

Authorizations

Parameters

Path Parameters

role
required

The agent role to pause

string

The agent role to pause

Responses

200

Successful Response

Wrapper response for pause/resume endpoints.

Attributes: data: The status payload.

object
data
required

Status payload returned after pause/resume actions.

Attributes: role: The agent role. status: The new lifecycle status.

object
role
required
string
status
required
string

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string