Skip to main content
GET
Get one document

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

knowledge_base_id
string
required

The knowledge base's id, from GET /v1/knowledge_bases

document_id
string
required

The document's id, from GET /v1/knowledge_bases/{knowledge_base_id}/documents

Response

200 - application/json

Successful Response

created_at
string
required

ISO 8601 UTC

format
string
required

Its file's type: pdf, docx or doc (an uploaded file); text, markdown or html; or another type a connector stored, such as a SharePoint spreadsheet or slides (xlsx, xls, pptx, ppt), which isn't indexed

id
string
required
knowledge_base_id
string
required
searchable
boolean
required

Whether a search finds it: true once a version is indexed, and while a newer version is queued, indexing or failed the previous one keeps answering

source
string
required

Its knowledge base's source: Where its documents come from: api (pushed through this API), upload (files uploaded in the app), team_answers (articles the team approved in the app), or the connector that syncs it (intercom, zendesk, notion, google_drive, sharepoint, website)

status
enum<string>
required

queued (waiting to be indexed), indexing, ready, or failed (see error): how its latest version stands. searchable says whether a search finds it

Available options:
queued,
indexing,
ready,
failed
title
string
required

Its title: a file's name for an upload, the page's or article's title otherwise

updated_at
string
required

ISO 8601 UTC: when its words or details last changed

account_id
string | null

Set when the document is filed for one account (from GET /v1/objects/account/records): a worker answering that account searches it, one answering another account does not. Null: searched for every account

content
string | null

Its words as stored (HTML for a page or a help-center article, Markdown or plain text). Null for a file that isn't text (a PDF, a Word file, a spreadsheet), and for a document whose stored file is gone

error
string | null

Why indexing failed; null unless status is failed

external_id
string | null

Your id for a document you pushed through this API; null for an upload or a connector's

source_url
string | null

Where its connector found it (a help-center article, a page, a file); null otherwise

url
string | null

The link a worker gives a customer when it answers from this document; null when it has none, and the worker then names it without a link