Skip to content

LLMs & Coding Agents

BiomAPI exposes several machine-readable resources designed for LLMs and coding agents building integrations.


FastAPI auto-generates a full OpenAPI 3.0 spec at:

GET /openapi.json

This is the canonical machine-readable description of every endpoint, request/response schema, authentication scheme, and error code. Feed it to any LLM or agent that needs to understand the API before writing code against it.

The interactive Swagger UI is built from the same spec.


Three variants of the documentation site index are available at the root:

URLContents
/llms.txtShort index — page titles and descriptions
/llms-full.txtFull page content in plain text
/llms-small.txtCondensed version optimized for smaller context windows

These follow the llms.txt convention and are auto-generated from the documentation source by the Starlight build. Use them to give an LLM a fast overview of what BiomAPI does and how to use it without browsing individual pages.


The BiomAPI CLI (biomapi.py) is distributed as an Agent Skill — a structured plugin that Claude Code and Codex CLI can install and invoke directly in conversation.

Terminal window
/plugin marketplace add mglraimundo/biomapi-cli
/plugin install biomapi-cli@mglraimundo-biomapi-cli

Once installed, the agent can call biomapi process, biomapi retrieve, biomapi csv, and other commands without leaving the conversation.

Terminal window
cp -r skills/biomapi ~/.codex/skills/

The skill bundles:

  • biomapi.py — zero-dependency Python script (only stdlib; no pip)
  • SKILL.md — agent-readable capability description and invocation guide
  • reference.md — API reference formatted for agent context

Source: mglraimundo/biomapi-cli