Sign in
Public-Docs

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.

post/knowledge-base/query

Request body

projectIDstring
questionstring required
instructionstring
chunkLimitinteger
synthesisboolean
filtersobject
projectEnvironmentIDOrAliasstring

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'draft' | 'published'

Response

type'completion' required
modelstring required
outputstring nullable required
durationnumber required
tokensnumber required
queryTokensnumber required
answerTokensnumber required
cacheWriteTokensnumber required
queryCachedTokensnumber required
queryRemainderTokensnumber required
inputMultipliernumber required
cacheMultipliernumber required
outputMultipliernumber required
cacheWriteMultipliernumber required

Changes