Jump to Content
Documentation
Code Samples
API Reference
Changelog
Tutorials
Join Discord
Trust Center
Billing Support
API Reference
Join Discord
Trust Center
Billing Support
Documentation
Code Samples
API Reference
Changelog
Tutorials
Health check endpoint
All
Pages
Start typing to search…
JUMP TO
Using the APIs
Voiceflow API Overview
Getting started with Voiceflow APIs
Overview and setup
How to get your Voiceflow Project API key
Using the Dialog Manager API (DM API)
How to send requests to Voiceflow APIs
How to start a conversation
How to parse the output traces
How to send user replies
How to deal with other traces (button, end, and more)
Using the Transcripts API
Saving your user transcript
Next steps
Authentication
Versions and Project IDs
Voiceflow Dialog Management API
Overview
Trace Types
Dialog API Endpoints
Interact
post
Interact Stream
post
Stream Completion Events
Update variables
patch
State API Endpoints
Understanding the dialog state stack
Fetch state
get
Update state
put
Delete state
delete
Knowledge Base API
Overview
Query API
Query
post
Filtering with Metadata
Document API Reference
Upload Document (url)
post
Upload Document (file)
post
Delete Document
delete
Document List
get
Document Chunk Retrieval
get
Replace Document (file)
put
Replace Document (url)
put
Update Document Metadata
patch
Update Chunk Metadata
patch
Upload Table Data
post
Project API
Project API
Fetch Project
get
Transcripts API
Fetch Project Transcripts
get
Check Transcripts Status
get
Create Transcript
put
Create Utterance Annotation
put
Get Transcript Dialog
get
Update Transcript
patch
Delete Transcript
delete
Export Transcript Dialog
get
Delete Transcript Tag
delete
Create Transcript Tag
put
Analytics API Endpoints
Query assistant usage
post
WEBHOOK
Call Events
Voiceflow Server CLI API
system
Get system information
get
Health check endpoint
get
tests
Execute a test suite
post
Get test execution status
get
Ask AI
Health check endpoint
get
https://localhost:8080/health
Check if the API server is running
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!