Documents

Create a visual component

Creates a new visual component for a document.

post/api/v0/documents/{document_id}/visual-components

Path parameters

document_idstring uuid required

Request body

typestring required

Component type (text, table, image, etc.)

page_numberinteger required

0-indexed page number

bbox_dpiinteger

DPI the bbox coordinates are expressed in. Stored VC bboxes are canonical BASE_DPI (72); a client that draws on a page image at a different DPI (e.g. PAGE_IMAGE_DPI=150) passes that value here and the server converts to BASE_DPI before persisting.

labelstring nullable

Optional label

Response

Successful Response

idstring uuid required

The ID of the visual component

typestring required

The type of the visual component

document_idstring uuid required

The ID of the document

page_numberinteger required

The page number of the visual component

sequence_numberinteger nullable

The sequence number for ordering within a page

labelstring required

The label of the visual component

descriptionstring required

The description of the visual component

contentstring nullable

The structured content of the component (e.g., HTML table)

created_atstring date-time required

The date and time the visual component was created

updated_atstring date-time required

The date and time the visual component was last updated

mask_urlstring nullable required

The URL of the mask image

metadataobject nullable required

The metadata of the visual component

render_svgstring nullable

SVG rendering of the component (for charts/graphs)

groundingobject nullable

Grounding metadata (bounding boxes, detections)

job_status_idstring uuid nullable

Job status ID when async processing is queued (e.g., chart regeneration)

job_statusstring nullable

Job status when async processing is queued

needs_reprocessingboolean

Whether this component needs reprocessing after bbox edit

parent_idstring uuid nullable

Public id of the parent visual component, when this component is nested

Changes

No recorded changes to this endpoint across all 1 revision of this API.