Skip to main content
GET
Get a text test session
Use the numeric agent and run IDs returned when creating the session. The session must belong to that agent in the requested workspace. Missing or mismatched sessions return 404; a run that is not text chat returns 400. Read revision before sending a message or rewinding. This operation retrieves state without executing a new turn.

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

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