Overview
Our API offers a suite of services accessible via HTTP calls, each operating asynchronously to enhance performance and responsiveness. Upon each service request, a unique process ID is returned, enabling you to track the processing status and access results when available.
How It Works
-
Service Requests and Process IDs
When a service is requested, an HTTP call to the API will initiate the process, and a process ID is returned. This ID serves as a unique identifier for tracking the status of that specific request. -
Polling for Status Updates
To check the progress of a service, use our polling route by providing the process ID. The polling route will return the current status of the request (e.g., pending, in progress, completed) along with relevant information, including the result if processing is complete. See more on ⚙️ Get Process Status -
Optional Webhook Integration
For additional flexibility, you can include a webhook URL in the initial request payload. When provided, this webhook will automatically send a callback with the processing results once completed, eliminating the need for continuous polling.