Auric Artisan · Documentation

REST API Reference

Published July 8, 2026 - Updated August 12, 2026

Back to Documentation Manage API Keys

Overview

The Auric Artisan REST API exposes the full color-science toolkit — conversions, palettes, harmonies, gradients, shade scales, WCAG/APCA accessibility checks, color-vision-deficiency simulation and Ishihara plates — as JSON-over-HTTPS endpoints under /v1. Base URL https://api.auricartisan.com. Authenticate with an API key created in your account dashboard.

1. Quick Start

Create an API key. Go to Dashboard → API Keys and create a key. The full key is shown once — copy it somewhere safe. You can hold up to 10 active keys and revoke any of them instantly.
Send it with every request in the x-api-key header. Requests without a valid key receive 401 Unauthorized.
Call any endpoint. Tool endpoints accept JSON via POST and reply in JSON. GET /v1 lists everything the API can do.

# Convert a color to OKLCH
curl -X POST https://api.auricartisan.com/v1/color/convert \
  -H "x-api-key: aa_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"color": "#d3af37", "to": "oklch"}'

# → {"input":{"rgb":[211,175,55],"hex":"#d3af37"},"to":"oklch",
#    "value":[0.7655,0.1384,91.55]}

2. Authentication

Every metered endpoint requires one of the following credentials.

Method	How	Best for
API key (recommended)	`x-api-key: aa_…` header, or `?key=aa_…` query parameter	Servers, scripts, CI — create in the dashboard
OAuth bearer	`Authorization: Bearer <token>` from the CLI device flow	The `auric` CLI and interactive tools

Keys are secret. The full key is displayed once at creation and stored only as a SHA-256 hash — nobody (including us) can recover it later. If a key leaks, revoke it in the dashboard; revocation takes effect within a minute. Each successful request updates the key's last used timestamp, which you can audit in the dashboard.

3. Rate Limits, Credits And Quotas

Limits follow your account plan. Rate limit, monthly credits and credit balance are pooled per account, not per key — ten keys share one allowance, so splitting traffic across keys buys you nothing.

Credits

The monthly quota is denominated in credits, not calls. One credit is one standard request; endpoints that cost more CPU cost more credits, so a caller doing simple colour maths does not subsidise one rendering PNGs. The cost of a call is returned in the x-credits-cost header of every response.

Credits	Endpoints
1	Standard work — `/v1/color/convert`, `/v1/color/contrast`, `/v1/science/convert`, `/v1/accessibility/check`, `/v1/vision/simulate`, and anything not listed below
2–4	Generators and multi-step maths — `/v1/palette/generate`, `/v1/harmony/generate`, `/v1/gradient/generate`, `/v1/shade/scale`, `/v1/science/delta-e`, `/v1/science/temperature`, `/v1/tokens/generate`, `/v1/graphql`
5	`/v1/science/dossier` (all 63 colour spaces plus a locus search) and `/v1/usage/stream` (charged once when the stream opens; events are free)
10–12	Rendered pixels — `/v1/palette/png`, `/v1/gradient/png`, `/v1/ishihara/png`, `/v1/vision/simulate-image`, `/v1/palette/from-image`, `/v1/accessibility/from-image`
25	Async jobs — `POST /v1/jobs/{type}`. Polling one with `GET /v1/jobs/id/{id}` costs 1

A new endpoint nobody has weighted yet bills as standard work (1 credit) — never free by accident. GET /v1/tiers returns the machine-readable version of the table below, so a client can read its own terms rather than hard-coding them.

What each plan includes

Plan	API tier	Requests / min	Credits / month	Hard ceiling	Max keys
Apprentice (free)	Free	—	Not included	—	—
Artisan	Paid	—	Not included	—	—
Specialist	Pro	300	1,000,000	10,000,000	10
Industrial Pro	Enterprise	3,000	10,000,000	100,000,000	10

Industrial Pro was sold as “Unlimited” before 12 August 2026. Subscriptions created before that date keep that allowance — they are metered at 1,000,000,000 credits a month, a hundred times the new included figure, which at 3,000 requests a minute cannot be reached inside a month. The finite allowance in the table applies to subscriptions started on or after 12 August 2026.

Past the allowance: overage, spend caps, ceilings

By default, running out of credits stops the traffic: further calls return 429 QUOTA_EXCEEDED until the monthly reset. Nothing is charged.

Pay-as-you-go overage is opt-in, off until you enable it in Dashboard → API Keys, and strictly prepaid — it spends a credit balance bought in advance, at $1.00 (₹85) per 100,000 credits. If the balance will not cover a call, the call is refused with 402 INSUFFICIENT_CREDITS; it is never served on account. No usage produces an invoice after the fact.

Spend cap. Set a monthly ceiling in money (up to $10,000). Overage stops there with 402 SPEND_CAP_REACHED — raise it in the dashboard to continue.
Hard ceiling. Independent of everything you configure, no account may spend more than ten times its included allowance in one month. Hitting it returns 429 HARD_CEILING_REACHED. It is a safety stop against runaway retries and leaked keys, not a sales lever; support can raise it per key.

Reading the meter

Every response carries your live consumption, so clients can self-throttle:

x-ratelimit-limit: 300            # requests allowed per minute
x-ratelimit-remaining: 297
x-ratelimit-reset: 1783502302     # unix seconds
x-quota-limit: 1000000            # included credits this month
x-quota-used: 412
x-quota-remaining: 999588
x-quota-reset: 1785091200         # unix seconds
x-credits-cost: 10                # what this call consumed

# only present once a call is paid for out of the prepaid balance:
x-credits-overage: 10
x-overage-cost-usd: 0.00          # 1.00 only when this call opens a new
                                  # 100,000-credit block; 0.00 inside one
x-credits-ceiling: 10000000

Check your usage anytime with GET /v1/usage/me, or full analytics with GET /v1/usage. A quota.threshold webhook fires when you cross 80% of the included allowance, so you can find out before your callers do.

4. Endpoint Reference

Everything lives under /v1. The interactive reference (GET /v1/docs) and the OpenAPI spec (GET /v1/openapi.yaml) are served by the API itself. The tables below are generated from the API's own route table, so they list every endpoint the service actually exposes. Auth shows the credential required: None means the endpoint is public and unmetered.

