Skip to main content

Pause & Resume Agent

Control agent execution by pausing and resuming. Paused agents will not accept new tasks but will retain their state and files.

Pause Agent

Pause an active agent.

Endpoint

POST /agent/:id/pause

Authentication

Requires JWT token or Platform API key.

Path Parameters

ParameterTypeDescription
idstringAgent UUID

Example Request

curl -X POST https://api.app.shinzo.ai/agent/agt_abc123def456/pause \
  -H "Authorization: Bearer <jwt_token>"

Response

{
  "uuid": "agt_abc123def456",
  "status": "paused",
  "paused_at": "2025-01-20T14:00:00Z"
}

Status Codes

CodeDescription
200Agent paused successfully
400Agent is already paused
401Invalid authentication
404Agent not found

Resume Agent

Resume a paused agent.

Endpoint

POST /agent/:id/resume

Authentication

Requires JWT token or Platform API key.

Path Parameters

ParameterTypeDescription
idstringAgent UUID

Example Request

curl -X POST https://api.app.shinzo.ai/agent/agt_abc123def456/resume \
  -H "Authorization: Bearer <jwt_token>"

Response

{
  "uuid": "agt_abc123def456",
  "status": "active",
  "resumed_at": "2025-01-20T15:00:00Z"
}

Status Codes

CodeDescription
200Agent resumed successfully
400Agent is not paused
401Invalid authentication
404Agent not found

Notes

  • Pausing an agent does not cancel running tasks
  • Paused agents retain their files and state
  • Resume restores the agent to active status