Skip to main content
POST
Create a browser run
This endpoint creates a run record using the draft definition. It does not place a phone call or run a complete conversation by itself. Use the console tester for browser conversations. Outbound calling is temporarily disabled.

Authorizations

Authorization
string
header
required

Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs super_user role.

Headers

X-VOAI-ORGANIZATION-ID
string | null

Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace ID to access. The key owner must be a current member. Missing or invalid IDs return 400; non-member workspaces return 403. Not required for bearer authentication, which uses the user's selected workspace.

Path Parameters

workflow_id
integer
required

Body

application/json
mode
enum<string>
required
Available options:
webrtc,
smallwebrtc
name
string
required

Response

Successful Response

created_at
string<date-time>
required
definition_id
integer
required
id
integer
required
mode
string
required
name
string
required
workflow_id
integer
required
initial_context
Initial Context · object | null