Skip to the content

List a Knowledge base's Documents

GET /v1/knowledge-bases/{knowledge_base_id}/documents

Property	Value
Operation	`list_knowledge_documents`
Group	Knowledge bases
Scope	`knowledge:read`
Scopes of `include` values	`names` needs `knowledge:read`
Route class	`read`
Idempotency	No `Idempotency-Key`
Audit	An audited content read `knowledge.document.list`, when the request names an `include` value
Released in	1.53.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Lists the Documents, newest first, by Source, status and review status (1.53.0); metadata only, title and external_ref null, unless include=names adds them, which makes the list an audited content read.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the knowledge:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/knowledge-bases/kb_.../documents" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/knowledge-bases/kb_.../documents`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/knowledge-bases/kb_.../documents",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Name	In	Type	Required	Description
`knowledge_base_id`	path	KnowledgeBaseId	yes	The id of a Knowledge base: `kb_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`limit`	query	integer	no	The page size, 1 to 100.
`cursor`	query	string	no	The opaque `next_cursor` of the previous page; it binds the filters it was issued under.
`source_id`	query	KnowledgeSourceId	no	Only the Documents of a Source.
`status`	query	KnowledgeDocumentStatus	no	Only those of a status.
`review_status`	query	KnowledgeReviewStatus	no	`open` lists the review queue.
`include`	query	array of KnowledgeDocumentInclude	no	Content classes to add, comma-separated: `names` answers `title` and `external_ref` and makes the read an audited content read (1.53.0, second part).

Responses

Status	Content type	Shape	Error codes
`200`	`application/json`	KnowledgeDocumentList
`400`	`application/json`	ErrorEnvelope	`invalid_request`, `invalid_cursor`
`401`	`application/json`	ErrorEnvelope	`unauthenticated`
`403`	`application/json`	ErrorEnvelope	`forbidden`
`404`	`application/json`	ErrorEnvelope	`not_found`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `200` answer

The shape is KnowledgeDocumentList.

Field	Type	Required	Description
`data`	array of KnowledgeDocument	yes	The Documents of this page, newest first.
`has_more`	boolean	yes	True when a further page exists.
`next_cursor`	string or null	yes	The cursor of the next page, or null on the last page.
`object`	`"list"`	yes