Cloud and BYOC for Orca Agent Engine are in Private Preview — request an invite
Docs
Agents

Agents.update

POST/v1/agents/{id}
x-api-key<token>

Workspace API key. Read from the x-api-key header by src/auth/api-key.ts. A key that is present and does not authenticate is final — no other scheme is consulted.

In: header

Path Parameters

id*string
Match^(?:agt|agent)_[A-Za-z0-9_-]+$

Header Parameters

idempotency-key?string
anthropic-beta?string

Accepted for Anthropic SDK compatibility and ignored. No value of this header changes request handling. Typed as a free-form string rather than an enum because this service recognises no specific beta value.

Request Body

application/json

Body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/agents/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "type": "agent",  "name": "string",  "description": "string",  "version": 1,  "model": {    "id": "string",    "speed": "standard",    "effort": {      "type": "low"    }  },  "system": "string",  "tools": [    {      "type": "agent_toolset",      "default_config": {        "enabled": true,        "permission_policy": {          "type": "always_allow"        }      },      "configs": [        {          "enabled": true,          "permission_policy": {            "type": "always_allow"          },          "name": "string"        }      ]    }  ],  "mcp_servers": [    {      "name": "string",      "type": "url",      "url": "http://example.com"    }  ],  "skills": [    {      "type": "anthropic",      "skill_id": "string",      "version": "string"    }  ],  "guardrail_ids": [    "string"  ],  "metadata": {    "property1": "string",    "property2": "string"  },  "multiagent": {    "type": "coordinator",    "agents": [      "string"    ]  },  "archived_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}