# REST API Reference

This is the reference for the REST API part of Robopipe API. To try out particular endpoints, simply navigate to the appropriate endpoint and click on the "**Test it**" button. All endpoints have included the request and response body schema, along with the restrictions for particular attributes. When running the API, you can also open your locally running docs on <https://robopipe-1.local/docs> (Swagger UI). The OpenAPI specification can be downloaded from your server (controller) at <https://robopipe-1.local/openapi.json> or below in the *yaml* format.

{% file src="/files/MX0s7cqJuGO8WXnG25Xq" %}


---

# 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://robopipe.gitbook.io/doc/api/rest-api-reference.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.