Paginated per-entity results for a conversation
Learn more about paginated per-entity results for a conversation.
Use the Paginated per-entity results for a conversation to get paginated per-entity results for a conversation. This lets you page through per-entity results to review individual outcomes.
HTTP method and endpoint
Use the following HTTP method and endpoint path to paginated per-entity results for a conversation.
POST {TenantURL}/ai/agentflow/api/v202605/{tenant_id}/lrt/jobs/conversation/{conversation_id}/entities/list
The following table describes the endpoint path parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
TenantURL | String | Yes | The base URL for your tenant. |
conversation_id | String | Yes | The unique identifier of the conversation associated with the job. |
tenant_id | String | Yes | The tenant identifier. |
Request headers
The following request headers must be included.
| Header | Value | Required |
|---|---|---|
Authorization | <access_token> | Yes |
Content-Type | application/json | Yes |
Request body
The following table describes the request body parameters.
| Parameter | Type | Required | Description | Accepted values / Default |
|---|---|---|---|---|
| filter_condition | Object | No | The filter to apply to the entities in the conversation. | — |
| filter_condition.entity_type | String | No | Returns only entities of this entity type. | — |
| filter_condition.entity_id | String | No | Returns only the entity with this identifier. | — |
| filter_condition.status | String | No | Returns only entities with this processing status. | — |
| filter_condition.decision_code | String | No | Returns only entities with this decision code (for example NO_MATCH). | — |
| run_id | String | No | Scopes the results to a single worker run. | — |
| reason_contains | String | No | Returns only entities whose short reason contains this text. The match is not case-sensitive. | — |
| limit | Integer | No | The maximum number of entities to return per page. | Default: 25 |
| page_token | String | No | The page token from a previous response. Omit to get the first page. | — |
Example request
Use the following example to see how a complete request is structured, with headers and a JSON body.
POST {TenantURL}/ai/agentflow/api/v202605/tenant-xyz/lrt/jobs/conversation/example-id/entities/list
Authorization: <access_token>
Content-Type: application/json
{
"filter_condition": {
"entity_type": "<string>",
"entity_id": "<string>",
"status": "<string>",
"decision_code": "<string>"
},
"run_id": "<string>",
"reason_contains": "<string>",
"limit": 0,
"page_token": "<string>"
}
Response body
The following table describes the fields returned in the response body.
| Parameter | Type | Description |
|---|---|---|
conversation_id | String | The unique identifier of the conversation. |
entities | Array | The entities that match the filter. |
entities[].entity_id | String | The unique identifier of the entity. |
entities[].entity_type | String | The entity type name. |
entities[].label | String | The display label of the entity. |
entities[].status | String | The processing status of the entity: processed, failed, or needs_review. |
entities[].decision_code | String | The outcome code for the entity (for example NO_MATCH). |
entities[].reason | String | A short explanation of the outcome, shortened for display. |
entities[].confidence | String | The confidence band for the outcome, when available. |
entities[].run_id | String | The unique identifier of the run that processed this entity. |
search_truncated | Boolean | Whether the search stopped at the page limit, so more matches may exist beyond this result. |
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.
{
"conversation_id": "<string>",
"entities": [
{
"entity_id": "<string>",
"entity_type": "<string>",
"label": "<string>",
"status": "<string>",
"decision_code": "<string>",
"reason": "<string>",
"confidence": "<string>",
"run_id": "<string>"
}
],
"search_truncated": false,
"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. |