Authentication
Everything you need to connect securely to the BriqMind API and services.
01Creating an API Key
To start using the API, you first need to obtain an API key. You can manage your keys from the Developer Panel.
- Sign in to the BriqMind dashboard.
- Click the Developer tab from the left menu.
- Go to the API Keys section.
- Click Create New Key to generate your key and store it securely. For your security, the key will only be shown once.
02API Key Usage and Types
To communicate with the Birk API, you must send your API key as a Bearer token in the HTTP header of every request. The system has two different environments and key types:
- bm_test_...Test Environment Keys: Used during development and testing. Requests made with these keys are not billed, but their rate limits are much lower.
- bm_live_...Live Environment Keys: Keys used when your application moves to production, subject to real quotas and billing.
Authorization: Bearer bm_live_12345abcdef...
Example Request
curl -X GET "https://api.briqmind.com/v1/models" \ -H "Authorization: Bearer $BRIQ_API_KEY"
03Security Recommendations
Do Not Use on the Client Side
Never expose your API keys in the browser, mobile app, or GitHub. Always route requests through your backend server.
Environment Variables (ENV)
Do not hardcode keys into your source code. Always store them in .env files and do not push them to git.
Regular Rotation
If you suspect a security breach, immediately revoke the old key from the panel and create a new one.