Every endpoint the service exposes — 64 of them — generated from the API's own catalogue, which the test suite refuses to let drift from the router. Auth shows the credential required; None means the endpoint is public and unmetered.

Method	Path	Auth	Summary
`GET`	`/v1`	None	Index of every endpoint, with the current version.
`GET`	`/v1/health`	None	Liveness probe. Always cheap, never touches storage.
`GET`	`/v1/ready`	None	Readiness probe — reports whether each backing store is bound.
`GET`	`/v1/methods/:tool`	`x-api-key`	The algorithms a given tool supports.
`GET`	`/v1/formats`	None	Every export format, across every exportable resource.
`GET`	`/v1/tiers`	None	Rate limit and monthly quota for each tier.
`GET`	`/v1/metrics`	None	Prometheus exposition of process-level counters.
`GET`	`/v1/status`	None	Human-readable status page.
`GET`	`/v1/catalog`	None	This catalogue as JSON — every endpoint with its parameters and examples.
`GET`	`/v1/docs`	None	Interactive reference (Redoc).
`GET`	`/v1/openapi.yaml`	None	The OpenAPI 3.1 document.
`GET`	`/v1/graphql`	None	GraphQL playground.
`POST`	`/v1/graphql`	`x-api-key`	Run a GraphQL query against the same resolvers as the REST surface.
`POST`	`/v1/color/convert`	`x-api-key`	Convert one colour between the common spaces.
`POST`	`/v1/color/contrast`	`x-api-key`	WCAG contrast ratio between two colours, with pass/fail at each level.
`GET`	`/v1/science/spaces`	`x-api-key`	Every colour space the platform knows, with provenance.
`GET`	`/v1/science/spaces/:key`	`x-api-key`	One colour space in full, including its conversion matrices.
`POST`	`/v1/science/convert`	`x-api-key`	Convert a colour into any registry space, or several at once.
`POST`	`/v1/science/dossier`	`x-api-key`	One colour rendered in every space at once, plus its colour temperature.
`POST`	`/v1/science/delta-e`	`x-api-key`	Perceptual difference between two colours.
`POST`	`/v1/science/temperature`	`x-api-key`	Correlated colour temperature from a colour, or the colour of a temperature.
`GET`	`/v1/science/illuminants`	`x-api-key`	Standard reference illuminants with their chromaticities.
`GET`	`/v1/science/metrics`	`x-api-key`	The difference formulae, their options, and when to use each.
`POST`	`/v1/palette/generate`	`x-api-key`	Generate a palette from a seed colour.
`POST`	`/v1/palette/evaluate`	`x-api-key`	Score a palette for harmony, contrast and accessibility.
`POST`	`/v1/palette/export`	`x-api-key`	Render a palette into a design-tool format (ASE, GPL, ACO, …).
`POST`	`/v1/palette/from-image`	`x-api-key`	Extract a palette from an uploaded image.
`POST`	`/v1/palette/png`	`x-api-key`	Render a palette as a PNG swatch sheet.
`POST`	`/v1/harmony/generate`	`x-api-key`	Build a harmony set (complementary, triadic, analogous, …) from a base colour.
`POST`	`/v1/harmony/classify`	`x-api-key`	Identify which harmony an existing set of colours follows.
`POST`	`/v1/harmony/export`	`x-api-key`	Export a harmony set.
`POST`	`/v1/gradient/generate`	`x-api-key`	Interpolate a gradient between stops, in a chosen space.
`POST`	`/v1/gradient/export`	`x-api-key`	Export a gradient as CSS, SVG or a design-tool format.
`POST`	`/v1/gradient/png`	`x-api-key`	Render a gradient as a PNG.
`POST`	`/v1/shade/scale`	`x-api-key`	Build a tint/shade scale from one colour.
`POST`	`/v1/shade/export`	`x-api-key`	Export a shade scale.
`POST`	`/v1/tokens/generate`	`x-api-key`	Turn one seed colour into a complete, contrast-checked token system.
`POST`	`/v1/tokens/export`	`x-api-key`	Render a token deck for a specific platform.
`GET`	`/v1/tokens/formats`	`x-api-key`	The ten token export targets.
`POST`	`/v1/accessibility/check`	`x-api-key`	Check a foreground/background pair against WCAG 2.2 and APCA.
`POST`	`/v1/accessibility/recommend`	`x-api-key`	Suggest the nearest accessible alternative to a failing pair.
`POST`	`/v1/accessibility/from-image`	`x-api-key`	Audit the colour contrast present in an image.
`GET`	`/v1/vision/models`	`x-api-key`	The colour-vision deficiency models available.
`POST`	`/v1/vision/simulate`	`x-api-key`	Simulate how a colour appears under a vision deficiency.
`POST`	`/v1/vision/simulate-image`	`x-api-key`	Simulate a vision deficiency across a whole image.
`POST`	`/v1/ishihara/plate`	`x-api-key`	Generate an Ishihara test plate as structured data.
`POST`	`/v1/ishihara/png`	`x-api-key`	Render an Ishihara plate as a PNG.
`GET`	`/v1/usage`	`x-api-key`	Durable per-day, per-endpoint history for your key.
`GET`	`/v1/usage/me`	`x-api-key`	Your tier, limits and month-to-date quota consumption.
`GET`	`/v1/usage/live`	`x-api-key`	The last 100 individual calls, with rolling latency and error stats.
`GET`	`/v1/usage/stream`	`x-api-key`	The same live feed, pushed over Server-Sent Events.
`GET`	`/v1/jobs`	`x-api-key`	The async job types this deployment can run.
`POST`	`/v1/jobs/:type`	`x-api-key`	Queue a long-running job and get an id back immediately.
`GET`	`/v1/jobs/id/:id`	`x-api-key`	Poll one job.
`GET`	`/v1/jobs/id/:id/stream`	`x-api-key`	Follow a job to completion over SSE instead of polling.
`GET`	`/v1/webhooks/events`	None	Event types you can subscribe to.
`GET`	`/v1/webhooks`	`x-api-key`	List your webhook subscriptions.
`POST`	`/v1/webhooks`	`x-api-key`	Subscribe a URL to one or more events.
`GET`	`/v1/webhooks/:id`	`x-api-key`	Fetch one subscription.
`DELETE`	`/v1/webhooks/:id`	`x-api-key`	Revoke a subscription.
`GET`	`/v1/admin/keys`	`x-admin-key`	List issued API keys.
`POST`	`/v1/admin/keys`	`x-admin-key`	Issue a key. The secret is shown once and stored only as a hash.
`GET`	`/v1/admin/keys/:id`	`x-admin-key`	Fetch one key record (never the secret).
`DELETE`	`/v1/admin/keys/:id`	`x-admin-key`	Revoke a key immediately.

