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

# API Reference

> Heimdall API documentation

<Info>
  **Coming Soon**

  The Heimdall REST API documentation is currently under development.

  In the meantime, you can explore the backend source code to understand the available endpoints.
</Info>

## Current Endpoints

The Heimdall backend currently exposes the following endpoints:

### OTLP Receiver

| Method | Endpoint     | Description                   |
| ------ | ------------ | ----------------------------- |
| `POST` | `/v1/traces` | Receive OTLP traces from SDKs |

### REST API

| Method   | Endpoint                          | Description                  |
| -------- | --------------------------------- | ---------------------------- |
| `GET`    | `/health`                         | Health check endpoint        |
| `GET`    | `/api/traces/:projectId`          | Get all traces for a project |
| `GET`    | `/api/traces/:projectId/:traceId` | Get a specific trace         |
| `DELETE` | `/api/traces/:projectId`          | Clear traces for a project   |
| `GET`    | `/api/projects`                   | Get all projects with traces |

## SDK Integration

For instrumenting your applications, we recommend using the official SDKs instead of calling the API directly:

<CardGroup cols={2}>
  <Card title="Python SDK" icon="python" href="/guides/tracing/python-sdk">
    Install with `pip install hmdl`
  </Card>

  <Card title="JavaScript SDK" icon="js" href="/guides/tracing/javascript-sdk">
    Install with `npm install hmdl`
  </Card>
</CardGroup>

## Need Help?

If you have questions about the API, please reach out:

* **Email**: [founder@tryheimdall.com](mailto:founder@tryheimdall.com)
* **GitHub Issues**: [github.com/hmdl-inc/heimdall/issues](https://github.com/hmdl-inc/heimdall/issues)