> For the complete documentation index, see [llms.txt](https://docs.biodock.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.biodock.ai/public-api/overview.md). # Overview Biodock provides a public REST API so that users can invoke actions on Biodock through simple web requests. This allows users to integrate an AI analysis built on Biodock into scripts and programs. {% hint style="info" %} Also note that **creating** an AI model, which is a highly visual process in the labeler, cannot be done through our API. {% endhint %} Any action that is invoked through the API will also be tracked in our dashboard. For example, any files uploaded through the API will be visible in the Biodock Filesystem, and any Analysis Jobs submitted through the API will be visible on the results page. ### Example use cases for our API * A script that automatically analyzes cell culture images acquired, three times a day, and uploads results to a cloud server. * A sync tool that uploads data to one place (Biodock) from multiple imagers. * A continuously running alarm that runs quality control on samples and sends an alert when quality control fails. * Integrate Biodock into an internal tool, allowing users to submit files for analysis from an existing dashboard. --- # 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.biodock.ai/public-api/overview.md?ask=&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.