{ "documents": [ { "id": "<string>", "data": "<KBDocumentData>", "status": { "type": "<KnowledgeBaseDocumentStatus>", "data": null }, "smartChunking": "<SmartChunking>" } ] }

Authorizations

Authorization

string

header

required

Voiceflow bearer token

Query Parameters

projectID

string

required

The ID of the project to operate on.

environmentAlias

string

required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json

Returns every document in the project's knowledge base, each with its source data, status, and smart chunking settings. Chunks and metadata are left out, so read a document by ID for those.

documents

object[]

required

Show child attributes

string

required

data

object

required

Show child attributes

status

object

required

Show child attributes

type

object

required

Available options: ERROR, PENDING, SUCCESS, INITIALIZED

data

any

smartChunking

object

required

Show child attributes

markdownConversion

object

When enabled, HTML is automatically converted to markdown to generate better chunks.

Show child attributes

Option 1

boolean

Option 2

enum<string>

llmBasedChunks

object

Show child attributes

Option 1

boolean

Option 2

enum<string>

llmGeneratedQ

object

When enabled, an LLM will be used to generate a question based on the document context and specific chunk, then prepend it to the chunk. This enhances retrieval by aligning chunks with potential user queries.

Show child attributes

Option 1

boolean

Option 2

enum<string>

llmContentSummarization

object

When enabled, an LLM summarizes and rewrites the content, removing unnecessary information and focusing on important parts to optimize for retrieval. Limited to 15 rows per table upload.

Show child attributes

Option 1

boolean

Option 2

enum<string>

llmPrependContext

object

When enabled, an LLM generates a context summary based on the document and chunk context, and prepends it to each chunk. This improves retrieval by providing additional context to each chunk. Note: If both llmGeneratedQ and llmPrependContext are set to true, llmGeneratedQ takes precedence, and the context summarization will not be applied.

Show child attributes

Option 1

boolean

Option 2

enum<string>

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks

List documents

Authorizations

Query Parameters

Response

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks