RelayaRelayaDocs
Dashboard

API Reference

Complete reference for the Relaya REST API. All endpoints use the base URL https://api.relaya.one/v1.

Request Format

All request bodies must be JSON. Set the Content-Type: application/json header for POST, PATCH, and PUT requests. Multipart uploads use multipart/form-data.

Response Format

All responses return JSON. Successful list endpoints include pagination metadata:

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

Appointments

GET
/v1/appointments

List appointments

POST
/v1/appointments

Create appointment

GET
/v1/appointments/:id

Get appointment

PATCH
/v1/appointments/:id

Update appointment

DELETE
/v1/appointments/:id

Cancel appointment

Patients

GET
/v1/patients

List patients

POST
/v1/patients

Create patient

GET
/v1/patients/:id

Get patient with history

PATCH
/v1/patients/:id

Update patient

Voice AI

GET
/v1/voice/calls

List calls

GET
/v1/voice/calls/:id

Get call with transcript

POST
/v1/voice/calls/:id/transfer

Transfer active call

Scribe

POST
/v1/scribe/transcribe

Submit audio for transcription

GET
/v1/scribe/notes/:id

Get generated note

POST
/v1/scribe/notes/:id/approve

Approve clinical note

Webhooks

POST
/v1/webhooks

Register webhook

GET
/v1/webhooks

List webhooks

DELETE
/v1/webhooks/:id

Remove webhook