Unify and manage your data

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.

ParameterTypeRequiredDescription
TenantURLStringYesThe base URL for your tenant.
conversation_idStringYesThe unique identifier of the conversation associated with the job.
tenant_idStringYesThe tenant identifier.

Request headers

The following request headers must be included.

HeaderValueRequired
Authorization<access_token>Yes
Content-Typeapplication/jsonYes

Request body

The following table describes the request body parameters.

ParameterTypeRequiredDescriptionAccepted values / Default
filter_conditionObjectNoThe filter to apply to the entities in the conversation.—
filter_condition.entity_typeStringNoReturns only entities of this entity type.—
filter_condition.entity_idStringNoReturns only the entity with this identifier.—
filter_condition.statusStringNoReturns only entities with this processing status.—
filter_condition.decision_codeStringNoReturns only entities with this decision code (for example NO_MATCH).—
run_idStringNoScopes the results to a single worker run.—
reason_containsStringNoReturns only entities whose short reason contains this text. The match is not case-sensitive.—
limitIntegerNoThe maximum number of entities to return per page.Default: 25
page_tokenStringNoThe 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.

ParameterTypeDescription
conversation_idStringThe unique identifier of the conversation.
entitiesArrayThe entities that match the filter.
entities[].entity_idStringThe unique identifier of the entity.
entities[].entity_typeStringThe entity type name.
entities[].labelStringThe display label of the entity.
entities[].statusStringThe processing status of the entity: processed, failed, or needs_review.
entities[].decision_codeStringThe outcome code for the entity (for example NO_MATCH).
entities[].reasonStringA short explanation of the outcome, shortened for display.
entities[].confidenceStringThe confidence band for the outcome, when available.
entities[].run_idStringThe unique identifier of the run that processed this entity.
search_truncatedBooleanWhether the search stopped at the page limit, so more matches may exist beyond this result.
paginationObjectPagination details for this page of results.
pagination.total_countIntegerThe number of items in this page of results.
pagination.next_page_tokenStringThe token to pass as page_token to get the next page of results. Empty when this is the last page.
pagination.limitIntegerThe 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
  }
}

The following table lists the possible error responses returned by this API.

HTTP statusDescriptionRecommended action
422 Unprocessable EntityValidation ErrorReview the request parameters or body, correct the invalid values, and resend the request.