Open Menace Voice

Get Workflow Runs

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

2 min read

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

Request example

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

Response

{
  "runs": [
    {
      "id": 1,
      "workflow_id": 1,
      "name": "<string>",
      "mode": "<string>",
      "created_at": "2026-08-10T12:00:00Z",
      "is_completed": true,
      "transcript_url": "<string>",
      "recording_url": "<string>",
      "user_recording_url": "<string>",
      "bot_recording_url": "<string>",
      "transcript_public_url": "<string>",
      "recording_public_url": "<string>",
      "user_recording_public_url": "<string>",
      "bot_recording_public_url": "<string>",
      "public_access_token": "<string>",
      "cost_info": {},
      "usage_info": {},
      "definition_id": 1,
      "initial_context": {},
      "gathered_context": {},
      "call_type": "inbound",
      "logs": {},
      "annotations": {}
    }
  ],
  "total_count": 1,
  "page": 1,
  "limit": 1,
  "total_pages": 1,
  "applied_filters": [
    {}
  ]
}

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

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

Path parameters

workflow_idintegerrequired#

Query parameters

pageinteger#

Page number (starts from 1)

Default: 1

Range: >= 1

limitinteger#

Number of items per page

Default: 50

Range: 1–100

filtersstring · null#

JSON-encoded filter criteria

sort_bystring · null#

Field to sort by (e.g., 'duration', 'created_at')

sort_orderstring · null#

Sort order ('asc' or 'desc')

Default: "desc"

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

runsobject[]required#

Show child attributes

idintegerrequired#

workflow_idintegerrequired#

namestringrequired#

modestringrequired#

created_atstringrequired#

is_completedbooleanrequired#

transcript_urlstring · nullrequired#

Show child attributes

recording_urlstring · nullrequired#

Show child attributes

user_recording_urlstring · null#

Show child attributes

bot_recording_urlstring · null#

Show child attributes

transcript_public_urlstring · null#

Show child attributes

recording_public_urlstring · null#

Show child attributes

user_recording_public_urlstring · null#

Show child attributes

bot_recording_public_urlstring · null#

Show child attributes

public_access_tokenstring · null#

Show child attributes

cost_infoobject · nullrequired#

Show child attributes

usage_infoobject · null#

Show child attributes

definition_idinteger · nullrequired#

Show child attributes

initial_contextobject · null#

Show child attributes

gathered_contextobject · null#

Show child attributes

call_typeenum<string>required#

Options:inboundoutbound

logsobject · null#

Show child attributes

annotationsobject · null#

Show child attributes

total_countintegerrequired#

pageintegerrequired#

limitintegerrequired#

total_pagesintegerrequired#

applied_filtersobject[] · null#

Show child attributes

Create Workflow Run Get Workflow Run