Get entity export status and download URL
Learn more about get entity export status and download URL.
Use the Get entity export status and download URL to get the status and download URL of an entity export. This lets you poll an export until it is ready and then download the file.
HTTP method and endpoint
Use the following HTTP method and endpoint path to get entity export status and download URL.
GET {TenantURL}/ai/agentflow/api/v202605/{tenant_id}/lrt/jobs/{conversation_id}/entities/export/{export_id}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. |
export_id | String | Yes | The unique identifier of the entity export. |
tenant_id | String | Yes | The tenant identifier. |
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/example-id/entities/export/example-id
Authorization: <access_token>Response body
The following table describes the fields returned in the response body.
| Parameter | Type | Description |
|---|---|---|
export_id | String | The unique identifier of the entity export. |
status | String | The status of the export job: queued, running, completed, or failed. |
format | String | The output file format of the export, as requested. |
include_conversation | Boolean | Whether the export includes the full conversation record, as requested. |
filters | Object | The entity status and confidence filters applied when the export was created. |
filters.status | String | The status filter applied when the export was created, if one was supplied. |
filters.confidence | String | The confidence filter applied when the export was created, if one was supplied. |
total_count | Integer | The total number of entities matched for this export. |
written_rows | Integer | The number of entity rows written to the export file. |
written_bytes | Integer | The size of the export file, in bytes. |
created_at | String | The date and time when the export was created. |
completed_at | String | The date and time when the export finished. Empty while the export is in progress. |
expires_at | String | The date and time when the download link expires. |
filename | String | The name of the generated export file. |
download_url | String | The URL used to download the completed export file. Empty until the export completes. |
email_sent_at | String | The date and time when a completion email was sent. Empty if no email was sent. |
error_code | String | The error code recorded if the export failed. Null if the export did not fail. |
Example response
The following example shows a response with successful response.
{
"export_id": "<string>",
"status": "<string>",
"format": "<string>",
"include_conversation": false,
"filters": {
"status": "<string>",
"confidence": "<string>"
},
"total_count": 0,
"written_rows": 0,
"written_bytes": 0,
"created_at": "<string>",
"completed_at": "<string>",
"expires_at": "<string>",
"filename": "<string>",
"download_url": "<string>",
"email_sent_at": "<string>",
"error_code": "<string>"
}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. |