Discovery

GET `/v1` No key

Index of every endpoint, with the current version.

Returns version string, endpoints string[]

Example

curl "https://api.auricartisan.com/v1"

GET `/v1/health` No key

Liveness probe. Always cheap, never touches storage.

Returns ok boolean, time ISO-8601

Example

curl "https://api.auricartisan.com/v1/health"

GET `/v1/ready` No key

Readiness probe — reports whether each backing store is bound.

Use this in a deploy gate. /v1/health says the process is up; this says it can actually serve.

Returns ready boolean, checks object

Example

curl "https://api.auricartisan.com/v1/ready"

GET `/v1/methods/:tool`

The algorithms a given tool supports.

Parameters

Name	Type	Required	Description
`tool`	path	Yes	e.g. `palette`, `harmony`, `vision`.

Example

curl "https://api.auricartisan.com/v1/methods/harmony" \
  -H "x-api-key: $AURIC_API_KEY"

GET `/v1/formats` No key

Every export format, across every exportable resource.

Example

curl "https://api.auricartisan.com/v1/formats"

GET `/v1/tiers` No key

Rate limit and monthly quota for each tier.

Example

curl "https://api.auricartisan.com/v1/tiers"

GET `/v1/metrics` No key

Prometheus exposition of process-level counters.

Example

curl "https://api.auricartisan.com/v1/metrics"

GET `/v1/status` No key

Human-readable status page.

Example

curl "https://api.auricartisan.com/v1/status"

GET `/v1/catalog` No key

This catalogue as JSON — every endpoint with its parameters and examples.

Machine-readable and generated from the same source as the OpenAPI spec, so a client can build its own reference or validate coverage.

Example

curl "https://api.auricartisan.com/v1/catalog"

GET `/v1/docs` No key

Interactive reference (Redoc).

Example

curl "https://api.auricartisan.com/v1/docs"

GET `/v1/openapi.yaml` No key

The OpenAPI 3.1 document.

Example

curl "https://api.auricartisan.com/v1/openapi.yaml"

Colour

POST `/v1/color/convert`

Convert one colour between the common spaces.

For the full 63-space registry with white-point control, use /v1/science/convert.

Request body

Name	Type	Required	Description
`color`	color	Yes	A colour as `#rrggbb`, `#rgb`, `rgb(r,g,b)`, `[r,g,b]`, or `{r,g,b}`.
`to`	string	No	A single target space. Omit to get every common space at once.

Example

curl -X POST "https://api.auricartisan.com/v1/color/convert" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"color":"#c9a227","to":"lab"}'

POST `/v1/color/contrast`

WCAG contrast ratio between two colours, with pass/fail at each level.

Request body

Name	Type	Required	Description
`foreground`	color	Yes	A colour as `#rrggbb`, `#rgb`, `rgb(r,g,b)`, `[r,g,b]`, or `{r,g,b}`.
`background`	color	Yes	A colour as `#rrggbb`, `#rgb`, `rgb(r,g,b)`, `[r,g,b]`, or `{r,g,b}`.

Returns ratio number, aa boolean, aaa boolean, aa_large boolean

Example

curl -X POST "https://api.auricartisan.com/v1/color/contrast" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"foreground":"#767676","background":"#ffffff"}'

Colour science

GET `/v1/science/spaces`

Every colour space the platform knows, with provenance.

Sixty-three spaces across RGB working spaces, CIE spaces, perceptual and appearance models, HDR containers, print and video. Ask for full=true to get primaries, transfer curves and the XYZ matrices.

Parameters

Name	Type	Required	Description
`category`	query	No	Filter: `rgb`, `cie`, `perceptual`, `cylindrical`, `appearance`, `hdr`, `print`, `video`, `order`, `opponent`.
`full`	query	No	`true` to include matrices, primaries and transfer functions.

Example

curl "https://api.auricartisan.com/v1/science/spaces?category=perceptual" \
  -H "x-api-key: $AURIC_API_KEY"

GET `/v1/science/spaces/:key`

One colour space in full, including its conversion matrices.

Parameters

Name	Type	Required	Description
`key`	path	Yes	e.g. `oklch`, `display-p3`, `acescct`.

Errors UNKNOWN_SPACE (404) — No space with that key. The response suggests near matches.

Example

curl "https://api.auricartisan.com/v1/science/spaces/oklch" \
  -H "x-api-key: $AURIC_API_KEY"

POST `/v1/science/convert`

Convert a colour into any registry space, or several at once.

Request body

Name	Type	Required	Description
`color`	color	Yes	A colour as `#rrggbb`, `#rgb`, `rgb(r,g,b)`, `[r,g,b]`, or `{r,g,b}`.
`to`	string \| string[]	Yes	One space key, or an array of them.
`white_point`	string	No	Reference white, default `D65`.

Example

curl -X POST "https://api.auricartisan.com/v1/science/convert" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"color":"#c9a227","to":["lab","oklch","display-p3"]}'

POST `/v1/science/dossier`

One colour rendered in every space at once, plus its colour temperature.

The full lab readout. Expensive relative to convert — reach for it when you want everything, not when you want three spaces.

Request body

Name	Type	Required	Description
`color`	color	Yes	A colour as `#rrggbb`, `#rgb`, `rgb(r,g,b)`, `[r,g,b]`, or `{r,g,b}`.
`white_point`	string	No	Reference white, default `D65`.
`category`	string	No	Restrict to one category.

Example

curl -X POST "https://api.auricartisan.com/v1/science/dossier" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"color":"#c9a227"}'

POST `/v1/science/delta-e`

Perceptual difference between two colours.

