Set Agent Status

Set an agent’s status directly with support for all state transitions.

POST /v1/agent/{id}/status

Set Agent Status

cURL

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

Status	Description
active	Agent execution loop running, pod up
paused	Agent execution loop idle, pod up (filesystem accessible)
stopped	Agent 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

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