Skip to main content
PATCH
Update Document Version Metadata Handler

Headers

authorization
string | null

Path Parameters

version_id
string<uuid>
required

DocumentVersion ID

Cookies

ks_uat
string | null

Body

application/json

Partial update schema for document version metadata.

All fields are optional. Only non-None fields are merged into the existing metadata dict.

source_s3
string | null
cleaned_source_s3
string | null
standard_pipeline_json_s3
string | null
fast_plaintext_s3
string | null
high_accuracy_content_list_s3
string | null
high_accuracy_middle_s3
string | null
hash
string | null
pipeline_state
PipelineState · object | null

Pipeline execution state tracking.

total_pages
integer | null
total_sections
integer | null
total_chunks
integer | null
total_formulas
integer | null
xlsx_parse_result_s3
string | null
xlsx_named_ranges
Xlsx Named Ranges · object[] | null
xlsx_kpi_catalog
Xlsx Kpi Catalog · object[] | null
information_statistics
InformationStatistics · object | null

Aggregate statistics for a section subtree or document version.

Response

Successful Response

DocumentVersion response model.

Shared schema for DocumentVersion responses, used by Document endpoints and DocumentVersion endpoints.

id
string<uuid>
required

DocumentVersion ID

path_part_id
string<uuid>
required

PathPart ID

version
integer
required

Version number (0, 1, 2...)

name
string
required

Auto-generated name from path_part (v0, v1, ...)

parent_path_id
string<uuid> | null
required

Document's PathPart ID

materialized_path
string
required

Full materialized path from root

system_managed
boolean
required

Whether this version is system-managed

tenant_id
string<uuid>
required

Tenant ID

created_at
string<date-time>
required

Creation timestamp

updated_at
string<date-time>
required

Last update timestamp

asset_s3_url
string | null

Presigned URL to download the source document (6-hour validity)

fast_plaintext_url
string | null

Presigned URL to download the fast plaintext export (6-hour validity)

system_metadata
DocumentVersionMetadata · object

Version metadata (S3 artifacts, pipeline state, statistics)