Save Text Scenario

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

2 min read

put/api/v1/workflow/{workflow_id}/text-chat/scenarios/{run_id}

Request example

curl --request PUT \
  --url https://voice.menaceui.com/api/v1/workflow/{workflow_id}/text-chat/scenarios/{run_id} \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "assertions": {
    "node_ids": [
      "<string>"
    ],
    "reply_contains": [
      "<string>"
    ]
  }
}'

Response

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

put/api/v1/workflow/{workflow_id}/text-chat/scenarios/{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#

Body

application/json

namestringrequired#

Length: 1–100

assertionsobject#

Show child attributes

node_idsstring[]#

Items: max 20

reply_containsstring[]#

Items: max 20

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

List Text Scenarios Delete Text Scenario