> For the complete documentation index, see [llms.txt](https://docs.lowcoder.cloud/lowcoder-api-specification/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lowcoder.cloud/lowcoder-api-specification/api-reference-lowcoder.md). # API reference Lowcoder The Base URL of the Lowcoder API depends on your installation. ### Single Docker Deployment The Base URL of the API is the same as for the Frontend. In local installations for example: ``` http://localhost:3000/ https://:3000/ https:/// ``` ### Multi-Docker Deployment In a Multi-Docker Deployment, you will have an individual IP address or Domain for the API-Service Container. This is then the Base URL for the Lowcoder API. ``` https://:8080/ https:/// ``` When you run Multi-Docker Deployment on Localhost, you will need to look for the [Bridge-Network Settings](https://www.baeldung.com/ops/docker-communicating-with-containers-on-same-machine) that apply to your setup. ### app.lowcoder.cloud To use the API of the Cloud Version, the API is to reach via the separate API Service. ``` https://api-service.lowcoder.cloud/ ``` Since Lowcoder v2.1.6 we publish the OpenAPI Specification and the Swagger Documentation automatically. ``` Swagger Documentation: /api/docs/webjars/swagger-ui/index.html# OpenAPI Specification: /api/docs/openapi.json ``` You can find the current API Documentation for example here: \ --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.lowcoder.cloud/lowcoder-api-specification/api-reference-lowcoder.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.