Skip to content
AACSearch

Read the collection schema for an installation source

Uses only the connector and collection explicitly bound to this installation source. The installation key never grants tenant-wide API access.

Full-key operation

Requires a full key; a search key or a browser key gets a 403. See Keys and credits.
GET
/cms/runtime/stores/{storeId}/sources/{sourceId}/schema

Uses only the connector and collection explicitly bound to this installation source. The installation key never grants tenant-wide API access.

Path Parameters

storeId*string
sourceId*string

Header Parameters

X-AACSEARCH-INSTALLATION-KEY*string

Dedicated installation credential, issued once in Console.

Match^aac_install_[a-f0-9]{64}$
X-AACSEARCH-INSTALLATION-ORIGIN*string

HTTPS origin pinned to this installation; clones require another installation.

Formaturi

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/cms/runtime/stores/string/sources/string/schema" \  -H "X-AACSEARCH-INSTALLATION-KEY: string" \  -H "X-AACSEARCH-INSTALLATION-ORIGIN: http://example.com"
{  "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}

Report discovery and acknowledge an applied configuration POST

Report discovery and acknowledge an applied configuration. Runtime credentials are installation-scoped and cannot authenticate against the tenant API.

Search an installation source with facets POST

Uses only the connector and collection explicitly bound to this installation source. The installation key never grants tenant-wide API access.