Inspect agent card

Error

A valid request URL is required to generate request examples

{
  "capabilities": {},
  "signature_count": 123,
  "security_schemes": [
    {
      "name": "<string>",
      "type": "<string>",
      "description": "<string>",
      "in": "<string>",
      "header": "<string>",
      "scheme": "<string>",
      "bearer_format": "<string>",
      "authorization_url": "<string>",
      "token_url": "<string>",
      "scopes": [
        "<string>"
      ]
    }
  ],
  "security_requirements": [
    [
      "<string>"
    ]
  ],
  "card": {
    "supportedInterfaces": [
      {
        "url": "<string>",
        "protocolBinding": "<string>",
        "protocolVersion": "<string>",
        "tenant": "<string>"
      }
    ],
    "capabilities": {
      "extensions": [
        {
          "description": "<string>",
          "params": {},
          "required": true,
          "uri": "<string>"
        }
      ],
      "pushNotifications": true,
      "streaming": true,
      "extendedAgentCard": true
    },
    "defaultInputModes": [
      "<string>"
    ],
    "defaultOutputModes": [
      "<string>"
    ],
    "description": "<string>",
    "name": "<string>",
    "skills": [
      {
        "description": "<string>",
        "id": "<string>",
        "name": "<string>",
        "tags": [
          "<string>"
        ],
        "examples": [
          "<string>"
        ],
        "inputModes": [
          "<string>"
        ],
        "outputModes": [
          "<string>"
        ],
        "securityRequirements": [
          {
            "schemes": {}
          }
        ]
      }
    ],
    "version": "<string>",
    "documentationUrl": "<string>",
    "iconUrl": "<string>",
    "provider": {
      "organization": "<string>",
      "url": "<string>"
    },
    "securityRequirements": [
      {
        "schemes": {}
      }
    ],
    "securitySchemes": {},
    "signatures": [
      {
        "protected": "<string>",
        "signature": "<string>",
        "header": {}
      }
    ]
  },
  "name": "<string>",
  "description": "<string>",
  "version": "<string>",
  "provider": "<string>",
  "provider_url": "<string>",
  "documentation_url": "<string>",
  "icon_url": "<string>",
  "interfaces": [
    {
      "url": "<string>",
      "protocol_binding": "<string>",
      "protocol_version": "<string>",
      "tenant": "<string>"
    }
  ],
  "default_input_modes": [
    "<string>"
  ],
  "default_output_modes": [
    "<string>"
  ],
  "skills": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "tags": [
        "<string>"
      ],
      "examples": [
        "<string>"
      ],
      "input_modes": [
        "<string>"
      ],
      "output_modes": [
        "<string>"
      ],
      "security_requirements": [
        [
          "<string>"
        ]
      ]
    }
  ],
  "extensions": [
    {
      "uri": "<string>",
      "description": "<string>",
      "required": true,
      "params": {}
    }
  ],
  "warnings": [
    "<string>"
  ]
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "anthropic",
    "model_requested": "<string>",
    "request_type": "<string>",
    "error_type": "<string>",
    "retry_after_ms": 150500
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "anthropic",
    "model_requested": "<string>",
    "request_type": "<string>",
    "error_type": "<string>",
    "retry_after_ms": 150500
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "anthropic",
    "model_requested": "<string>",
    "request_type": "<string>",
    "error_type": "<string>",
    "retry_after_ms": 150500
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "anthropic",
    "model_requested": "<string>",
    "request_type": "<string>",
    "error_type": "<string>",
    "retry_after_ms": 150500
  }
}

POST

api

agents

inspect

Error

A valid request URL is required to generate request examples

