-
Notifications
You must be signed in to change notification settings - Fork 77
Expand file tree
/
Copy pathdocs.yml
More file actions
1116 lines (1091 loc) · 41.7 KB
/
docs.yml
File metadata and controls
1116 lines (1091 loc) · 41.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# yaml-language-server: $schema=https://schema.buildwithfern.dev/docs-yml.json
instances:
- url: https://vapi.docs.buildwithfern.com
custom-domain: docs.vapi.ai
edit-this-page:
github:
owner: VapiAI
repo: docs
branch: main
title: Vapi
favicon: static/images/favicon.ico
logo:
light: static/images/logo/logo-light.svg
dark: static/images/logo/logo-dark.svg
href: /
height: 22
colors:
accentPrimary:
light: "#12A594"
dark: "#12A594"
background:
light: "#FFFFFF"
dark: "#0E0E13"
header-background:
light: "#FFFFFF"
dark: "#0E0E13"
experimental:
openapi-parser-v3: true
mdx-components:
- snippets
settings:
http-snippets: false
dark-mode-code: true
css: assets/styles.css
js:
- path: ./assets/close-playground.js
- path: ./custom.js
navbar-links:
- type: minimal
text: Website
href: https://vapi.ai/
- type: minimal
text: Status
href: https://status.vapi.ai/
- type: outlined
text: Support
rightIcon: fa-solid fa-headset
href: /support
- type: filled
text: Dashboard
rightIcon: fa-solid fa-chevron-right
href: https://dashboard.vapi.ai/
rounded: true
footer-links:
github: https://github.com/vapiai
twitter: https://twitter.com/vapi_ai
discord: https://discord.gg/pUFNcf2WmH
website: https://vapi.ai/
linkedin: https://www.linkedin.com/company/vapi-ai
tabs:
api-reference:
slug: api-reference
icon: terminal
display-name: API Reference
documentation:
display-name: Documentation
icon: book
slug: documentation
sdks:
display-name: SDKs
icon: code
slug: sdks
cli:
display-name: CLI (new)
icon: fa-light fa-square-terminal
slug: cli
changelog:
display-name: Changelog
slug: changelog
changelog: ./changelog
icon: history
mcp:
display-name: MCP
icon: fa-light fa-code-branch
slug: mcp
layout:
tabs-placement: header
searchbar-placement: header
header-height: 80px
page-width: full
content-width: 55rem
sidebar-width: 300px
analytics:
posthog:
api-key: ${POSTHOG_PROJECT_API_KEY}
endpoint: https://us.i.posthog.com
ga4:
measurement-id: G-BVPB7XB842
navigation:
- tab: documentation
layout:
- section: Get started
contents:
- page: Introduction
icon: fa-light fa-info-circle
path: quickstart/introduction.mdx
- page: Phone calls
icon: fa-solid fa-phone
path: quickstart/phone.mdx
- page: Web calls
icon: fa-light fa-browser
path: quickstart/web.mdx
- page: Vapi Guides
icon: fa-light fa-book-open
path: guides.mdx
- page: Composer
icon: fa-light fa-wand-magic-sparkles
path: composer.mdx
availability: pre-release
- page: CLI quickstart
icon: fa-light fa-terminal
path: cli/overview.mdx
- section: Assistants
contents:
# Removed dedicated introduction; Quickstart is the landing
- page: Quickstart
path: assistants/quickstart.mdx
icon: fa-light fa-rocket
- section: Core concepts
icon: fa-light fa-brain
contents:
- page: Transient vs permanent configurations
path: assistants/concepts/transient-vs-permanent-configurations.mdx
- section: Conversation behavior
icon: fa-light fa-comments
contents:
- page: Variables
path: assistants/dynamic-variables.mdx
- page: Multilingual support
path: customization/multilingual.mdx
- page: Personalization with user information
path: assistants/personalization.mdx
- page: Voice formatting plan
path: assistants/voice-formatting-plan.mdx
- page: Flush syntax
path: assistants/flush-syntax.mdx
- page: Background messages
path: assistants/background-messages.mdx
- page: Idle messages
path: assistants/idle-messages.mdx
- page: Assistant hooks
path: assistants/assistant-hooks.mdx
- page: Background speech denoising
path: assistants/background-speech-denoising.mdx
- page: Pronunciation dictionaries
path: assistants/pronunciation-dictionaries.mdx
- section: Model configurations
icon: fa-light fa-waveform-lines
contents:
- page: Speech configuration
path: customization/speech-configuration.mdx
- page: Voice pipeline configuration
path: customization/voice-pipeline-configuration.mdx
- page: Voice fallback configuration
path: voice-fallback-plan.mdx
- page: Transcriber fallback configuration
path: customization/transcriber-fallback-plan.mdx
- page: OpenAI realtime speech-to-speech
path: openai-realtime.mdx
- page: Provider keys
path: customization/provider-keys.mdx
- section: Tools
path: tools/introduction.mdx
collapsed: true
icon: fa-light fa-toolbox
contents:
- page: Built-in call tools
path: tools/default-tools.mdx
icon: fa-light fa-gear
- page: Voicemail tool
path: tools/voicemail-tool.mdx
icon: fa-light fa-voicemail
- page: Custom tools
path: tools/custom-tools.mdx
icon: fa-light fa-screwdriver-wrench
- page: Code tool
path: tools/code-tool.mdx
icon: fa-light fa-code
- page: Client-side tools (Web SDK)
path: tools/client-side-websdk.mdx
icon: fa-light fa-browser
- page: Tool rejection plan
path: tools/tool-rejection-plan.mdx
icon: fa-light fa-shield-xmark
- page: Static variables and aliases
path: tools/static-variables-and-aliases.mdx
icon: fa-light fa-arrow-right-arrow-left
- page: Custom tools troubleshooting
path: tools/custom-tools-troubleshooting.mdx
icon: fa-light fa-wrench
- link: Handoff tool
href: /squads/handoff
icon: fa-light fa-hand-holding-hand
- section: External tools
icon: fa-light fa-cubes
contents:
- page: Google Calendar
path: tools/google-calendar.mdx
icon: fa-light fa-calendar-days
- page: Google Sheets
path: tools/google-sheets.mdx
icon: fa-brands fa-google-drive
- page: Slack
path: tools/slack.mdx
icon: fa-brands fa-slack
- page: GoHighLevel
path: tools/go-high-level.mdx
icon: fa-light fa-arrow-up
- section: Knowledge retrieval
path: knowledge-base/knowledge-base.mdx
icon: fa-light fa-book
contents:
- page: Query tool
path: knowledge-base/using-query-tool.mdx
icon: fa-light fa-magnifying-glass
- page: Custom knowledge base
path: knowledge-base/custom-knowledge-base.mdx
icon: fa-light fa-server
- page: Migrating from Trieve
path: knowledge-base/migrating-from-trieve.mdx
icon: fa-light fa-triangle-exclamation
- page: Argument encryption
path: tools/arguments-encryption.mdx
icon: fa-light fa-lock
- page: Custom keywords
path: customization/custom-keywords.mdx
icon: fa-light fa-bullseye
- section: Custom voices
path: customization/custom-voices/custom-voice.mdx
icon: fa-light fa-user
contents:
- page: Elevenlabs
path: customization/custom-voices/elevenlabs.mdx
- page: PlayHT
path: customization/custom-voices/playht.mdx
- page: Custom transcriber
path: customization/custom-transcriber.mdx
icon: fa-light fa-microphone
- page: Custom TTS
path: customization/custom-tts.mdx
icon: fa-light fa-volume-high
- section: Custom LLMs
icon: fa-light fa-brain-circuit
contents:
- page: Fine-tuned OpenAI models
path: customization/custom-llm/fine-tuned-openai-models.mdx
- page: Bring your own server
path: customization/custom-llm/using-your-server.mdx
- page: Tool calling integration
path: customization/custom-llm/tool-calling-integration.mdx
- section: Examples
icon: fa-light fa-code
contents:
- page: Appointment scheduling
path: assistants/examples/appointment-scheduling.mdx
icon: fa-light fa-calendar-check
- page: Lead qualification
path: assistants/examples/lead-qualification.mdx
icon: fa-light fa-phone
- page: Inbound support
path: assistants/examples/inbound-support.mdx
icon: fa-light fa-phone-volume
- page: Voice widget
path: assistants/examples/voice-widget.mdx
icon: fa-light fa-window-maximize
- page: Documentation agent
path: assistants/examples/docs-agent.mdx
icon: fa-light fa-microphone
- page: Support escalation
path: assistants/examples/support-escalation.mdx
icon: fa-light fa-headset
- page: Multilingual agent
path: assistants/examples/multilingual-agent.mdx
icon: fa-light fa-globe
- section: Observability
contents:
- section: Evals
icon: fa-light fa-clipboard-check
contents:
- page: Quickstart
path: observability/evals-quickstart.mdx
icon: fa-light fa-clipboard-check
- page: Advanced
path: observability/evals-advanced.mdx
icon: fa-light fa-clipboard-check
- section: Simulations
icon: fa-light fa-flask-vial
availability: pre-release
contents:
- page: Quickstart
path: observability/simulations-quickstart.mdx
icon: fa-light fa-rocket
- page: Advanced
path: observability/simulations-advanced.mdx
icon: fa-light fa-flask-vial
- page: Boards
path: observability/boards-quickstart.mdx
icon: fa-light fa-chart-line
- section: Structured outputs
icon: fa-light fa-database
contents:
- page: Quickstart
path: assistants/structured-outputs-quickstart.mdx
icon: fa-light fa-rocket
- page: Examples
path: assistants/structured-outputs-examples.mdx
icon: fa-light fa-code
- section: Scorecard
icon: fa-light fa-star
contents:
- page: Quickstart
path: observability/scorecard-quickstart.mdx
icon: fa-light fa-rocket
- section: Squads
contents:
- page: Quickstart
path: squads-example.mdx
icon: fa-light fa-bolt-lightning
- page: Overview
path: squads.mdx
icon: fa-light fa-eye
- page: Handoff tool
path: squads/handoff.mdx
icon: fa-light fa-hand-holding-hand
- page: Splitting best practices
path: squads/splitting-best-practices.mdx
icon: fa-light fa-scissors
- section: Examples
icon: fa-light fa-code
contents:
- page: Clinic triage & scheduling (handoff tool)
path: squads/examples/clinic-triage-scheduling-handoff-tool.mdx
- page: Clinic triage & scheduling
path: squads/examples/clinic-triage-scheduling.mdx
- page: E-commerce order management
path: squads/examples/ecommerce-order-management.mdx
- page: Property management routing
path: squads/examples/property-management.mdx
- page: Multilingual support
path: squads/examples/multilingual-support.mdx
- page: Silent handoffs
path: squads/silent-handoffs.mdx
icon: fa-light fa-arrow-right-arrow-left
- section: Best practices
contents:
- page: Prompting guide
path: prompting-guide.mdx
icon: fa-light fa-pen-to-square
- page: Debugging voice agents
path: debugging.mdx
icon: fa-light fa-bug
- page: Enterprise environments (DEV/UAT/PROD)
path: enterprise/dev-uat-prod.mdx
icon: fa-light fa-diagram-project
- page: IVR navigation
path: ivr-navigation.mdx
icon: fa-light fa-phone-office
- section: Testing
collapsed: true
icon: fa-light fa-clipboard-check
contents:
- page: Test suites
path: test/test-suites.mdx
icon: fa-light fa-check
- page: Chat testing
path: test/chat-testing.mdx
icon: fa-light fa-message
- page: Voice testing
path: test/voice-testing.mdx
icon: fa-light fa-volume-high
- section: Phone numbers
contents:
- page: Free Vapi number
path: phone-numbers/free-telephony.mdx
icon: fa-light fa-gift
- page: Inbound SMS
path: phone-numbers/inbound-sms.mdx
icon: fa-light fa-message
- section: Telephony integrations
icon: fa-light fa-link
contents:
- page: Twilio
path: phone-numbers/import-twilio.mdx
- page: Telnyx
path: phone-numbers/telnyx.mdx
- section: SIP integration
icon: fa-light fa-sitemap
contents:
- page: SIP telephony
path: advanced/sip/sip.mdx
- page: SIP trunking
path: advanced/sip/sip-trunk.mdx
- page: Networking and firewall
path: advanced/sip/sip-networking.mdx
- section: Providers
contents:
- page: Twilio
path: advanced/sip/sip-twilio.mdx
- page: Telnyx
path: advanced/sip/sip-telnyx.mdx
- page: Zadarma
path: advanced/sip/sip-zadarma.mdx
- page: Plivo
path: advanced/sip/sip-plivo.mdx
- page: Troubleshoot SIP trunk credential errors
path: advanced/sip/troubleshoot-sip-trunk-credential-errors.mdx
- page: Phone Number Hooks
path: phone-numbers/phone-number-hooks.mdx
icon: fa-light fa-webhook
- section: Calls
path: phone-calling.mdx
contents:
- section: Place calls
icon: fa-light fa-phone-arrow-up-right
contents:
- page: Outbound calls
path: calls/call-outbound.mdx
- page: WebSocket transport
path: calls/websocket-transport.mdx
- section: In-call control
icon: fa-light fa-sliders
contents:
- page: Real-time call control
path: calls/call-features.mdx
- page: Customer join timeout
path: calls/customer-join-timeout.mdx
- page: Voicemail detection
path: calls/voicemail-detection.mdx
- section: Transfer calls
icon: fa-light fa-phone-arrow-right
contents:
- page: Call forwarding
path: call-forwarding.mdx
- page: Assistant-based warm transfer
path: calls/assistant-based-warm-transfer.mdx
- page: Dynamic call transfers
path: calls/call-dynamic-transfers.mdx
- page: On-hold specialist transfer
path: calls/call-handling-with-vapi-and-twilio.mdx
- page: Debug forwarding drops
path: calls/troubleshoot-call-forwarding-drops.mdx
icon: fa-light fa-bug
- page: Call queue management
path: calls/call-queue-management.mdx
icon: fa-light fa-phone-office
- page: Call concurrency
path: calls/call-concurrency.mdx
icon: fa-light fa-gauge-high
- page: Call end reasons
path: calls/call-ended-reason.mdx
icon: fa-light fa-phone-hangup
- section: Call insights
icon: fa-light fa-chart-simple
contents:
- page: Call analysis
path: assistants/call-analysis.mdx
icon: fa-light fa-magnifying-glass-chart
- page: Call recording
path: assistants/call-recording.mdx
icon: fa-light fa-circle-dot
# Squads moved to top-level section
- section: Outbound Campaigns
contents:
- page: Quickstart
path: outbound-campaigns/quickstart.mdx
icon: fa-light fa-rocket
- page: Overview
path: outbound-campaigns/overview.mdx
icon: fa-light fa-eye
- section: Chat
contents:
- page: Quickstart
path: chat/quickstart.mdx
icon: fa-light fa-bolt-lightning
- page: Streaming
path: chat/streaming.mdx
icon: fa-light fa-stream
- page: Non-streaming
path: chat/non-streaming.mdx
icon: fa-light fa-message
- page: OpenAI compatibility
path: chat/openai-compatibility.mdx
icon: fa-light fa-puzzle-piece
- page: Session management
path: chat/session-management.mdx
icon: fa-light fa-layer-group
- page: Variable substitution
path: chat/variable-substitution.mdx
icon: fa-light fa-brackets-curly
- page: SMS chat
path: chat/sms-chat.mdx
icon: fa-light fa-comment-sms
- page: Web widget
path: chat/web-widget.mdx
icon: fa-light fa-window-maximize
- section: Webhooks
collapsed: true
icon: fa-light fa-webhook
path: server-url.mdx
contents:
- page: Setting server URLs
path: server-url/setting-server-urls.mdx
- page: Server events
path: server-url/events.mdx
- page: Spam call rejection
path: server-url/spam-call-rejection.mdx
- page: Developing locally
path: server-url/developing-locally.mdx
- page: Server authentication
path: server-url/server-authentication.mdx
- section: Workflows
contents:
- page: Quickstart
path: workflows/quickstart.mdx
icon: fa-light fa-rocket
- page: Overview
path: workflows/overview.mdx
icon: fa-light fa-eye
- section: Examples
icon: fa-light fa-code
contents:
- page: Appointment scheduling
path: workflows/examples/appointment-scheduling.mdx
icon: fa-light fa-calendar-check
- page: Lead qualification
path: workflows/examples/lead-qualification.mdx
icon: fa-light fa-money-bill-wave
- page: Medical triage
path: workflows/examples/clinic-triage-scheduling.mdx
icon: fa-light fa-stethoscope
- page: Order management
path: workflows/examples/ecommerce-order-management.mdx
icon: fa-light fa-shopping-cart
- page: Property management
path: workflows/examples/property-management.mdx
icon: fa-light fa-building
- page: Multilingual support
path: workflows/examples/multilingual-support.mdx
icon: fa-light fa-globe
- section: Resources
collapsed: false
contents:
- page: FAQ
path: faq.mdx
icon: fa-light fa-question
- section: How Vapi works
icon: fa-light fa-diagram-project
contents:
- page: Core models
path: quickstart.mdx
icon: fa-light fa-microchip-ai
- page: Orchestration models
icon: fa-light fa-network-wired
path: how-vapi-works.mdx
- section: Integrations
collapsed: true
icon: fa-light fa-link
contents:
- section: Voices (Text-to-speech)
icon: fa-light fa-waveform-lines
contents:
- section: Vapi Voices
path: providers/voice/vapi-voices.mdx
contents:
- page: Legacy migration
path: providers/voice/vapi-voices/legacy-migration.mdx
icon: fa-light fa-triangle-exclamation
- page: ElevenLabs
path: providers/voice/elevenlabs.mdx
- page: PlayHT
path: providers/voice/playht.mdx
- page: Azure
path: providers/voice/azure.mdx
- page: OpenAI
path: providers/voice/openai.mdx
- page: Cartesia
path: providers/voice/cartesia.mdx
- page: LMNT
path: providers/voice/imnt.mdx
- page: RimeAI
path: providers/voice/rimeai.mdx
- page: Deepgram
path: providers/voice/deepgram.mdx
- page: Inworld
path: providers/voice/inworld.mdx
- section: Large language models
icon: fa-light fa-brain-circuit
contents:
- page: OpenAI
path: providers/model/openai.mdx
- page: Azure OpenAI
path: providers/model/azure-openai.mdx
- page: Anthropic Bedrock
path: providers/model/anthropic-bedrock.mdx
- page: Gemini
path: providers/model/gemini.mdx
- page: Groq
path: providers/model/groq.mdx
- page: DeepInfra
path: providers/model/deepinfra.mdx
- page: Perplexity
path: providers/model/perplexity.mdx
- page: TogetherAI
path: providers/model/togetherai.mdx
- page: OpenRouter
path: providers/model/openrouter.mdx
- section: Transcribers (Speech-to-text)
icon: fa-light fa-microphone
contents:
- page: Deepgram
path: providers/transcriber/deepgram.mdx
- page: Google
path: providers/transcriber/google.mdx
- page: Gladia
path: providers/transcriber/gladia.mdx
- page: Speechmatics
path: providers/transcriber/speechmatics.mdx
- page: Talkscriber
path: providers/transcriber/talkscriber.mdx
- page: AssemblyAI
path: providers/transcriber/assembly-ai.mdx
- section: Cloud storage
icon: fa-light fa-cloud-arrow-up
contents:
- page: AWS S3
path: providers/cloud/s3.mdx
icon: fa-brands fa-aws
- page: GCP Cloud Storage
path: providers/cloud/gcp.mdx
icon: fa-brands fa-google
- page: Cloudflare R2
path: providers/cloud/cloudflare.mdx
icon: fa-brands fa-cloudflare
- page: Supabase
path: providers/cloud/supabase.mdx
icon: fa-light fa-table
- section: Observability
icon: fa-light fa-magnifying-glass-chart
contents:
- page: Langfuse
path: providers/observability/langfuse.mdx
- section: Ecosystem
icon: fa-light fa-boxes-stacked
contents:
- page: Voiceflow
path: providers/voiceflow.mdx
- page: ChatDash
path: providers/chat-dash.mdx
- page: Vapify
path: providers/vapify.mdx
- page: Voicerr AI
path: providers/voicerr.mdx
- page: VoiceAIWrapper
path: providers/voiceaiwrapper.mdx
- page: Sympana Connector
path: providers/sympana-connector.mdx
icon: fa-light fa-link
- section: Community
collapsed: true
icon: fa-light fa-users
contents:
- link: Videos
icon: fa-light fa-video
href: https://content.vapi.ai/
- link: Expert Directory
icon: fa-light fa-book-user
href: https://vapi.ai/library
- link: Discord
href: https://discord.com/invite/pUFNcf2WmH
icon: fa-brands fa-discord
- section: Support
icon: fa-light fa-circle-info
path: support.mdx
collapsed: true
contents:
- page: How to Report Issues
path: issue-reporting.mdx
icon: fa-light fa-bug
- page: Enterprise
path: enterprise/plans.mdx
icon: fa-light fa-building-shield
- page: Glossary
path: glossary.mdx
icon: fa-light fa-book-open
- page: RSS feed
path: rss-feed.mdx
icon: fa-light fa-rss
- section: Security and privacy
icon: fa-light fa-shield-check
collapsed: true
contents:
- page: Data flow
path: security-and-privacy/data-flow.mdx
- page: JWT authentication
path: customization/jwt-authentication.mdx
- page: Recording consent plan
path: security-and-privacy/recording-consent-plan.mdx
- page: GDPR compliance
path: security-and-privacy/GDPR.mdx
- page: HIPAA compliance
path: security-and-privacy/hipaa.mdx
- page: PCI compliance
path: security-and-privacy/PCI.mdx
- page: Proxy server guide
path: security-and-privacy/proxy-server.mdx
- page: Static IP addresses
path: security-and-privacy/static-ip-addresses.mdx
- link: SOC-2 Compliance
href: https://security.vapi.ai/
- section: Legal
collapsed: true
icon: fa-light fa-user-shield
contents:
- page: TCPA consent guidelines
path: tcpa-consent.mdx
- link: Privacy policy
href: https://vapi.ai/privacy
- link: Terms of service
href: https://vapi.ai/terms-of-service
- tab: api-reference
layout:
- api: API reference
api-name: api
flattened: true
skip-slug: true
paginated: true
snippets:
typescript: "@vapi/server-sdk"
python: vapi_server_sdk
go: https://github.com/VapiAI/server-sdk-go
- api: Webhooks
api-name: webhooks
paginated: true
- section: ""
contents:
- link: Swagger
href: https://api.vapi.ai/api
- link: OpenAPI
href: https://api.vapi.ai/api-json
- tab: mcp
layout:
- section: MCP
contents:
- page: MCP client
path: tools/mcp.mdx
icon: fa-light fa-network-wired
- page: MCP server
path: sdk/mcp-server.mdx
icon: fa-light fa-server
- tab: sdks
layout:
- section: Client SDKs
contents:
- link: Web SDK
href: https://github.com/VapiAI/web
icon: fa-brands fa-js
- link: iOS
href: https://github.com/VapiAI/ios
icon: fa-brands fa-apple
- link: Flutter
href: https://github.com/VapiAI/flutter
icon: fa-light fa-mobile
- link: React Native
href: https://github.com/VapiAI/react-native
icon: fa-brands fa-react
- link: Python
href: https://github.com/VapiAI/python
icon: fa-brands fa-python
- section: Server SDKs
contents:
- link: TypeScript
href: https://github.com/VapiAI/server-sdk-typescript
icon: fa-brands fa-js
- link: Python
href: https://github.com/VapiAI/server-sdk-python
icon: fa-brands fa-python
- link: Java
href: https://github.com/VapiAI/server-sdk-java
icon: fa-brands fa-java
- link: Ruby
href: https://github.com/VapiAI/server-sdk-ruby
icon: fa-light fa-gem
- link: C#
href: https://github.com/VapiAI/server-sdk-csharp
icon: fa-light fa-brackets-curly
- link: Go
href: https://github.com/VapiAI/server-sdk-go
icon: fa-brands fa-golang
- page: Ecosystem
path: resources.mdx
icon: fa-light fa-boxes-stacked
- tab: cli
layout:
- section: Getting Started
contents:
- page: Overview
path: cli/overview.mdx
icon: fa-light fa-rocket
- section: Core Features
contents:
- page: Project Integration
path: cli/project-integration.mdx
icon: fa-light fa-folder-plus
- page: MCP Integration
path: cli/mcp-integration.mdx
icon: fa-light fa-brain-circuit
- page: Webhook Testing
path: cli/webhook-testing.mdx
icon: fa-light fa-webhook
- page: Authentication
path: cli/authentication.mdx
icon: fa-light fa-key
- section: Resources
contents:
- link: GitHub Repository
href: https://github.com/VapiAI/cli
icon: fa-brands fa-github
- link: Report Issues
href: https://github.com/VapiAI/cli/issues
icon: fa-light fa-bug
- tab: changelog
redirects:
- source: /developer-documentation
destination: /introduction
- source: /documentation/general/changelog
destination: /changelog
- source: /api-reference/assistants/create-assistant
destination: /api-reference/assistants/create
- source: /api-reference/assistants/get-assistant
destination: /api-reference/assistants/get
- source: /api-reference/assistants/list-assistants
destination: /api-reference/assistants/list
- source: /api-reference/assistants/update-assistant
destination: /api-reference/assistants/update
- source: /api-reference/assistants/delete-assistant
destination: /api-reference/assistants/delete
- source: /api-reference/calls/create-call
destination: /api-reference/calls/create
- source: /api-reference/calls/create-phone-call
destination: /api-reference/calls/create
- source: /api-reference/calls/get-call
destination: /api-reference/calls/get
- source: /api-reference/calls/list-calls
destination: /api-reference/calls/list
- source: /api-reference/calls/update-call
destination: /api-reference/calls/update
- source: /api-reference/calls/delete-call-data
destination: /api-reference/calls/delete
- source: /api-reference/phone-numbers/create-phone-number
destination: /api-reference/phone-numbers/create
- source: /api-reference/phone-numbers/get-phone-number
destination: /api-reference/phone-numbers/get
- source: /api-reference/phone-numbers/list-phone-numbers
destination: /api-reference/phone-numbers/list
- source: /api-reference/phone-numbers/update-phone-number
destination: /api-reference/phone-numbers/update
- source: /api-reference/phone-numbers/delete-phone-number
destination: /api-reference/phone-numbers/delete
- source: /api-reference/files/upload-file
destination: /api-reference/files/upload
- source: /api-reference/files/get-file
destination: /api-reference/files/get
- source: /api-reference/files/list-files
destination: /api-reference/files/list
- source: /api-reference/files/update-file
destination: /api-reference/files/update
- source: /api-reference/files/delete-file
destination: /api-reference/files/delete
- source: /api-reference/squads/create-squad
destination: /api-reference/squads/create
- source: /api-reference/squads/get-squad
destination: /api-reference/squads/get
- source: /api-reference/squads/list-squads
destination: /api-reference/squads/list
- source: /api-reference/squads/update-squad
destination: /api-reference/squads/update
- source: /api-reference/squads/delete-squad
destination: /api-reference/squads/delete
- source: /api-reference/tools/create-tool
destination: /api-reference/tools/create
- source: /api-reference/tools/get-tool
destination: /api-reference/tools/get
- source: /api-reference/tools/list-tools
destination: /api-reference/tools/list
- source: /api-reference/tools/update-tool
destination: /api-reference/tools/update
- source: /api-reference/tools/delete-tool
destination: /api-reference/tools/delete
- source: /api-reference/analytics/create-analytics-queries
destination: /api-reference/analytics/get
- source: /api-reference/messages/server-message
destination: /api-reference/webhooks/server-message
- source: /api-reference/messages/server-message-response
destination: /api-reference/webhooks/server-message
- source: /api-reference/messages/client-message
destination: /api-reference/webhooks/client-message
- source: /api-reference/messages/client-inbound-message
destination: /api-reference/webhooks/client-message
- source: "/api-reference/phone-numbers/import-twilio-number"
destination: "/api-reference/phone-numbers/create-phone-number"
- source: /community/expert-directory
destination: https://vapi.ai/library
- source: "api-reference/calls/create-call"
destination: "https://api.vapi.ai/api#/Calls/CallController_create"
- source: "/getting_started"
destination: "/quickstart/phone"
- source: "/dashboard"
destination: "/quickstart/phone"
- source: "/quickstart/dashboard"
destination: "/quickstart/phone"
- source: "/provider_keys"
destination: "/assistants/provider-keys"
- source: "/provider-keys"
destination: "/assistants/provider-keys"
- source: "/custom_llm"
destination: "/assistants/custom-llm"
- source: "/custom-llm"
destination: "/assistants/custom-llm"
- source: "/custom_voice"
destination: "/assistants/custom-voice"
- source: "/custom-voice"
destination: "/assistants/custom-voice"
- source: "/function_calling"
destination: "/assistants/function-calling"
- source: "/function-calling"
destination: "/assistants/function-calling"
- source: "/persistent_assistants"
destination: "/assistants/persistent-assistants"
- source: "/persistent-assistants"
destination: "/assistants/persistent-assistants"
- source: "/dynamic_variables"
destination: "/assistants/dynamic-variables"
- source: "/dynamic-variables"
destination: "/assistants/dynamic-variables"
- source: "/call_analysis"
destination: "/assistants/call-analysis"
- source: "/call-analysis"
destination: "/assistants/call-analysis"
- source: "/text_message"
destination: "/assistants/background-messages"
- source: "/text-message"
destination: "/assistants/background-messages"
- source: "/privacy_hipaa"
destination: "/enterprise/hipaa"
- source: "/server_url"
destination: "/server-url"
- source: "/phone_calling"
destination: "/phone-calling"
- source: "/multilingual_support"
destination: "/multilingual"
- source: "/multilingual/introduction"
destination: "/multilingual"
- source: "/outbound_sales"
destination: "/workflows/examples/lead-qualification"
- source: "/technical_support"
destination: "/assistants/examples/inbound-support"
- source: "/pizza_website"
destination: "/assistants/examples/inbound-support"
- source: "/examples/pizza-website"
destination: "/assistants/examples/inbound-support"
- source: "/voice_widget"
destination: "/assistants/examples/voice-widget"
- source: "/clients"
destination: "/sdks"
- source: "/error_message_guide"