Skip to content
AACSearch

List all collections

Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first.

Full-key operation

Requires a full key; a search key or a browser key gets a 403. See Keys and credits.
GET
/collections

Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first.

Authorization

api_key_header
X-NOVA-API-KEY<token>

Every request carries an organization API key. A key has one of two scopes. A full key reaches every operation in this document and belongs on your server. A search key is the one to ship in a browser widget or a storefront page: it reaches only the operations marked x-nova-key-scope: search — searching, federated search, recommendations, event ingestion, and the visitor-facing AI operations (semantic and image search, voice transcription and voice search, assistant chat, and the visitor's own conversation). It cannot write documents or read or change configuration; any other operation answers 403. AI operations are paid in credits from the organization's wallet whichever key calls them (402 when the balance runs out), and a search key needs X-NOVA-SESSION-ID on them: the session is what a conversation belongs to, and what the per-session allowance (429) is counted against. A key of either scope may additionally carry restrictions set in the console: an allowlist of collections (403 elsewhere), a forced filter_by per collection that is ANDed into every search (document-level access control), an allowlist of fields (include_fields is limited to it and a request naming any other field in query_by, facet_by, sort_by, filter_by or highlight_fields answers 400), an IP/CIDR allowlist and an Origin/Referer allowlist (403), and a per-key rate limit (429 with Retry-After).

In: header

Query Parameters

getCollectionsParameters?

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/collections"
[  {    "name": "companies",    "fields": [      {        "name": "num_employees",        "type": "int32",        "facet": false      },      {        "name": "company_name",        "type": "string",        "facet": false      },      {        "name": "country",        "type": "string",        "facet": true      }    ],    "default_sorting_field": "num_employees",    "token_separators": [],    "curation_sets": [      "curation_set_1"    ],    "synonym_sets": [      "synonym_set_1"    ],    "enable_nested_fields": true,    "symbols_to_index": [],    "voice_query_model": {      "model_name": "ts/whisper/base.en"    },    "metadata": {},    "num_documents": 0,    "created_at": 0  }]