Skip to main content
POST
/
assets
/
agents
Register Agent
curl --request POST \
  --url https://api.example.com/assets/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_card": {
    "name": "<string>",
    "version": "<string>",
    "description": "<string>",
    "url": "<string>",
    "protocolVersion": "<string>",
    "supportedInterfaces": [
      {
        "url": "<string>",
        "protocolVersion": "<string>",
        "protocolBinding": "<string>",
        "transportType": "<string>"
      }
    ],
    "provider": {},
    "capabilities": {},
    "skills": [
      {}
    ],
    "defaultInputModes": [
      "<string>"
    ],
    "defaultOutputModes": [
      "<string>"
    ],
    "securitySchemes": {},
    "security": [
      {}
    ],
    "extensions": [
      {}
    ],
    "signatures": [
      {}
    ]
  },
  "tags": [
    "<string>"
  ],
  "visibility": "TENANT_ONLY"
}
'
{
  "resource_uri": "<string>",
  "name": "<string>",
  "status": "<string>",
  "lifecycle_stage": "<string>",
  "health_status": "<string>",
  "verification_status": "<string>",
  "visibility": "<string>",
  "current_version": 123,
  "agent_card": {},
  "source": "<string>",
  "organization_id": "<string>",
  "project_id": "<string>",
  "owner_id": "<string>",
  "registered_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "updated_by": "<string>",
  "etag": "<string>",
  "description": "<string>",
  "a2a_protocol_version": "<string>",
  "tags": [],
  "deprecation_message": "<string>",
  "deprecation_deadline": "2023-11-07T05:31:56Z",
  "successor_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Project-ID
string | null

Body

application/json

Request body for POST /assets/agents

​
agent_card
AgentCardPayload · object
required

A2A Agent Card JSON — supports both v0.3 and v1.0 formats.

v0.3 cards have a required top-level url and optional supportedInterfaces. v1.0 cards have required supportedInterfaces and no top-level url. The validator ensures at least one transport declaration is present.

​
tags
string[] | null
​
visibility
enum<string> | null
default:TENANT_ONLY
Available options:
PUBLIC,
TENANT_ONLY,
PRIVATE

Response

Successful Response

Full single-resource response.

​
resource_uri
string
required
​
name
string
required
​
status
string
required
​
lifecycle_stage
string
required
​
health_status
string
required
​
verification_status
string
required
​
visibility
string
required
​
current_version
integer
required
​
agent_card
Agent Card · object
required
​
source
string
required
​
organization_id
string
required
​
project_id
string
required
​
owner_id
string
required
deprecated

Deprecated: use created_by instead. Will be removed in a future release.

​
registered_by
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
created_by
string
required
​
updated_by
string
required
​
etag
string
required
​
description
string | null
​
a2a_protocol_version
string | null
​
tags
string[]
​
deprecation_message
string | null
​
deprecation_deadline
string<date-time> | null
​
successor_id
string | null