Skip to main content
GET
/
v1
/
knowledge-base
/
documents
/
{doc_id}
/
versions
/
{ref}
Get a version by UUID, version number, or alias
curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/knowledge-base/documents/{doc_id}/versions/{ref} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version_number": 123,
  "state": "<string>",
  "source_type": "<string>",
  "source_url": "<string>",
  "chunk_count": 123,
  "token_count": 123,
  "error_message": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "processed_at": "2023-11-07T05:31:56Z",
  "scan_status": "<string>",
  "filename": "<string>",
  "metadata": {},
  "download_url": "<string>",
  "governance_status": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "pii_status": "<string>",
  "sensitivity": "<string>",
  "pii_detection_count": 123,
  "pii_entity_types": [
    "<string>"
  ],
  "pii_coverage_status": "<string>",
  "pii_scrubbed_at": "2023-11-07T05:31:56Z",
  "safe_title": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

doc_id
string<uuid>
required
ref
string
required

Response

Successful Response

id
string<uuid>
required
document_id
string<uuid>
required
version_number
integer
required
state
string
required
source_type
string
required
source_url
string | null
required
chunk_count
integer
required
token_count
integer
required
error_message
string | null
required
created_at
string<date-time>
required
processed_at
string<date-time> | null
required
scan_status
string | null
filename
string | null
metadata
Metadata · object
download_url
string | null
governance_status
string | null
expires_at
string<date-time> | null
pii_status
string | null
sensitivity
string | null
pii_detection_count
integer | null
pii_entity_types
string[] | null
pii_coverage_status
string | null
pii_scrubbed_at
string<date-time> | null
safe_title
string | null