Skip to main content
GET
/
v1
/
knowledge-base
/
documents
/
{doc_id}
/
classification
Get a document's sensitivity classification
curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/knowledge-base/documents/{doc_id}/classification \
  --header 'x-api-key: <api-key>'
{
  "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sensitivity": "<string>",
  "sensitivity_level": 123,
  "classification_source": "<string>",
  "classification_status": "<string>",
  "classification_confidence": 123,
  "classified_at": "2023-11-07T05:31:56Z",
  "classified_by": "<string>",
  "manual_override_floor": 123,
  "manual_lower_hash": "<string>",
  "visibility_mode": "<string>",
  "audience_tags": [
    "<string>"
  ],
  "detected_sensitivity": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
doc_id
string<uuid>
required

Response

Successful Response

Current classification of a document.

Built explicitly (not from_attributes) because document_id maps to Document.id and detected_sensitivity comes from the active version.

​
document_id
string<uuid>
required
​
sensitivity
string
required
​
sensitivity_level
integer
required
​
classification_source
string | null
required
​
classification_status
string
required
​
classification_confidence
number | null
required
​
classified_at
string<date-time> | null
required
​
classified_by
string | null
required
​
manual_override_floor
integer | null
required
​
manual_lower_hash
string | null
required
​
visibility_mode
string
required
​
audience_tags
string[]
required
​
detected_sensitivity
string | null