{
  "capabilities": {},
  "signature_count": 123,
  "security_schemes": [
    {
      "name": "<string>",
      "type": "<string>",
      "description": "<string>",
      "in": "<string>",
      "header": "<string>",
      "scheme": "<string>",
      "bearer_format": "<string>",
      "authorization_url": "<string>",
      "token_url": "<string>",
      "scopes": [
        "<string>"
      ]
    }
  ],
  "security_requirements": [
    [
      "<string>"
    ]
  ],
  "card": {
    "supportedInterfaces": [
      {
        "url": "<string>",
        "protocolBinding": "<string>",
        "protocolVersion": "<string>",
        "tenant": "<string>"
      }
    ],
    "capabilities": {
      "extensions": [
        {
          "description": "<string>",
          "params": {},
          "required": true,
          "uri": "<string>"
        }
      ],
      "pushNotifications": true,
      "streaming": true,
      "extendedAgentCard": true
    },
    "defaultInputModes": [
      "<string>"
    ],
    "defaultOutputModes": [
      "<string>"
    ],
    "description": "<string>",
    "name": "<string>",
    "skills": [
      {
        "description": "<string>",
        "id": "<string>",
        "name": "<string>",
        "tags": [
          "<string>"
        ],
        "examples": [
          "<string>"
        ],
        "inputModes": [
          "<string>"
        ],
        "outputModes": [
          "<string>"
        ],
        "securityRequirements": [
          {
            "schemes": {}
          }
        ]
      }
    ],
    "version": "<string>",
    "documentationUrl": "<string>",
    "iconUrl": "<string>",
    "provider": {
      "organization": "<string>",
      "url": "<string>"
    },
    "securityRequirements": [
      {
        "schemes": {}
      }
    ],
    "securitySchemes": {},
    "signatures": [
      {
        "protected": "<string>",
        "signature": "<string>",
        "header": {}
      }
    ]
  },
  "name": "<string>",
  "description": "<string>",
  "version": "<string>",
  "provider": "<string>",
  "provider_url": "<string>",
  "documentation_url": "<string>",
  "icon_url": "<string>",
  "interfaces": [
    {
      "url": "<string>",
      "protocol_binding": "<string>",
      "protocol_version": "<string>",
      "tenant": "<string>"
    }
  ],
  "default_input_modes": [
    "<string>"
  ],
  "default_output_modes": [
    "<string>"
  ],
  "skills": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "tags": [
        "<string>"
      ],
      "examples": [
        "<string>"
      ],
      "input_modes": [
        "<string>"
      ],
      "output_modes": [
        "<string>"
      ],
      "security_requirements": [
        [
          "<string>"
        ]
      ]
    }
  ],
  "extensions": [
    {
      "uri": "<string>",
      "description": "<string>",
      "required": true,
      "params": {}
    }
  ],
  "warnings": [
    "<string>"
  ]
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "anthropic",
    "model_requested": "<string>",
    "request_type": "<string>",
    "error_type": "<string>",
    "retry_after_ms": 150500
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "anthropic",
    "model_requested": "<string>",
    "request_type": "<string>",
    "error_type": "<string>",
    "retry_after_ms": 150500
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "anthropic",
    "model_requested": "<string>",
    "request_type": "<string>",
    "error_type": "<string>",
    "retry_after_ms": 150500
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "anthropic",
    "model_requested": "<string>",
    "request_type": "<string>",
    "error_type": "<string>",
    "retry_after_ms": 150500
  }
}

Required Permissions

Permission	Granted via
`AgentGateway:Create`	RBAC role or API key scope

How permissions work

Authorizations

Authorization

string

header

required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <token>, where <token> is one of:

a Bifrost management API key,
a dashboard session token issued by POST /api/session/login,
base64 of <admin-username>:<admin-password> (legacy equivalent of BasicAuth).

Virtual keys (sk-bf-*) and the x-api-key header are not accepted on management APIs - the sole exception is GET /api/governance/virtual-keys/quota, which is virtual-key-only.

Authentication alone is not sufficient in Bifrost Enterprise: each operation page shows a Required Permissions table (Resource:Operation, for example Dashboard:View) above its Authorizations section, and the caller's RBAC role or management API key scopes must include what it lists, otherwise the request is rejected with 403 Forbidden.

A local admin — authenticated with the admin password, or any caller on a deployment with dashboard auth disabled — bypasses these checks and can call every management endpoint.

OSS setup lock. On Bifrost OSS, while dashboard auth is not active (no admin account, or auth disabled), every management endpoint except the public ones (/health, /api/version, /api/session/is-auth-enabled, /api/session/login, ...) requires the operator's setup token in the X-Bifrost-Setup-Token header, in place of Authorization. The token is set with setup_token in config.json or the BIFROST_SETUP_TOKEN environment variable. A missing header returns 401, a wrong token 403. The header stops working once dashboard auth is enabled. The dashboard instead trades the token once for an HttpOnly bifrost_setup_session cookie via POST /api/session/setup. See Required permissions for how permissions are derived and which endpoints are exempt.

Body

application/json

agent_card_url

string

required

discovery_auth

object

Shared upstream authentication. Header auth requires nonempty headers. OAuth uses client credentials and requires client_id, client_secret, and a token, discovery, or provider URL. Interactive OAuth is not supported.

Show child attributes

Response

Success

capabilities

object

required

Show child attributes

signature_count

integer

required

security_schemes

object[]

required

Show child attributes

security_requirements

string[][]

required

card

object

Show child attributes

name

string

description

string

version

string

provider

string

provider_url

string

documentation_url

string

icon_url

string

interfaces

object[]

Show child attributes

default_input_modes

string[]

default_output_modes

string[]

skills

object[]

Show child attributes

extensions

object[]

Show child attributes

warnings

string[]

Authentication

Inference

Integrations

Platform

Governance

Routing

Deprecated

Inspect agent card

Authorizations

Body

Response