RESTful API v1.0

API Reference

Build powerful healthcare applications with our comprehensive REST API. Full FHIR R4 support included.

Base URL

All API requests should be made to:

https://api.kareops.ai/v1
TLS 1.3 required
JSON request/response format
UTF-8 encoding

Authentication

Authenticate using Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY
API keys are unique per environment
Rotate keys regularly for security
Never expose keys in client-side code

Rate Limits

Standard

1,000

requests per minute

Enterprise

10,000

requests per minute

Burst

100

requests per second

Quick Start Example

Make your first API call in your preferred language

curl -X GET https://api.kareops.ai/v1/agents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

API Endpoints

Explore our comprehensive API endpoints

GET/api/v1/agents

List all available AI agents

Category: AgentsView Details
POST/api/v1/agents/{agentId}/deploy

Deploy an AI agent to production

Category: AgentsView Details
GET/api/v1/calls

Retrieve call history and recordings

Category: CallsView Details
POST/api/v1/calls/schedule

Schedule an outbound call

Category: CallsView Details
GET/api/v1/patients/{patientId}

Get patient information

Category: PatientsView Details
POST/api/v1/appointments

Create a new appointment

Category: AppointmentsView Details
PUT/api/v1/appointments/{appointmentId}

Update appointment details

Category: AppointmentsView Details
POST/api/v1/webhooks

Register a webhook endpoint

Category: WebhooksView Details

SDKs & Libraries

Official SDKs to accelerate your integration

Node.js

v2.1.050k+ downloads
View on GitHub

Python

v2.0.535k+ downloads
View on GitHub

PHP

v1.8.220k+ downloads
View on GitHub

Ruby

v1.5.015k+ downloads
View on GitHub

Go

v1.2.010k+ downloads
View on GitHub

Java

v2.0.025k+ downloads
View on GitHub

Start Building Today

Get your API keys and start integrating in minutes