Skip to main content
GET
Get a knowledge base document

Authorizations

X-API-Key
string
header
required

API key for external access. Format: tp_live_<32-hex-chars>. Create keys in the TalkPilot Dashboard under Settings > API.

Path Parameters

agentId
string<uuid>
required

Agent UUID

documentId
string<uuid>
required

Knowledge base document UUID

Response

Document details

id
string<uuid>
agent_id
string<uuid> | null

Agent that created the document; null for organization-level documents

org_id
string<uuid> | null
read-only
scope
enum<string>
read-only

agent: created by this agent, writable. organization: shared company knowledge granted to this agent — readable, but write operations return 403 (manage it in the Dashboard)

Available options:
agent,
organization
title
string
content
string | null

Document text content (null for file-based documents)

source_type
enum<string> | null

manual for documents created via the API; Dashboard uploads carry their file type or website

Available options:
manual,
pdf,
csv,
txt,
docx,
website
source_url
string | null
status
enum<string>

Processing status, managed by the pipeline (read-only)

Available options:
pending,
processing,
ready,
error,
failed
chunk_count
integer | null

Number of chunks created for embedding

error_message
string | null
created_at
string<date-time>
updated_at
string<date-time>