Getting Started
Your First 10 Minutes with Biamo Core
Welcome to Biamo Core — the developer platform powering innovation in women's health. Biamo Core provides a RESTful API that allows you to integrate with our platform for breastpump and related device management. This documentation covers all available endpoints, authentication, error handling, and best practices.
You can get started in just three quick steps:
Step 1: Create a project
Projects help you organize your integrations and isolate your API keys, webhooks, and logs.
To create a new project:
Go to the Dashboard and click "Create Project."
Give your project a name (e.g., MomTracker App or MilkSense loT Device).
Once created, you'll receive a Project ID - you'll use this when making API requests.
Step 2: Generate an API Key
To authenticate with Biamo Core:
Inside your project, navigate to Developer → API Keys.
Click "Generate API Key."
Save your API key securely - you'll need it to authorize API calls.
Important:
Biamo Core uses the x-api-key header for authentication.
You must include your API key and Project ID in every API request.
Step 3: Make Your First API Request
Once you have your Project ID and API Key, you're ready to make your first call.
Here's an example using curl to list your project's API keys:
If everything is set up correctly, you'll receive a JSON response listing your active API keys.
That's it - you're now connected to Biamo Core!