Error

A valid request URL is required to generate request examples

{
  "status": "pending_oauth",
  "message": "<string>",
  "oauth_config_id": "<string>",
  "authorize_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "mcp_client_id": "<string>",
  "complete_url": "<string>",
  "status_url": "<string>",
  "next_steps": [
    "<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": {
    "model_requested": "<string>",
    "request_type": "<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": {
    "model_requested": "<string>",
    "request_type": "<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": {
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

MCP

Initiate verification for a pending MCP client

Starts the one-time admin OAuth authorization for an MCP client sitting in pending_verification state (declared via config.json with auth_type “oauth” or “per_user_oauth”). Runs OAuth metadata discovery (RFC 8414) and dynamic client registration (RFC 7591) against the client’s connection_string when the declared oauth_config omits those fields, creates a fresh OAuth flow, and returns the authorization URL.

Complete the flow like a create-time OAuth flow: open authorize_url in a browser, poll status_url until “authorized”, then POST complete_url. Safe to call again if a previous attempt expired or was abandoned — each call starts a fresh flow.

POST

/

api

/

mcp

/

client

/

{id}

/

initiate-verification

Error

A valid request URL is required to generate request examples

{
  "status": "pending_oauth",
  "message": "<string>",
  "oauth_config_id": "<string>",
  "authorize_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "mcp_client_id": "<string>",
  "complete_url": "<string>",
  "status_url": "<string>",
  "next_steps": [
    "<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": {
    "model_requested": "<string>",
    "request_type": "<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": {
    "model_requested": "<string>",
    "request_type": "<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": {
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Path Parameters

id

string

required

MCP client ID

Response

OAuth flow initiated

Response when initiating an OAuth flow

status

enum<string>

Available options:

pending_oauth

message

string

oauth_config_id

string

ID of the OAuth config created for this flow

authorize_url

string

URL to redirect the user to for authorization

expires_at

string<date-time>

When the OAuth authorization request expires

mcp_client_id

string

The MCP client ID that initiated this OAuth flow

complete_url

string

Relative URL to POST once the flow is authorized (/api/mcp/client/{oauth_config_id}/complete-oauth). Note the path parameter is the oauth_config_id, not the MCP client ID.

status_url

string

Relative URL to poll for the flow status (/api/oauth/config/{oauth_config_id}/status). Wait for status "authorized" before calling complete_url.

next_steps

string[]

Human-readable steps to complete the flow (authorize, poll, complete)

⌘I