List Text Scenarios

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

1 min read

get/api/v1/workflow/{workflow_id}/text-chat/scenarios

Request example

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

Response

[
  {
    "source_run_id": 1,
    "name": "<string>",
    "messages": [
      "<string>"
    ],
    "initial_context": {},
    "assertions": {
      "node_ids": [
        "<string>"
      ],
      "reply_contains": [
        "<string>"
      ]
    }
  }
]

get/api/v1/workflow/{workflow_id}/text-chat/scenarios

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

Path parameters

workflow_idintegerrequired#

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

source_run_idintegerrequired#

namestringrequired#

messagesstring[]required#

Items: 1–20

initial_contextobjectrequired#

assertionsobjectrequired#

Show child attributes

node_idsstring[]#

Items: max 20

reply_containsstring[]#

Items: max 20

Rewind Text Chat Session Save Text Scenario