Skip to content

Authentication & BYOK

All BiomAPI endpoints are publicly accessible — authentication is optional and provides higher rate limits, not access control.

ScenarioRate limit
No keyPer-IP daily limits (30 BiomAI calls/day)
BiomAPI keyPer-user custom quotas
BYOK Gemini keyUnlimited BiomAI (your Gemini quota), separate bucket
Both keysYour Gemini quota + custom retrieve quota

Pass your key as a Bearer token or query parameter:

Terminal window
# Bearer token (recommended)
curl -H "Authorization: Bearer biom_your_key_here" ...
# Query parameter
curl "https://biomapi.com/api/v1/biom/process?api_key=biom_your_key_here" ...

Key format: biom_ + 43 random base64url characters (256-bit entropy). GitHub Secret Scanning compatible.

Terminal window
curl -H "Authorization: Bearer biom_your_key" \
https://biomapi.com/api/v1/biom/usage

Supply your own Google Gemini API key to use your personal quota. The server’s shared BiomAI quota is not consumed.

Terminal window
curl -X POST https://biomapi.com/api/v1/biom/process \
-H "X-Gemini-API-Key: AIza_your_gemini_key" \
-F "file=@report.pdf"

BYOK details:

  • Applies to POST /api/v1/biom/process (PDF/image files only)
  • Ignored for JSON uploads — BiomJSON doesn’t call the LLM
  • Tracked under the biomai_byok rate limit bucket (separate from biomai)
  • Validate your key: GET /api/v1/biom/usage?validate=true

All limits use a 24-hour sliding window (not a midnight reset). Usage timestamps roll off 24 hours after they were recorded.

See Rate Limits for full details.