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>"
    }
  ],
  "projectEnvironmentIDOrAlias": "<string>",
  "versionVariant": "published"
}
'
{
  "model": "<string>",
  "output": "<string>",
  "duration": 123,
  "tokens": 123,
  "queryTokens": 123,
  "answerTokens": 123,
  "cacheWriteTokens": 123,
  "queryCachedTokens": 123,
  "queryRemainderTokens": 123,
  "inputMultiplier": 123,
  "cacheMultiplier": 123,
  "outputMultiplier": 123,
  "cacheWriteMultiplier": 123,
  "base": {
    "queryTokens": 123,
    "answerTokens": 123,
    "cacheWriteTokens": 123,
    "queryCachedTokens": 123
  },
  "chunks": [
    {
      "score": 123,
      "chunkID": "<string>",
      "documentID": "<string>",
      "content": "<string>",
      "source": {
        "name": "<string>",
        "url": "<string>",
        "lastSuccessUpdate": "<string>",
        "accessTokenID": 123,
        "integrationExternalID": "<string>"
      },
      "metadata": {},
      "internalMetadata": [
        {
          "key": "<string>",
          "values": [
            "<string>"
          ]
        }
      ]
    }
  ]
}

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 - application/json
type
enum<string>
required
Available options:
completion
model
string
required
output
string | null
required
duration
number
required
tokens
number
required
queryTokens
number
required
answerTokens
number
required
cacheWriteTokens
number
required
queryCachedTokens
number
required
queryRemainderTokens
number
required
inputMultiplier
number
required
cacheMultiplier
number
required
outputMultiplier
number
required
cacheWriteMultiplier
number
required
base
object
required
chunks
object[]
required