SDKs — Developer Docs

Node.js / TypeScript

simlir-js

Install the published SDK

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
});

Python

simlir==0.1.2

Install the published SDK

python -m pip install simlir

import os
from simlir import Simlir

client = Simlir(api_key=os.environ["SIMLIR_API_KEY"])
result = client.search(
    query="wireless headphones",
    market="GB",
    limit=10,
)

Shared contract facts

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 1 · visual 2 · exact lookup 1 · product 1

Images

Hosted HTTPS image_url; optional natural-language query context

Errors

400, 401, 402, 403, 404, 405, 413, 429, 500, 502

Operational release evidence

• Stable API deployment and public OpenAPI URL remain proven against the release contract.
• Repository/account administration, an approved licence, assigned maintenance roles, and release permissions.
• npm/PyPI namespace checks, clean-install tests, provenance, support, and a recorded rollback role.
• Contract freshness checks run before every SDK and adapter release.

Start with the public API

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.

Create an API account Read the REST reference