Vapi Squads API is one of 15 APIs that Vapi publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
This API exposes 6 JSON Schema definitions.
Tagged areas include Squads. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 6 JSON Schemas.
This API exposes 5 operations across 2 paths, and defines 300 schemas. It is described by OpenAPI 3.0.0, at version 1.0.
Requests are made against a single base URL, https://api.vapi.ai.
5 operations
2 paths
300 schemas
1 DELETE2 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Vapi Squads API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (Bearer) (bearer).
By default, every request must be authenticated.
bearer— Retrieve your API Key from [Dashboard](dashboard.vapi.ai).
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Squads 5
Squads endpoints.
POST
/squad
Create Squad
GET
/squad
List Squads
GET
/squad/{id}
Get Squad
PATCH
/squad/{id}
Update Squad
DELETE
/squad/{id}
Delete Squad
Schemas 300
The contract defines 300 schemas that model the data the API accepts and returns. The most detailed are AssistantOverrides (33 properties), CreateAssistantDTO (31 properties), ArtifactPlan (17 properties), AssemblyAITranscriber (16 properties). Each schema is shown below with its type and property counts.
SpkiPemPublicKeyConfig
object
3 properties
2 required
CreateTransferCallToolDTO
object
4 properties
1 required
ToolParameter
object
2 properties
2 required
ToolCallHookAction
object
3 properties
1 required
SipTrunkOutboundAuthenticationPlan
object
3 properties
CreateCartesiaCredentialDTO
object
4 properties
2 required
CallHookAssistantSpeechInterrupted
object
2 properties
2 required
CustomTranscriber
object
3 properties
2 required
CreateAnthropicCredentialDTO
object
3 properties
2 required
CreateRunpodCredentialDTO
object
3 properties
2 required
OpenAIFunction
object
4 properties
1 required
SonioxContextGeneralItem
object
2 properties
2 required
FormatPlan
object
4 properties
SecurityFilterPlan
object
4 properties
GoogleVoicemailDetectionPlan
object
4 properties
1 required
LangfuseObservabilityPlan
object
6 properties
2 required
ElevenLabsTranscriber
object
8 properties
1 required
ToolMessageDelayed
object
5 properties
1 required
CreateEndCallToolDTO
object
3 properties
1 required
CreateSlackSendMessageToolDTO
object
3 properties
1 required
InflectionAIModel
object
10 properties
2 required
HandoffDestinationSquad
object
8 properties
1 required
CreateGoHighLevelCalendarAvailabilityToolDTO
object
3 properties
1 required
AssistantOverrides
object
33 properties
ElevenLabsPronunciationDictionaryLocator
object
2 properties
2 required
AnalysisPlan
object
6 properties
FallbackOpenAIVoice
object
7 properties
2 required
XaiModel
object
10 properties
2 required
ContextEngineeringPlanNone
object
1 property
1 required
CreateMakeCredentialDTO
object
5 properties
4 required
CreateDeepgramCredentialDTO
object
4 properties
2 required
GoogleModel
object
11 properties
2 required
FallbackCartesiaTranscriber
object
3 properties
1 required
WorkflowCustomModel
object
8 properties
3 required
CreateAnyscaleCredentialDTO
object
3 properties
2 required
FallbackNeuphonicVoice
object
7 properties
3 required
SesameVoice
object
6 properties
3 required
OpenAITranscriber
object
4 properties
2 required
MessageAddHookAction
object
3 properties
2 required
AssistantCustomEndpointingRule
object
4 properties
3 required
CreateDtmfToolDTO
object
4 properties
1 required
OpenAIMessage
object
2 properties
2 required
CreateQueryToolDTO
object
4 properties
1 required
CreateInflectionAICredentialDTO
object
3 properties
2 required
CreateGoogleSheetsRowAppendToolDTO
object
3 properties
1 required
SonioxTranscriber
object
9 properties
1 required
CreateCloudflareCredentialDTO
object
7 properties
1 required
CreateGoHighLevelMCPCredentialDTO
object
3 properties
2 required
RegexReplacement
object
4 properties
3 required
KeypadInputPlan
object
3 properties
FallbackRimeAIVoice
object
11 properties
2 required
GoogleRealtimeConfig
object
5 properties
PublicKeyEncryptionPlan
object
3 properties
3 required
CreateSonioxCredentialDTO
object
4 properties
2 required
FallbackDeepgramTranscriber
object
15 properties
1 required
CreateGoogleSheetsOAuth2AuthorizationCredentialDTO
object
3 properties
2 required
FallbackPlayHTVoice
object
12 properties
2 required
CartesiaVoice
object
10 properties
2 required
CreateAssistantDTO
object
31 properties
GcpKey
object
11 properties
11 required
CreateSipRequestToolDTO
object
6 properties
2 required
ToolCall
object
3 properties
3 required
GeminiMultimodalLiveSpeechConfig
object
1 property
1 required
FallbackSmallestAIVoice
object
6 properties
2 required
CreateCustomKnowledgeBaseDTO
object
2 properties
2 required
DeepgramVoice
object
7 properties
2 required
LMNTVoice
object
7 properties
2 required
FallbackTalkscriberTranscriber
object
3 properties
1 required
CreateGoHighLevelCalendarEventCreateToolDTO
object
3 properties
1 required
SystemMessage
object
4 properties
4 required
SipTrunkGateway
object
7 properties
1 required
VapiSmartEndpointingPlan
object
1 property
1 required
CreateTogetherAICredentialDTO
object
3 properties
2 required
GroqModel
object
10 properties
2 required
MonitorPlan
object
5 properties
CreateStructuredOutputDTO
object
9 properties
2 required
AssemblyAITranscriber
object
16 properties
1 required
AnyscaleModel
object
10 properties
2 required
VariableExtractionAlias
object
2 properties
2 required
ContextEngineeringPlanAll
object
1 property
1 required
FallbackLMNTVoice
object
6 properties
2 required
UpdateSquadDTO
object
3 properties
1 required
CreateVoicemailToolDTO
object
4 properties
1 required
CreatePerplexityAICredentialDTO
object
3 properties
2 required
SbcConfiguration
object
CustomerCustomEndpointingRule
object
4 properties
3 required
CreateGoogleCalendarOAuth2ClientCredentialDTO
object
2 properties
1 required
RegexOption
object
2 properties
2 required
BothCustomEndpointingRule
object
6 properties
4 required
ToolMessageStart
object
5 properties
1 required
FallbackXaiTranscriber
object
3 properties
1 required
AnthropicThinkingConfig
object
2 properties
2 required
SpeechmaticsTranscriber
object
13 properties
2 required
TransferFallbackPlan
object
2 properties
1 required
StartSpeakingPlan
object
5 properties
JsonSchema
object
9 properties
1 required
CustomEndpointingModelSmartEndpointingPlan
object
2 properties
1 required
TogetherAIModel
object
10 properties
2 required
CreateFunctionToolDTO
object
8 properties
1 required
FallbackElevenLabsTranscriber
object
7 properties
1 required
SecurityFilterBase
object
VoicemailDetectionBackoffPlan
object
3 properties
BackgroundSpeechDenoisingPlan
object
2 properties
CreateMcpToolDTO
object
6 properties
1 required
SmallestAIVoice
object
7 properties
2 required
FallbackGladiaTranscriber
object
15 properties
1 required
CreateGoHighLevelContactCreateToolDTO
object
3 properties
1 required
CreatePlayHTCredentialDTO
object
4 properties
3 required
CreateNeuphonicCredentialDTO
object
3 properties
2 required
BackoffPlan
object
4 properties
3 required
TavusVoice
object
11 properties
2 required
OpenAIVoice
object
8 properties
2 required
TavusConversationProperties
object
10 properties
CreateGoHighLevelContactGetToolDTO
object
3 properties
1 required
CreateGoHighLevelCredentialDTO
object
3 properties
2 required
CreateXAiCredentialDTO
object
3 properties
2 required
CreateEmailCredentialDTO
object
3 properties
2 required
BucketPlan
object
5 properties
1 required
McpToolMessages
object
2 properties
1 required
MinimaxVoice
object
14 properties
2 required
ToolMessage
object
5 properties
3 required
CreateHumeCredentialDTO
object
3 properties
2 required
CreateGcpCredentialDTO
object
6 properties
2 required
CreateCerebrasCredentialDTO
object
3 properties
2 required
StructuredDataPlan
object
4 properties
McpToolMetadata
object
1 property
FallbackSesameVoice
object
5 properties
3 required
ToolMessageComplete
object
6 properties
1 required
DeepInfraModel
object
10 properties
2 required
CreateTavusCredentialDTO
object
3 properties
2 required
SessionCreatedHook
object
3 properties
2 required
TranscriptionEndpointingPlan
object
3 properties
CartesiaExperimentalControls
object
2 properties
CreateTextEditorToolDTO
object
6 properties
3 required
FallbackXaiVoice
object
5 properties
2 required
TwilioVoicemailDetectionPlan
object
7 properties
1 required
Squad
object
7 properties
5 required
SquadMemberDTO
object
4 properties
KnowledgeBase
object
5 properties
4 required
ScorecardMetric
object
2 properties
2 required
MessageTarget
object
2 properties
OpenRouterModel
object
10 properties
2 required
CreateComputerToolDTO
object
9 properties
5 required
NeuphonicVoice
object
8 properties
3 required
CreateLmntCredentialDTO
object
3 properties
2 required
CartesiaTranscriber
object
4 properties
1 required
ToolMessageFailed
object
5 properties
1 required
CreateVonageCredentialDTO
object
4 properties
3 required
InworldVoice
object
9 properties
2 required
Condition
object
3 properties
3 required
CallHookCustomerSpeechInterrupted
object
2 properties
2 required
CreateMinimaxCredentialDTO
object
4 properties
3 required
AWSStsAuthenticationPlan
object
3 properties
2 required
ArtifactPlan
object
17 properties
TalkscriberTranscriber
object
4 properties
1 required
CreateWellSaidCredentialDTO
object
3 properties
2 required
TransferDestinationSip
object
7 properties
2 required
CreateSquadDTO
object
3 properties
1 required
CreateGoogleCalendarCheckAvailabilityToolDTO
object
3 properties
1 required
TransferPlan
object
12 properties
1 required
FallbackHumeVoice
object
7 properties
2 required
FallbackCartesiaVoice
object
9 properties
2 required
RecordingConsentPlanStayOnLine
object
5 properties
2 required
WorkflowOpenAIModel
object
4 properties
2 required
FallbackSonioxTranscriber
object
8 properties
1 required
CreateInworldCredentialDTO
object
3 properties
2 required
WorkflowAnthropicModel
object
5 properties
2 required
Oauth2AuthenticationSession
object
3 properties
AssistantMessage
object
6 properties
1 required
CreateLangfuseCredentialDTO
object
5 properties
4 required
CreateSpeechmaticsCredentialDTO
object
3 properties
2 required
XaiTranscriber
object
4 properties
1 required
CustomLLMModel
object
15 properties
3 required
GladiaTranscriber
object
16 properties
1 required
AzureBlobStorageBucketPlan
object
3 properties
2 required
CreateDeepSeekCredentialDTO
object
3 properties
2 required
PerplexityAIModel
object
10 properties
2 required
StopSpeakingPlan
object
5 properties
CreateCodeToolDTO
object
11 properties
2 required
CreateS3CredentialDTO
object
8 properties
6 required
FallbackSpeechmaticsTranscriber
object
12 properties
2 required
TransportConfigurationTwilio
object
4 properties
1 required
RecordingConsentPlanVerbal
object
6 properties
2 required
CustomVoice
object
6 properties
2 required
CreateSmsToolDTO
object
3 properties
1 required
CreateDeepInfraCredentialDTO
object
3 properties
2 required
StructuredDataMultiPlan
object
2 properties
2 required
CallHookFilter
object
3 properties
3 required
CallHookCallEnding
object
3 properties
2 required
BearerAuthenticationPlan
object
4 properties
2 required
FallbackWellSaidVoice
object
7 properties
2 required
VariableExtractionPlan
object
2 properties
FallbackOpenAITranscriber
object
3 properties
2 required
CreateSlackWebhookCredentialDTO
object
3 properties
2 required
HandoffDestinationDynamic
object
3 properties
1 required
WellSaidVoice
object
8 properties
2 required
OpenAIModel
object
14 properties
2 required
SmartDenoisingPlan
object
1 property
CreateRimeAICredentialDTO
object
3 properties
2 required
CreateByoSipTrunkCredentialDTO
object
8 properties
1 required
CreateGoogleCalendarCreateEventToolDTO
object
3 properties
1 required
CartesiaGenerationConfigExperimental
object
1 property
VapiVoice
object
7 properties
2 required
ContextEngineeringPlanUserAndAssistantMessages
object
1 property
1 required
CreateElevenLabsCredentialDTO
object
3 properties
2 required
CreateGladiaCredentialDTO
object
3 properties
2 required
CreateSlackOAuth2AuthorizationCredentialDTO
object
3 properties
2 required
GladiaCustomVocabularyConfigDTO
object
2 properties
1 required
FallbackCustomVoice
object
5 properties
2 required
RegexCondition
object
4 properties
2 required
FallbackAzureVoice
object
5 properties
2 required
HMACAuthenticationPlan
object
11 properties
3 required
OpenAIVoicemailDetectionPlan
object
4 properties
1 required
CreateHandoffToolDTO
object
6 properties
1 required
ComplianceOverride
object
1 property
LiquidCondition
object
2 properties
2 required
FallbackTavusVoice
object
10 properties
2 required
CreateCustomCredentialDTO
object
4 properties
2 required
CallHookCustomerSpeechTimeout
object
4 properties
2 required
CerebrasModel
object
10 properties
2 required
TransferDestinationAssistant
object
5 properties
2 required
AzureVoice
object
6 properties
2 required
AzureSpeechTranscriber
object
6 properties
1 required
WorkflowGoogleModel
object
4 properties
2 required
FallbackAssemblyAITranscriber
object
15 properties
1 required
Server
object
7 properties
RimeAIVoice
object
12 properties
2 required
CreateGoogleCredentialDTO
object
3 properties
2 required
WorkflowAnthropicBedrockModel
object
5 properties
2 required
GladiaVocabularyItemDTO
object
4 properties
1 required
SpeechmaticsCustomVocabularyItem
object
2 properties
1 required
CreateGroqCredentialDTO
object
3 properties
2 required
ContextEngineeringPlanLastNMessages
object
2 properties
2 required
HumeVoice
object
8 properties
2 required
OAuth2AuthenticationPlan
object
5 properties
4 required
TransferDestinationNumber
object
8 properties
2 required
HandoffDestinationAssistant
object
8 properties
1 required
CreateGoogleCalendarOAuth2AuthorizationCredentialDTO
object
3 properties
2 required
CreateAzureCredentialDTO
object
7 properties
2 required
UserMessage
object
11 properties
5 required
XaiVoice
object
6 properties
2 required
DeepgramTranscriber
object
16 properties
1 required
CreateTwilioCredentialDTO
object
6 properties
2 required
GeminiMultimodalLivePrebuiltVoiceConfig
object
1 property
1 required
GroupCondition
object
3 properties
3 required
CreateAzureOpenAICredentialDTO
object
7 properties
5 required
OpenAIFunctionParameters
object
3 properties
2 required
CustomerSpeechTimeoutOptions
object
3 properties
1 required
FallbackAzureSpeechTranscriber
object
5 properties
1 required
CreateWebhookCredentialDTO
object
3 properties
2 required
CreateBashToolDTO
object
6 properties
3 required
TextContent
object
3 properties
3 required
CreateOpenAICredentialDTO
object
3 properties
2 required
DeepSeekModel
object
10 properties
2 required
FallbackGoogleTranscriber
object
3 properties
1 required
CompliancePlan
object
4 properties
FallbackVapiVoice
object
6 properties
2 required
CreateCustomLLMCredentialDTO
object
4 properties
2 required
CreateAssemblyAICredentialDTO
object
3 properties
2 required
CartesiaGenerationConfig
object
3 properties
FallbackDeepgramVoice
object
6 properties
2 required
VapiVoicemailDetectionPlan
object
4 properties
1 required
CloudflareR2BucketPlan
object
5 properties
1 required
ChunkPlan
object
4 properties
CodeToolEnvironmentVariable
object
2 properties
2 required
AnthropicBedrockModel
object
11 properties
2 required
CustomMessage
object
3 properties
1 required
FallbackElevenLabsVoice
object
15 properties
2 required
SayHookAction
object
3 properties
1 required
GeminiMultimodalLiveVoiceConfig
object
1 property
1 required
DeveloperMessage
object
4 properties
2 required
FallbackInworldVoice
object
8 properties
2 required
TranscriptPlan
object
3 properties
FallbackTranscriberPlan
object
1 property
CreateOpenRouterCredentialDTO
object
3 properties
2 required
SuccessEvaluationPlan
object
4 properties
SipTrunkOutboundSipRegisterPlan
object
3 properties
CreateScorecardDTO
object
4 properties
1 required
ToolRejectionPlan
object
1 property
CreateApiRequestToolDTO
object
15 properties
3 required
AnthropicModel
object
11 properties
2 required
CreateSupabaseCredentialDTO
object
4 properties
1 required
GoogleTranscriber
object
4 properties
1 required
AWSIAMCredentialsAuthenticationPlan
object
3 properties
3 required
ContextEngineeringPlanPreviousAssistantMessages
object
1 property
1 required
FourierDenoisingPlan
object
6 properties
PlayHTVoice
object
13 properties
2 required
LivekitSmartEndpointingPlan
object
2 properties
1 required
CreateSmallestAICredentialDTO
object
3 properties
2 required
SupabaseBucketPlan
object
6 properties
5 required
FallbackPlan
object
1 property
1 required
CreateAnthropicBedrockCredentialDTO
object
4 properties
3 required
MinimaxLLMModel
object
10 properties
2 required
ExactReplacement
object
4 properties
3 required
ElevenLabsVoice
object
16 properties
2 required
VapiPronunciationDictionaryLocator
object
2 properties
1 required
SummaryPlan
object
3 properties
ToolCallFunction
object
2 properties
2 required
CreateMistralCredentialDTO
object
3 properties
2 required
FallbackCustomTranscriber
object
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Vapi 12
Other APIs Vapi publishes across the network.
Vapi Analytics API
Vapi Assistants API
Vapi Calls API
Vapi Campaigns API
Vapi Chats API
Vapi Eval API
Vapi Files API
Vapi Insight API
Vapi Observability/Scorecard API
Vapi Phone Numbers API
Vapi Provider Resources API
Vapi Sessions API
#Squads
Where this information came from
This is an independent, third-party profile of Vapi Squads API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.