AACsearch
Api reference

Export documents

Exports all or filtered documents from an index as JSONL or JSON.

Exports all or filtered documents from an index as JSONL or JSON.

GET
/indexes/{indexId}/documents/export

Authorization

BearerAuth
AuthorizationBearer <token>

Search API key (ss_search_*) from the dashboard or keys API. Scopes (search, ingest, admin) are stored on the key; each route requires the matching scope.

In: header

Path Parameters

indexId*string

Query Parameters

filterBy?string

Typesense filter expression for partial export.

format?string

Export format. jsonl=NDJSON stream (default), json=parsed array.

Default"jsonl"
Value in"json" | "jsonl"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://loading/api/v1/indexes/string/documents/export"
Empty
{
  "error": "string",
  "message": "string",
  "details": null
}
{
  "error": "string",
  "message": "string",
  "details": null
}
{
  "error": "string",
  "message": "string",
  "details": null
}
{
  "error": "string",
  "message": "string",
  "details": null
}
Empty

Batch delete documents by IDs

Enqueues up to 5 000 documents for deletion by their IDs. Documents are removed asynchronously via the ingest worker.

Delete documents by query

Deletes all documents matching a Typesense filter expression. Requires admin scope. This is a direct Typesense operation (not buffered). Returns the number of deleted documents.