canonical: https://jentic.com/apis/api.aire.link/aire-link # AIRe Link API Jentic publishes the only available OpenAPI specification for AIRe Link API, keeping it validated and agent-ready. AIRe Link is a remote-care and clinical-collaboration platform that lets healthcare providers run video calls, collect structured clinical guides, manage clients and contacts, and exchange files with patients and partner clinicians. The API surfaces 324 operations across accounts, calls, clients, contacts, devices, exports, file libraries, forms, guide templates, and webhooks, making it suitable for embedding remote-consultation flows into a wider EHR or care-coordination product. Authentication is via the X-API-Key header. ## For AI agents Manage remote clinical video calls, clients, contacts, devices, and structured care guides on the AIRe Link telehealth platform. ## Scope Does not handle billing, prescribing, or core EHR record-of-truth functions - use for AIRe Link remote-consultation, client, and structured-guide workflows only. ## Capabilities - Create and manage remote-care video calls and their participants via /calls - Look up and update client records on the AIRe Link platform through /clients - Manage clinician and partner contacts via /contacts - Provision and inspect connected devices through /devices - Build structured clinical data collection through /guides, /guide-templates, and /guide-fragments - Share files and documents with patients via /file-libraries and /files - Trigger and download data exports through /exports for analytics or backup ## Use cases ### Embedded remote consultation Embed AIRe Link's video consultation flow inside a wider clinical product by creating a client through /clients, scheduling a call through /calls, and exposing the join link to both clinician and patient. The platform handles WebRTC plumbing, recording, and post-call notes; the embedding application keeps ownership of the appointment record. Suitable for telemedicine, remote diagnostics, and second-opinion services. Example prompt: POST a new call via /calls referencing an existing client and a clinician contact, then return the call id and join URL. ### Structured pre-consultation triage Send a structured clinical guide to a patient before a consultation using /guide-templates and /guides, then receive the responses through /guide-data. The clinician arrives at the call with the patient's reported symptoms, vital signs, and consent already captured, shortening the call and feeding straight into the medical record. Particularly valuable for chronic-care and pre-surgical workflows. Example prompt: Pick a guide template via /guide-templates, instantiate it for a client through /guides, then poll /guide-data until the patient submits responses. ### Care coordination across partners Coordinate care across a primary clinic and partner specialists by sharing client records and files via /contacts and /file-libraries. Webhooks notify each partner when a new file or call is created, so an agent can keep the partner clinic's record system in sync without manual handoff. Reduces faxing and email-attachment workflows still common in healthcare. Example prompt: On a /file-libraries 'file added' webhook, fetch the file metadata and forward a copy via /files to the partner contact's library. ### Agent integration via Jentic Wire AIRe Link into a clinical assistant agent through Jentic. The agent searches for the right operation by intent (schedule a call, send a guide, fetch a contact) and Jentic returns the matching schema from across the 324 endpoints. The X-API-Key sits in your Jentic One instance, satisfying the basic confidentiality bar required for healthcare operational tooling. Example prompt: Search Jentic for 'schedule a remote consultation', load /calls (POST), and execute it with client_id, contact_id, and scheduled_at. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /calls | List remote consultation calls | | GET | /clients | List clients on the platform | | GET | /contacts | List clinician and partner contacts | | GET | /guides | List structured clinical guides | | GET | /guide-templates | List available guide templates | | GET | /file-libraries | List file libraries shared between clinicians and clients | | GET | /devices | List connected devices | | GET | /exports | List or trigger data exports | ## Key resources - **Calls** — Schedule, run, and retrieve remote video consultations - **Clients** — Manage patient/client records on the platform - **Contacts** — Manage clinician and partner contact records - **Guides** — Structured clinical guides and templates for data collection - **Files and File Libraries** — Share documents, images, and recordings between clinicians and clients - **Devices** — Provision and inspect connected medical or peripheral devices - **Exports** — Bulk export data for reporting or backup ## Why Jentic - **Setup:** Wiring the AIRe Link API by hand means handling its X-API-Key header and finding the right routes among 324 remote-consultation and client endpoints yourself. Through Jentic you install once, import AIRe Link from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** For the collection routes here AIRe Link addresses work through query parameters and request bodies rather than resource ids in the URL path, so you limit the agent to the operations it needs, such as listing calls or clients. Actions like scheduling a consultation are separate operations that are only available if you include them in the allowed set. - **Credential handling:** Your AIRe Link X-API-Key is stored once, encrypted, by your own Jentic One instance and injected as the header at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'schedule a remote video consultation', and Jentic returns the matching AIRe Link operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Epic FHIR API** — Underlying EHR data source to combine with AIRe Link's remote consultation flow - **Onfido API** — Patient identity verification to gate AIRe Link sign-ups - **ComplyAdvantage API** — Sanctions screening to apply to private healthcare patients onboarding in regulated markets ## FAQ ### Why is there no official OpenAPI spec for AIRe Link API? AIRe Link does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call AIRe Link API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the AIRe Link API use? The AIRe Link API uses an API key passed in the X-API-Key header on every request. Keys are issued from your AIRe Link admin console and scoped per environment. Through Jentic the key is held in your Jentic One instance and injected at execution time. ### Can I schedule a remote consultation through the AIRe Link API? Yes. POST to /calls with the client_id, clinician contact_id, and scheduled_at to create a consultation. The response includes the call id and the join URLs for clinician and patient. GET /calls/{id} returns the call's state and any recordings or notes attached after it ends. ### What are the rate limits for the AIRe Link API? AIRe Link does not publish public rate limits in the OpenAPI metadata; in practice the platform is provisioned per tenant with limits in the low thousands of requests per minute. Agents should respect 429 responses with exponential backoff and avoid tight polling on high-cardinality endpoints like /guide-data. ### How do I send a structured pre-consultation guide through Jentic? Search Jentic for 'send AIRe Link guide to client', load the /guides POST operation, and execute it with template_id and client_id. The patient receives a notification, fills in the guide, and the responses become available on /guide-data for the same guide id. ### Does the AIRe Link API support webhooks? Yes. The API exposes webhook configuration so that a partner system can subscribe to events such as new calls, file uploads, and guide submissions. Use the webhook endpoints to register a callback URL; AIRe Link delivers signed JSON payloads for each subscribed event type. ### Can I limit what my agent is allowed to do with the AIRe Link API? Yes. Because you run Jentic One yourself, your own rules decide which AIRe Link operations and credentials the agent may use, so you can allow read-only calls like listing calls or clients while excluding everything else. The collection routes address records through query parameters and request bodies rather than ids in the path, so granting a listing operation does not expose write actions. Actions such as scheduling a consultation are separate operations that the agent can only call if you add them to the allowed set.