Introduction

The Heyrafiki API: base URL, authentication, errors and resources.

The Heyrafiki API is a REST API over Mental Healthcare infrastructure: Practitioner verification, Matching, Sessions, clinical Notes, Claims and Payments.

It uses standard HTTP verbs, returns JSON, and authenticates with a secret key sent as a Bearer token.

https://api.heyrafiki.space/v1

The API is in private beta. The endpoints below are not yet live. Authentication, the error envelope and the base URL are final and respond today. Sandbox keys go to Waitlist members first.

Try it now

Every request to the API today returns a structured error. This is the real response, not an example.

cURL

curl https://api.heyrafiki.space/v1/practitioners

{
  "error": {
    "code": "api_key_missing",
    "message": "The Heyrafiki API requires a key. Send it as an Authorization: Bearer header, or as x-api-key.",
    "docs": "https://heyrafiki.space/solutions/developers"
  }
}

Next

Authentication

Keys, headers and environments.

Errors

Status codes and the error envelope.

Resources

The objects the API exposes.

Webhooks

Events, delivery and signatures.

Versioning

Breaking versus additive, deprecation and rate limits.