In this article, you will learn
- which tasks are covered by the radixAPI interface,
- which basic information is required to access the interface, and
- how a typical integration with radixAPI is structured.
1. Introduction
radixAPI provides an interface for the automated processing of print data, such as checking, correcting and converting PDF files or generating preview images and reports. The interface offers authenticated endpoints for managing resources and for running document-processing workflows. Requests are processed asynchronously in the background. The status of a workflow can be queried or returned to a connected system via a callback URL.
The API is a REST (Representational State Transfer) service. HTTPS is used as the application layer protocol. REST unifies the interface between systems to a manageable and standardised set of actions regarding the expected behavior, which are explained in detail in this documentation.
Applications can integrate radixAPI either by calling the REST API directly or by using the Node.js SDK, which is available for Node.js and TypeScript.
Even with intensive testing and careful research, we cannot guarantee the full correctness of the documentation. Since the interface is constantly being expanded, the scope of the documentation will also change constantly. Please always note the publication date and version number.
2. Overview
Below, you will find the basic information on the interface.
2.1. URI Scheme
| Parameter | Value |
|---|---|
| Host | radix.prepress-digital.com |
| BasePath | /api |
| Schemes | HTTPS |
Valid credentials are required to access the interface. Protected requests are authenticated with an access token, which is returned at login. Further information can be found in the articles "Registration and Account Security" and "Authentication and Tokens".
2.2. Availability of Requests
radixAPI is licensed per user. The license of the respective user determines which requests can be made. Marketing endpoints require the corresponding marketing permissions, while custom workflows require the permission for workflows as well as the permissions for the nodes used. This also applies to administrators. Further information can be found in the article "Endpoint License Permissions".
2.3. Integration via Node.js SDK
The Node.js SDK handles login, token refresh, request encoding and workflow polling automatically. Node.js 20 or newer is required. The SDK is currently not published in a public npm registry and is available upon request from the provider. Further information can be found in the article "Node.js SDK".
2.4. API Reference
In addition to this documentation, the hosted environment provides an interactive API reference at https://radix.prepress-digital.com/reference. The OpenAPI specification is available in JSON format at https://radix.prepress-digital.com/api-json. Further information can be found in the article "OpenAPI Specification".
3. Typical Integration
Since workflows are processed asynchronously, a successful request does not return the output file directly, but creates and queues a workflow. A typical integration therefore follows this sequence:
- Authenticate and obtain an access token.
- Submit a request to a marketing endpoint or create a custom workflow.
- Store the workflow ID returned in the response.
- Wait for the workflow to complete via polling, callback URL or server-sent events.
- Check the status and result of the completed workflow.
- Download each output resource.
- Delete the workflow after all required files have been saved.
The individual steps are described in detail in the chapters "Getting Started", "Marketing Endpoints", "Custom Workflows" and "Workflow Results".
Article update: radixAPI 2.4.0 – 10/2026