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

# RAPI Documentation

## Overview

![RAPI Overview](https://2782441740-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjLjPj3wCHnfCfuOYQpf4%2Fuploads%2Fgit-blob-b0cf226f27353fb233588697231674bf52a85539%2FRapiDiagram%20\(1\).png?alt=media)

## Usage Limits

Every tenant has a limit on their maximum number of catalogs and items in a catalog. That limit depends on the purchased package. If an item or catalog is created that would cross the limit, the call returns status 402.

## v3 API Reference (Swagger)

The v3 endpoints are documented interactively with Swagger UI, generated from the running API:

* **Swagger UI:** <https://api.roomle.com/v3/docs>
* **OpenAPI spec (JSON):** <https://api.roomle.com/v3/api-docs> — import it into Postman or a client generator.

To try requests from Swagger UI, click **Authorize** and enter your `rml-api-key`, `rml-token` and `rml-language` once; they are sent with every request.

Swagger covers only the endpoints already available in v3, and that set grows over time. Every other endpoint is documented in the v2 reference below.

## API Reference Index (v2)

* [Authentication](/rubens/rest-api/rest-api-reference/endpoints/authentication.md)
* [User](/rubens/rest-api/rest-api-reference/endpoints/user.md)
* [UserSettings](/rubens/rest-api/rest-api-reference/endpoints/usersettings.md)
* [Catalog](/rubens/rest-api/rest-api-reference/endpoints/catalog.md)
* [Item](/rubens/rest-api/rest-api-reference/endpoints/item.md)
* [Component](/rubens/rest-api/rest-api-reference/endpoints/component.md)
* [Plan](/rubens/rest-api/rest-api-reference/endpoints/plan.md)
* [PlanSnapshot](/rubens/rest-api/rest-api-reference/endpoints/plansnapshot.md)
* [Material](/rubens/rest-api/rest-api-reference/endpoints/material.md)
* [Texture](/rubens/rest-api/rest-api-reference/endpoints/texture.md)
* [PriceService](/rubens/rest-api/rest-api-reference/endpoints/priceservice.md)
* [Price](/rubens/rest-api/rest-api-reference/endpoints/price.md)
* [Mesh](/rubens/rest-api/rest-api-reference/endpoints/mesh.md)
* [Configuration](/rubens/rest-api/rest-api-reference/endpoints/configuration.md)
* [Tag](/rubens/rest-api/rest-api-reference/endpoints/tag.md)
* [ShortId](/rubens/rest-api/rest-api-reference/endpoints/shortid.md)
* [Configurator](/rubens/rest-api/rest-api-reference/endpoints/configurator.md)
* [Statistics](/rubens/rest-api/rest-api-reference/endpoints/statistics.md)

## Webhooks

For information about webhook, please check [here](/rubens/rest-api/rest-api-reference/webhook.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.roomle.com/rubens/rest-api/rest-api-reference/rapidocumentation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.