Skip to main content
Version: API v2 Preview

Migrating from API v1

API v2 keeps page, image, path, form, font, and snapshot workflows, but changes how you edit text. Instead of selecting an editable paragraph or text line, you specify the text to target as part of a replace, insert, delete, or style operation.

Text migration

API v1API v2
Select a Paragraph or TextLine, then open an edit builderConstruct TextReplaceRequest, TextInsertRequest, TextDeleteRequest, or TextStyleRequest
ParagraphBuilder, TextLineBuilder, or Java text referencespdf.text() or pdf.page(n).text()
ReflowPresetTextLayoutRequest mode and profile
Boolean or edited-object resultTextEditResponse with match/change counts and diagnostics
Template request objectsIndividual text replacements where the workflow is equivalent

Literal and regular-expression selectors identify text to edit. They are not a replacement for the v1 text-extraction interface.

Documentation map

API v1 pageAPI v2 destination
Introduction + Getting StartedGetting Started
Working with TextWorking with Text, Editing Text, and Styling Text
Deleting ContentThe relevant text, page, image, path, or form guide
How Reflow WorksText Layout
Embedded Font WarningWorking with Fonts
Extracting TextNo public v2 SDK counterpart is currently documented
RedactionNo public v2 SDK counterpart is currently documented

Python and TypeScript promote several existing object types to their package root. Treat these as import-path changes, not new capabilities. Java v2 public packages use com.pdfdancer... names.

Do not mix v1 examples with v2 sessions. The complete v1 documentation remains available under /v1/.