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

# 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" %}