Skip to main content
PATCH
Update a document's title and/or metadata

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 | null

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