Jump to Content
Documentation
API reference
Changelog
Tutorials
Join Discord
Contact support
API reference
Search
Ask AI
Join Discord
Contact support
Documentation
API reference
Changelog
Tutorials
Filtering with Metadata
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 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
State API Endpoints
Understanding the dialog state stack
Fetch state
get
Update state
put
Delete state
del
Update variables
patch
Session Event
post
Knowledge Base API
Overview
Query API
Query
post
Filtering with Metadata
Document API Reference
Upload Document (url)
post
Upload Document (non-url)
post
Delete Document
del
Document List
get
Document Chunk Retrieval
get
Replace Document (non-url)
put
Replace Document (url)
put
Update Document Metadata
patch
Update Chunk Metadata
patch
Upload Table Data
post
Project API
Legacy 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
del
Export Transcript Dialog
get
Delete Transcript Tag
del
Create Transcript Tag
put
Transcripts API
Get All Project Transcripts
post
Get Transcript with Logs
get
Delete a Transcript
del
Project API
Fetch Project
get
Analytics API Endpoints
Query usage for a project
post
Query usage for a project v2
post
Transcript properties API
Get All Project Transcript Properties
get
Get Transcript Property
get
Update Transcript Property
patch
Delete a Transcript Property
del
Create a Transcript Property
post
Create a Transcript Property
post
Delete a Transcript Property Value
del
Get Transcript Property Values
get
Evaluations API
Create a Transcript Evaluation
post
Update a Transcript Evaluation
patch
Get Transcript Evaluation
get
Delete a Transcript Evaluation
del
Get All Project Evaluations
get
Queue a Transcript Evaluations
post
Run an Evaluation for a Transcript
post
Estimate a Transcript Evaluation
post
Webhooks
Call events webhooks
Voiceflow Server CLI API
system
Get system information
get
Health check endpoint
get
tests
Execute a test suite
post
Get test execution status
get
Knowledge Base APIs
API Reference
Upload Document (File)
post
Upload Document (URL)
post
Delete Document
del
Document Chunk Retrieval
get
Document List
get
Replace Document (File)
put
Replace Document (URL)
put
Knowledge Base - Management APIs
API Reference
Upload Document (non-url)
post
Update Document Metadata
patch
Delete Document
del
Document Chunk Retrieval
get
Update Chunk Metadata
patch
API Reference
Upload Document (non-url)
post
Update Document Metadata
patch
Delete Document
del
Document Chunk Retrieval
get
Document List
get
Replace Document (non-url)
put
Update Chunk Metadata
patch
API Reference
Document List
get
Replace Document (non-url)
put
Filtering with Metadata
Ask AI
