GET
/
squad
curl --request GET \
  --url https://api.vapi.ai/squad \
  --header 'Authorization: Bearer <token>'
[
  {
    "members": [
      {
        "assistantId": "<string>",
        "assistant": {
          "transcriber": {
            "provider": "deepgram",
            "model": "nova-2",
            "language": "bg",
            "smartFormat": false,
            "keywords": [
              "<string>"
            ]
          },
          "model": {
            "messages": [
              {
                "content": "<string>",
                "role": "assistant"
              }
            ],
            "tools": [
              {
                "async": false,
                "messages": [
                  {
                    "type": "request-start",
                    "content": "<string>",
                    "conditions": [
                      {
                        "param": "<string>",
                        "value": {},
                        "operator": "eq"
                      }
                    ]
                  }
                ],
                "type": "transferCall",
                "destinations": [
                  {
                    "type": "assistant",
                    "assistantName": "<string>",
                    "message": "<string>",
                    "description": "<string>"
                  }
                ],
                "function": {
                  "name": "<string>",
                  "description": "<string>",
                  "parameters": {
                    "type": "object",
                    "properties": {},
                    "required": [
                      "<string>"
                    ]
                  }
                },
                "server": {
                  "url": "<string>",
                  "secret": "<string>"
                }
              }
            ],
            "toolIds": [
              "<string>"
            ],
            "provider": "openai",
            "model": "gpt-4o",
            "fallbackModels": [
              "gpt-4-0125-preview",
              "gpt-4-0613"
            ],
            "semanticCachingEnabled": true,
            "numFastTurns": 1,
            "temperature": 1,
            "knowledgeBase": {
              "provider": "canonical",
              "topK": 123,
              "fileIds": [
                "<string>"
              ]
            },
            "maxTokens": 525,
            "emotionRecognitionEnabled": true
          },
          "voice": {
            "inputPreprocessingEnabled": true,
            "inputMinCharacters": 10,
            "inputPunctuationBoundaries": [
              "。",
              "，",
              ".",
              "!",
              "?",
              ";",
              ")",
              "،",
              "۔",
              "।",
              "॥",
              "|",
              "||",
              ",",
              ":"
            ],
            "fillerInjectionEnabled": false,
            "provider": "azure",
            "voiceId": "andrew",
            "speed": 1.25
          },
          "firstMessageMode": "assistant-speaks-first",
          "recordingEnabled": true,
          "hipaaEnabled": false,
          "clientMessages": [
            "transcript",
            "hang",
            "tool-calls",
            "speech-update",
            "metadata",
            "conversation-update"
          ],
          "serverMessages": [
            "end-of-call-report",
            "status-update",
            "hang",
            "tool-calls"
          ],
          "silenceTimeoutSeconds": 30,
          "responseDelaySeconds": 0.4,
          "llmRequestDelaySeconds": 0.1,
          "numWordsToInterruptAssistant": 1,
          "maxDurationSeconds": 1800,
          "backgroundSound": "office",
          "backchannelingEnabled": true,
          "name": "<string>",
          "firstMessage": "<string>",
          "voicemailDetection": {
            "provider": "twilio",
            "voicemailDetectionTypes": [
              "machine_end_beep",
              "machine_end_silence"
            ],
            "enabled": true,
            "machineDetectionTimeout": 31,
            "machineDetectionSpeechThreshold": 3500,
            "machineDetectionSpeechEndThreshold": 2750,
            "machineDetectionSilenceTimeout": 6000
          },
          "voicemailMessage": "<string>",
          "endCallMessage": "<string>",
          "endCallPhrases": [
            "<string>"
          ],
          "metadata": {},
          "serverUrl": "<string>",
          "serverUrlSecret": "<string>",
          "analysisPlan": {
            "summaryPrompt": "<string>",
            "successEvaluationPrompt": "<string>",
            "successEvaluationRubric": "NumericScale",
            "structuredDataPrompt": "<string>",
            "structuredDataSchema": {
              "type": "string",
              "items": {},
              "properties": {},
              "description": "<string>",
              "required": [
                {}
              ]
            }
          }
        },
        "assistantOverrides": {
          "transcriber": {
            "provider": "deepgram",
            "model": "nova-2",
            "language": "bg",
            "smartFormat": false,
            "keywords": [
              "<string>"
            ]
          },
          "model": {
            "messages": [
              {
                "content": "<string>",
                "role": "assistant"
              }
            ],
            "tools": [
              {
                "async": false,
                "messages": [
                  {
                    "type": "request-start",
                    "content": "<string>",
                    "conditions": [
                      {
                        "param": "<string>",
                        "value": {},
                        "operator": "eq"
                      }
                    ]
                  }
                ],
                "type": "transferCall",
                "destinations": [
                  {
                    "type": "assistant",
                    "assistantName": "<string>",
                    "message": "<string>",
                    "description": "<string>"
                  }
                ],
                "function": {
                  "name": "<string>",
                  "description": "<string>",
                  "parameters": {
                    "type": "object",
                    "properties": {},
                    "required": [
                      "<string>"
                    ]
                  }
                },
                "server": {
                  "url": "<string>",
                  "secret": "<string>"
                }
              }
            ],
            "toolIds": [
              "<string>"
            ],
            "provider": "openai",
            "model": "gpt-4o",
            "fallbackModels": [
              "gpt-4-0125-preview",
              "gpt-4-0613"
            ],
            "semanticCachingEnabled": true,
            "numFastTurns": 1,
            "temperature": 1,
            "knowledgeBase": {
              "provider": "canonical",
              "topK": 123,
              "fileIds": [
                "<string>"
              ]
            },
            "maxTokens": 525,
            "emotionRecognitionEnabled": true
          },
          "voice": {
            "inputPreprocessingEnabled": true,
            "inputMinCharacters": 10,
            "inputPunctuationBoundaries": [
              "。",
              "，",
              ".",
              "!",
              "?",
              ";",
              ")",
              "،",
              "۔",
              "।",
              "॥",
              "|",
              "||",
              ",",
              ":"
            ],
            "fillerInjectionEnabled": false,
            "provider": "azure",
            "voiceId": "andrew",
            "speed": 1.25
          },
          "firstMessageMode": "assistant-speaks-first",
          "recordingEnabled": true,
          "hipaaEnabled": false,
          "clientMessages": [
            "transcript",
            "hang",
            "tool-calls",
            "speech-update",
            "metadata",
            "conversation-update"
          ],
          "serverMessages": [
            "end-of-call-report",
            "status-update",
            "hang",
            "tool-calls"
          ],
          "silenceTimeoutSeconds": 30,
          "responseDelaySeconds": 0.4,
          "llmRequestDelaySeconds": 0.1,
          "numWordsToInterruptAssistant": 1,
          "maxDurationSeconds": 1800,
          "backgroundSound": "office",
          "backchannelingEnabled": true,
          "variableValues": {},
          "name": "<string>",
          "firstMessage": "<string>",
          "voicemailDetection": {
            "provider": "twilio",
            "voicemailDetectionTypes": [
              "machine_end_beep",
              "machine_end_silence"
            ],
            "enabled": true,
            "machineDetectionTimeout": 31,
            "machineDetectionSpeechThreshold": 3500,
            "machineDetectionSpeechEndThreshold": 2750,
            "machineDetectionSilenceTimeout": 6000
          },
          "voicemailMessage": "<string>",
          "endCallMessage": "<string>",
          "endCallPhrases": [
            "<string>"
          ],
          "metadata": {},
          "serverUrl": "<string>",
          "serverUrlSecret": "<string>",
          "analysisPlan": {
            "summaryPrompt": "<string>",
            "successEvaluationPrompt": "<string>",
            "successEvaluationRubric": "NumericScale",
            "structuredDataPrompt": "<string>",
            "structuredDataSchema": {
              "type": "string",
              "items": {},
              "properties": {},
              "description": "<string>",
              "required": [
                {}
              ]
            }
          }
        },
        "assistantDestinations": [
          {
            "type": "assistant",
            "assistantName": "<string>",
            "message": "<string>",
            "description": "<string>"
          }
        ]
      }
    ],
    "id": "<string>",
    "orgId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Retrieve your key from Dashboard.

Query Parameters

​
limit
number

This is the maximum number of items to return. Defaults to 100.

Required range: 0 <= x <= 1000
​
createdAtGt
string

This will return items where the createdAt is greater than the specified value.

​
createdAtLt
string

This will return items where the createdAt is less than the specified value.

​
createdAtGe
string

This will return items where the createdAt is greater than or equal to the specified value.

​
createdAtLe
string

This will return items where the createdAt is less than or equal to the specified value.

​
updatedAtGt
string

This will return items where the updatedAt is greater than the specified value.

​
updatedAtLt
string

This will return items where the updatedAt is less than the specified value.

​
updatedAtGe
string

This will return items where the updatedAt is greater than or equal to the specified value.

​
updatedAtLe
string

This will return items where the updatedAt is less than or equal to the specified value.

Response

200 - application/json

The response is of type object[].