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.
| 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 |
|---|---|---|---|---|
| entity_id | String | Yes | The 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.
| Parameter | Type | Description |
|---|---|---|
conversation_id | String | The unique identifier of the conversation. |
entity_id | String | The unique identifier of the entity. |
entity_type | String | The entity type name. The full URI is preserved under attributes. |
label | String | The display label of the entity. |
status | String | The processing status of the entity: processed, failed, or needs_review. |
decision_code | String | The outcome code for the entity (for example NO_MATCH). |
reason | String | A short explanation of the outcome. |
summary | String | The full per-entity narrative, when available. |
run_summary | String | The 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_excerpt | Boolean | Whether 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_truncated | Boolean | Whether the run summary was shortened to fit the character limit. When true, the run summary is shortened. When false, the run summary is complete. |
error | String | The error text, when the entity failed. |
confidence | String | The confidence band for the outcome, when available. |
action | String | The action that was taken (for example merge or not_match). |
record_type | String | The record type, when available. |
run_id | String | The unique identifier of the run that processed this entity. |
job_id | String | The unique identifier of the job. |
message_id | String | The unique identifier of the parent message. |
task_index | Integer | The index of the task within the message. |
created_at | String | The date and time when the record was created. |
updated_at | String | The date and time when the record was last updated. |
attributes | Object | The 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": {}
}
Error codes and recommended actions
The following table lists the possible error responses returned by this API.
| HTTP status | Description | Recommended action |
|---|---|---|
404 Not Found | Entity not found in this conversation | Verify the entity_id in the request body and the conversation_id in the request path. Resend the request with valid identifiers. |
422 Unprocessable Entity | Validation Error | Review the request parameters or body, correct the invalid values, and resend the request. |