Skip to main content
GET
/
agents
/
{id}
/
agent-card.json
Javascript SDK (Beta)
import { CortiEnvironment, CortiClient } from "@corti/sdk";

const client = new CortiClient({
    environment: CortiEnvironment.Eu,
    auth: {
        clientId: "YOUR_CLIENT_ID",
        clientSecret: "YOUR_CLIENT_SECRET"
    },
    tenantName: "YOUR_TENANT_NAME"
});
await client.agents.getCard("12345678-90ab-cdef-gh12-34567890abc");
{
  "protocolVersion": "<string>",
  "name": "<string>",
  "description": "<string>",
  "url": "<string>",
  "preferredTransport": "<string>",
  "additionalInterfaces": [
    {
      "url": "<string>",
      "transport": "<string>"
    }
  ],
  "iconUrl": "<string>",
  "documentationUrl": "<string>",
  "provider": {
    "organization": "<string>",
    "url": "<string>"
  },
  "version": "<string>",
  "capabilities": {
    "streaming": true,
    "pushNotifications": true,
    "stateTransitionHistory": true,
    "extensions": [
      {
        "uri": "<string>",
        "description": "<string>",
        "required": true,
        "params": {}
      }
    ]
  },
  "securitySchemes": {},
  "security": {},
  "defaultInputModes": [
    "<string>"
  ],
  "defaultOutputModes": [
    "<string>"
  ],
  "skills": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "tags": [
        "<string>"
      ],
      "examples": [
        {
          "role": "user",
          "parts": [
            {
              "kind": "text",
              "text": "<string>",
              "metadata": {}
            }
          ],
          "metadata": {},
          "extensions": [
            "<string>"
          ],
          "referenceTaskIds": [
            "<string>"
          ],
          "messageId": "<string>",
          "taskId": "<string>",
          "contextId": "<string>",
          "kind": "message"
        }
      ],
      "inputModes": [
        "<string>"
      ],
      "outputModes": [
        "<string>"
      ],
      "security": {}
    }
  ],
  "supportsAuthenticatedExtendedCard": true,
  "signatures": [
    {
      "protected": "<string>",
      "signature": "<string>",
      "header": {}
    }
  ]
}

Headers

​
Tenant-Name
string
required

Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.

Example:

"copiloteu"

Path Parameters

​
id
string
required

The identifier of the agent associated with the context.

Example:

"12345678-90ab-cdef-gh12-34567890abc"

Response

Agent card retrieved successfully.

​
protocolVersion
string
required

The version of the A2A protocol this agents supports.

​
name
string
required

The name of the agent.

​
description
string
required

A human readable description of the agent.

​
url
string
required

The URL where the agent can be reached to process messages.

​
version
string
required

The version of the agent.

​
capabilities
object
required
​
defaultInputModes
string[]
required

Default set of supported input MIME types for all skills, which can be overridden on a per-skill basis.

​
defaultOutputModes
string[]
required

Default set of supported output MIME types for all skills, which can be overridden on a per-skill basis.

​
skills
object[]
required

The set of skills, or distinct capabilities, that the agent can perform.

​
preferredTransport
string | null
​
additionalInterfaces
object[] | null

A list of additional transport protocols and URL combinations the agent supports.

​
iconUrl
string | null

A URL to an icon representing the agent.

​
documentationUrl
string | null

A URL to documentation describing how to interact with the agent.

​
provider
object
​
securitySchemes
object | null

A declaration of the security schemes available to authorize requests. The key is the scheme name. Follows the OpenAPI 3.0 Security Scheme Object.

​
security
object | null

A list of security requirement objects that apply to all agent interactions. Each object lists security schemes that can be used. Follows the OpenAPI 3.0 Security Requirement Object. This list can be seen as an OR of ANDs. Each object in the list describes one possible set of security requirements that must be present on a request. This allows specifying, for example, "callers must either use OAuth OR an API Key AND mTLS."

​
supportsAuthenticatedExtendedCard
boolean | null

Indicates whether the agent supports returning an extended agent card when called with authentication.

​
signatures
object[] | null

JSON Web Signatures computed for this AgentCard.