Create Test Run

Execute a workflow without placing a real phone call

1 min read

post/api/v1/workflow/{workflow_id}/runs

Request example

curl --request POST \
  --url https://voice.menaceui.com/api/v1/workflow/{workflow_id}/runs \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>' \
  --header 'Content-Type: application/json' \
  --data '{
  "mode": "<string>",
  "name": "<string>"
}'

Response

{
  "id": 1,
  "workflow_id": 1,
  "name": "<string>",
  "mode": "<string>",
  "created_at": "2026-08-10T12:00:00Z",
  "definition_id": 1,
  "initial_context": {}
}

post/api/v1/workflow/{workflow_id}/runs

Creates the run record used by an editor chat or voice session, using the current draft and test context. This request does not itself complete a conversation or establish the media connection. Use the editor or the appropriate session transport to run the test, then inspect its results.

Path parameters

workflow_idintegerrequired#

Headers

authorizationstring · null#

X-API-Keystring · null#

Body

application/json

modestringrequired#

namestringrequired#

Responses

application/json

Successful Response

idintegerrequired#

workflow_idintegerrequired#

namestringrequired#

modestringrequired#

created_atstringrequired#

definition_idintegerrequired#

initial_contextobject · null#

Show child attributes

Any of

Validate Workflow List Runs