Skip to main content

Export Record Set

Export every record in a record set as a single JSON response: record IDs, source documents, ordinals, keys, statuses, and confidence, without pagination.

Export the complete list of records in a record set as one JSON response, without pagination. Each exported record carries its identity metadata: the record UUID, the document_id it maps to, its ordinal position, the optional record_key, the row status, and the aggregate confidence. Use it when you need the full row inventory of a set in a single call, for example to drive a bulk sync or an offline audit.

The export returns row metadata only. To read the cell values, page through GET /v1/record-sets/{id}/records?include=values, which attaches the latest cell value, status, and confidence per field. For very large sets, or for pushing complete datasets to S3, SFTP, or a webhook, the delivery module is the better fit than repeated exports.

GET/v1/record-sets/{id}/export

Path parameters

id*uuidRecord set UUID. Must belong to your organization.

Response

Response fields

record_set_idstringUUID of the exported record set.
namestringRecord set name.
totalintegerTotal number of exported records.
recordsarrayComplete array of record objects, ordered by ordinal.
records[].idstringRecord UUID.
records[].document_idstring | nullSource document UUID, if the record maps to a document.
records[].ordinalintegerStable row order within the record set (0-based).
records[].record_keystring | nullExternal or customer-defined key, when known.
records[].statusstringRow-level lifecycle state.
records[].confidencenumber | nullAggregate confidence for the row (0-1).

curl

Response

{
  "record_set_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Resolution Run 2024-10-15",
  "total": 142,
  "records": [
    {
      "id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
      "document_id": "d1c2b3a4-e5f6-7890-abcd-ef1234567890",
      "ordinal": 0,
      "record_key": "INV-2024-0042",
      "status": "active",
      "confidence": 0.96
    }
  ]
}
The export contains record metadata, not cell values. To read values, call the records endpoint with include=values, or configure a delivery binding to push assembled output to a destination.

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundRecord set not found or does not belong to your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.