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>",
  "versionID": "<string>",
  "projectID": "<string>",
  "instruction": "<string>",
  "chunkLimit": 15,
  "synthesis": true,
  "settings": {
    "model": "<string>",
    "temperature": 123,
    "maxTokens": 123,
    "system": "<string>",
    "reasoningEffort": "<string>"
  },
  "tags": {
    "include": {
      "items": [
        "<string>"
      ],
      "operator": "<string>"
    },
    "exclude": {
      "items": [
        "<string>"
      ],
      "operator": "<string>"
    },
    "includeAllTagged": true,
    "includeAllNonTagged": true
  },
  "filters": {},
  "internalFilters": [
    {
      "key": "<string>",
      "value": "<string>",
      "operator": "is"
    }
  ]
}
'

Authorizations

authorization
string
header
required

Voiceflow Dialog Manager API key (VF.DM)

Headers

authorization
string
required

Body

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

Response

200 - undefined