Skip to main content
POST
/
v1
/
agent
/
{id}
/
status
Set Agent Status
curl --request POST \
  --url https://api.app.shinzo.ai/v1/agent/{id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "<string>"
}
'

​
Authentication

Requires JWT token or Platform API key via Authorization: Bearer <token> header.
​
id
string
required
Agent UUID
​
status
string
required
Target status: active, paused, or stopped

​
Example Request

curl -X POST https://api.app.shinzo.ai/v1/agent/a1b2c3d4-e5f6-7890-abcd-ef1234567890/status \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "paused"
  }'

​
Example Response

{
  "message": "Agent status updated successfully",
  "status": "paused"
}

​
Status Values

StatusDescription
activeAgent execution loop running, pod up
pausedAgent execution loop idle, pod up (filesystem accessible)
stoppedAgent pod shut down (workspace preserved)
Use paused to bring a stopped agent’s pod up without starting the execution loop. This gives you filesystem access without the agent processing messages.

​
Status Codes

CodeDescription
200Agent status updated successfully
400Invalid status value
401Unauthorized - invalid or missing authentication
404Agent not found