BeatAware Developer API

Integrate heart health monitoring into your applications with our REST API

API Overview

The BeatAware API allows developers to integrate heart health monitoring capabilities into their applications. Our API provides endpoints for managing patients, uploading heart sound recordings, and retrieving detailed cardiology reports with statistical analysis.

Base URL

https://api.beataware.com/v1

API Specification

Our API follows the OpenAPI 3.0.3 specification. You can download the full specification file:

Rate Limits

The API has rate limits to ensure fair usage. Standard accounts are limited to 100 requests per minute. For higher limits, please contact our sales team.

API Playground

Accelerate your development process with our Admin Console. This interactive playground allows you to visualize your data, test API endpoints, and experiment with your API key in a user-friendly environment.

Authentication

To request an API key, please contact us with details about your integration.

All API requests require authentication using API keys. You will need to include your API key in thex-api-key header of each request.

Example Request with Authentication

curl -X GET "https://api.beataware.com/v1/patients" \
  -H "x-api-key: YOUR_API_KEY"

Endpoints

POST/patients

Create a new patient

GET/patients

Get list of all patients

GET/patients/{patientId}

Get a patient by ID

PUT/patients/{patientId}

Update a patient by ID

DELETE/patients/{patientId}

Delete a patient by ID

GET/patients/{patientId}/recordings

List all recordings for a patient

POST/patients/{patientId}/recordings

Upload a heart sound recording for a specific patient

DELETE/recordings/{recordingId}

Delete a recording by ID

GET/recordings/{recordingId}/status

Check the status of a report

GET/recordings/{recordingId}/report

Download cardiology report

GET/recordings/{recordingId}/audio

Download original audio file