Skip to content
You're offline. Some features may be unavailable.
QPortal is live. Deploy QR-powered AI instantly.

API Reference

Authentication

The 3QPR API uses API keys for authentication. All requests must include a valid key in the Authorization header.

Creating an API key

API keys are tied to your user account. Create and manage them in the Developer Portal.

Create an API key via APIbash
curl -X POST https://api.3qpr.com/v1/api-keys \
  -H "Authorization: Bearer YOUR_EXISTING_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Production Key"}'
{
  "id": "key_01HXYZ",
  "name": "Production Key",
  "key": "3qpr_sk_live_AbCdEfGhIjKlMnOp...",
  "created_at": "2026-03-20T12:00:00Z"
}
The raw key is only returned once at creation time. Store it securely.

Using your API key

Pass your key in the Authorization header as a Bearer token on every request:

curl https://api.3qpr.com/v1/qpr-codes \
  -H "Authorization: Bearer 3qpr_sk_live_AbCdEfGhIjKlMnOp..."

Listing API keys

curl https://api.3qpr.com/v1/api-keys \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "keys": [
    {
      "id": "key_01HXYZ",
      "name": "Production Key",
      "last_used_at": "2026-03-20T15:30:00Z",
      "revoked": false,
      "created_at": "2026-03-20T12:00:00Z"
    }
  ]
}

Revoking a key

curl -X DELETE https://api.3qpr.com/v1/api-keys/key_01HXYZ \
  -H "Authorization: Bearer YOUR_API_KEY"

Error responses

StatusMeaning
401 UnauthorizedMissing or invalid API key
403 ForbiddenKey is revoked or lacks permission
402 Payment RequiredFeature requires Premium or Enterprise plan
429 Too Many RequestsRate limit exceeded