Build with an AI agent

Before asking your coding agent to build or update an integration, give it https://biomapi.com/llms.txt. This page links to the current machine-readable documentation and OpenAPI schema. Tell the agent which approach you want:

• For the hosted interface, start with the Web Widget. The Browser SDK opens it and provides BiomPIN retrieval, sharing, and optional browser history.
• For direct file processing, your own interface, or server-side automation, use the REST API.

---

Start with llms.txt

Three machine-readable documentation resources are available at the site root:

URL	Contents
/llms.txt	Recommended entry point linking to the documentation sets and OpenAPI schema
/llms-full.txt	Full documentation content in plain text
/llms-small.txt	Shorter documentation for smaller context windows; excludes material used only by legacy integrations

These follow the llms.txt convention and are generated from the same source as the public docs.

For repeated or offline work, download local copies and ask your agent to use them together as project context:

curl -O https://biomapi.com/openapi.json
curl -O https://biomapi.com/llms-full.txt

If your agent has limited context, keep openapi.json and consider replacing llms-full.txt with llms-small.txt for a shorter overview.

---

OpenAPI schema

FastAPI generates the OpenAPI 3.1 schema for the public REST API at:

GET /openapi.json

Use this schema as the main machine-readable reference for public REST operations. It defines request and response schemas, authentication options, and documented errors.

For POST /api/v1/biom/process, OpenAPI describes the multipart file upload. JSON input / BiomDIRECT explains the contents of a JSON upload, including required report objects and metadata added by the server. Use that page to create input. Use the response schema to read the completed output.

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 this documentation.

The interactive Swagger UI is built from the same spec.