canonical: https://jentic.com/apis/swaggerhub.om-labs/bifrost-api

# Om Labs Bifrost API

This is the section of the Bifrost API that provides all methods to handle FoFo data capture and management in a custom app. The API exposes 22 endpoints.

## For AI agents

Programmatically access Bifrost API resources. Covers 22 operations.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Access Bifrost API resources via REST API
- Manage developer tools data programmatically
- Integrate Bifrost API into automated workflows
- Query and filter Bifrost API records by parameters
- Monitor Bifrost API operational status and events

## Use cases

### Developer Tools Operations

The API provides 22 endpoints for developer tools operations.

Example prompt: Execute a primary operation against the Bifrost API

### Data Retrieval and Monitoring

Query Bifrost API resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.

Example prompt: Poll the primary Bifrost API endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call Bifrost API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.

Example prompt: Search Jentic for 'bifrost API', load the operation schema, and execute with Jentic-managed credentials

## Key resources

- **tests** — Methods to handle the FoFo data entry in to Bifrost
- **results** — Methods to retrieve FoFo data through Bifrost
- **tenants** — Methods to retrieve all the organizations using Bifrost-powered systems
- **patients** — Methods to create and manage patient records
- **users** — Methods to create and manage user profiles for clinicians and examiners. These are necessary if usin

## Why Jentic

- **Setup:** Wiring this Bifrost API by hand means pointing at its Azure host and calling its message and results endpoints yourself. Through Jentic you install once, import Bifrost API from the API Directory, store any connection detail once, and your agent calls it.
- **Permission scoping:** Bifrost API carries its targets in the request body rather than the URL path, so scope your agent by the operations it needs, such as reading unread patient messages or showing results. You choose which operations it may call, so writes like sending a message or saving results are not included unless you add them.
- **Credential handling:** Any Bifrost API connection detail is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get unread patient messages' or 'show consultation results', and Jentic returns the matching Bifrost API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Bifrost API use?

The Bifrost API uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### What are the rate limits for the Bifrost API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I use bifrost API through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'use bifrost API'. Jentic returns the matching Bifrost API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Bifrost API have?

The Bifrost API exposes 22 endpoints covering tests, results, tenants operations.

### Does the Bifrost API support pagination?

Pagination support depends on the specific endpoint. Check the endpoint parameters for page, limit, or offset fields. Through Jentic, the operation schema exposes all available parameters so agents can paginate automatically.

### Can I limit what my agent is allowed to do with the Bifrost API?

Yes. Because you run Jentic One yourself, your own rules decide which Bifrost API operations and credentials your agent can use. Since the Bifrost API carries its targets in the request body rather than the URL path, you scope the agent by the operations you grant it, such as reading unread patient messages or showing consultation results. Write operations like sending a message or saving results stay off limits unless you explicitly add them.