Skip to main content
GET
Get knowledge base

Authorizations

Authorization
string
header
default:<auth-token>
required

Your API token, sent raw (no Bearer prefix).

Path Parameters

knowledgeId
string
required

Response

The knowledge base.

Status and size fields describe the current version.

knowledgeId
string

5 characters

Example:

"k7x2m"

name
string
Example:

"pricing.pdf"

type
enum<string>
Available options:
pdf,
txt,
csv,
json,
docx,
md,
url
status
enum<string>
  • processing: being parsed and indexed. Not available to agents yet.
  • ready: indexed and available to agents.
  • failed: processing stopped. statusReason says why.
Available options:
processing,
ready,
failed
statusReason
string | null

Why processing failed.

failureCode
string | null

For example upload_failed or job_not_scheduled.

sizeInBytes
integer | null

0 for website knowledge bases.

pageCount
integer | null
sectionCount
integer | null
charCount
integer | null
folderId
string | null

null when it's at the top level.

currentVersion
integer

The version agents read from.

latestVersion
integer

The newest version. It may still be processing

createdAt
string<date-time>
updatedAt
string<date-time>
markdown
string | null

The parsed text of the current version. null until status is ready.

fileUrl
string | null

Downloads the original file. null until status is ready, and for website knowledge bases.

fileUrlExpiresAt
string<date-time> | null

When fileUrl stops working

sourceUrl
string | null

The site the pages are on. Website knowledge bases only.

pages
string[]

The pages that are parsed. Website knowledge bases only.