Returns CIE76, CIE94, CIEDE2000 and CMC together, with a plain-language band. CIEDE2000 is the headline figure and is verified against the Sharma reference set.

Request body

Name	Type	Required	Description
`from`	color	Yes	A colour as `#rrggbb`, `#rgb`, `rgb(r,g,b)`, `[r,g,b]`, or `{r,g,b}`.
`to`	color	Yes	A colour as `#rrggbb`, `#rgb`, `rgb(r,g,b)`, `[r,g,b]`, or `{r,g,b}`.
`metric`	string	No	`ciede2000` (default headline), `cie94`, `cie76`, `cmc`, or `all`.
`application`	string	No	CIE94 only: `graphic` (default) or `textile`.
`l`	number	No	CMC lightness weight, default 2.
`c`	number	No	CMC chroma weight, default 1.

Returns delta_e number, band string, metrics object

Example

curl -X POST "https://api.auricartisan.com/v1/science/delta-e" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"from":"#c9a227","to":"#d3af37"}'

POST `/v1/science/temperature`

Correlated colour temperature from a colour, or the colour of a temperature.

Send color to measure, or kelvin to render. Always returns Duv alongside the CCT — beyond about ±0.05 the colour is too far from the Planckian locus for a temperature to describe it, and meaningful says so.

Request body

Name	Type	Required	Description
`color`	color	No	Measure this colour. Mutually exclusive with `kelvin`.
`kelvin`	number	No	Render this temperature, 1667–25000 K.

Returns cct_kelvin number, duv number, meaningful boolean, tint string

Example

curl -X POST "https://api.auricartisan.com/v1/science/temperature" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"color":"#fff5e1"}'

GET `/v1/science/illuminants`

Standard reference illuminants with their chromaticities.

Example

curl "https://api.auricartisan.com/v1/science/illuminants" \
  -H "x-api-key: $AURIC_API_KEY"

GET `/v1/science/metrics`

The difference formulae, their options, and when to use each.

Example

curl "https://api.auricartisan.com/v1/science/metrics" \
  -H "x-api-key: $AURIC_API_KEY"

Palettes

POST `/v1/palette/generate`

Generate a palette from a seed colour.

Request body

Name	Type	Required	Description
`seed`	color	No	A colour as `#rrggbb`, `#rgb`, `rgb(r,g,b)`, `[r,g,b]`, or `{r,g,b}`.
`count`	integer	No	How many colours.
`method`	string	No	See `/v1/methods/palette`.

Example

curl -X POST "https://api.auricartisan.com/v1/palette/generate" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"seed":"#c9a227","count":5}'

POST `/v1/palette/evaluate`

Score a palette for harmony, contrast and accessibility.

Request body

Name	Type	Required	Description
`colors`	color[]	Yes	The palette to assess.

Example

curl -X POST "https://api.auricartisan.com/v1/palette/evaluate" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"colors":["#c9a227","#1d2a3e","#fffcf7"]}'

POST `/v1/palette/export`

Render a palette into a design-tool format (ASE, GPL, ACO, …).

Request body

Name	Type	Required	Description
`colors`	color[]	Yes	The palette to render.
`format`	string	Yes	See `/v1/formats`.

Example

curl -X POST "https://api.auricartisan.com/v1/palette/export" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"colors":["#c9a227","#1d2a3e"],"format":"ase"}'

POST `/v1/palette/from-image`

Extract a palette from an uploaded image.

Request body

Name	Type	Required	Description
`image`	string	Yes	Base64 or data URL.
`count`	integer	No	Colours to extract.

Example

curl -X POST "https://api.auricartisan.com/v1/palette/from-image" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

POST `/v1/palette/png`

Render a palette as a PNG swatch sheet.

Request body

Name	Type	Required	Description
`colors`	color[]	Yes	The palette to draw.

Returns image/png

Example

curl -X POST "https://api.auricartisan.com/v1/palette/png" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

Harmony

POST `/v1/harmony/generate`

Build a harmony set (complementary, triadic, analogous, …) from a base colour.

Request body

Name	Type	Required	Description
`color`	color	Yes	A colour as `#rrggbb`, `#rgb`, `rgb(r,g,b)`, `[r,g,b]`, or `{r,g,b}`.
`scheme`	string	No	See `/v1/methods/harmony`.

Example

curl -X POST "https://api.auricartisan.com/v1/harmony/generate" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"color":"#c9a227","scheme":"triadic"}'

POST `/v1/harmony/classify`

Identify which harmony an existing set of colours follows.

Request body

Name	Type	Required	Description
`colors`	color[]	Yes	The colours to classify.

Example

curl -X POST "https://api.auricartisan.com/v1/harmony/classify" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

POST `/v1/harmony/export`

Export a harmony set.

Request body

Name	Type	Required	Description
`colors`	color[]	Yes	The harmony set to render.
`format`	string	Yes	See `/v1/formats`.

Example

curl -X POST "https://api.auricartisan.com/v1/harmony/export" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

Gradients

POST `/v1/gradient/generate`

Interpolate a gradient between stops, in a chosen space.

Request body

Name	Type	Required	Description
`stops`	color[]	Yes	Two or more colours.
`steps`	integer	No	Samples to return.
`space`	string	No	Interpolation space — `oklab` avoids the grey dip that `srgb` produces.

Example

curl -X POST "https://api.auricartisan.com/v1/gradient/generate" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"stops":["#c9a227","#1d2a3e"],"steps":7,"space":"oklab"}'

POST `/v1/gradient/export`

Export a gradient as CSS, SVG or a design-tool format.

Request body

Name	Type	Required	Description
`stops`	color[]	Yes	The gradient stops.
`format`	string	Yes	See `/v1/formats`.

Example

curl -X POST "https://api.auricartisan.com/v1/gradient/export" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

POST `/v1/gradient/png`

Render a gradient as a PNG.

Request body

Name	Type	Required	Description
`stops`	color[]	Yes	The gradient stops.

Returns image/png

Example

curl -X POST "https://api.auricartisan.com/v1/gradient/png" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

Shades

POST `/v1/shade/scale`

Build a tint/shade scale from one colour.

Request body

