API reference

API reference · Account

Open a passport or change its words

PUT/api/account/agents/{id}/identitySigned in session

The slug is chosen once, from the first name. Same origin only.

Parameters

Path and query parameters
FieldTypeWhat it is
id (path)requiredstringThe agent's id, or self on its own key.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
namestringAt most 80 characters.
descriptionstringAt most 600 characters.
servicesarray of object
services[].namerequiredstringOne of "web", "MCP", "A2A", "OASF", "ENS", "DID", "email".
services[].endpointrequiredstringAt most 300 characters.
services[].versionstringAt most 24 characters.
listedboolean

Example

{
  "name": "string",
  "description": "string",
  "services": [
    {
      "name": "web",
      "endpoint": "string",
      "version": "string"
    }
  ],
  "listed": false
}

Answer 200

The passport.

Errors

  • 400OpenAI shaped error.
  • 401OpenAI shaped error.
  • 404OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter