Skip to main content
GET
/
.well-known
/
agent.json
GET /.well-known/agent.json
curl --request GET \
  --url https://api.example.com/.well-known/agent.json \
  --header 'Authorization: Bearer <token>'

​
GET /.well-known/agent.json

Retrieve the agent card containing metadata about the agent for A2A protocol discovery.

​
Endpoint

GET /.well-known/agent.json

​
Description

This endpoint returns the agent card, a JSON document that describes the agent’s capabilities, supported protocols, and metadata. It follows the A2A (Agent-to-Agent) protocol specification for agent discovery.

​
Request

No request body or parameters required.

​
Headers

HeaderValueRequired
Acceptapplication/jsonOptional

​
Response

​
Success Response (200 OK)

{
  "name": "Assistant",
  "description": "A helpful AI assistant",
  "url": "http://localhost:8000",
  "version": "1.0.0",
  "capabilities": {
    "streaming": true,
    "pushNotifications": false,
    "stateTransitionHistory": false
  },
  "defaultInputModes": ["text"],
  "defaultOutputModes": ["text"],
  "skills": [
    {
      "id": "general-assistant",
      "name": "General Assistant",
      "description": "General purpose assistance"
    }
  ]
}

​
Response Fields

FieldTypeDescription
namestringAgent name
descriptionstringAgent description
urlstringBase URL for the agent
versionstringAgent version
capabilitiesobjectSupported capabilities
defaultInputModesarraySupported input modes
defaultOutputModesarraySupported output modes
skillsarrayList of agent skills

​
Example

​
cURL

curl -X GET http://localhost:8000/.well-known/agent.json \
  -H "Accept: application/json"

​
Python

import requests

response = requests.get("http://localhost:8000/.well-known/agent.json")
agent_card = response.json()
print(agent_card["name"])

​
JavaScript

const response = await fetch("http://localhost:8000/.well-known/agent.json");
const agentCard = await response.json();
console.log(agentCard.name);

​
Error Responses

StatusDescription
404Agent card not configured
500Internal server error

​
See Also