Name	Type	Required	Description
`color`	color	Yes	A colour as `#rrggbb`, `#rgb`, `rgb(r,g,b)`, `[r,g,b]`, or `{r,g,b}`.
`steps`	integer	No	Steps in the scale.

Example

curl -X POST "https://api.auricartisan.com/v1/shade/scale" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"color":"#c9a227","steps":9}'

POST `/v1/shade/export`

Export a shade scale.

Request body

Name	Type	Required	Description
`color`	color	Yes	Base colour of the scale.
`format`	string	Yes	See `/v1/formats`.

Example

curl -X POST "https://api.auricartisan.com/v1/shade/export" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

Design tokens

POST `/v1/tokens/generate`

Turn one seed colour into a complete, contrast-checked token system.

Ramps are stepped in OKLCH so every hue is perceptually even, chroma follows a gamut-aware envelope so the light and dark ends stay distinct, and the foreground roles are measured rather than assumed — --color-on-primary is whichever of white or ink actually clears 4.5:1.

Request body

Name	Type	Required	Description
`seed`	color	Yes	A colour as `#rrggbb`, `#rgb`, `rgb(r,g,b)`, `[r,g,b]`, or `{r,g,b}`.
`name`	string	No	System name used in file headers.
`harmony`	string	No	`analogous` (default), `complementary`, `triadic`, `mono`.
`include`	string[]	No	Any of `color`, `space`, `radius`, `type`. Defaults to all.
`dark`	boolean	No	Include dark-mode roles. Default true.

Returns meta object, contrast array, out_of_gamut string[], tokens array

Example

curl -X POST "https://api.auricartisan.com/v1/tokens/generate" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"seed":"#c9a227","name":"Auric","harmony":"analogous"}'

POST `/v1/tokens/export`

Render a token deck for a specific platform.

Ten targets, from CSS custom properties to Jetpack Compose. Pass raw: true to get the file itself rather than a JSON envelope.

Request body

Name	Type	Required	Description
`tokens`	array	Yes	Objects of `{ name, value, group? }` — the `tokens` array from `generate`, or your own.
`format`	string	Yes	See `/v1/tokens/formats`.
`name`	string	No	System name for the file header.
`raw`	boolean	No	`true` returns the file with a download disposition.

Example

curl -X POST "https://api.auricartisan.com/v1/tokens/export" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"format":"css","tokens":[{"name":"--color-primary","value":"#c9a227"}]}'

GET `/v1/tokens/formats`

The ten token export targets.

Example

curl "https://api.auricartisan.com/v1/tokens/formats" \
  -H "x-api-key: $AURIC_API_KEY"

Accessibility

POST `/v1/accessibility/check`

Check a foreground/background pair against WCAG 2.2 and APCA.

Request body

Name	Type	Required	Description
`foreground`	color	Yes	Text colour.
`background`	color	Yes	Surface behind the text.
`font_size`	number	No	Enables large-text thresholds.

Example

curl -X POST "https://api.auricartisan.com/v1/accessibility/check" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"foreground":"#767676","background":"#ffffff"}'

POST `/v1/accessibility/recommend`

Suggest the nearest accessible alternative to a failing pair.

Keeps hue, moves lightness — so the fix still looks like the brand.

Request body

Name	Type	Required	Description
`foreground`	color	Yes	Text colour to adjust.
`background`	color	Yes	Surface it sits on.
`target`	string	No	`AA` (default) or `AAA`.

Example

curl -X POST "https://api.auricartisan.com/v1/accessibility/recommend" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"foreground":"#c9a227","background":"#ffffff","target":"AA"}'

POST `/v1/accessibility/from-image`

Audit the colour contrast present in an image.

Request body

Name	Type	Required	Description
`image`	string	Yes	Base64 or data URL.

Example

curl -X POST "https://api.auricartisan.com/v1/accessibility/from-image" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

Vision

GET `/v1/vision/models`

The colour-vision deficiency models available.

Example

curl "https://api.auricartisan.com/v1/vision/models" \
  -H "x-api-key: $AURIC_API_KEY"

POST `/v1/vision/simulate`

Simulate how a colour appears under a vision deficiency.

Request body

Name	Type	Required	Description
`color`	color	Yes	A colour as `#rrggbb`, `#rgb`, `rgb(r,g,b)`, `[r,g,b]`, or `{r,g,b}`.
`model`	string	No	`deuteranopia`, `protanopia`, `tritanopia`, …
`severity`	number	No	0–1, for anomalous trichromacy.

Example

curl -X POST "https://api.auricartisan.com/v1/vision/simulate" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"color":"#c9a227","model":"deuteranopia"}'

POST `/v1/vision/simulate-image`

Simulate a vision deficiency across a whole image.

Request body

Name	Type	Required	Description
`image`	string	Yes	Base64 or data URL.
`model`	string	Yes	Deficiency to simulate.

Returns image/png

Example

curl -X POST "https://api.auricartisan.com/v1/vision/simulate-image" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

Ishihara

POST `/v1/ishihara/plate`

Generate an Ishihara test plate as structured data.

Request body

Name	Type	Required	Description
`value`	string	No	Digits to hide in the plate.
`model`	string	No	Deficiency the plate should discriminate.

Example

curl -X POST "https://api.auricartisan.com/v1/ishihara/plate" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"value":"74","model":"deuteranopia"}'

POST `/v1/ishihara/png`

Render an Ishihara plate as a PNG.

Request body

Name	Type	Required	Description
`value`	string	No	Digits to hide in the plate.

Returns image/png

Example

curl -X POST "https://api.auricartisan.com/v1/ishihara/png" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

Usage

GET `/v1/usage`

Durable per-day, per-endpoint history for your key.

Parameters

Name	Type	Required	Description
`since`	query	No	Earliest day to include, `YYYY-MM-DD`. Defaults to seven days back.

Example

curl "https://api.auricartisan.com/v1/usage" \
  -H "x-api-key: $AURIC_API_KEY"

GET `/v1/usage/me`

Your tier, limits and month-to-date quota consumption.

Example

curl "https://api.auricartisan.com/v1/usage/me" \
  -H "x-api-key: $AURIC_API_KEY"

GET `/v1/usage/live`

The last 100 individual calls, with rolling latency and error stats.

