Build the Future of Women's Health with Biamo

Device Bridge API

Retrieve all API keys associated with your project.

Session Started

Notify Biamo Core that a breastpump session has started.

Request

index.js

1curl --request POST \
2  --url https://api.biamo.dev/api/device-bridge/pumping-session-started \
3  --header "x-api-key: YOUR_API_KEY" \
4  --header "x-project-id: YOUR_PROJECT_ID" \
5  --header "Content-Type: application/json" \
6  --data &#39;{
7    "session_id": "sess_123456",
8    "device_id": "pump_01ABC123",
9    "user_id": "usr_789012",
10    "mode": "expression",
11    "initial_suction_level": 5
12  }&#39;
13

Successful Response

index.js

1{
2  "event": "pumping.session_started",
3  "triggered": true,
4  "deliveries": 1
5}
6

Session Stopped

Notify Biamo Core that a breastpump session has completed.

Request

index.js

1curl --request POST \
2  --url https://api.biamo.dev/api/device-bridge/pumping-session-completed \
3  --header "x-api-key: YOUR_API_KEY" \
4  --header "x-project-id: YOUR_PROJECT_ID" \
5  --header "Content-Type: application/json" \
6  --data &#39;{
7    "session_id": "sess_123456",
8    "device_id": "pump_01ABC123",
9    "user_id": "usr_789012",
10    "duration_seconds": 1800,
11    "volume_ml": {
12      "left": 60,
13      "right": 65
14    },
15    "mode_changes": 2
16  }&#39;
17

Successful Response

index.js

1{
2  "event": "pumping.session_completed",
3  "triggered": true,
4  "deliveries": 1
5}
6

Device Connected

Notify Biamo Core that a breastpump device has connected.

Request

index.js

1curl --request POST \
2  --url https://api.biamo.dev/api/device-bridge/device-connected \
3  --header "x-api-key: YOUR_API_KEY" \
4  --header "x-project-id: YOUR_PROJECT_ID" \
5  --header "Content-Type: application/json" \
6  --data &#39;{
7    "device_id": "pump_01ABC123",
8    "device_type": "breastpump",
9    "connection_type": "bluetooth",
10    "battery_percent": 85,
11    "user_id": "usr_789012"
12  }&#39;
13

Successful Response

index.js

1{
2  "event": "device.connected",
3  "triggered": true,
4  "deliveries": 1
5}
6

Device Disconnected

Notify Biamo Core that a breastpump device has disconnected.

Request

index.js

1curl --request POST \
2  --url https://api.biamo.dev/api/device-bridge/device-disconnected \
3  --header "x-api-key: YOUR_API_KEY" \
4  --header "x-project-id: YOUR_PROJECT_ID" \
5  --header "Content-Type: application/json" \
6  --data &#39;{
7    "device_id": "pump_01ABC123",
8    "device_type": "breastpump",
9    "disconnection_reason": "User ended session",
10    "battery_percent": 80,
11    "session_duration_seconds": 1800
12  }&#39;
13

Successful Response

index.js

1{
2  "event": "device.disconnected",
3  "triggered": true,
4  "deliveries": 1
5}
6

Device Registered

Request

index.js

1curl --request POST \
2  --url https://api.biamo.dev/api/device-bridge/device-registered \
3  --header "x-api-key: YOUR_API_KEY" \
4  --header "x-project-id: YOUR_PROJECT_ID" \
5  --header "Content-Type: application/json" \
6  --data &#39;{
7    "device_id": "pump_01ABC123",
8    "device_type": "breastpump",
9    "model": "BiamoSense Pro",
10    "firmware_version": "1.0.5",
11    "user_id": "usr_789012"
12  }&#39;
13

Successful Response

index.js

1{
2  "event": "device.registered",
3  "triggered": true,
4  "deliveries": 1
5}
6

Session Started

Session Stopped

Device Connected

Device Disconnected

Device Registered

Dev Experience

Our Blog

API Docs

Paper

Partner with us

Dev Experience

Our Blog

API Docs

Paper

Partner with us

Dev Experience

Our Blog

API Docs

Paper

Partner with us