# Get Started

## 1. Introduction

Welcome to our API reference!

REST APIs (which are a type of web API) involves requests and responses, not too unlike visiting a web page. You make a request to a resource stored on a server, and the server responds with the requested information. The protocol used to transport the data is HTTP. “REST” stands for Representational State Transfer.

## 2. Get an API key

If you would like to use the api.minical.io PMS API, please request an API key here: 

<https://app.minical.io/settings/api_access>

Go to the Settings page \
Settings -> [API Access](https://app.minical.io/settings/api_access)

You will find here the **"Enable API access"** switch When you enable it, an API key will be generated in the input box just below the switch then update the settings page.\
From there you can copy this **Key** and set it in the HTTP header

X-API-KEY :  c74d8325xxxxxxxxxxxxxxf2ed17fc7

![You can easily generate API key by clicking on "Enable minical-app API access" slide button](https://811327896-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRi5vAE8q5IV5CQr0PerQ%2Fuploads%2FNsrgRLzlZ9etJOCptQaj%2Fimage%20\(2\).png?alt=media\&token=347ba02d-247e-4362-87d4-0992ef6f1c80)

{% hint style="info" %}
&#x20;The X-API-KEY and company\_id will need to be submitted with every request
{% endhint %}

## 3. Data Format <a href="#contact-us" id="contact-us"></a>

The API operates with the JSON data format.

Message us on [discord](https://discord.gg/a7B7RXZ3w5)

API can be accessed by placing the JSON in the request body. Always use the correct method (mentioned with every request) to send requests to us.

JSON (raw): Set the HTTP header Content-Type: application/json and pass a raw UTF8 encoded json body.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://api-docs.minical.io/quick-start/get-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.