Getting started

BiomAPI turns biometry reports into structured measurements. Use the web app to review a report. Use the widget to add the same workflow to your application.

Use BiomAPI

1. Open BiomAPI and choose Open file. Select a supported PDF or image. To try the synthetic JSON report, save it as report.json first.
2. Select Process Biometry. BiomAI extracts PDFs and images. BiomJSON validates JSON without an AI call.
3. Check the patient, examination date, and OD/OS measurements. For PDFs and images, choose Original to reopen the source. On a wide screen, choose Compare to view it beside the result. Select Edit to correct values.
4. Choose Download to keep the JSON result. If a BiomPIN was created, you can copy its link or open the result in the ESCRS calculator.

The web app requests a temporary BiomPIN automatically for single reports. Download results you need to keep. Browser History lists temporary shares; it does not keep a permanent copy of the measurements.

Continue with the Web app guide for phone upload, manual entry, datasets, and sharing. Before uploading patient data, review how BiomAPI handles it.

Integrate BiomAPI

Use the Web Widget to add BiomAPI’s upload and review interface to your application. The Browser SDK opens the widget. It also retrieves BiomPINs, creates sharing links, and provides optional local history.

Use the REST API to process files directly, build your own interface, or connect from a server.

Use the Web Widget

The Web Widget opens BiomAPI from a button in your application. The user uploads or retrieves a report, reviews it, and presses Send. Your application receives the reviewed response. If the user cancels, it receives no data.

Try the live demo, then copy the complete example in the widget guide.

Make a REST request

Try the API with synthetic data. These commands save a sample report, submit it, and save the response:

curl --fail-with-body -o report.json https://biomapi.com/docs/examples/report.json
curl --fail-with-body https://biomapi.com/api/v1/biom/process \
  -F "file=@report.json" \
  -o result.json

Open result.json. Measurements are under data. For this JSON input, metadata.extraction.method is BiomDIRECT. To create a BiomPIN, add -F "biompin=true". To extract a PDF, change the file argument to file=@report.pdf.

To construct your own JSON, follow JSON input / BiomDIRECT for the required objects and automatically added metadata.

Public requests need no API key. See the REST API for options and errors, the response schema for fields, and authentication for higher quotas or your own Gemini key.

Work from a terminal or assistant

Use the CLI for terminal workflows, or follow Use with an AI assistant to process reports through a supported assistant. For help building an integration, see Build with an AI agent.

If something goes wrong, see Troubleshooting.