Retrieve the status of a process initiated in one of our AI services.
The /process
route allows you to retrieve the current status and details of a process that has been initiated in one of our AI services. Each request to this endpoint returns information about the process, including its status and any additional details relevant to its execution.
Possible Statuses
The execution status will be one of the following:
- NOT_FOUND: The specified
uuid
was not found. This means the process does not exist, or theuuid
provided is incorrect. - CREATED: The execution has been successfully created and is waiting to be processed.
- IN_PROGRESS: The execution is currently being processed. The system is working on completing the task.
- FAILED: The execution has failed. This could be due to an error or issue encountered during processing.
- DELIVERED: The execution has been completed successfully, and the results have been delivered.
Additional Information
The response will include the status of the execution, as well as any additional information or error messages.
For further details on the data
field and additional context on the process, please refer to the webhook page of the respective service. This page will provide more specific details on how the webhook is used to track and return process updates.
Caching and TTL Policy
To ensure the reliability of the API and prevent overloading our architecture, we use a Time-to-Live (TTL) mechanism for caching responses from the /process
route. This allows us to optimize performance while ensuring accurate responses.
TTL Durations by Status
-
Short TTL:
- Applied to statuses:
{CREATED, IN_PROGRESS, NOT_FOUND}
- These statuses are expected to change more frequently, so we cache the response with a 1-second TTL.
- Applied to statuses:
-
Long TTL:
- Applied to statuses:
{FAILED, DELIVERED}
- These statuses are final, meaning there’s no reason for the status to change further. The response is cached with a 60-second TTL.
- Applied to statuses:
This caching strategy ensures minimal latency for ongoing tasks while reducing redundant processing for completed or failed executions.