Skip to main content
GET
/
api
/
v1
/
multi-agent
List Multi Agents
curl --request GET \
  --url https://api.voicebot.studio/api/v1/multi-agent \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "members": [
      {
        "assistantId": "<string>",
        "assistant": {
          "name": "<string>",
          "model": {
            "messages": [
              {}
            ],
            "provider": "standard",
            "model": "standard",
            "tools": [
              {}
            ],
            "toolIds": [
              "<string>"
            ],
            "temperature": 123,
            "maxTokens": 123,
            "numFastTurns": 123,
            "knowledgeBase": {
              "provider": "<string>",
              "topK": 123,
              "fileIds": [
                "<any>"
              ]
            },
            "fallbackModels": [
              "standard"
            ],
            "semanticCachingEnabled": true,
            "emotionRecognitionEnabled": true
          },
          "voice": {
            "fillerInjectionEnabled": true,
            "model": "standard",
            "style": 123,
            "voiceId": "Robert",
            "language": "<string>",
            "provider": "<string>",
            "stability": 123,
            "similarityBoost": 123,
            "useSpeakerBoost": true,
            "enableSsmlParsing": true,
            "optimizeStreamingLatency": 123,
            "chunkPlan": {
              "enabled": true,
              "minCharacters": 40.5,
              "punctuationBoundaries": [
                "<any>"
              ],
              "formatPlan": {}
            }
          },
          "firstMessageMode": "assistant-speaks-first",
          "hipaaEnabled": true,
          "clientMessages": [
            "<string>"
          ],
          "serverMessages": [
            "end-of-call-report"
          ],
          "silenceTimeoutSeconds": 123,
          "maxDurationSeconds": 123,
          "backgroundSound": "off",
          "backgroundDenoisingEnabled": true,
          "modelOutputInMessagesEnabled": true,
          "transportConfigurations": [
            {
              "provider": "<string>",
              "timeout": 123,
              "record": true,
              "recordingChannels": "mono"
            }
          ],
          "firstMessage": "<string>",
          "voicemailDetection": {
            "enabled": true,
            "provider": "<string>",
            "machineDetectionTimeout": 123,
            "voicemailDetectionTypes": [
              "machine_start"
            ],
            "machineDetectionSilenceTimeout": 123,
            "machineDetectionSpeechThreshold": 123,
            "machineDetectionSpeechEndThreshold": 123
          },
          "voicemailMessage": "<string>",
          "endCallMessage": "<string>",
          "endCallPhrases": [
            "<string>"
          ],
          "metadata": {},
          "serverUrl": "<string>",
          "serverUrlSecret": "<string>",
          "analysisPlan": {
            "successEvaluationRubric": "NumericScale",
            "successEvaluationRequestTimeoutSeconds": 123,
            "successEvaluationPrompt": "<string>",
            "structuredDataSchema": {
              "type": "string",
              "items": {},
              "properties": {},
              "description": "<string>",
              "required": [
                "<any>"
              ]
            },
            "structuredDataRequestTimeoutSeconds": 123,
            "structuredDataPrompt": "<string>",
            "summaryPrompt": "<string>",
            "summaryRequestTimeoutSeconds": 123
          },
          "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
          },
          "transcriber": {
            "provider": "standard",
            "model": "standard",
            "language": "<string>",
            "smartFormat": true,
            "languageDetectionEnabled": true,
            "keywords": [
              "<string>"
            ],
            "endpointing": 123
          },
          "dialKeypadFunctionEnabled": true,
          "endCallFunctionEnabled": true,
          "forwardingPhoneNumber": "<string>"
        },
        "assistantOverrides": {
          "name": "<string>",
          "model": {
            "messages": [
              {}
            ],
            "provider": "standard",
            "model": "standard",
            "tools": [
              {}
            ],
            "toolIds": [
              "<string>"
            ],
            "temperature": 123,
            "maxTokens": 123,
            "numFastTurns": 123,
            "knowledgeBase": {
              "provider": "<string>",
              "topK": 123,
              "fileIds": [
                "<any>"
              ]
            },
            "fallbackModels": [
              "standard"
            ],
            "semanticCachingEnabled": true,
            "emotionRecognitionEnabled": true
          },
          "voice": {
            "fillerInjectionEnabled": true,
            "model": "standard",
            "style": 123,
            "voiceId": "Robert",
            "language": "<string>",
            "provider": "<string>",
            "stability": 123,
            "similarityBoost": 123,
            "useSpeakerBoost": true,
            "enableSsmlParsing": true,
            "optimizeStreamingLatency": 123,
            "chunkPlan": {
              "enabled": true,
              "minCharacters": 40.5,
              "punctuationBoundaries": [
                "<any>"
              ],
              "formatPlan": {}
            }
          },
          "firstMessageMode": "assistant-speaks-first",
          "hipaaEnabled": true,
          "clientMessages": [
            "<string>"
          ],
          "serverMessages": [
            "end-of-call-report"
          ],
          "silenceTimeoutSeconds": 123,
          "maxDurationSeconds": 123,
          "backgroundSound": "off",
          "backgroundDenoisingEnabled": true,
          "modelOutputInMessagesEnabled": true,
          "transportConfigurations": [
            {
              "provider": "<string>",
              "timeout": 123,
              "record": true,
              "recordingChannels": "mono"
            }
          ],
          "firstMessage": "<string>",
          "voicemailDetection": {
            "enabled": true,
            "provider": "<string>",
            "machineDetectionTimeout": 123,
            "voicemailDetectionTypes": [
              "machine_start"
            ],
            "machineDetectionSilenceTimeout": 123,
            "machineDetectionSpeechThreshold": 123,
            "machineDetectionSpeechEndThreshold": 123
          },
          "voicemailMessage": "<string>",
          "endCallMessage": "<string>",
          "endCallPhrases": [
            "<string>"
          ],
          "metadata": {},
          "serverUrl": "<string>",
          "serverUrlSecret": "<string>",
          "analysisPlan": {
            "successEvaluationRubric": "NumericScale",
            "successEvaluationRequestTimeoutSeconds": 123,
            "successEvaluationPrompt": "<string>",
            "structuredDataSchema": {
              "type": "string",
              "items": {},
              "properties": {},
              "description": "<string>",
              "required": [
                "<any>"
              ]
            },
            "structuredDataRequestTimeoutSeconds": 123,
            "structuredDataPrompt": "<string>",
            "summaryPrompt": "<string>",
            "summaryRequestTimeoutSeconds": 123
          },
          "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
          },
          "transcriber": {
            "provider": "standard",
            "model": "standard",
            "language": "<string>",
            "smartFormat": true,
            "languageDetectionEnabled": true,
            "keywords": [
              "<string>"
            ],
            "endpointing": 123
          },
          "dialKeypadFunctionEnabled": true,
          "endCallFunctionEnabled": true,
          "forwardingPhoneNumber": "<string>"
        },
        "assistantDestinations": [
          {
            "message": "<string>",
            "type": "assistant",
            "transferMode": "rolling-history",
            "assistantName": "<string>",
            "description": "<string>"
          }
        ]
      }
    ],
    "members_overrides": {
      "name": "<string>",
      "model": {
        "messages": [
          {}
        ],
        "provider": "standard",
        "model": "standard",
        "tools": [
          {}
        ],
        "toolIds": [
          "<string>"
        ],
        "temperature": 123,
        "maxTokens": 123,
        "numFastTurns": 123,
        "knowledgeBase": {
          "provider": "<string>",
          "topK": 123,
          "fileIds": [
            "<any>"
          ]
        },
        "fallbackModels": [
          "standard"
        ],
        "semanticCachingEnabled": true,
        "emotionRecognitionEnabled": true
      },
      "voice": {
        "fillerInjectionEnabled": true,
        "model": "standard",
        "style": 123,
        "voiceId": "Robert",
        "language": "<string>",
        "provider": "<string>",
        "stability": 123,
        "similarityBoost": 123,
        "useSpeakerBoost": true,
        "enableSsmlParsing": true,
        "optimizeStreamingLatency": 123,
        "chunkPlan": {
          "enabled": true,
          "minCharacters": 40.5,
          "punctuationBoundaries": [
            "<any>"
          ],
          "formatPlan": {}
        }
      },
      "firstMessageMode": "assistant-speaks-first",
      "hipaaEnabled": true,
      "clientMessages": [
        "<string>"
      ],
      "serverMessages": [
        "end-of-call-report"
      ],
      "silenceTimeoutSeconds": 123,
      "maxDurationSeconds": 123,
      "backgroundSound": "off",
      "backgroundDenoisingEnabled": true,
      "modelOutputInMessagesEnabled": true,
      "transportConfigurations": [
        {
          "provider": "<string>",
          "timeout": 123,
          "record": true,
          "recordingChannels": "mono"
        }
      ],
      "firstMessage": "<string>",
      "voicemailDetection": {
        "enabled": true,
        "provider": "<string>",
        "machineDetectionTimeout": 123,
        "voicemailDetectionTypes": [
          "machine_start"
        ],
        "machineDetectionSilenceTimeout": 123,
        "machineDetectionSpeechThreshold": 123,
        "machineDetectionSpeechEndThreshold": 123
      },
      "voicemailMessage": "<string>",
      "endCallMessage": "<string>",
      "endCallPhrases": [
        "<string>"
      ],
      "metadata": {},
      "serverUrl": "<string>",
      "serverUrlSecret": "<string>",
      "analysisPlan": {
        "successEvaluationRubric": "NumericScale",
        "successEvaluationRequestTimeoutSeconds": 123,
        "successEvaluationPrompt": "<string>",
        "structuredDataSchema": {
          "type": "string",
          "items": {},
          "properties": {},
          "description": "<string>",
          "required": [
            "<any>"
          ]
        },
        "structuredDataRequestTimeoutSeconds": 123,
        "structuredDataPrompt": "<string>",
        "summaryPrompt": "<string>",
        "summaryRequestTimeoutSeconds": 123
      },
      "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
      },
      "transcriber": {
        "provider": "standard",
        "model": "standard",
        "language": "<string>",
        "smartFormat": true,
        "languageDetectionEnabled": true,
        "keywords": [
          "<string>"
        ],
        "endpointing": 123
      },
      "dialKeypadFunctionEnabled": true,
      "endCallFunctionEnabled": true,
      "forwardingPhoneNumber": "<string>"
    },
    "organizationId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
]

Authorizations

X-API-Key
string
header
required

Response

200 - application/json

Successful Response

id
string
required
members
SquadMemberDTO · object[]
required
organizationId
string
required
createdAt
string
required
updatedAt
string
required
name
string | null
members_overrides
object | null