Skip to main content

Overview

The Operahealth External API enables third-party integrations to programmatically manage patient data within your organization. Built on RESTful conventions, the API provides a secure and straightforward way to create and manage patient records.

Base URLs

Operahealth API is available in two environments:
EnvironmentBase URLUse Case
Productionhttps://api.prod.operahealth.ai/api/v1Live production use
Developmenthttps://api.demo.operahealth.ai/api/v1Testing and development
All API requests should be made to the appropriate base URL for your environment.

Content Type

All requests must include the Content-Type: application/json header. All responses are returned in JSON format.

API Key Format

API keys follow a specific format based on environment:
EnvironmentExample
Productionopera_live_a1b2c3d4e5f6...
Developmentopera_demo_a1b2c3d4e5f6...

Available Endpoints

Patients

MethodEndpointDescription
POST/api/v1/patientsCreate a new patient
Additional endpoints for retrieving, listing, and updating patients are planned for future releases.