Sign in

v3

latestOpenAPI 3.0.02026-08-081996601.2 MB
A2A Protocol

Get A2A agent card (well-known)

Returns the A2A v0.3 Agent Card for the specified agent at the canonical .well-known/agent-card.json discovery URL. Standard A2A clients fetch this URL, then use the card's url and preferredTransport to drive subsequent calls.

get/v2/agents/{agent_key}/.well-known/agent-card.json

Path parameters

agent_keystring required

A unique key that identifies an agent.

Example:customer_support

The unique key of the agent.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

The A2A v0.3 Agent Card describing this agent.

protocolVersionstring

The version of the A2A protocol this agent supports (e.g. 0.3.0).

namestring required

Human-readable name of the agent.

descriptionstring required

Human-readable description of the agent.

urlstring required

URL of the agent's preferred RPC endpoint.

preferredTransportstring nullable

Transport of the preferred endpoint. If empty, defaults to JSONRPC.

versionstring required

Version string of the agent implementation.

documentationUrlstring nullable

URL of the agent's documentation.

securitySchemesobject nullable

Security schemes the agent supports, keyed by scheme name.

securityobject[] nullable

Security requirements for the agent. Each entry maps scheme names to scope lists. Entries are alternatives. All schemes in one entry apply together.

defaultInputModesstring[] required

Default media types the agent accepts as input across all skills.

defaultOutputModesstring[] required

Default media types the agent produces as output across all skills.

supportsAuthenticatedExtendedCardboolean

True if the agent serves an extended card requiring authentication.