dialogbrain-com · Schema

VoiceBridgeRequest

Request to bridge an external LiveKit room to an agent.

CompanyArtificial IntelligenceCustomer ServiceMessagingVoice

Properties

Name Type Description
livekit_url string WebSocket URL of your LiveKit server, wss:// only. Private addresses are refused.
room string Room name in the partner's LiveKit instance.
token string LiveKit access token for joining the partner's room. Must be valid for at least 300 seconds (or answer_delay_s if longer).
agent_id integer The DialogBrain agent to handle the call.
caller_external_identity string The caller's participant identity in your room. The bridge listens to this participant only, and its departure ends the call.
owner_identity object The room owner's participant identity. Only meaningful with a non-zero answer_delay_s: this participant joining means the human answered, and the agent stands down unbilled.
end_user_id object Your identifier for the caller. Comes back on the call events inside metadata.
answer_delay_s object Seconds to ring the human before the agent answers (0-120). Absent or 0: agent answers immediately.
metadata object Arbitrary JSON-serializable data. Returned on call events. Max 4 KB.
View JSON Schema on GitHub

JSON Schema

dialogbrain-com-voice-bridge-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/dialogbrain-com/json-schema/dialogbrain-com-voice-bridge-request-schema.json",
  "title": "VoiceBridgeRequest",
  "description": "Request to bridge an external LiveKit room to an agent.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/dialogbrain-com-calls-api-openapi.yml#/components/schemas/VoiceBridgeRequest",
  "properties": {
    "livekit_url": {
      "type": "string",
      "title": "Livekit Url",
      "description": "WebSocket URL of your LiveKit server, wss:// only. Private addresses are refused."
    },
    "room": {
      "type": "string",
      "title": "Room",
      "description": "Room name in the partner's LiveKit instance."
    },
    "token": {
      "type": "string",
      "title": "Token",
      "description": "LiveKit access token for joining the partner's room. Must be valid for at least 300 seconds (or answer_delay_s if longer)."
    },
    "agent_id": {
      "type": "integer",
      "title": "Agent Id",
      "description": "The DialogBrain agent to handle the call."
    },
    "caller_external_identity": {
      "type": "string",
      "title": "Caller External Identity",
      "description": "The caller's participant identity in your room. The bridge listens to this participant only, and its departure ends the call."
    },
    "owner_identity": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Owner Identity",
      "description": "The room owner's participant identity. Only meaningful with a non-zero answer_delay_s: this participant joining means the human answered, and the agent stands down unbilled."
    },
    "end_user_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "End User Id",
      "description": "Your identifier for the caller. Comes back on the call events inside metadata."
    },
    "answer_delay_s": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Answer Delay S",
      "description": "Seconds to ring the human before the agent answers (0-120). Absent or 0: agent answers immediately."
    },
    "metadata": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Metadata",
      "description": "Arbitrary JSON-serializable data. Returned on call events. Max 4 KB."
    }
  },
  "type": "object",
  "required": [
    "livekit_url",
    "room",
    "token",
    "agent_id",
    "caller_external_identity"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/dialogbrain-com-voice-bridge-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.