Getting Started

1. Get your API key

Navigate to the API Settings page in your Relaya dashboard. Click "Create API Key" and give it a descriptive name.

2. Make your first request

Use your API key in the Authorization header as a Bearer token:

curl -X GET https://api.relaya.one/v1/appointments \
  -H "Authorization: Bearer rlya_live_abc123def456" \
  -H "Content-Type: application/json"

3. Parse the response

All successful responses return JSON with a consistent structure:

{
  "data": [...],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 142
  }
}

4. Handle errors

Errors return a consistent error object with a machine-readable code:

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key provided is invalid or expired.",
    "status": 401
  }
}

5. Explore the API

Now that you have a working connection, explore the full API:

• Appointments API - Manage scheduling and availability
• Patients API - Access and update patient records
• Voice AI API - Retrieve call transcripts and manage transfers
• Scribe API - Transcribe audio and generate clinical notes