Agents

Update agent details

Updates agent name, description, and metadata. Also updates the agent's APort passport. At least one of name, description, or meta must be provided.

patch/v0.2.4/agents/update

Request

Base URL
https://api.chimoney.io
Auth
API key in header X-API-KEY
TypeScript
https://skmtc.dev/chimoney/apis/chimoney-api-docs/docs/v0.2.4/agents/update/patch.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

Agent UID

subAccountstring

Sub-account identifier

namestring

New agent name

descriptionstring

New agent description

metaobject

Additional metadata to update

{
  "name": "UpdatedBot",
  "description": "Updated AI Agent for processing payments"
}

Agent updated successfully

statusstring

dataobject

Updated agent details

{
  "status": "success"
}

No recorded changes to this operation across all 1 revision of this API.