Skip to main content
POST
Create a text test session
Requires Editor, Admin, or Owner and available usage quota. Optionally supply a name, initial context variables, and annotations. This creates a run in textchat mode and can execute the agent’s opening turn; configured model and tool calls can incur usage or external side effects. The response contains the run ID, revision, session data, checkpoint, and completion state. A missing agent returns 404; insufficient quota returns 402. Retrying a successful creation makes another session.

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
annotations
Annotations · object | null
initial_context
Initial Context · object | null
name
string | null

Response

Successful Response

checkpoint
Checkpoint · object
required
created_at
string<date-time>
required
is_completed
boolean
required
mode
string
required
name
string
required
revision
integer
required
session_data
Session Data · object
required
state
string
required
workflow_id
integer
required
workflow_run_id
integer
required
annotations
Annotations · object | null
gathered_context
Gathered Context · object | null
initial_context
Initial Context · object | null
updated_at
string<date-time> | null