# Introduction

### Documentation

The API is organized around the [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) standard. It is the recommended way to interact with your data.\
To begin the integration, you should start by understanding the `Authentification`process in the menu from the same name. \
All endpoints available are listed in the `Resources` menu. \
The objects returned from the endpoint are listed in the `Objects` menu.

### JSON returned

Every call to an endpoint will return a JSON object. \
The object will always contain the `success` value which will either be `false` or `true`. \
If `success` is `true`, the data will be contained in the `data` value.\
If `success` is `false`, the error will be contained in the `error` value.


---

# 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://docs.gem-suite.com/master.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.
