Skip to main content
PATCH
/
v1
/
documents
/
{document_id}
Update Document Handler
curl --request PATCH \
  --url http://localhost:8000/v1/documents/{document_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "parent_path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "active_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "part_type": "DOCUMENT",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "parent_path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "active_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "active_version": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version": 123,
    "name": "<string>",
    "parent_path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "materialized_path": "<string>",
    "system_managed": true,
    "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "asset_s3_url": "<string>",
    "fast_plaintext_url": "<string>",
    "system_metadata": {
      "source_s3": "<string>",
      "cleaned_source_s3": "<string>",
      "fast_plaintext_s3": "<string>",
      "hash": "<string>",
      "pipeline_state": {
        "last_run_timestamp": "2023-11-07T05:31:56Z",
        "last_state_update_timestamp": "2023-11-07T05:31:56Z",
        "last_activity": "<string>",
        "error": "<string>",
        "temporal_workflow_id": "<string>",
        "chunks_processed": 123,
        "page_dpi": 123
      },
      "total_pages": 123,
      "total_sections": 123,
      "total_chunks": 123,
      "total_formulas": 123,
      "xlsx_parse_result_s3": "<string>",
      "xlsx_named_ranges": [
        {}
      ],
      "xlsx_kpi_catalog": [
        {}
      ],
      "information_statistics": {
        "num_chunks_by_type": {},
        "total_tokens": 0,
        "num_direct_children": 0,
        "children_depth": 0
      }
    }
  },
  "materialized_path": "<string>",
  "system_managed": true,
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "color": "<string>",
      "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>"
    }
  ]
}

Headers

​
authorization
string | null

Path Parameters

​
document_id
string<uuid>
required

Cookies

​
ks_uat
string | null

Body

application/json

Request to update a document (rename, move, and/or change active version).

​
name
string | null

New document name

Required string length: 1 - 255
​
parent_path_part_id
string<uuid> | null

New parent PathPart ID for move (must be a FOLDER type)

​
active_version_id
string<uuid> | null

New active version ID

Response

Successful Response

Document response model.

​
part_type
enum<string>
required

Path part type

Available options:
DOCUMENT
​
id
string<uuid>
required

Document ID

​
path_part_id
string<uuid>
required

PathPart ID

​
name
string
required

Document name

​
parent_path_part_id
string<uuid> | null
required

Parent PathPart ID

​
document_type
enum<string>
required

Type of document

Available options:
PDF,
DOCX,
PLAINTEXT,
IMAGE,
XLSX,
CSV,
PPTX,
UNKNOWN
​
document_origin
enum<string>
required

Origin of document

Available options:
SOURCE,
GENERATED
​
active_version_id
string<uuid>
required

Active version ID

​
active_version
DocumentVersionResponse · object
required

Active version details

​
materialized_path
string
required

Full materialized path from root

​
system_managed
boolean
required

Whether this document 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

​
tags
TagResponse · object[] | null

Tags attached to this document