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

# Introduction

> Welcome to the Assentir API documentation

The Assentir API provides developers with a robust interface for integrating the platform's features directly into their applications, allowing for seamless automation, and enhanced workflows.

<Card title="Assentir Endpoints" icon="leaf" href="https://github.com/assentir-app/documentation/blob/main/api-reference/openapi.json">
  View the OpenAPI specification file
</Card>

## Key Features

* **RESTful Architecture**: Standardised and predictable API behaviour.
* **JSON Format**: All API requests and responses use JSON, making it easy to integrate with modern applications.
* **Authentication**: Secure API authentication using token-based methods.
* **Pagination & Filtering**: Flexible filtering and pagination options to retrieve large data sets efficiently.
* **Error Handling**: Consistent and detailed error messages to support smooth debugging and development.
  Use Cases

## Getting Started

To start using the Assentir API:

1. **Create an API Key**: You will need an API key, which can be generated in the settings section of your Assentir account. Keep this key secure, as it authenticates all requests.

2. **Base URL**: All API requests are made to the following base URL:

```arduino theme={null}
https://{your-workspace}.assentir.com/v1/

```

3. **Authentication**: Include the API key in the header of all requests for authentication:

```makefile theme={null}
Authorization: Bearer YOUR_API_KEY
```