Changelog and versioning
How the API is versioned, what counts as a breaking change, and what changed.
Versioning
The version is in the path: /v1. The current document version is 1.2.0. Within a version, changes only add: a new endpoint, a new optional parameter, a new field in an answer, a new error code or a new webhook event. Write your code to ignore fields and events it does not know.
These are breaking changes, and they ship only in a new path version, announced here at least 12 months before the old version ends:
- Removing or renaming an endpoint, a parameter, a field or an error code.
- Changing the type or the meaning of a field, or making an optional parameter required.
- Changing the status code of an answer.
Security fixes may change behaviour sooner when a delay would put accounts at risk. Such a change is listed below on the day it ships.
Changelog
1.2.0 2026-11-04
- Signatures: create, send, remind and void signature requests, send a template to many signers, follow each signer and the timeline of a request, and download the signed document and the completion certificate. The routes are under /v1/signature-requests and /v1/signature-templates.
- The signatures:send and signatures:read scopes can now be given to a key.
- Seven webhook events: signature.request_sent, signature.viewed, signature.signed, signature.declined, signature.completed, signature.voided and signature.expired.
- New error codes: signatures.exhausted, forbidden, signature.not_draft, signature.not_open and signature.not_completed.
1.1.0 2026-11-04
- The API now runs every tool. Merge, split, reorder, extract pages, delete pages, rotate, crop, page numbers, watermark, compare, redact, annotate, forms, sign, editor, JPG to PDF, scan to PDF, PDF to JPG, PDF to PNG, PDF to ZPL and ZPL to PDF were listed with runnable false before, because the web app processes them in the browser. A run through the API uploads the files and runs on the server. The web app is unchanged: those tools still run in the browser, and the file stays on the device.
- GET /v1/tools and GET /v1/tools/{toolId} return the options of a tool as a JSON Schema in the new options field, and the OpenAPI document lists every tool in x-tool-options.
- The accepts, minFiles and maxFiles of a tool now describe a run through the API. The sign and editor tools take the document first and then the pictures to place on it.
1.0.0 2026-11-04
- First release of the public API, authenticated with API keys that carry scopes and a per-key rate limit.
- Upload files, run server tools, follow runs and download results.
- List, save, download and delete documents.
- Create and delete webhook endpoints. Signed events for job.completed, job.failed, document.created and document.deleted, with retries, a delivery log and replay.
- Idempotency-Key support on every call that creates something.