List recommendation models
Lists the recommendation models configured on a collection.
Full-key operation
Lists the recommendation models configured on a collection.
Authorization
api_key_header 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
Path Parameters
The name of the collection
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/collections/string/recommendation_models"{ "models": [ { "type": "looking_similar", "vector_field": "string", "event_weights": { "view": 0, "click": 0, "add_to_cart": 0, "purchase": 0, "conversion": 0 }, "decay_half_life_hours": 0, "window_days": 0, "filter_by": "string", "exclude_filter_by": "string", "pins": [ { "id": "string", "position": 0, "filter_by": "string" } ], "blend": { "behavioral": 0, "vector": 0, "graph": 0 }, "cold_start": { "fallback": "trending", "min_results": 3 }, "category_field": "string", "price_field": "string", "upsell_max_ratio": 1, "price_tolerance": 0, "complementary_only": true, "edge_kinds": [ "requires" ], "hops": 1, "sequence_length": 1, "id": "string", "status": "ready", "last_built_at": 0 } ]}Plan, expiry and what is left GET
The organization's subscription and the state of both metered resources. Everything an integration needs to decide what to show: `plan.status` and `plan.expires_at` for the subscription, `features` for what the plan covers, `quota` for search requests in the current period, and `credits` for AI operations (assistants, voice, image and semantic search). Cheap to call and safe to cache for a few minutes — it is not a per-request authorization check, the API enforces the same limits itself.
Retrieve a recommendation model GET
Retrieves the configuration and build status of a recommendation model.