Preview Agent

POST /api/v1/workflow/{workflow_id}/agent-preview — request parameters and responses from the Menace Voice API schema.

2 min read

post/api/v1/workflow/{workflow_id}/agent-preview

Request example

curl --request POST \
  --url https://voice.menaceui.com/api/v1/workflow/{workflow_id}/agent-preview \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>' \
  --header 'Content-Type: application/json' \
  --data '{
  "agent_brief": "<string>",
  "tone": "<string>",
  "language": "<string>",
  "voice_provider": "<string>",
  "voice_name": "<string>",
  "behavior_notes": "<string>",
  "workflow_stages": [
    "<string>"
  ],
  "agent_name": "<string>",
  "use_case": "<string>",
  "call_type": "inbound"
}'

Response

{
  "workflow_definition": {},
  "agent_setup": {
    "agent_brief": "<string>",
    "tone": "<string>",
    "language": "<string>",
    "voice_provider": "<string>",
    "voice_name": "<string>",
    "behavior_notes": "<string>",
    "workflow_stages": [
      "<string>"
    ],
    "agent_name": "<string>",
    "use_case": "<string>",
    "call_type": "inbound"
  }
}

post/api/v1/workflow/{workflow_id}/agent-preview

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#

Body

application/json

agent_briefstringrequired#

Length: 1–8000

tonestringrequired#

Length: 1–100

languagestringrequired#

Length: 1–100

voice_providerstringrequired#

Length: 1–100

voice_namestringrequired#

Length: 1–255

behavior_notesstring · null#

Show child attributes

Any of

workflow_stagesstring[]#

Optional template hints; the planner chooses the stages from the brief.

Items: max 8

agent_namestringrequired#

Length: 1–255

use_casestringrequired#

Length: 1–2000

call_typeenum<string>required#

Options:inboundoutbound

Responses

application/json

Successful Response

workflow_definitionobjectrequired#

agent_setupobjectrequired#

Show child attributes

agent_briefstringrequired#

Length: 1–8000

tonestringrequired#

Length: 1–100

languagestringrequired#

Length: 1–100

voice_providerstringrequired#

Length: 1–100

voice_namestringrequired#

Length: 1–255

behavior_notesstring · null#

Show child attributes

Any of

workflow_stagesstring[]#

Optional template hints; the planner chooses the stages from the brief.

Items: max 8

agent_namestringrequired#

Length: 1–255

use_casestringrequired#

Length: 1–2000

call_typeenum<string>required#

Options:inboundoutbound

Get Agent Setup Get Workflow Versions