Get Public Chat Session

GET /api/v1/public/embed/chat/{session_token} — request parameters and responses from the Menace Voice API schema.

1 min read

get/api/v1/public/embed/chat/{session_token}

Request example

curl --request GET \
  --url https://voice.menaceui.com/api/v1/public/embed/chat/{session_token}

Response

{
  "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>"
      }
    }
  ]
}

get/api/v1/public/embed/chat/{session_token}

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

Path parameters

session_tokenstringrequired#

Responses

application/json

Successful Response

revisionintegerrequired#

statestringrequired#

is_completedbooleanrequired#

turnsobject[]required#

Show child attributes

idstringrequired#

statusstringrequired#

user_messageobject · null#

Show child attributes

Any of

textstringrequired#

created_atstring · null#

Show child attributes

Any of

assistant_messageobject · null#

Show child attributes

Any of

textstringrequired#

created_atstring · null#

Show child attributes

Any of

Options Turn Credentials Options Public Chat Session