{✦} Stylumia Developers

Quickstart

First successful call in minutes — every step below runs from this page.

1

Create your account and key

One email, one code. Then create a named API key — and every example on this page fills in with your key. Keys don't expire; revoke one whenever you're done with it.

Sign in or create an account takes about a minute

2

Make your first call

A capped sample of real catalog rows, deterministic on purpose so you can assert against it.

GET/v1/sample?category=power_tools Sign in to run
curl "https://api.stylumia.com/v1/sample?category=power_tools" \
  -H "Authorization: Bearer $STYLUMIA_KEY"  # Never commit your key — see /docs/key-security

Check meta.resolved in the response — the server echoes every parameter it actually used, including defaults you omitted.

3

Break it on purpose

Guess a category instead of discovering it. The error is the point: retryable tells you not to retry, recovery tells you what to do, and valid_options hands you real values — click one to re-run the fixed call.

GET/v1/catalog?retailer=home_depot&category=power+tool Sign in to run

That loop — fail, read the body, fix, succeed — is what a client does unattended, straight from the response body.

4

See what exists before you pull it

One call tells you how much data matches your filters, per retailer, category and department. Build it visually in the Explorer, or by hand:

GET/v1/coverage
GET/v1/coverage?retailer=home_depot

View as markdown