> For the complete documentation index, see [llms.txt](https://docs.gem-suite.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gem-suite.com/master.md).

# Introduction

Welcome to the GEM API documentation!

The GEM REST API allows developers to integrate external applications and services with **GEM-CAR** and **GEM-BOOKS**.

Through our API, you can securely retrieve, create, and update data, automate workflows, and build custom integrations that connect your systems with the GEM ecosystem.

### Getting Started

Our API follows REST principles and uses JSON for data exchange, making it easy to integrate with most modern programming languages and platforms.

To get started, we recommend exploring the following sections:

1. **Authentication** — Learn how to authenticate your requests and securely access the API.
2. **Resources** — Explore the available endpoints and the operations you can perform.
3. **Objects** — Understand the structure and properties of the data exchanged through the API.

### API Responses

All API requests return a JSON response containing a `success` field indicating whether the operation was completed successfully.

**Successful response**

```
{
  "success": true,
  "data": {
    "id": 123,
    "name": "Example"
  }
}
```

When `success` is `true`, the requested information is available in the `data` field.

**Error response**

```
{
  "success": false,
  "error": "An error occurred while processing the request."
}
```

When `success` is `false`, the `error` field provides information about what went wrong.

### Ready to Build?

Start by reviewing the **Authentication** section to learn how to connect to the GEM API and make your first request.