---
title: "Query"
method: POST
path: "/knowledge-base/query"
tags: ["Public-Docs"]
---

# Query

`POST /knowledge-base/query`

Query the knowledge base and retrieve answers to user questions. Send a question and receive a synthesized answer or relevant document chunks from the knowledge base.

## Request body

- object
  - `projectID` string
  - `question` string, required
  - `instruction` string
  - `chunkLimit` integer
  - `synthesis` boolean
  - `settings` object
    - `model` string
    - `temperature` number
    - `maxTokens` integer
    - `system` string
    - `reasoningEffort` string, nullable
  - `filters` object
  - `internalFilters` CompiledAgentKnowledgeBaseFilter[]
    - `key` string, required
    - `value` string, required
    - `operator` 'is' | 'is_not' | 'contains' | 'not_contains', required
  - `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](/documentation/deploy/environments).
  - `versionVariant` 'draft' | 'published'

## Response `200`

- object
  - `type` 'completion', required
  - `model` string, required
  - `output` string, nullable, 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
    - `queryTokens` number, required
    - `answerTokens` number, required
    - `cacheWriteTokens` number, required
    - `queryCachedTokens` number, required
  - `chunks` object[], required
    - `score` number, required
    - `chunkID` string, required
    - `documentID` string, required
    - `content` string, required
    - `source` union, required
      - union
        - KBDocumentUrlData
          - `type` 'url', required
          - `name` string, required
          - `url` string, required
          - `refreshRate` 'daily' | 'weekly' | 'monthly' | 'never'
          - `lastSuccessUpdate` string
          - `accessTokenID` number
          - `integrationExternalID` string
          - `source` 'zendesk' | 'shopify'
        - KBDocumentDocxData
          - `type` 'docx', required
          - `name` string, required
          - `url` string, nullable
        - KBDocumentPDFData
          - `type` 'pdf', required
          - `name` string, required
          - `url` string, nullable
        - KBDocumentTextData
          - `type` 'text', required
          - `name` string, required
          - `canEdit` boolean
          - `url` string, nullable
        - KBDocumentMarkdownData
          - `type` 'md', required
          - `name` string, required
          - `url` string, nullable
        - KBDocumentCSVData
          - `type` 'csv', required
          - `name` string, required
          - `rowsCount` number
          - `url` string, nullable
        - KBDocumentXLSXData
          - `type` 'xlsx', required
          - `name` string, required
          - `rowsCount` number
          - `url` string, nullable
        - KBDocumentTableData
          - `type` 'table', required
          - `name` string, required
          - `rowsCount` number, required
          - `url` string, nullable
      - object
    - `metadata` object, required
    - `internalMetadata` DocumentMetadataFields[]
      - `key` string, required
      - `values` string[], required

---

[API](https://skmtc.dev/voiceflow/apis/general-runtime.md) · [All operations](https://skmtc.dev/voiceflow/apis/general-runtime/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/voiceflow/general-runtime/revisions/6b1c4f778c56/schema)