Long-Running Tasks (LRT) APIs
Learn about the Long-Running Tasks APIs used to manage agents, schedules, and long-running jobs.
The Long-Running Tasks provides access to automated long-running task data in Reltio. These APIs let you find agents, schedule them to run, and review the schedule executions. They also let you create and monitor LRT jobs. You can then review and export the job results.
Long-Running Tasks APIs complement the autonomous agents Task Management experience in the UI. While the UI helps business users explore and manage tasks interactively, these APIs provide a programmatic way to retrieve the same structures and apply controlled changes at scale.
What you can do with these APIs
The autonomous agents Long-Running Tasks APIs support the following use cases:
-
Discover the agents published in your tenant before scheduling or invoking one
-
Schedule an agent to run on a recurring basis, using a
cronexpression or a fixed interval -
Run an agent immediately, without creating a persistent schedule
-
Update or delete an existing schedule, and review its execution history
-
Create a long-running (LRT) agent job and optionally attach bulk-upload files
-
Check an LRT job's status and result, trigger it immediately, or cancel it
-
Continue an LRT job's conversation with a follow-up message
-
Review per-entity status counts, paginated results, and full per-entity detail for a conversation
-
Export per-entity results for a conversation job and retrieve the download URL
List of APIs
The following table lists the APIs and describes the purpose of each.
| API | Purpose |
|---|---|
| List available agents | Returns the catalog of published agents available for scheduling and invocation. Only active, published agents are returned. |
| Get agent details | Returns details for a specific agent by ID. |
| List schedules | List all schedules for the current tenant with optional filtering. |
| Create a schedule | Create a new schedule to run an agent on a recurring or one-time basis. |
| Run agent immediately | Execute an agent immediately without creating a persistent schedule. |
| Get schedule details | Returns the details of a schedule. |
| Update schedule | Partially update an existing schedule. All fields are optional. |
| Delete schedule | Deletes a schedule. |
| List schedule executions | List conversations (executions) from a schedule. |
| Get conversation status | Returns the status of a single schedule execution. |
| List jobs for the authenticated tenant | Returns the LRT jobs for the tenant. |
| Create and optionally trigger a new LRT job | Create a one-off LRT conversation job. |
| Get LRT job status | Returns only the status of an LRT job, without its result. |
| Get job status and result | Returns the status and result of an LRT job. |
| Cancel a pending or running job | Cancels a pending or running LRT job. |
| Trigger immediate execution of an existing job | Triggers immediate execution of an existing LRT job. |
| Add a follow-up message to an LRT job conversation | Append a follow-up turn to an existing LRT job's conversation. |
| List all agent runs for a conversation | Returns the agent runs for a conversation. |
| Get details of a specific agent run | Returns the details of a single agent run. |
| Entity status counts for a conversation | Returns the number of processed, failed, and needs_review entities for a conversation, with a breakdown by entity type. Use this API when you need counts, instead of listing every entity. |
| Paginated per-entity results for a conversation | Returns one page of per-entity results, each with a short reason. You can filter the results by entity type, entity ID, or status. |
| Full detail for a single entity in a conversation | Returns the complete stored record for one entity, including its full summary, error text, and other attributes. |
| Cancel all active worker runs for a conversation | Cancels all active worker runs for a conversation. |
| List entity exports for a conversation job | List exports created by the authenticated user for this conversation. |
| Create an entity export for a conversation job | Creates an entity export for a conversation job. |
| Get entity export status and download URL | Returns the status and download URL of an entity export. |