API Reference

The vviinn REST API lets you call search, recommendation, and product management endpoints directly, without going through a prebuilt Widget component — useful if you’re building your own front-end or syncing products from your backend. It uses the same site credentials as the widgets and MCP tools.

Note

This reference covers merchant-facing endpoints only. For agent-oriented tooling built on top of this API, see Developer Tools (MCP).

Base URL

All requests go to https://api.vviinn.com.

Authentication

Every endpoint authenticates with one of your site’s two credentials, both found in your site settings in Panel:

• Read-only token — a bearer token for search and recommendation requests. It can’t read sensitive data or change anything, so it’s safe to use in the browser.
• Site credentials — HTTP basic credentials that can also read sensitive data and modify your site, such as setting or deleting products. Keep them secret and use them only on the server side.

Endpoints

The endpoints are grouped in the sidebar under Endpoints, starting from the reference overview:

• Services — text search, auto-suggest, visual search, similar products, cross-selling, and attribute prediction. Start with Text-Search Products.
• Product Management — set and delete products in your catalog.
• Model Context Protocol (MCP) — the endpoint AI agents connect to.

The full spec behind this reference is also available as a raw OpenAPI document at /openapi.yaml, for generating a client or importing into your own API tooling.