Fetch external agent card | Runtype Documentation

curl -X POST https://api.runtype.com/v1/agents/fetch-agent-card \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "url": "https://example.com/.well-known/agent.json"
}'

{
  "authentication": {
    "apiKeyAuth": {
      "headerName": "string"
    },
    "bearerAuth": {
      "scopes": [
        "string"
      ]
    },
    "type": "bearer"
  },
  "capabilities": {
    "pushNotifications": true,
    "statefulness": "none",
    "streaming": true
  },
  "description": "string",
  "iconUrl": "string",
  "name": "string",
  "protocolVersion": "string",
  "provider": {
    "organization": "string",
    "url": "string"
  },
  "skills": [
    {
      "description": "string",
      "id": "string",
      "inputModes": [
        "string"
      ],
      "inputSchema": {},
      "name": "string",
      "outputModes": [
        "string"
      ]
    }
  ],
  "url": "string",
  "version": "string"
}

Proxy-fetch an external agent card from a URL, avoiding CORS issues. The URL is validated against SSRF attacks. With transport: "device", the card is fetched through the paired local listener deviceId, so the URL must be a loopback address on that machine. Pass bearerToken when the card itself requires one.

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects an object.

urlstringRequiredformat: "uri"

bearerTokenstringOptional1-4096 characters

Sent as Authorization: Bearer on the card request. Never stored or echoed.

deviceIdstringOptional1-128 characters

The paired listener to fetch through. Required when transport is "device".

transportenumOptional

How to reach the card: directly (default) or through a paired local listener

Allowed values:

Response

Agent card JSON

authenticationobjectOptional

capabilitiesobjectOptional

descriptionstringOptional

iconUrlstringOptional

namestringOptional

protocolVersionstringOptional

providerobjectOptional

skillslist of objectsOptional

urlstringOptional

versionstringOptional

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

502

Bad Gateway Error