> ## Documentation Index
> Fetch the complete documentation index at: https://docs.heyrafiki.space/llms.txt
> Use this file to discover all available pages before exploring further.

# 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
```

<Note>
  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.
</Note>

## Try it now

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

<CodeGroup>
  ```bash cURL theme={"dark"}
  curl https://api.heyrafiki.space/v1/practitioners
  ```

  ```json Response theme={"dark"}
  {
    "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"
    }
  }
  ```
</CodeGroup>

## Next

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/authentication">
    Keys, headers and environments.
  </Card>

  <Card title="Errors" icon="triangle-exclamation" href="/errors">
    Status codes and the error envelope.
  </Card>

  <Card title="Resources" icon="cube" href="/resources">
    The objects the API exposes.
  </Card>

  <Card title="Webhooks" icon="bolt" href="/webhooks">
    Events, delivery and signatures.
  </Card>

  <Card title="Versioning" icon="code-branch" href="/versioning">
    Breaking versus additive, deprecation and rate limits.
  </Card>
</CardGroup>