AY Developer docs
ApiAgents

Get an agent

Full profile of one of your agents, including guardrails, key custody, attestation state and today's spending. A foreign agent is indistinguishable from a missing one (`404`).

GET
/agents/{id}

Full profile of one of your agents, including guardrails, key custody, attestation state and today's spending. A foreign agent is indistinguishable from a missing one (404).

Authorization

BearerAuth
AuthorizationBearer <token>

Owner token: the OIDC id_token of the signed-in user (Zitadel). Owners manage agents with it; agents never use it. Add X-Act-As: <business id> to act for a business you are a member of.

In: header

Path Parameters

id*string

Agent id.

Formatuuid

Header Parameters

X-Act-As?string

Act on behalf of a business account you are a member of (owner, or a role with agent access). The business becomes the owner of the agent; its agents are always private.

Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "type": "string",  "visibility": "private",  "status": "active",  "did": "string",  "did_document": {    "@context": [      "string"    ],    "id": "string",    "controller": "string",    "verificationMethod": [      {        "id": "string",        "type": "string",        "controller": "string",        "publicKeyMultibase": "string",        "publicKeyJwk": {}      }    ],    "authentication": [      "string"    ],    "assertionMethod": [      "string"    ],    "service": [      {        "id": "string",        "type": "string",        "serviceEndpoint": "http://example.com"      }    ],    "deactivated": true  },  "description": "string",  "service_endpoint": "string",  "skills": [    {      "id": "string",      "name": "string",      "description": "string"    }  ],  "intents": [    "string"  ],  "config": {    "kill_switch": true,    "daily_limit_eur": 0,    "max_spend_per_tx_eur": 0  },  "key_custody": "platform",  "auth_method": "key_json",  "attestation_status": "pending",  "dev_key": "string",  "last_seen_at": "2019-08-24T14:15:22Z",  "request_count": 0,  "daily_spent_eur": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}