Vapi · Schema

BearerAuthenticationPlan

AIVoiceAgentsRealtimeCPaaS

Properties

Name	Type	Description
type	string
token	string	This is the bearer token value.
headerName	string	This is the header name where the bearer token will be sent. Defaults to 'Authorization'.
bearerPrefixEnabled	boolean	Whether to include the 'Bearer ' prefix in the header value. Defaults to true.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BearerAuthenticationPlan",
  "title": "BearerAuthenticationPlan",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "bearer"
      ]
    },
    "token": {
      "type": "string",
      "description": "This is the bearer token value."
    },
    "headerName": {
      "type": "string",
      "description": "This is the header name where the bearer token will be sent. Defaults to 'Authorization'."
    },
    "bearerPrefixEnabled": {
      "type": "boolean",
      "description": "Whether to include the 'Bearer ' prefix in the header value. Defaults to true."
    }
  },
  "required": [
    "type",
    "token"
  ]
}