Skip to main content

Agent-ready API context

Copy these resources into your coding agent to give it the API contract and Cobalt-specific EHR guidance.
Copy for your agent

OpenAPI specification

The machine-readable API contract for every endpoint, with per-EMR support tags.

LLM guide

An index of the concepts and endpoints, written for agents. Append .md to any docs page URL for its raw markdown.
Per-EMR support lives in the spec, not in these pages. An operation’s x-supported-emrs lists the EMRs that support that endpoint. A request field’s x-required-for-emrs lists the EMRs that require it, and x-allowed-values-for-emrs maps each EMR to the values it accepts. Consult those tags rather than assuming support.
You need a client_id and client_secret to interact with the Cobalt API. You will also need an access_token for each user which can be obtained in through the Cobalt Link flow.

Authentication Headers

Example request:

Response Warnings

Some responses include a top-level warnings array of human-readable strings. Warnings are non-fatal: the request still succeeds and the data is returned as usual. They flag conditions worth your attention without failing the call. Unrecognized query parameters are one such condition. If a GET request includes a query parameter the endpoint does not support (a typo, or a parameter that was renamed or removed), it is ignored, not applied, and the response includes a warning that names it, so the mistake is visible rather than silent. The same message is also returned in a Cobalt-Warning response header.
Treat a warning as a signal to check your request against this reference. Unknown parameters are never rejected with an error, so an integration that relies on one silently having no effect will keep working, but the warning tells you it is doing nothing. A turned-off sync is another. GET endpoints that return synced data (for example GET /patients or GET /appointments) serve what Cobalt last synced from your EMR. If your EMR supports syncing that resource but the sync is turned off for the account, the response includes a warning: results may be empty (the sync was never turned on) or out of date (it was turned off later). Turn the sync on from the API Access tab in the Cobalt app; new data appears after the next sync completes.