Assistants

List assistants

GET/openapi/assistants

Request

Response

200 OK

codeintegerrequired

msgstringrequired

dataobject[]required

[].idintegerrequired

[].namestringrequired

[].versionIdintegerrequired

[].scenestringrequired

[].speakerIdintegerrequired

[].websocketUrlstringrequired

[].websocketTokenstringrequired

[].listenerIdintegerrequired

[].welcomestringrequired

[].promptstringrequired

[].collectobject[]required

[].questionstringrequired

[].answersstring[]required

[].knowledgestringrequired

[].createdAtstringrequired

[].updatedAtstringrequired

Sample code

curl -X GET 'https://openapi.voicefox.ai/openapi/assistants' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  -H 'Content-Type: application/json'

Response example

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "id": 0,
      "name": "string",
      "versionId": 0,
      "scene": "string",
      "speakerId": 0,
      "websocketUrl": "string",
      "websocketToken": "string",
      "listenerId": 0,
      "welcome": "string",
      "prompt": "string",
      "collect": [
        {
          "question": "string",
          "answers": [
            "string"
          ]
        }
      ],
      "knowledge": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}