Unify and manage your data

Full detail for a single entity in a conversation

Learn more about full detail for a single entity in a conversation.

Use the Full detail for a single entity in a conversation to get the full detail for a single entity in a conversation to retrieve the full record for one entity when you need the complete detail.

HTTP method and endpoint

Use the following HTTP method and endpoint path to full detail for a single entity in a conversation.

POST {TenantURL}/ai/agentflow/api/v202605/{tenant_id}/lrt/jobs/conversation/{conversation_id}/entities/detail

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
entity_idStringYesThe unique identifier of the entity to look up.—

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/detail
Authorization: <access_token>
Content-Type: application/json

{
  "entity_id": "<string>"
}

Response body

The following table describes the fields returned in the response body.

ParameterTypeDescription
conversation_idStringThe unique identifier of the conversation.
entity_idStringThe unique identifier of the entity.
entity_typeStringThe entity type name. The full URI is preserved under attributes.
labelStringThe display label of the entity.
statusStringThe processing status of the entity: processed, failed, or needs_review.
decision_codeStringThe outcome code for the entity (for example NO_MATCH).
reasonStringA short explanation of the outcome.
summaryStringThe full per-entity narrative, when available.
run_summaryStringThe portion of the owning run's summary that concerns this entity. Empty when the entity has no run ID or the run could not be read.
run_summary_is_excerptBooleanWhether run_summary is this entity's own portion of the run summary. When true, the value is this entity's own portion. When false, the value is a generic summary that may describe other records.
run_summary_truncatedBooleanWhether the run summary was shortened to fit the character limit. When true, the run summary is shortened. When false, the run summary is complete.
errorStringThe error text, when the entity failed.
confidenceStringThe confidence band for the outcome, when available.
actionStringThe action that was taken (for example merge or not_match).
record_typeStringThe record type, when available.
run_idStringThe unique identifier of the run that processed this entity.
job_idStringThe unique identifier of the job.
message_idStringThe unique identifier of the parent message.
task_indexIntegerThe index of the task within the message.
created_atStringThe date and time when the record was created.
updated_atStringThe date and time when the record was last updated.
attributesObjectThe remaining raw fields from the agent, excluding oversized values.

Example response

The following example shows a successful response.

{
  "conversation_id": "<string>",
  "entity_id": "<string>",
  "entity_type": "<string>",
  "label": "<string>",
  "status": "<string>",
  "decision_code": "<string>",
  "reason": "<string>",
  "summary": "<string>",
  "run_summary": "<string>",
  "run_summary_is_excerpt": false,
  "run_summary_truncated": false,
  "error": "<string>",
  "confidence": "<string>",
  "action": "<string>",
  "record_type": "<string>",
  "run_id": "<string>",
  "job_id": "<string>",
  "message_id": "<string>",
  "task_index": 0,
  "created_at": "<string>",
  "updated_at": "<string>",
  "attributes": {}
}

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

HTTP statusDescriptionRecommended action
404 Not FoundEntity not found in this conversationVerify the entity_id in the request body and the conversation_id in the request path. Resend the request with valid identifiers.
422 Unprocessable EntityValidation ErrorReview the request parameters or body, correct the invalid values, and resend the request.