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.

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects an object.

urlstringRequiredformat: "uri"

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