Skip to main content
POST
Send a test message
Requires membership in the requested workspace and available usage quota. Send nonempty text and the latest expected_revision to detect concurrent edits. This executes the agent and may call its configured tools. A stale revision returns 409; fetch the session again before retrying. Insufficient quota returns 402. The response contains the updated session, revision, and completion state. A repeated successful request can append the message again; it is not an idempotent retry.

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
run_id
integer
required

Body

application/json
text
string
required
Minimum string length: 1
expected_revision
integer | 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