Skip to main content
PATCH
/
v1
/
knowledge-base
/
documents
/
{doc_id}
Update a document's title and/or metadata
curl --request PATCH \
  --url https://api-sandbox.featherhq.com/v1/knowledge-base/documents/{doc_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "title": "<string>",
  "metadata": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "knowledge_base_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "active_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version_number": 123,
  "state": "<string>",
  "scan_status": "<string>",
  "source_type": "<string>",
  "chunk_count": 123,
  "token_count": 123,
  "segment_count": 123,
  "version_count": 0,
  "download_url": "<string>",
  "normalized_download_url": "<string>",
  "sensitivity": "internal",
  "sensitivity_level": 10,
  "pii_status": "<string>",
  "safe_title": "<string>",
  "pii_sensitivity": "<string>",
  "pii_coverage_status": "<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}.

At least one of title / metadata must be provided. metadata is a FULL replacement (matches the PUT /knowledge-bases/{id} convention).

title
string | null
Maximum string length: 500
metadata
Metadata · object

Response

Successful Response

id
string<uuid>
required
knowledge_base_id
string<uuid>
required
organization_id
string<uuid>
required
title
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
metadata
Metadata · object
active_version_id
string<uuid> | null
version_number
integer | null
state
string | null
scan_status
string | null
source_type
string | null
chunk_count
integer | null
token_count
integer | null
segment_count
integer | null
version_count
integer
default:0
download_url
string | null
normalized_download_url
string | null
sensitivity
string
default:internal
sensitivity_level
integer
default:10
pii_status
string | null
safe_title
string | null
pii_sensitivity
string | null
pii_coverage_status
string | null