AI Docs
BiomAPI publishes machine-readable resources that help LLMs and coding agents understand the API before writing integrations.
OpenAPI spec
Section titled “OpenAPI spec”FastAPI generates the OpenAPI 3.1 schema for the public REST API at:
GET /openapi.jsonThis is the canonical machine-readable description of the public REST operations, their request and response schemas, authentication options, and documented error responses.
Web pages such as /, /pin/{biompin}, /widget, and /browser-sdk-demo, along with
documentation resources, are excluded from the schema. They remain available and
are covered by the Web App guide,
Web Widget guide, and the documentation below.
The interactive Swagger UI is built from the same spec.
llms.txt
Section titled “llms.txt”Three machine-readable documentation resources are available at the site root:
| URL | Contents |
|---|---|
/llms.txt |
Entry point linking to the documentation sets and OpenAPI schema |
/llms-full.txt |
Full documentation content in plain text |
/llms-small.txt |
Abridged documentation for smaller context windows, excluding legacy-only material |
These follow the llms.txt convention and are generated from the same source as the public docs.