Initialize Embed Session

POST /api/v1/public/embed/init — request parameters and responses from the Menace Voice API schema.

2 min read

post/api/v1/public/embed/init

Request example

curl --request POST \
  --url https://voice.menaceui.com/api/v1/public/embed/init \
  --header 'Content-Type: application/json' \
  --data '{
  "token": "<string>",
  "context_variables": {}
}'

Response

{
  "session_token": "<string>",
  "workflow_run_id": 1,
  "config": {},
  "widget_type": "voice",
  "chat_session": {
    "revision": 1,
    "state": "<string>",
    "is_completed": true,
    "turns": [
      {
        "id": "<string>",
        "status": "<string>",
        "user_message": {
          "text": "<string>",
          "created_at": "<string>"
        },
        "assistant_message": {
          "text": "<string>",
          "created_at": "<string>"
        }
      }
    ]
  }
}

post/api/v1/public/embed/init

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

Body

application/json

tokenstringrequired#

context_variablesobject · null#

Show child attributes

Any of

Responses

application/json

Successful Response

session_tokenstringrequired#

workflow_run_idintegerrequired#

configobjectrequired#

widget_typestring#

Default: "voice"

chat_sessionobject · null#

Show child attributes

Any of

revisionintegerrequired#

statestringrequired#

is_completedbooleanrequired#

turnsobject[]required#

Show child attributes

idstringrequired#

statusstringrequired#

user_messageobject · null#

Show child attributes

assistant_messageobject · null#

Show child attributes

Delete Voice Clone Options Init