Answers "what is happening right now" where /v1/usage answers "how much have I used". Pass the returned cursor back as since to poll incrementally.

Parameters

Name	Type	Required	Description
`limit`	query	No	1–100, default 50.
`since`	query	No	Sequence number from a previous `cursor`.

Returns cursor number, stats object, events array

Example

curl "https://api.auricartisan.com/v1/usage/live" \
  -H "x-api-key: $AURIC_API_KEY"

GET `/v1/usage/stream` SSE

The same live feed, pushed over Server-Sent Events.

Emits hello on connect with current stats, usage per request, and heartbeat every 15 s. Connections are capped at 10 minutes; EventSource reconnects on its own.

Example

curl "https://api.auricartisan.com/v1/usage/stream" \
  -H "x-api-key: $AURIC_API_KEY"

Jobs

GET `/v1/jobs`

The async job types this deployment can run.

Example

curl "https://api.auricartisan.com/v1/jobs" \
  -H "x-api-key: $AURIC_API_KEY"

POST `/v1/jobs/:type`

Queue a long-running job and get an id back immediately.

The body is the parameter set for the chosen job type, so its shape varies — GET /v1/jobs documents what each type accepts. Poll /v1/jobs/id/:id or follow /v1/jobs/id/:id/stream.

Parameters

Name	Type	Required	Description
`type`	path	Yes	From `GET /v1/jobs`.

Example

curl -X POST "https://api.auricartisan.com/v1/jobs/palette-batch" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"count":500}'

GET `/v1/jobs/id/:id`

Poll one job.

Parameters

Name	Type	Required	Description
`id`	path	Yes

Example

curl "https://api.auricartisan.com/v1/jobs/id/<id>" \
  -H "x-api-key: $AURIC_API_KEY"

GET `/v1/jobs/id/:id/stream` SSE

Follow a job to completion over SSE instead of polling.

Parameters

Name	Type	Required	Description
`id`	path	Yes

Example

curl "https://api.auricartisan.com/v1/jobs/id/<id>/stream" \
  -H "x-api-key: $AURIC_API_KEY"

Webhooks

GET `/v1/webhooks/events` No key

Event types you can subscribe to.

Public: it is a static list of event names, useful for deciding whether the API fits before you buy.

Example

curl "https://api.auricartisan.com/v1/webhooks/events"

GET `/v1/webhooks`

List your webhook subscriptions.

Example

curl "https://api.auricartisan.com/v1/webhooks" \
  -H "x-api-key: $AURIC_API_KEY"

POST `/v1/webhooks`

Subscribe a URL to one or more events.

Deliveries are signed; verify the signature header before trusting a payload.

Request body

Name	Type	Required	Description
`url`	string	Yes	HTTPS endpoint to deliver to.
`events`	string[]	Yes	From `/v1/webhooks/events`.

Example

curl -X POST "https://api.auricartisan.com/v1/webhooks" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"url":"https://example.com/hook","events":["job.succeeded"]}'

GET `/v1/webhooks/:id`

Fetch one subscription.

Parameters

Name	Type	Required	Description
`id`	path	Yes

Example

curl "https://api.auricartisan.com/v1/webhooks/<id>" \
  -H "x-api-key: $AURIC_API_KEY"

DELETE `/v1/webhooks/:id`

Revoke a subscription.

Parameters

Name	Type	Required	Description
`id`	path	Yes

Example

curl -X DELETE "https://api.auricartisan.com/v1/webhooks/<id>" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GraphQL

GET `/v1/graphql` No key

GraphQL playground.

Example

curl "https://api.auricartisan.com/v1/graphql"

POST `/v1/graphql`

Run a GraphQL query against the same resolvers as the REST surface.

Useful when one round trip should answer several questions — convert a colour, check its contrast and simulate it at once.

Request body

Name	Type	Required	Description
`query`	string	Yes	The GraphQL document.
`variables`	object	No	Variable values.

Example

