Use with an AI assistant

BiomAPI lets you work with biometry reports in Codex or Claude Code using plain language. Select a report or give its local path, then say what you need.

No API key needed. Public access includes 25 BiomAI credits per rolling 24 hours, enough for 25 Standard PDF/image extractions. People using the same IP address share this allowance. See credits and limits for how usage is counted.

Use BiomAPI to process this report and give me the ESCRS calculator link.

You get a short patient summary, a BiomPIN, links to BiomAPI and the ESCRS IOL Calculator, and the path to the saved JSON result. Ask for a table when you want to see the measurements in the conversation.

Install once

You need Python 3.11+ and internet access. The plugin includes the client, so there is no separate CLI download or Python package to install.

Codex

Run these commands in your terminal:

codex plugin marketplace add mglraimundo/biomapi-cli
codex plugin add biomapi-cli@biomapi

Start a new task, then select BiomAPI in the skill picker or mention it in your prompt.

Claude Code

Run these commands inside Claude Code:

/plugin marketplace add mglraimundo/biomapi-cli
/plugin install biomapi-cli@biomapi-plugins

Start a new conversation and ask to use BiomAPI. You can also invoke /biomapi-cli:biomapi explicitly.

The visible plugin name is BiomAPI in clients that support display names. biomapi-cli remains the installation ID. Codex also displays the bundled BiomAPI icon; Claude Code controls its own plugin presentation.

Prompts to try

Use the file picker to reference a local report, or replace the example filename with its path. For a first test without patient data, save this synthetic JSON report and ask BiomAPI to process it.

Process a report

Use BiomAPI to process report.pdf.

Returns the compact summary, sharing links, and saved result path. PDF and image reports use AI extraction; JSON files go through validation without using BiomAI credits.

Show the measurements

Use BiomAPI to process report.pdf and show the measurements for both eyes in a table.

Shows right and left eyes side by side, with units and posterior keratometry when present. If you already processed the report in this conversation, just ask: “Show the measurements from that result.”

Prepare several reports for a spreadsheet

Process these three reports with BiomAPI and give me the combined spreadsheet export.

Processes the selected files and returns one ZIP containing combined CSV and XLSX spreadsheets plus each JSON result. You can also ask to export previously saved BiomAPI results without repeating extraction.

Retrieve a BiomPIN

Use BiomAPI to retrieve this BiomPIN: [paste your code or full sharing link].

Returns the shared result and saves a local JSON copy. BiomPINs expire; use a current code or link. Full links can include patient context, so treat them as patient-identifying data.

Skip sharing

Process report.pdf with BiomAPI without creating a BiomPIN.

Saves the result locally without creating a temporary share. The source is still uploaded for processing.

Use fewer credits

Process these reports with BiomAPI using Slow. I can wait.

Slow uses 0.5 BiomAI credits per PDF or image instead of 1, but can take substantially longer. Standard is used unless you request Slow.

Update BiomAPI

Updating the plugin updates both the skill and its bundled client. You can ask:

Update the BiomAPI plugin to the latest version.

The assistant can run the plugin manager’s update commands when it has access to your installation. BiomAPI does not silently update itself while processing reports. To update manually:

Codex updates

Run in your terminal, in order:

codex plugin marketplace upgrade biomapi
codex plugin add biomapi-cli@biomapi

The first command refreshes the source. The second installs the version from that source. If the refresh fails, resolve the error before continuing. Start a new task afterward.

Claude Code updates

Run in your terminal, in order:

claude plugin marketplace update biomapi-plugins
claude plugin update biomapi-cli@biomapi-plugins

If the marketplace refresh fails, resolve the error before continuing. Restart Claude Code afterward.

These commands use the default user installation. For a project or local installation, add --scope project or --scope local to the plugin update command.

For automatic updates in Claude Code, open /plugin → Marketplaces → biomapi-plugins → Enable auto-update. Third-party marketplaces do not enable this by default. See Claude Code’s update guidance.

Saved keys are separate from the plugin and survive updates. These commands apply to the GitHub installation above; a local checkout or workspace-managed installation follows its own update process.

Advanced: optional API keys

You can skip this section. The public allowance is available immediately after installation. Keys are useful if you have an assigned BiomAPI quota or want extraction to use your own Google quota.

Set up or check an optional key

Ask:

Help me set up my BiomAPI key.

Or:

Help me use my own Gemini key with BiomAPI.

The assistant checks whether a key is already configured and gives you a command tailored to the installed plugin. Run it in your own terminal, then paste your key at the hidden prompt. Press Enter to keep an existing key or skip an option. Keep keys out of the conversation.

Key	When to use it	Where to get it
BiomAPI	You have an assigned service quota	The BiomAPI operator, through the contact form on biomapi.com
Gemini	You want extraction to use your own Google quota	Google AI Studio

You can use either key or both. Settings are saved locally in ~/.config/biomapi/config. Codex, Claude Code, and the standalone CLI reuse them under the same user account on the same machine. They survive plugin updates. The website and remote environments have separate settings.

To check setup later:

Check which keys BiomAPI has configured without showing their values, and show my current usage.

Environment variables take precedence over saved keys. The configuration check reports which source is active. For file locations, permissions, and command-line options, see CLI configuration.

What happens to the report

The assistant passes the source path to the bundled client. The client uploads the report to BiomAPI. PDF and image extraction also sends it to Google Gemini.

A local path lets the client upload the report without asking the assistant to read it. Processing still happens remotely. The host application controls how it handles attachments.

Sharing is enabled by default. Returned links may contain a reversible #biomctx=... fragment with the patient acronym and ID. Treat the complete link as patient-identifying data. See the Privacy Policy for processing, storage, and sharing details.

Verify extracted measurements against the original report. The skill extracts and formats data; the ESCRS link opens the calculator for you to review and continue there.

Troubleshooting

• The assistant cannot find BiomAPI: confirm that the plugin is enabled and start a new task or conversation.
• Python is missing: install Python 3.11 or later in the environment where the assistant runs.
• A credit limit is reached: ask “Check my BiomAPI usage and when credits become available again.”
• A saved key seems ignored: ask for a configuration check; an environment variable may override it, or the assistant may be running on another machine.

Source and installation updates: BiomAPI on GitHub.