Get Text Chat Session

GET /api/v1/workflow/{workflow_id}/text-chat/sessions/{run_id} — request parameters and responses from the Menace Voice API schema.

2 min read

get/api/v1/workflow/{workflow_id}/text-chat/sessions/{run_id}

Request example

curl --request GET \
  --url https://voice.menaceui.com/api/v1/workflow/{workflow_id}/text-chat/sessions/{run_id} \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>'

Response

{
  "workflow_run_id": 1,
  "workflow_id": 1,
  "name": "<string>",
  "mode": "<string>",
  "state": "<string>",
  "is_completed": true,
  "revision": 1,
  "initial_context": {},
  "gathered_context": {},
  "annotations": {},
  "session_data": {},
  "checkpoint": {},
  "created_at": "2026-08-10T12:00:00Z",
  "updated_at": "2026-08-10T12:00:00Z"
}

get/api/v1/workflow/{workflow_id}/text-chat/sessions/{run_id}

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

Path parameters

workflow_idintegerrequired#

run_idintegerrequired#

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

workflow_run_idintegerrequired#

workflow_idintegerrequired#

namestringrequired#

modestringrequired#

statestringrequired#

is_completedbooleanrequired#

revisionintegerrequired#

initial_contextobject · null#

Show child attributes

Any of

gathered_contextobject · null#

Show child attributes

Any of

annotationsobject · null#

Show child attributes

Any of

session_dataobjectrequired#

checkpointobjectrequired#

created_atstringrequired#

updated_atstring · null#

Show child attributes

Any of

Create Text Chat Session Append Text Chat Message