Skip to main content
POST
/
v1
/
agent
/
{id}
/
pause
Pause Agent
curl --request POST \
  --url https://api.app.shinzo.ai/v1/agent/{id}/pause \
  --header 'Authorization: Bearer <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.shinzo.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

Requires JWT token or Platform API key via Authorization: Bearer <token> header.
​
id
string
required
Agent UUID

​
Example Request

curl -X POST https://api.app.shinzo.ai/v1/agent/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pause \
  -H "Authorization: Bearer <token>"

​
Example Response

{
  "message": "Agent paused successfully"
}
Pausing an agent does not cancel any active tasks that are already in progress. Those tasks will complete normally. The agent simply stops accepting new messages until you resume it.

​
Status Codes

CodeDescription
200Agent paused successfully
400Agent is already paused
401Unauthorized - invalid or missing authentication
404Agent not found