Open Menace Voice

Get Agent

Retrieve a single agent by ID, including its full workflow definition

1 min read

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

Request example

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

Response

{
  "id": 1,
  "name": "<string>",
  "status": "<string>",
  "created_at": "2026-08-10T12:00:00Z",
  "workflow_definition": {},
  "current_definition_id": 1,
  "template_context_variables": {},
  "call_disposition_codes": {
    "disposition_codes": []
  },
  "total_runs": 1,
  "workflow_configurations": {},
  "version_number": 1,
  "version_status": "<string>",
  "workflow_uuid": "<string>"
}

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

Returns the full agent including workflow_definition (nodes and edges), template_context_variables, workflow_configurations, and run statistics.

Path parameters

workflow_idintegerrequired#

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

idintegerrequired#

namestringrequired#

statusstringrequired#

created_atstringrequired#

workflow_definitionobjectrequired#

current_definition_idinteger · nullrequired#

Show child attributes

template_context_variablesobject · null#

Show child attributes

call_disposition_codesobject · null#

Show child attributes

total_runsinteger · null#

Show child attributes

workflow_configurationsobject · null#

Show child attributes

version_numberinteger · null#

Show child attributes

version_statusstring · null#

Show child attributes

workflow_uuidstring · null#

Show child attributes

Get Agent Count Update Agent