curl -X POST "https://api.auricartisan.com/v1/graphql" \
  -H "x-api-key: $AURIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"query":"{ contrast(foreground: \"#000\", background: \"#fff\") { ratio wcag_aa } }"}'

Admin

GET `/v1/admin/keys` Admin

List issued API keys.

Example

curl "https://api.auricartisan.com/v1/admin/keys" \
  -H "x-admin-key: $AURIC_ADMIN_KEY"

POST `/v1/admin/keys` Admin

Issue a key. The secret is shown once and stored only as a hash.

Request body

Name	Type	Required	Description
`tier`	string	No	One of `free`, `pro`, `enterprise`.
`label`	string	No	Who this key is for.

Example

curl -X POST "https://api.auricartisan.com/v1/admin/keys" \
  -H "x-admin-key: $AURIC_ADMIN_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET `/v1/admin/keys/:id` Admin

Fetch one key record (never the secret).

Parameters

Name	Type	Required	Description
`id`	path	Yes

Example

curl "https://api.auricartisan.com/v1/admin/keys/<id>" \
  -H "x-admin-key: $AURIC_ADMIN_KEY"

DELETE `/v1/admin/keys/:id` Admin

Revoke a key immediately.

Parameters

Name	Type	Required	Description
`id`	path	Yes

Example

curl -X DELETE "https://api.auricartisan.com/v1/admin/keys/<id>" \
  -H "x-admin-key: $AURIC_ADMIN_KEY" \
  -H "content-type: application/json" \
  -d '{}'

Errors returned by any endpoint

Code	Status	When
`UNAUTHENTICATED`	`401`	No key, or a key that is not recognised.
`FORBIDDEN`	`403`	Valid key without rights for this route (for example a non-admin key on `/v1/admin/*`).
`NOT_FOUND`	`404`	No route matches. `GET /v1` lists them all.
`METHOD_NOT_ALLOWED`	`405`	Right path, wrong verb. The `Allow` header lists what is accepted.
`INVALID_INPUT`	`400`	A field failed validation. The message names the field.
`INVALID_JSON`	`400`	The body is not parseable JSON.
`RATE_LIMITED`	`429`	Per-minute rate limit exceeded. `Retry-After` says when to try again.
`QUOTA_EXCEEDED`	`429`	Monthly quota exhausted. `x-quota-reset` gives the reset time.
`INTERNAL`	`500`	Unhandled server error. Quote the `request_id` when reporting it.

5. Request Examples

Contrast check (WCAG + APCA)

curl -X POST https://api.auricartisan.com/v1/color/contrast \
  -H "x-api-key: aa_YOUR_KEY" -H "Content-Type: application/json" \
  -d '{"fg": "#1a1712", "bg": "#d3af37"}'

Generate a palette

curl -X POST https://api.auricartisan.com/v1/palette/generate \
  -H "x-api-key: aa_YOUR_KEY" -H "Content-Type: application/json" \
  -d '{"method": "analogous", "count": 5, "hue": 45}'

Simulate protanopia

curl -X POST https://api.auricartisan.com/v1/vision/simulate \
  -H "x-api-key: aa_YOUR_KEY" -H "Content-Type: application/json" \
  -d '{"color": "#d3af37", "model": "protanopia", "severity": 1}'

Check your usage

curl https://api.auricartisan.com/v1/usage/me -H "x-api-key: aa_YOUR_KEY"

# → {"tier":"pro","plan":"specialist","auth_type":"api_key",
#    "limits":{"rate_per_minute":300,"monthly_quota":1000000},
#    "this_month":{"slot":"2026-08","used":412}}
#
# `used` counts credits, not calls — see section 3.

6. Errors

Errors are JSON with a stable code and a human-readable message; most include a request_id for support.

{
  "error": {
    "code": "INVALID_INPUT",
    "message": "seed: not a number"
  },
  "request_id": "daebcbed-508b-4d4d-91ef-87ee99d32f03"
}

Status	Code	Meaning
400	`INVALID_INPUT`	A parameter is missing or malformed — the message names it.
401	`UNAUTHORIZED`	Missing, invalid or revoked API key.
404	`NOT_FOUND`	Unknown endpoint or resource id.
413	`PAYLOAD_TOO_LARGE`	Body over the limit (4 MB for image endpoints).
429	`RATE_LIMITED`	Per-minute rate exceeded — honor `retry-after`.
429	`IP_RATE_LIMITED`	Too many requests from one address, regardless of key.
429	`QUOTA_EXCEEDED`	Included monthly credits are used up and pay-as-you-go is off. Enable it, or wait for the reset — `details.resets_at` says when.
429	`HARD_CEILING_REACHED`	The absolute monthly ceiling (ten times the included allowance) was hit. A safety stop, not a sales gate — contact support to raise it.
402	`INSUFFICIENT_CREDITS`	Pay-as-you-go is on but the prepaid balance will not cover the call. Top up; nothing is billed after the fact.
402	`SPEND_CAP_REACHED`	Your own monthly overage spend cap was reached. Raise it in the dashboard.
402	`CREDIT_DEBIT_FAILED`	The balance could not be debited, so the request was not served. No charge was made — retry.
402	`PLAN_UPGRADE_REQUIRED`	Valid key on a plan without API access. Included from Specialist upward.
503	`NOT_CONFIGURED`	Optional subsystem disabled in this deployment.
503	`ENFORCEMENT_UNAVAILABLE`	Rate limiting, quota or idempotency could not be evaluated. Nothing was executed — retry later.

429 or 402 — which is which

The split is by what you should do about it, which is what a status code is for. 429 means back off and retry: the condition resets on its own, on the clock named in retry-after and details.resets_at. Every SDK already retries on it, and an exhausted allowance keeps returning it exactly as this API did before overage existed. 402 means only a money decision unblocks it — a top-up or a raised spend cap — and retrying without one is pointless.

Every refusal names its remedy in details.remedy (enable_overage, buy_credits, raise_spend_cap, contact_support) alongside credits_used, credits_included, credits_this_request and resets_at, so a client can log something actionable rather than “quota exceeded”.

{
  "error": {
    "code": "INSUFFICIENT_CREDITS",
    "message": "Pay-as-you-go is on, but the prepaid credit balance is empty. Top up to continue — nothing is billed after the fact.",
    "details": {
      "tier": "pro",
      "credits_used": 1000010,
      "credits_included": 1000000,
      "credits_this_request": 10,
      "resets_at": "2026-09-01T00:00:00.000Z",
      "remedy": "buy_credits",
      "credits_needed": 10
    }
  },
  "request_id": "daebcbed-508b-4d4d-91ef-87ee99d32f03"
}

7. SDKs And Tooling

Official clients and integrations, all speaking the same v1 surface.

Client	Package / location	Notes
JavaScript	`@auric-artisan/api`	Node 18+, browsers, Workers. Typed methods for every endpoint.
Python	`auric-artisan`	Python 3.8+, stdlib-only, zero dependencies.
CLI	`@auric-artisan/cli`	`auric contrast '#222' '#fff'` straight from your terminal.
MCP server	`api/sdk/mcp/`	Give Claude, Cursor or any MCP host direct access to the color tools.
Postman	`api/postman.json`	Ready-made collection covering the whole API.
GraphQL	`POST /v1/graphql`	Single-endpoint alternative; playground included.

8. Local Development

Contributors running the repo can start the API locally with npm run api (port 3002). That server is a loopback-only development convenience — it is not a public endpoint, and hosted clients should always call https://api.auricartisan.com. To accept the keys you create in the dashboard, point the local server at your auth worker:

AURIC_AUTH_WORKER_URL=http://127.0.0.1:8787 npm run api

AURIC_API_KEYS=key1,key2 seeds ad-hoc in-memory keys.
AURIC_API_OPEN_MODE=1 allows anonymous requests (local only).
AURIC_ADMIN_KEY=… enables the /v1/admin/* endpoints.

For account-level key management (create, revoke, last-used audit), see the API Keys tab in your dashboard.

9. Plans And Pricing

The API is metered in credits — one credit per standard request, more for heavier work (see section 3). Each plan includes a monthly allowance of credits; past it, prepaid pay-as-you-go overage can be turned on, and nothing is ever invoiced after the fact.

Plan	API access	Credits / month	Rate limit	Overage
Apprentice (free)	Not included	—	—	—
Artisan	Not included	—	—	—
Specialist	Included	1,000,000	300 / min	$1.00 / 100,000 credits, prepaid & opt-in
Industrial Pro	Included	10,000,000	3,000 / min	$1.00 / 100,000 credits, prepaid & opt-in

Industrial Pro subscriptions started before 12 August 2026 are grandfathered. That plan was sold with unlimited API requests, and we are not taking that back from anyone who bought it: those accounts keep an allowance of 1,000,000,000 credits a month — a hundred times the figure above. At 3,000 requests a minute that is not reachable with standard 1-credit calls; sustained image (10–12 credits) or async-job (25 credits) traffic could reach it, and the hard ceiling for these accounts scales with the allowance rather than sitting below it. The 10,000,000 figure applies to subscriptions started on or after that date.

The API is a paid feature. It is included from Specialist upward — see plans. A key created on a plan without API access authenticates but is refused on metered endpoints with 402 PLAN_UPGRADE_REQUIRED, and the response names the upgrade path.

Discovery stays open to everyone, with or without a key, so you can evaluate the API before buying: GET /v1, GET /v1/catalog, GET /v1/openapi.yaml, GET /v1/docs, GET /v1/tiers and GET /v1/health.

Exceeding a plan's allowance returns 429 QUOTA_EXCEEDED rather than a surprise charge. Overage is off until you enable it, spends only credits bought in advance, respects a spend cap you set, and stops unconditionally at ten times the included allowance. Credit top-ups are self-serve: buy a pack from Dashboard → API keys → Add credits, and note that purchased credits do not expire at period end. For volume beyond the largest pack, a custom rate limit, or a contract, talk to us.

Billing terms — expiry, cancellation, downgrade and refunds on prepaid credits — are in the Subscription & Billing Policy.

Compare plans Manage API keys

REST API Reference

Overview

1. Quick Start

2. Authentication

3. Rate Limits, Credits And Quotas

Credits

What each plan includes

Past the allowance: overage, spend caps, ceilings

Reading the meter

4. Endpoint Reference

Discovery

GET /v1 No key

GET /v1/health No key

GET /v1/ready No key

GET /v1/methods/:tool

GET /v1/formats No key

GET /v1/tiers No key

GET /v1/metrics No key

GET /v1/status No key

GET /v1/catalog No key

GET /v1/docs No key

GET /v1/openapi.yaml No key

Colour

POST /v1/color/convert

POST /v1/color/contrast

Colour science

GET /v1/science/spaces

GET /v1/science/spaces/:key

POST /v1/science/convert

POST /v1/science/dossier

POST /v1/science/delta-e

POST /v1/science/temperature

GET /v1/science/illuminants

GET /v1/science/metrics

Palettes

POST /v1/palette/generate

POST /v1/palette/evaluate

POST /v1/palette/export

POST /v1/palette/from-image

POST /v1/palette/png

Harmony

POST /v1/harmony/generate

POST /v1/harmony/classify

POST /v1/harmony/export

Gradients

POST /v1/gradient/generate

POST /v1/gradient/export

POST /v1/gradient/png

Shades

POST /v1/shade/scale

POST /v1/shade/export

Design tokens

POST /v1/tokens/generate

POST /v1/tokens/export

GET /v1/tokens/formats

Accessibility

POST /v1/accessibility/check

POST /v1/accessibility/recommend

POST /v1/accessibility/from-image

Vision

GET /v1/vision/models

POST /v1/vision/simulate

POST /v1/vision/simulate-image

Ishihara

POST /v1/ishihara/plate

POST /v1/ishihara/png

Usage

GET /v1/usage

GET /v1/usage/me

GET /v1/usage/live

GET /v1/usage/stream SSE

Jobs

GET /v1/jobs

POST /v1/jobs/:type

GET /v1/jobs/id/:id

GET /v1/jobs/id/:id/stream SSE

Webhooks

GET /v1/webhooks/events No key

GET /v1/webhooks

POST /v1/webhooks

GET `/v1` No key

GET `/v1/health` No key

GET `/v1/ready` No key

GET `/v1/methods/:tool`

GET `/v1/formats` No key

GET `/v1/tiers` No key

GET `/v1/metrics` No key

GET `/v1/status` No key

GET `/v1/catalog` No key

GET `/v1/docs` No key

GET `/v1/openapi.yaml` No key

POST `/v1/color/convert`

POST `/v1/color/contrast`

GET `/v1/science/spaces`

GET `/v1/science/spaces/:key`

POST `/v1/science/convert`

POST `/v1/science/dossier`

POST `/v1/science/delta-e`

POST `/v1/science/temperature`

GET `/v1/science/illuminants`

GET `/v1/science/metrics`

POST `/v1/palette/generate`

POST `/v1/palette/evaluate`

POST `/v1/palette/export`

POST `/v1/palette/from-image`

POST `/v1/palette/png`

POST `/v1/harmony/generate`

POST `/v1/harmony/classify`

POST `/v1/harmony/export`

POST `/v1/gradient/generate`

POST `/v1/gradient/export`

POST `/v1/gradient/png`

POST `/v1/shade/scale`

POST `/v1/shade/export`

POST `/v1/tokens/generate`

POST `/v1/tokens/export`

GET `/v1/tokens/formats`

POST `/v1/accessibility/check`

POST `/v1/accessibility/recommend`

POST `/v1/accessibility/from-image`

GET `/v1/vision/models`

POST `/v1/vision/simulate`

POST `/v1/vision/simulate-image`

POST `/v1/ishihara/plate`

POST `/v1/ishihara/png`

GET `/v1/usage`

GET `/v1/usage/me`

GET `/v1/usage/live`

GET `/v1/usage/stream` SSE

GET `/v1/jobs`

POST `/v1/jobs/:type`

GET `/v1/jobs/id/:id`

GET `/v1/jobs/id/:id/stream` SSE

GET `/v1/webhooks/events` No key

GET `/v1/webhooks`

POST `/v1/webhooks`

GET `/v1/webhooks/:id`

DELETE `/v1/webhooks/:id`

GET `/v1/graphql` No key

POST `/v1/graphql`

GET `/v1/admin/keys` Admin

POST `/v1/admin/keys` Admin

GET `/v1/admin/keys/:id` Admin

DELETE `/v1/admin/keys/:id` Admin