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

# Introduction

> Authenticate and send requests to the Lerix REST API.

## Base URL

All API requests are sent to your project endpoint:

```
https://api.lerix.dev/v1/:project-id
```

Replace `:project-id` with your project ID from the [Lerix Dashboard](https://app.lerix.dev) under **Project Settings**.

**Example:**

```
https://api.lerix.dev/v1/my-project-id
```

## Authentication

Before you call the API, create a **private key** in **Project Settings** in the [dashboard](https://app.lerix.dev).

Send the private key on every request in the `lerix-key` header:

```bash theme={"dark"}
curl https://api.lerix.dev/v1/my-project-id/endpoint \
  -H "lerix-key: <your-private-key>"
```

<Warning>
  Keep your private key secret. Do not commit it to source control, expose it in client-side code, or share it publicly.
</Warning>

## Next steps

<CardGroup cols={2}>
  <Card title="Push Notifications" icon="bell" href="/api-reference/push-notifications">
    Send push notifications through the REST API.
  </Card>

  <Card title="Update a Notification" icon="pen" href="/api-reference/update-notification">
    Change a notification's title and body.
  </Card>

  <Card title="Unsend a Notification" icon="bell-slash" href="/api-reference/unsend-notification">
    Remove an already-delivered notification from devices.
  </Card>

  <Card title="Cancel a Scheduled Notification" icon="clock" href="/api-reference/cancel-notification">
    Stop a scheduled notification before it goes out.
  </Card>

  <Card title="Get Delivery Status" icon="list-check" href="/api-reference/notification-deliveries">
    Read per-recipient delivery outcomes.
  </Card>

  <Card title="Error & success codes" icon="hashtag" href="/developers/errors-responses">
    Reference common API response codes.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.