Read a Document's content

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

Answers the parsed, redacted text of the current revision in pages of segments, in document order (1.53.0), never the original bytes. Every read is an Audit event. The held text of a quarantined Document is for review: Session only: the api refuses every API key with forbidden, and a Member who is not an owner or admin with forbidden and the detail owner_or_admin_required.

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/kdoc_.../content" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/knowledge-bases/kb_.../documents/kdoc_.../content`, {
  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/kdoc_.../content",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is KnowledgeDocumentSegmentList.