v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-3089191317.6 KB
a2a

Get Agent Card

get/api/v1/a2a/{provider_id}/.well-known/agent-card.json

Path parameters

provider_idstring uuid required

Response

Successful Response

defaultInputModesstring[] required
defaultOutputModesstring[] required
descriptionstring required
documentationUrlstring nullable
iconUrlstring nullable
namestring required
preferredTransportstring nullable
protocolVersionstring nullable
securityobject[] nullable
securitySchemesobject nullable
supportsAuthenticatedExtendedCardboolean nullable
urlstring required
versionstring required

Example response

{
  "additionalInterfaces": [
    {
      "transport": "JSONRPC",
      "url": "https://api.example.com/a2a/v1"
    }
  ],
  "description": "Agent that helps users with recipes and cooking.",
  "name": "Recipe Agent",
  "preferredTransport": "JSONRPC",
  "security": [
    {
      "oauth": [
        "read"
      ]
    },
    {
      "api-key": [],
      "mtls": []
    }
  ],
  "skills": [
    {
      "examples": [
        "I need a recipe for bread"
      ],
      "security": [
        {
          "google": [
            "oidc"
          ]
        }
      ],
      "tags": [
        "cooking",
        "customer support",
        "billing"
      ]
    }
  ],
  "url": "https://api.example.com/a2a/v1",
  "version": "1.0.0"
}