Platform quickstart

1. Create an account

Register and verify your email address. We create a workspace for you with 1,000 free credits for the current month. You are its owner.

2. Create an API key

Open Dashboard → API keys and choose Create key.

• Name: something that identifies where the key is used, such as production-backend.
• Role: the permissions the key carries. The default Developer role can call every API.
• Referrer restrictions (optional): only needed for keys used directly from a browser.

The secret (hx_sk_…) is shown once. Store it in your secret manager. If you lose it, rotate the key.

3. Make a request

export WEBKNX_SECRET_KEY=hx_sk_your_secret

curl -X POST https://webknx.com/api/v1/qrcode \
  -H "Authorization: Bearer $WEBKNX_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data":"https://example.com","size":512}' \
  --output qrcode.png

A successful request returns the PNG and these headers:

4. Watch your usage

Dashboard → Usage shows requests, failures and credits by API, key and status code. Each row carries the request id, so you can match it with your own logs.

Next steps

• Invite your team and assign roles.
• Read about errors and retries.
• Choose a plan when you need more than the free allowance.