Skip to main content
GET
/
api
/
v1
/
assistants
List Assistants
curl --request GET \
  --url https://api.voicebot.studio/api/v1/assistants \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "organizationId": "<string>",
    "createdBy": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "model": {
      "messages": [
        {
          "content": "<string>",
          "role": "<string>"
        }
      ],
      "provider": "standard",
      "model": "standard",
      "tools": [
        {
          "type": "dtmf",
          "async": false,
          "messages": [
            {
              "type": "request-start",
              "contents": [
                {
                  "type": "text",
                  "text": "<string>",
                  "language": "aa"
                }
              ],
              "content": "<string>",
              "conditions": [
                {
                  "operator": "eq",
                  "param": "<string>",
                  "value": {}
                }
              ]
            }
          ],
          "function": {
            "name": "<string>",
            "strict": false,
            "description": "<string>",
            "parameters": {
              "type": "object",
              "properties": {},
              "required": [
                "<string>"
              ]
            }
          },
          "server": {
            "url": "<string>",
            "timeoutSeconds": 20,
            "secret": "<string>",
            "headers": {}
          }
        }
      ],
      "toolIds": [
        "<string>"
      ],
      "temperature": 123,
      "maxTokens": 123,
      "numFastTurns": 123,
      "knowledgeBase": {
        "topK": 123,
        "fileIds": [
          "<string>"
        ],
        "provider": "canonical"
      },
      "fallbackModels": [
        "standard"
      ],
      "semanticCachingEnabled": true,
      "emotionRecognitionEnabled": true
    },
    "voice": {
      "model": "standard",
      "style": 123,
      "voiceId": "Robert",
      "language": "<string>",
      "chunkPlan": {
        "enabled": true,
        "minCharacters": 30,
        "punctuationBoundaries": [
          "<string>"
        ],
        "formatPlan": {
          "enabled": true,
          "numberToDigitsCutoff": 2025,
          "replacements": [
            {
              "key": "<string>",
              "value": "<string>",
              "type": "exact"
            }
          ]
        }
      },
      "fillerInjectionEnabled": true,
      "provider": "standard",
      "stability": 123,
      "similarityBoost": 123,
      "useSpeakerBoost": false,
      "enableSsmlParsing": false,
      "optimizeStreamingLatency": 3
    },
    "transcriber": {
      "provider": "standard",
      "model": "standard",
      "language": "<string>",
      "smartFormat": true,
      "languageDetectionEnabled": true,
      "keywords": [
        "<string>"
      ],
      "endpointing": 123
    },
    "analysisPlan": {
      "successEvaluationRubric": "NumericScale",
      "successEvaluationRequestTimeoutSeconds": 123,
      "successEvaluationPrompt": "<string>",
      "structuredDataSchema": {
        "type": "string",
        "items": {},
        "properties": {},
        "description": "<string>",
        "required": [
          "<string>"
        ]
      },
      "structuredDataRequestTimeoutSeconds": 123,
      "structuredDataPrompt": "<string>",
      "summaryPrompt": "<string>",
      "summaryRequestTimeoutSeconds": 123
    },
    "serverUrl": "<string>",
    "serverUrlSecret": "<string>",
    "artifactPlan": {
      "transcriptPlan": {
        "enabled": true,
        "userName": "<string>",
        "assistantName": "<string>"
      },
      "recordingEnabled": true,
      "videoRecordingEnabled": true,
      "recordingPath": "<string>"
    },
    "messagePlan": {
      "idleMessages": [
        "<string>"
      ],
      "idleMessageMaxSpokenCount": 123,
      "idleTimeoutSeconds": 123
    },
    "startSpeakingPlan": {
      "waitSeconds": 123,
      "smartEndpointingEnabled": true,
      "transcriptionEndpointingPlan": {
        "onPunctuationSeconds": 123,
        "onNoPunctuationSeconds": 123,
        "onNumberSeconds": 123
      }
    },
    "stopSpeakingPlan": {
      "numWords": 123,
      "voiceSeconds": 123,
      "backoffSeconds": 123
    },
    "monitorPlan": {
      "listenEnabled": true,
      "controlEnabled": true
    },
    "clientMessages": [
      "<string>"
    ],
    "dialKeypadFunctionEnabled": true,
    "endCallFunctionEnabled": true,
    "forwardingPhoneNumber": "<string>"
  }
]

Authorizations

X-API-Key
string
header
required

Response

200 - application/json

Successful Response

id
string
required
name
string
required
organizationId
string
required
createdBy
string
required
createdAt
string
required
updatedAt
string
required
model
CreateAssistantDtoModel · object
voice
CreateAssistantDtoVoice · object
transcriber
CreateAssistantDtoTranscriber · object
analysisPlan
changedAssistantAnalysisPlan · object

This is the analysis plan for the assistant.

serverUrl
string | null

Server URL must match either workflow.amira.bot or workflow.voicebot.studio

serverUrlSecret
string | null
artifactPlan
ArtifactPlan · object
messagePlan
MessagePlan · object
startSpeakingPlan
StartSpeakingPlan · object
stopSpeakingPlan
StopSpeakingPlan · object
monitorPlan
MonitorPlan · object
clientMessages
string[] | null
dialKeypadFunctionEnabled
boolean | null
endCallFunctionEnabled
boolean | null
forwardingPhoneNumber
string | null