Resellers/Integration checklist

Reseller Checklist

If you resell the Wokey API to your own downstream users, go through the list below in order. Each item links to the full details.

Checklistlink

  1. 1

    Send X-End-User-Id on every request

    When one key serves many end users, this header says which end user a request belongs to. If one end user keeps violating, Wokey restricts only that user and your other users keep working. Enterprise and reseller accounts can also review restricted users and lift restrictions in the console.

    End-user ID & limits →

  2. 2

    Detect model refusals

    A refusal still returns HTTP 200, so detect it from the fields in the response. When you find one, ask your user to change the content instead of retrying the same request.

    Model refusals →

  3. 3

    Stop violating users early

    Repeated refusals lead to rate limits, model suspensions, and violation fees. With or without X-End-User-Id, violations count against your account, so filter content before you send requests to Wokey.

    Violation fees & limits →

  4. 4

    Handle errors by status code

    Tell insufficient balance (402), rate limits (429), and upstream errors (502, 504, 529) apart, and prompt or retry accordingly. Include the x-wokey-request-id response header when you contact support.

    Error codes →

  5. 5

    Monitor balance and usage

    Query the account balance with /v1/dashboard/balance, and per-key usage and remaining limit with /v1/usage and /v1/key. Top up before the balance runs out.

    Balance & usage →

  6. 6

    Choose a vendor when you need to

    When a model has several vendors, use provider in the request body to require or exclude vendors.

    Vendor routing →