Skip to main content
PATCH
/
agents
/
{agentId}
Update agent
curl --request PATCH \
  --url https://api.natural.co/agents/{agentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "data": {
    "attributes": {
      "name": "Carrier Payment Agent v3.0",
      "description": "Autonomous agent that pays delivery carriers with enhanced fraud detection"
    }
  }
}
'
{
  "data": {
    "type": "agent",
    "id": "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
    "attributes": {
      "name": "Carrier Payment Agent v2.1",
      "description": "Autonomous agent that pays delivery carriers",
      "handle": "@natural/carrier-payments",
      "status": "ACTIVE",
      "limits": {
        "perTransaction": 100000
      },
      "createdAt": "2026-01-04T15:30:00Z",
      "createdBy": "usr_550e8400e29b41d4a716446655440000"
    },
    "relationships": {
      "party": {
        "data": {
          "type": "party",
          "id": "pty_7c9e6679e29b41d4a716446655440001"
        }
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string
required

Unique key for idempotent request handling. If a request with the same key was already processed, the original response is returned.

​
X-Agent-ID
string | null

Agent ID (agt_xxx) identifying which agent is making the request.

​
X-Instance-ID
string | null

Required when X-Agent-ID is present. Session or conversation ID for agent observability.

Maximum string length: 1024

Path Parameters

​
agentId
string
required

Agent ID

Pattern: ^agt_[0-9a-f]{32}$

Body

application/json
​
data
object
required

Resource object

Response

Successful Response

​
data
AgentResource · object
required