List entity exports for a conversation job

Learn more about list entity exports for a conversation job.

Use the List entity exports for a conversation job to list the entity exports for a conversation job. This lets you find an existing export and get its download URL.

HTTP method and endpoint

Use the following HTTP method and endpoint path to list entity exports for a conversation job.

GET {TenantURL}/ai/agentflow/api/v202605/{tenant_id}/lrt/jobs/{conversation_id}/entities/export

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.

Query parameters

The following table describes the query parameters and their values.


Parameter	Type	Required	Description	Accepted values / Default
`limit`	Integer	No	The maximum number of exports to return per page.	Default: `50`
`page_token`	String	No	The page token from a previous response. Omit to get the first page.	—

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
Authorization: <access_token>

Response body

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


Parameter	Type	Description
`exports`	Array	The exports returned in this page.
`exports[].export_id`	String	The unique identifier of the entity export.
`exports[].status`	String	The status of the export job: queued, running, completed, or failed.
`exports[].format`	String	The output file format of the export, as requested.
`exports[].include_conversation`	Boolean	Whether the export includes the full conversation record, as requested.
`exports[].filters`	Object	The entity status and confidence filters applied when the export was created.
`exports[].filters.status`	String	The status filter applied when the export was created, if one was supplied.
`exports[].filters.confidence`	String	The confidence filter applied when the export was created, if one was supplied.
`exports[].total_count`	Integer	The total number of entities matched for this export.
`exports[].written_rows`	Integer	The number of entity rows written to the export file.
`exports[].written_bytes`	Integer	The size of the export file, in bytes.
`exports[].created_at`	String	The date and time when the export was created.
`exports[].completed_at`	String	The date and time when the export finished. Empty while the export is in progress.
`exports[].expires_at`	String	The date and time when the download link expires.
`exports[].filename`	String	The name of the generated export file.
`exports[].download_url`	String	The URL used to download the completed export file. Empty until the export completes.
`exports[].email_sent_at`	String	The date and time when a completion email was sent. Empty if no email was sent.
`exports[].error_code`	String	The error code recorded if the export failed. Null if the export did not fail.
`next_page_token`	String	The token to pass as page_token to get the next page of results. Empty when there are no more pages.
`total_count`	Integer	The number of exports in this page of results.

Example response

The following example shows a response with paginated list of exports.

{
  "exports": [
    {
      "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>"
    }
  ],
  "next_page_token": "<string>",
  "total_count": 0
}

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`	Job not found	Verify the identifier in the request path and resend the request with a valid identifier.
`422 Unprocessable Entity`	Validation Error	Review the request parameters or body, correct the invalid values, and resend the request.

Unify and manage your data