Quick start

1. Create an API key

Sign in and open API keys in the dashboard, pick an application, then choose Create key. The key can call every family unless you limit it to some of them. Copy the key straight away: it is only shown once.

2. Check the key

GET /api-keys/verify works with any key and costs no credits. It shows the key's application, plan, rate limit and the families it can call. Replace YOUR_API_KEY with your key.

curl "https://api.rezolvelabs.com/api/v1/api-keys/verify" \
  -H "X-API-KEY: YOUR_API_KEY"

The response looks like this:

{
  "id": 42,
  "name": "Default key",
  "prefix": "rzlb_live_sk_a1b2",
  "kind": "secret",
  "environment": "live",
  "allowed_ips": [],
  "allowed_origins": [],
  "owner": "you@example.com",
  "application_id": "3f2b8c1e-5d4a-4e7b-9a60-1c2d3e4f5a6b",
  "application": "Default",
  "plan": "Basic",
  "rate_limit_per_minute": 60,
  "expires_at": null,
  "families": [{ "id": 1, "name": "Voice and audio production", "slug": "voice-audio" }]
}

3. Call a family's operation

Each family's operations are under its slug: https://api.rezolvelabs.com/api/v1/<family>/<operation path>. Send the same X-API-KEY header. Calls are paid in credits, and each answer shows what the call cost in X-Credits-Charged and what is left in X-Credits-Remaining. The API reference (sign-in required) lists every operation with its parameters, request body and responses, and gives an example request for each one.

Routing by vertical

Some operations are served differently per catalogue vertical. Those operations take an X-Catalog-Vertical header, such as X-Catalog-Vertical: grocery; the reference shows which operations take it and the values it accepts.