# API Documentation

Rain provides a complete, interactive Swagger/OpenAPI reference for developers who want to integrate with the platform. This documentation includes every public endpoint, validation rules, example payloads, authentication details, and live request/response testing.

<br>

Use this site to explore the API, verify request formats, and quickly prototype integrations without needing any additional tools.

<br>

Access the full API documentation:\
\
STAGE Environment

<https://stg-api.rain.one/api-docs/>

DEV Environment

[https://dev-api.rain.one/api-docs/<br>](https://dev-api.rain.one/api-docs/)

The Swagger interface is updated automatically with every backend release, ensuring the information remains accurate and current. This should be your primary resource when building or maintaining any integration with Rain services.


---

# 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://rain-4.gitbook.io/rain-docs/api-documentation.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.