Skip to main content
GET
Get Knowledge Base Document By Id
Retrieve complete details about a specific document including metadata, processing status, and content information.

Path Parameters

string
required
Unique identifier of the knowledge base (UUID format)
string
required
Unique identifier of the document (UUID format)

Response

string
Knowledge base ID this document belongs to
string
Unique identifier for the document (UUID)
string
URL of the document
string
UUID of the organization that owns this document
string
Document name (typically the document URL)
string
The extracted text content of the document

Example Request

Example Response

Notes

  • The raw_data field contains the extracted text content of the document
  • Returns 404 if the document or knowledge base is not found

Authorizations

x-api-key
string
header
required

API Key for authentication

Path Parameters

kb_id
string
required
document_id
string
required

Response

Successful Response

Represents a document item within a Knowledge Base.

Attributes: kb_id (Optional[str]): KB identifier. id (str): Document unique identifier. document_url (str): URL of the document. raw_data (Optional[str]): Raw textual data of the document. local_env (Optional[bool]): Indicates if the document is in a local environment. Defaults to False.

document_url
string
required

Document URL

kb_id
string | null

KB identifier

id
string | null

Document unique identifier

organization_id
string | null

Organization ID

name
string | null

Doc name

raw_data
string | null

Raw data (textual)

local_env
boolean | null
default:false

Is local

sync
boolean | null
default:false

Is sync?