Skip to main content
POST
/
knowledge-base
/
query
Query
curl --request POST \
  --url https://general-runtime.voiceflow.com/knowledge-base/query \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "question": "<string>",
  "projectID": "<string>",
  "instruction": "<string>",
  "chunkLimit": 15,
  "synthesis": true,
  "filters": {},
  "internalFilters": [
    {
      "key": "<string>",
      "value": "<string>",
      "operator": "is"
    }
  ],
  "projectEnvironmentIDOrAlias": "<string>",
  "versionVariant": "published"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.voiceflow.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
authorization
string
header
required

Voiceflow API key

Headers

​
authorization
string
required

Body

application/json
​
question
string
required
​
projectID
string
​
instruction
string
​
chunkLimit
integer
Required range: 1 < x < 30
​
synthesis
boolean
​
settings
object
​
filters
object
​
internalFilters
object[]
​
projectEnvironmentIDOrAlias
string

The alias of the environment to target (ie. main). You can find this in the environments page of your agent.

💡 Tip: Learn more about Environments.

​
versionVariant
enum<string>
default:published
Available options:
draft,
published

Response

200 - undefined