HWPXkit

Return a privacy-minimized capability summary for an open HWPX document. It reports aggregate target kinds, section and table structure, whole-value fillability totals, types of HWPX parts that supply no editable targets, diagnostic counts, and structural warnings with an enumerated code and fixed HWPX part name. It does not return document text, labels, anchors, or target handles.

analyze_document

Apply value edits to cell, paragraph, or equation targets, or apply a structural edit. Within the batching limits and separation rules in this description, group compatible edits into one call whenever possible; per-call fixed overhead dominates, so splitting the same work across individual calls costs substantially more. Select with targetHandle, structuralCoord, or an opaque anchor. Anchor-only selection needs no structureVersion: an anchor remains valid while the session is alive and survives this service's structural edits. When targetHandle, structuralCoord, and/or anchor are supplied together, every supplied selector is cross-validated and a mismatch is rejected. If a uniquely resolved anchor is supplied with a stale targetHandle, the stale handle is ignored, the edit proceeds by anchor, and warnings includes stale-handle-ignored; valid conflicting selectors are still rejected. When using structuralCoord without targetHandle or anchor, pass sibling structureVersion equal to N from a targetHandle shaped v<N>:<index> in the same list_targets result; a missing or stale coordinate version is rejected with stale-coord, and the caller must call list_targets again. Before a whole-value cell or paragraph edit, require list_targets fillable=true; otherwise inspect fillBlockedReason. For a recognized placeholder cell, use a whole-cell value edit; paragraph- or run-addressed value edits leave example styling behind. A cell paragraph's listed anchor with value replaces only that paragraph; adding a listed runIndex replaces only that run in the anchored paragraph. This differs from selecting the same cell by its cell targetHandle with value, which keeps the existing whole-cell replacement meaning. For run-addressed edits, inspect runOps and runs[].removable. For a cell or paragraph, pass runIndex with value to replace one listed run, runIndex with setCharStyle to assign it to an existing style, runIndex with setCharStyleDelta to apply bold/italic/textColor (creating one only if no equivalent exists), runIndex with splitAt (a UTF-16 offset inside the run) and optional secondCharStyle to split it into two adjacent runs using existing document styles, or operation removeRun with runIndex to remove the whole addressed run. removeRun accepts only a run containing one text item and nothing else and refuses the last run in its paragraph; use removeParagraph for the whole line. For a cell, pass operation cloneParagraph or removeParagraph with one listed paragraphIndex, or pass operation addParagraph only when that paragraph has addSourceEligible=true, with paragraphIndex plus value to clone a listed one-text-item source paragraph and replace the clone text atomically; value must contain the complete new paragraph text including its marker. A cell paragraph anchor selects its current parent cell and paragraphIndex. addParagraph rejects multi-run, equation, field, or paragraphs paired with objects. For those paragraphs use cloneParagraph, call list_targets again, identify the new paragraph's runs by runs[].paragraphIndex, then edit individual text runs and equation targets; equation values follow valueContract=latex and are LaTeX-only. Run removal and paragraph structure edits must be sent alone. These forms are mutually exclusive. Equation values are LaTeX (for example, \frac{n}{m}); unsupported LaTeX is rejected. targetHandle remains valid after successful value-only or run-style edits. A successful run split, run removal, cell paragraph clone/remove/add, or row clone/remove invalidates every prior targetHandle and structuralCoord version and returns structureChanged plus a new structureVersion; the anchor remains usable without relisting. addParagraph also returns newParagraphIndex. Do not mix row structure edits with value edits. Use updatedTargets only for non-structural edits. Do not put multiple adjacent cells in the same table into one batch; apply them in separate batches. A batch contains at most the configured edit limit. Optional expectedRevision: if supplied and it differs from the session's current revision, nothing is applied and stale-revision is returned.

apply_edits

Permanently close your document session and make its handle unusable. A download link already issued stays usable until it expires. If it was already closed or is not yours, no session is changed; call open_document to begin another session.

close_document

Export the current document session as HWP or HWPX and return an expiring owner-bound download URL. HWP export preserves the service's typed conversion failure code and stage without returning inline bytes.

export_document

List opaque editable target handles for cell, paragraph, equation, and row edits. When filling values, use fillableOnly: true to substantially reduce the response, and combine it with kind when only one target kind is needed. Paragraph targets and cell paragraphs also list an opaque anchor. An anchor is valid while the document session remains alive and survives this service's structural edits; it may be used without structureVersion. If targetHandle, structuralCoord, and/or anchor are supplied together, apply_edits cross-validates every supplied selector and rejects a mismatch. Each targetHandle shaped v<N>:<index> encodes the current structureVersion N; when a listed structuralCoord is later used without targetHandle or anchor, apply_edits must receive N as sibling structureVersion. fillable means form-fill readiness: true guarantees that a valid whole-value edit can resolve and pass all target eligibility rules; when a cell or paragraph is not fillable, inspect fillBlockedReason. editable means at least one listed edit can succeed; inspect editDisabledReason when false. Cell targets list own-body paragraphs with anchor, addSourceEligible, and clone/remove/add eligibility; cellParagraphOps maps those operation names. Attempt a paragraph operation only when that paragraph's ops.<operation>.eligible is true, and inspect disabledReason otherwise. Cell and paragraph targets with runs expose runOps; each run includes paragraphIndex, removable, and splittable; attempt removeRun or splitRun only when its flag is true, and inspect splitBlockedReason when splittable is false. Equation targets expose valueContract=latex while remaining fillable=false. Row targets expose clone/remove eligibility and refusal reasons before an edit is attempted. label is a display hint, not a selector, and carries no direction. For a cell it is the text of the left neighbouring cell in the same row, or of the right neighbour when the left one has no text; a cell to the right of a 위임인 성명 label cell has label 위임인 성명. Otherwise it is the target's own text, possibly shortened. A label differing from currentText is not an error.

list_targets

Download an HWP or HWPX file from a provided file object or URL, normalize HWP input to HWPX, and create an editing session that expires after 1 hour of inactivity and always within 4 hours of opening. Supply a file object or a direct HTTPS download link to the file itself. For a file on the user's computer, they can upload and edit it at https://hwpxkit.jhlim.dev/app.

open_document

Return export-serialized bytes for an owned live document at the requested revision, up to 2 MiB.

read_document_bytes

Apply a single-step rollback token to the current document edit sequence. Existing targetHandle values remain valid after a successful value-only rollback. A run-split, run-removal, cell-paragraph, or row-structure rollback increments structureVersion again and requires list_targets before further edits.

rollback

Return a viewer for the current revision of an owned open document.

view_document