Skip to main content
PATCH
/
v1
/
knowledge-base
/
documents
/
{doc_id}
/
classification
Manually correct a document's sensitivity classification
curl --request PATCH \
  --url https://api-sandbox.featherhq.com/v1/knowledge-base/documents/{doc_id}/classification \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "audience_tags": [
    "<string>"
  ],
  "reason": "<string>"
}
'
{
  "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

Body

application/json

Request body for PATCH /documents/{doc_id}/classification.

Optionally sets the document's effective sensitivity (a RAISE is sticky; a LOWER is content-scoped and additionally requires org:manage — anti-escalation is enforced in the service layer) and/or its audience scope (ENG-648): visibility_mode='audience' + audience_tags narrows the doc to those groups; visibility_mode='org_wide' re-opens it. At least one field must be supplied. reason is recorded on the audit event(s).

​
sensitivity
enum<string> | null
Available options:
public,
internal,
confidential,
restricted
​
visibility_mode
enum<string> | null
Available options:
org_wide,
audience
​
audience_tags
string[] | null
​
reason
string | null
Maximum string length: 1000

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