Authentication

How to Authenticate API Requests

All requests to Biamo Core must be authenticated to ensure secure access.

We use a simple, project-scoped API key authentication model.

Every API request must include your API Key and Project ID.

Authentication Headers

Header & Purpose

x-api-key Your secret API key that authorizes the request.

x-project-id The specific project you are operating on.

Alternative Method (Query Parameter)

If needed, you can also supply the project-id as a query parameter:

index.js
1https://api.biamo.dev/developer/api-keys?project-id=YOUR_PROJECT_ID

Note

Supplying the Project ID via the x-project-id header is the preferred method for consistency and security.

Example Request (Header-based)

index.js
1curl --request GET \
2 --url https://api.biamo.dev/developer/api-keys \
3 --header "x-api-key: YOUR_API_KEY" \
4 --header "x-project-id: YOUR_PROJECT_ID"
5

Where to Find Your API Key and Project ID

Your API Key is generated in your project's Developer → API Keys section.

Your Project ID is assigned automatically when you create a new project in the dashboard.

Important Notes

Keep your API key secret. Treat it like a password.

Scope your keys wisely. Create separate projects for dev/prop environments if needed.

API keys do not expire by default but can be revoked manually from the Dashboard.


Project IDs can be passed via headers (preferred) or query parameters (alternate method).

2025 © BIAMO. All Rights Reserved.