Migrate older API examples
Documentation version 2.0 updates the request paths and contracts for the current application. It does not introduce an /api/v2 service.
| Older example | Use in this edition |
|---|---|
https://api.inkit.com/v1/generate | POST https://apps.inkit.com/api/v1/generate |
/v1/document | GET /api/v1/documents?page_size=25 |
/v1/document/{documentId} | GET /api/v1/documents/{public_id}/retrieve |
/v1/download/{documentId} | GET /api/v1/documents/{public_id}/download for raw bytes |
Delete /v1/document/{documentId} | DELETE /api/v1/documents/delete/{public_id} |
/v1/invoke | POST /api/v1/workflows-invoke |
Poll /v1/invoke | Query /api/v1/renders or /api/v1/renders/{id} |
Authorization: Inkit ... | X-Inkit-API-Token: ... |
A path mapping is not a promise of payload compatibility. Use the current endpoint schemas. In particular, file IDs, document IDs, template IDs, and render IDs are distinct.
The old batch, contacts, tags, Verify, streaming-render, and mail-piece examples are not covered by the current API-key contract in this repository. Their absence here does not prove every historical service has been shut down; confirm ownership before migrating an integration that still uses them. Workflow batch invocation in the current application is session-authenticated.
Older Python/Node SDK examples may target the historical service and have not been validated for these paths. Use the HTTP examples in this edition until your chosen SDK version has been checked.
Legacy API articles remain marked as historical where needed, with links to this guide. Non-API product guides are retained; this API update does not revalidate their screenshots or UI instructions.
Updated 10 days ago