---
title: "Update document metadata"
method: PATCH
path: "/v1/documents/{document_id}"
tags: ["documents"]
---

# Update document metadata

`PATCH /v1/documents/{document_id}`

## Request

- Base URL: `https://mcp.techmanual.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://mcp.techmanual.ai/v1/documents/{document_id}`
- Auth: none declared

Update equipment metadata for a document. All fields are optional — omitted fields leave current values unchanged. Provide ``applicable_models`` as an explicit empty list ``[]`` to clear all model associations. Used by enrichment bots to tag documents after ingestion.

## Path parameters

- `document_id` integer, required

## Headers

- `authorization` string

## Request body

- DocumentMetadataUpdate: Request schema for PATCH /v1/documents/{id}. All fields are optional — omitted fields leave the current value unchanged. Provide ``applicable_models`` as an explicit empty list to clear all models.
  - `title` string, nullable
  - `document_type` string, nullable
  - `document_version` string, nullable
  - `manufacturer` string, nullable
  - `equipment_type` string, nullable
  - `equipment_family` 'test_and_measurement' | 'industrial_controls' | 'automotive' | 'rf_and_communications' | 'power_electronics' | 'ics_and_microcontrollers' | 'miscellaneous', nullable
  - `applicable_models` string[], nullable
  - `description` string, nullable

## Response `200`

Successful Response

- DocumentOut: Metadata for a manual/document.
  - `document_id` integer, required
  - `title` string, required
  - `document_type` string, nullable
  - `document_version` string, nullable
  - `manufacturer` string, nullable
  - `equipment_type` string, nullable
  - `equipment_family` 'test_and_measurement' | 'industrial_controls' | 'automotive' | 'rf_and_communications' | 'power_electronics' | 'ics_and_microcontrollers' | 'miscellaneous', nullable
  - `applicable_models` string[]
  - `page_count` integer, required
  - `estimated_token_count` integer, required
  - `ingestion_status` string, required
  - `visibility_status` string, nullable
  - `toc_start_page` integer, nullable
  - `toc_end_page` integer, nullable
  - `pdf_page_offset` integer, nullable
  - `featured` boolean
  - `enrichment_status` string, nullable
  - `vision_enrichment_status` VisionEnrichmentStatusOut: Per-document vision enrichment progress summary.
    - `total_pages` integer, required
    - `pages_enriched` integer, required
    - `pages_skipped` integer, required
    - `pages_pending` integer, required
    - `pages_failed` integer, required
  - `quarantine_reason` string, nullable
  - `created_at` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/techmanual/apis/techmanual-ai-api.md) · [All operations](https://skmtc.dev/techmanual/apis/techmanual-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/techmanual/apis/techmanual-ai-api/revisions/97e0fde41040?raw)