Skip to content
AACSearch

Recommend from the configured source model

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.
POST
/cms/runtime/stores/{storeId}/sources/{sourceId}/recommendations

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/cms/runtime/stores/string/sources/string/recommendations" \  -H "X-AACSEARCH-INSTALLATION-KEY: string" \  -H "X-AACSEARCH-INSTALLATION-ORIGIN: http://example.com" \  -H "Content-Type: application/json" \  -d '{}'
{  "model_id": "string",  "hits": [    {      "highlights": [        {          "field": "company_name",          "snippet": "<mark>Stark</mark> Industries"        }      ],      "document": {        "id": "124",        "company_name": "Stark Industries",        "num_employees": 5215,        "country": "USA"      },      "text_match": 1234556    }  ],  "took_ms": 0,  "queries": [    "string"  ],  "experiment": "string"}

Record source behavioral events POST

Records clicks, cart and purchase signals through the existing analytics pipeline. The server overrides every event collection with the bound source collection. The installation key never grants tenant-wide API access. Batches are limited to 64 KiB.

List the last 100 commands for an installation GET

List the last 100 commands for an installation. Commands are a fixed set of CMS actions; no remote code or arbitrary parameters can be executed.