View the OpenAPI Specification
Our API is documented using the OpenAPI 3.1 standard. You can view the raw specification file to see all available endpoints, models, and security schemes.
Authentication
All Burki API endpoints are protected and require a valid API key to be included in all requests. Authentication is performed by passing a Bearer Token in theAuthorization
header of your HTTP requests.
You can generate and manage your API keys from the API Keys section in your organization’s dashboard.
How to Use Your API Key
To authenticate an API request, you must include anAuthorization
header with the value Bearer YOUR_API_KEY
, where YOUR_API_KEY
is the key you generated in the dashboard.
Treat your API keys like passwords! Do not share them publicly or commit them to version control.
Error Codes
If your API key is missing, invalid, or expired, you will receive a401 Unauthorized
HTTP response code.