Create an entity export for a conversation job

Learn more about create an entity export for a conversation job.

Use the Create an entity export for a conversation job to export the per-entity results of a conversation job to a CSV or JSONL file. After the export completes, you can download the file and analyze the results outside Reltio.

HTTP method and endpoint

Use the following HTTP method and endpoint path to create an entity export for a conversation job.

POST {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 created by 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
format	String	No	The output file format for the export.	`csv`, `jsonl`. Default: `csv`
status	String	No	Filters the exported entities by status, for example processed, failed, or needs_review.	—
confidence	String	No	Filters the exported entities by confidence band, when the producer emitted one.	—
include_conversation	Boolean	No	Whether to include the full conversation record alongside the exported entities. Set to `true` to include the record. Set to `false` to export only the entities.	Default: `false`

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/example-id/entities/export
Authorization: <access_token>
Content-Type: application/json

{
  "format": "<string>",
  "status": "<string>",
  "confidence": "<string>",
  "include_conversation": false
}

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 entity 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 the response when an identical export already exists

{
  "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
`404 Not Found`	Job not found	Verify the `conversation_id` value in the request path and resend the request with the identifier of an existing conversation..
`409 Conflict`	The job is still pending or running.	Wait until the job is no longer pending or running, then resend the request.
`422 Unprocessable Entity`	Validation Error	Review the request parameters or body, correct the invalid values, and resend the request.

Unify and manage your data