Logo

Export documents

This endpoint paginates through all documents in a namespace.

If you want to look up documents by ID, use the query endpoint with an id filter. This endpoint is generally faster than paginating through querying.

Documents inserted while the export is in progress will be included.

A common use-case for this endpoint is to copy your all documents to a different namespace after some transformation.

Parameters

cursor stringoptional

used to retrieve the next page of results (pass next_cursor from the response payload)

This endpoint may return 202 ACCEPTED if the data is not ready for export. In this case, retry the request after several seconds.

Documents, ids, and attributes are returned in a column-oriented layout Documents are returned in insertion order, with each batch containing up to 10,000 documents. Each batch is billed at the cost of 1 query.

Examples

// GET /v1/namespaces/namespace-name
{
  "ids": [1, 2],
  "vectors": [[0.1, 0.1], [0.2, 0.2]],
  "attributes": {
    "key1": ["one", "two"],
    "key2": ["a", "b"]
  },
  "next_cursor": "eyJmaWxlX2lkIjoxMTMzfQ"
}

// GET /v1/namespaces/namespace-name?cursor=eyJmaWxlX2lkIjoxMTMzfQ
{
  "ids": [3, 4],
  "vectors": [[0.3, 0.3], [0.4, 0.4]],
  "attributes": {
    "key1": ["three", "four"],
    "key2": ["c", "d"]
  },
  "next_cursor": null
}
© 2024 turbopuffer Inc.
Privacy PolicyTerms of service