Getting Started
BiomAPI extracts, validates, reviews, exports, and securely shares structured optical biometry data. You can use its ready-made interfaces or integrate the same processing into another application.
Choose how to use BiomAPI
Section titled “Choose how to use BiomAPI”Use BiomAPI directly
Section titled “Use BiomAPI directly”- Web app - Upload or transcribe reports, retrieve BiomPINs, review and edit results, and export data in the browser.
- CLI - Process and retrieve data from a terminal without building an API client.
- AI Skill - Process or retrieve data from supported AI assistants through the packaged CLI.
Integrate BiomAPI
Section titled “Integrate BiomAPI”- Web Widget - Usually the simpler option for browser-based form autofill. It opens the full BiomAPI review interface and returns data only after the user presses Send.
- REST API - Use direct requests for a custom interface, server-side processing, automation, or full workflow control.
The Browser SDK combines the widget with attributed public BiomPIN retrieval, copy/share utilities, URL-fragment consumption, patient identity context, and optional history. Processing and authenticated retrieval remain REST requests owned by your application.
Web app
Section titled “Web app”Open BiomAPI and upload a supported biometry PDF or image. No account is required for public access. BiomAPI routes the file automatically, displays the structured result beside the source report, and lets you review or edit the values before export or sharing.
See the Web App guide for uploads, multiple-file workflows, transcription, History, editing, BiomPIN sharing, and exports.
Web Widget
Section titled “Web Widget”The Web Widget gives another browser application the complete BiomAPI upload and review experience in a popup. The integrating page receives a standard response only after explicit user confirmation.
Start with the live demo, then follow the Web Widget guide.
REST API
Section titled “REST API”Process a file with one request:
curl -X POST https://biomapi.com/api/v1/biom/process \ -F "file=@report.pdf"The response follows the StandardAPIResponse schema. Public requests work without an API key at lower limits. Production integrations can use authentication for higher per-user limits.
Continue with the REST API reference for processing, BiomPIN retrieval, exports, usage, status, and health endpoints.
Command line and AI tools
Section titled “Command line and AI tools”The CLI guide covers terminal installation and configuration. For agent-based use, see the AI Skill and machine-readable AI documentation.