List jobs for the authenticated tenant
Learn more about list jobs for the authenticated tenant.
Use the List jobs for the authenticated tenant to list the jobs for your tenant. This lets you monitor all long-running jobs in the tenant in one place.
HTTP method and endpoint
Use the following HTTP method and endpoint path to list jobs for the authenticated tenant.
GET {TenantURL}/ai/agentflow/api/v202605/{tenant_id}/lrt/jobs
The following table describes the endpoint path parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
TenantURL | String | Yes | The base URL for your tenant. |
tenant_id | String | Yes | The tenant identifier. |
Query parameters
The following table describes the query parameters and their values.
| Parameter | Type | Required | Description | Accepted values / Default |
|---|---|---|---|---|
agent_id | String | No | Returns only results for this agent. | — |
limit | Integer | No | The maximum number of jobs to return per page. | Default: 50 |
page_token | String | No | The page token from a previous response. Omit to get the first page. | — |
Request headers
The following request headers must be included.
| Header | Value | Required |
|---|---|---|
Authorization | <access_token> | Yes |
Request body
This operation does not require a request body.
Example request
Use the following example to see how a complete request is structured, with headers.
GET {TenantURL}/ai/agentflow/api/v202605/tenant-xyz/lrt/jobs
Authorization: <access_token>
Response body
The following table describes the fields returned in the response body.
| Parameter | Type | Description |
|---|---|---|
jobs | Array | The jobs in this page of results. |
jobs[].job_id | String | The unique identifier of the LRT job. |
jobs[].tenant_id | String | The unique identifier of the tenant. |
jobs[].agent_id | String | The unique identifier of the agent that the job or schedule runs. |
jobs[].name | String | The display name. |
jobs[].title | String | The title of the conversation. |
jobs[].query | String | The prompt or query that was submitted for execution. |
jobs[].status | String | The status of the job. |
jobs[].next_run_at | String | The date and time when the job is next queued to run. |
jobs[].last_run_at | String | The date and time when the last run finished. |
jobs[].conversation_id | String | The unique identifier of the conversation that the job created. |
jobs[].bulk_upload | Boolean | Whether the job runs as a bulk file-upload job. |
jobs[].file_ids | Array | The unique identifiers of the files attached to this job. |
jobs[].files | Array | The details of each attached file (ID, name, extension, size, record count, and upload time). |
jobs[].result | Object | The execution result details, when available. |
jobs[].last_error | String | The most recent error for the job, if any. |
jobs[].created_at | String | The date and time when the job or schedule was created. |
jobs[].updated_at | String | The date and time when the record was last updated. |
pagination | Object | Pagination details for this page of results. |
pagination.total_count | Integer | The number of items in this page of results. |
pagination.next_page_token | String | The token to pass as page_token to get the next page of results. Empty when this is the last page. |
pagination.limit | Integer | The maximum number of items per page. |
Example response
The following example shows a response with successful response.
{
"jobs": [
{
"job_id": "0b4720e4-0b1c-41f7-9b53-0ebc907f45f8",
"tenant_id": "tenant-xyz",
"agent_id": "MRA",
"name": "Manual LRT entity processing",
"title": "Process pending entities",
"query": "<string>",
"status": "running",
"next_run_at": "<string>",
"last_run_at": "<string>",
"conversation_id": "<string>",
"bulk_upload": false,
"file_ids": "<value>",
"files": "<value>",
"result": "<value>",
"last_error": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
],
"pagination": {
"total_count": 50,
"next_page_token": "eyJvZmZzZXQiOiA1MH0=",
"limit": 50
}
}
Error codes and recommended actions
The following table lists the possible error responses returned by this API.
| HTTP status | Description | Recommended action |
|---|---|---|
422 Unprocessable Entity | Validation Error | Review the request parameters or body, correct the invalid values, and resend the request. |