Skip to main content
POST
/
agent
/
update
/
:id
Update Agent
curl --request POST \
  --url https://api.example.com/agent/update/:id

​
Update Agent

Update the configuration of an existing agent.

​
Endpoint

POST /agent/update/:id

​
Authentication

Requires JWT token or Platform API key.

​
Path Parameters

ParameterTypeDescription
idstringAgent UUID

​
Request Body

All fields are optional. Only include fields you want to update.
FieldTypeDescription
namestringNew agent name
descriptionstringNew description
configurationobjectConfiguration updates

​
Example Request

curl -X POST https://api.app.shinzo.ai/agent/update/agt_abc123def456 \
  -H "Authorization: Bearer <jwt_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Updated description",
    "configuration": {
      "timeout_seconds": 3600
    }
  }'

​
Response

{
  "uuid": "agt_abc123def456",
  "name": "code-review-agent",
  "description": "Updated description",
  "status": "active",
  "updated_at": "2025-01-20T14:30:00Z",
  "configuration": {
    "timeout_seconds": 3600,
    "memory_config": {
      "type": "hierarchical",
      "max_size_mb": 1024,
      "persistence": "persistent"
    }
  }
}

​
Status Codes

CodeDescription
200Agent updated successfully
400Invalid request
401Invalid authentication
403AI Agents feature not enabled
404Agent not found
409Agent has running tasks (cannot update)

​
Notes

  • Agents with running tasks cannot be updated unless you cancel the tasks first
  • Configuration changes may require the agent to restart