Voiceflow bearer token
Query knowledge base
curl --request POST \
--url https://realtime-api.voiceflow.com/v1/stable/knowledge-base/query \
--header 'Authorization: Bearer <token>'
--header 'Content-Type: application/json' \
--data '{
"version": "draft",
"filters": {},
"question": "<string>",
"settings": {
"model": "gpt-3.5-turbo-1106",
"system": "<string>",
"maxTokens": 0,
"temperature": 0,
"reasoningEffort": "off"
},
"synthesis": true,
"chunkLimit": 0,
"instruction": "<string>"
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/knowledge-base/query?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"version": "draft",
"filters": {},
"question": "<string>",
"settings": {
"model": "gpt-3.5-turbo-1106",
"system": "<string>",
"maxTokens": 0,
"temperature": 0,
"reasoningEffort": "off"
},
"synthesis": true,
"chunkLimit": 0,
"instruction": "<string>"
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1/stable/knowledge-base/query?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"version": "draft",
"filters": {},
"question": "<string>",
"settings": {
"model": "gpt-3.5-turbo-1106",
"system": "<string>",
"maxTokens": 0,
"temperature": 0,
"reasoningEffort": "off"
},
"synthesis": True,
"chunkLimit": 0,
"instruction": "<string>"
},
)
data = response.json()vf knowledge-base query --project-id <projectID> --environment-alias <environmentAlias> \
< body.json{
"answer": {
"model": "gpt-3.5-turbo-1106",
"output": "<string>",
"tokens": 0,
"duration": 0,
"queryTokens": 0,
"answerTokens": 0,
"inputMultiplier": 0,
"cacheMultiplier": 0,
"outputMultiplier": 0,
"cacheWriteTokens": 0,
"queryCachedTokens": 0,
"cacheWriteMultiplier": 0,
"queryRemainderTokens": 0,
"base": {
"queryTokens": 0,
"answerTokens": 0,
"cacheWriteTokens": 0,
"queryCachedTokens": 0
},
"priorityMultipliers": {
"inputMultiplier": 0,
"cacheMultiplier": 0,
"outputMultiplier": 0,
"cacheWriteMultiplier": 0
},
"chunks": [
{
"score": 0,
"chunkID": "<string>",
"documentID": "<string>",
"content": "<string>",
"source": "<KBDocumentData>",
"metadata": {}
}
]
}
}Query knowledge base
Searches the knowledge base and returns the passages a retrieval would surface, which is how to see what an agent will be grounded on before it answers.
POST
/v1/stable/knowledge-base/query
Query knowledge base
curl --request POST \
--url https://realtime-api.voiceflow.com/v1/stable/knowledge-base/query \
--header 'Authorization: Bearer <token>'
--header 'Content-Type: application/json' \
--data '{
"version": "draft",
"filters": {},
"question": "<string>",
"settings": {
"model": "gpt-3.5-turbo-1106",
"system": "<string>",
"maxTokens": 0,
"temperature": 0,
"reasoningEffort": "off"
},
"synthesis": true,
"chunkLimit": 0,
"instruction": "<string>"
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/knowledge-base/query?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"version": "draft",
"filters": {},
"question": "<string>",
"settings": {
"model": "gpt-3.5-turbo-1106",
"system": "<string>",
"maxTokens": 0,
"temperature": 0,
"reasoningEffort": "off"
},
"synthesis": true,
"chunkLimit": 0,
"instruction": "<string>"
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1/stable/knowledge-base/query?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"version": "draft",
"filters": {},
"question": "<string>",
"settings": {
"model": "gpt-3.5-turbo-1106",
"system": "<string>",
"maxTokens": 0,
"temperature": 0,
"reasoningEffort": "off"
},
"synthesis": True,
"chunkLimit": 0,
"instruction": "<string>"
},
)
data = response.json()vf knowledge-base query --project-id <projectID> --environment-alias <environmentAlias> \
< body.json{
"answer": {
"model": "gpt-3.5-turbo-1106",
"output": "<string>",
"tokens": 0,
"duration": 0,
"queryTokens": 0,
"answerTokens": 0,
"inputMultiplier": 0,
"cacheMultiplier": 0,
"outputMultiplier": 0,
"cacheWriteTokens": 0,
"queryCachedTokens": 0,
"cacheWriteMultiplier": 0,
"queryRemainderTokens": 0,
"base": {
"queryTokens": 0,
"answerTokens": 0,
"cacheWriteTokens": 0,
"queryCachedTokens": 0
},
"priorityMultipliers": {
"inputMultiplier": 0,
"cacheMultiplier": 0,
"outputMultiplier": 0,
"cacheWriteMultiplier": 0
},
"chunks": [
{
"score": 0,
"chunkID": "<string>",
"documentID": "<string>",
"content": "<string>",
"source": "<KBDocumentData>",
"metadata": {}
}
]
}
}Authorizations
Query Parameters
Body
Show child attributes
The AI model used to synthesize the answer.
Available options:
gpt-3.5-turbo-1106, gpt-3.5-turbo, gpt-4, gpt-4o, gpt-4o-mini, gpt-4.1-2025-04-14, gpt-4.1-mini-2025-04-14, gpt-4.1-nano-2025-04-14, gpt-o3-mini, o3-2025-04-16, o4-mini-2025-04-16, gpt-5, gpt-5-mini, gpt-5-nano, gpt-5.2, gpt-5.4, gpt-5.4-mini, gpt-5.5, gpt-5.6-sol, gpt-5.6-terra, gpt-5.6-luna, gpt-realtime, gpt-live-1, claude-4-opus, claude-4-sonnet, claude-4.5-sonnet, claude-4.6-sonnet, claude-4.5-haiku, claude-4.5-opus, claude-4.7-opus, bedrock-claude-4-sonnet, bedrock-claude-4.5-sonnet, bedrock-claude-4.6-sonnet, bedrock-claude-5-sonnet, bedrock-claude-4.5-haiku, bedrock-claude-4.5-opus, bedrock-claude-4.7-opus, bedrock-claude-4.8-opus, voiceflow-core-4.0, voiceflow-core-4.2, voiceflow-flash-4.2, kimi-k3, gemini-2.5-pro, gemini-2.5-flash, gemini-live-2.5-flash, gemini-3-flash, gemini-3.5-flash, gemini-3.1-pro, gpt-oss-20b, gpt-oss-120b, llama-guard-4, llama-3.1-instant, llama-3.3-versatile, qwen3.6-27b, grok-4.6, voiceflow-core-4.1, voiceflow-flash-4.1, gemini-flash-2, gpt-4-turbo, claude-3.5-haiku, claude-3-opus, claude-3.7-sonnet, claude-v2, llama-3.2-1b-preview, gemini-pro-1.5, claude-3-haiku, claude-3-sonnet, text-davinci-003, claude-v1, claude-instant-v1, deep-seek-r1-distill-llama-70B, claude-3.5-sonnetResponse
200 - application/jsonReturns the answer generated from the knowledge base and the chunks it was drawn from, alongside the model used, the duration, and the token accounting for the call.
The result of the knowledge base query, including the synthesized answer and token usage.
Show child attributes
The AI model used to answer the query.
Available options:
gpt-3.5-turbo-1106, gpt-3.5-turbo, gpt-4, gpt-4o, gpt-4o-mini, gpt-4.1-2025-04-14, gpt-4.1-mini-2025-04-14, gpt-4.1-nano-2025-04-14, gpt-o3-mini, o3-2025-04-16, o4-mini-2025-04-16, gpt-5, gpt-5-mini, gpt-5-nano, gpt-5.2, gpt-5.4, gpt-5.4-mini, gpt-5.5, gpt-5.6-sol, gpt-5.6-terra, gpt-5.6-luna, gpt-realtime, gpt-live-1, claude-4-opus, claude-4-sonnet, claude-4.5-sonnet, claude-4.6-sonnet, claude-4.5-haiku, claude-4.5-opus, claude-4.7-opus, bedrock-claude-4-sonnet, bedrock-claude-4.5-sonnet, bedrock-claude-4.6-sonnet, bedrock-claude-5-sonnet, bedrock-claude-4.5-haiku, bedrock-claude-4.5-opus, bedrock-claude-4.7-opus, bedrock-claude-4.8-opus, voiceflow-core-4.0, voiceflow-core-4.2, voiceflow-flash-4.2, kimi-k3, gemini-2.5-pro, gemini-2.5-flash, gemini-live-2.5-flash, gemini-3-flash, gemini-3.5-flash, gemini-3.1-pro, gpt-oss-20b, gpt-oss-120b, llama-guard-4, llama-3.1-instant, llama-3.3-versatile, qwen3.6-27b, grok-4.6, voiceflow-core-4.1, voiceflow-flash-4.1, gemini-flash-2, gpt-4-turbo, claude-3.5-haiku, claude-3-opus, claude-3.7-sonnet, claude-v2, llama-3.2-1b-preview, gemini-pro-1.5, claude-3-haiku, claude-3-sonnet, text-davinci-003, claude-v1, claude-instant-v1, deep-seek-r1-distill-llama-70B, claude-3.5-sonnetThe raw token counts before billing multipliers are applied.
Show child attributes
The billing multipliers applied when the query runs with priority processing.
Show child attributes
Show child attributes
Show child attributes
Option 1 · KBDocumentUrlData
Option 2 · KBDocumentDocxData
Option 3 · KBDocumentPDFData
Option 4 · KBDocumentTextData
Option 5 · KBDocumentMarkdownData
Option 6 · KBDocumentCSVData
Option 7 · KBDocumentXLSXData
Was this page helpful?
Thanks for your feedback.