Loading documentation…
Loading documentation…
Typed Node.js and Python clients that preserve the public API contract, market validation, bounded requests, and safe error handling.
The checked-in candidates are private and intentionally not installable from npm or PyPI yet. The commands below show the intended integration shape, not a claim that those registry releases exist today. Use the canonical REST contract now.
simlir-js
npm install simlir-js
import { Simlir } from 'simlir-js';
const client = new Simlir({
apiKey: process.env.SIMLIR_API_KEY
});
const result = await client.search({
query: 'wireless headphones',
market: 'GB',
limit: 10
});simlir
python -m pip install simlir
from simlir import Simlir
client = Simlir(api_key=os.environ["SIMLIR_API_KEY"])
result = client.search(
query="wireless headphones",
market="GB",
limit=10,
)Required market code
gb, us, de, fr, es, it, au, ca
Beta catalogue
United Kingdom currently live. United States planned next.
Tool/API credits
Semantic 2 · visual 3 · exact lookup 1 · product 1
Images
Hosted HTTPS image_url only for visual search
Errors
400, 401, 402, 403, 404, 405, 413, 429, 500, 502
Create an account, generate a key, and use the same market-scoped contract from any channel. Keep keys in a server-side secret manager; never put one in a browser bundle, checked-in config, or support ticket.
Existing v1 Bearer keys and endpoints remain the compatibility baseline. There are no user-selectable scopes or sandbox environments today; the public demo and dashboard playground are separate evaluation surfaces, not alternate API environments.