canonical: https://jentic.com/apis/coviu.com/coviu

# Coviu Telehealth Video API

Jentic publishes the only available OpenAPI specification for Coviu Telehealth Video API, keeping it validated and agent-ready. The Coviu API powers the Coviu telehealth video platform, used by clinicians and allied health practices for secure video consultations. It exposes operations for creating and managing video sessions, adding and removing participants, monitoring waiting room queues, and retrieving collections data including submission files and audio recordings. Authentication is via OAuth 2.0 client credentials, HTTP Basic, or bearer token, depending on the integration model.

## For AI agents

Create and manage telehealth video consultation sessions, participants, and waiting room queues on Coviu. Use when an agent needs to schedule, monitor, or close a clinician-patient video call.

## Scope

Does not handle electronic health records, prescriptions, or medical billing - use for telehealth video session management only.

## Capabilities

- Create scheduled or on-demand video consultation sessions for clinicians and patients
- Add and remove participants from an active telehealth session
- List currently waiting calls for a clinic team and route them to the right practitioner
- Retrieve session summary data including duration and participant attendance
- Download submission files and audio recordings from a clinical collection
- Cancel or modify a scheduled telehealth session before it starts

## Use cases

### Telehealth Appointment Scheduling

A clinic's practice management system creates a Coviu video session for each scheduled telehealth appointment. POST /sessions returns a session URL that is sent to the patient by SMS or email and embedded into the clinician's calendar. When the appointment is rescheduled, PUT /sessions/{session_id} updates the time without forcing a new link. This keeps the patient-facing URL stable and avoids confusion on the day of the call.

Example prompt: Call POST /sessions with {start: '2026-06-11T10:00:00Z', duration: 30, hostName: 'Dr Patel'} and email the returned roomUrl to the patient.

### Waiting Room Triage

When patients arrive in the Coviu waiting room, a triage agent or receptionist polls GET /waiting/{teamId} to see who is queued, then routes each caller to the right clinician. The endpoint returns wait time and queue assignment so a dashboard can highlight long waits and prompt staff to admit or reassign callers. This avoids patients dropping off because nobody noticed they were ready.

Example prompt: Call GET /waiting/{teamId} every 30 seconds and post a Slack alert if any caller has been waiting longer than 5 minutes.

### Clinical Collections and Recordings

After a consultation, structured intake forms and audio recordings are stored as submissions inside a Coviu collection. A back-office workflow uses GET /collections/{teamId}/collection/{collectionId} to enumerate submissions and then downloads each file via GET /collections/{teamId}/collection/{collectionId}/submission/{submissionId}/file/{fileId} for archival into the clinic's EHR. This automates record keeping without exposing patient data to staff inboxes.

Example prompt: List submissions for collection 'intake-2026' on team 'sunshine-clinic', then download every audio recording from the last 24 hours and upload to S3 bucket 'clinic-archive'.

### Agent-Driven Video Session Lifecycle

An AI scheduling agent embedded in a clinic's chat workflow handles end-to-end session lifecycle: it creates a Coviu session when a patient confirms an appointment, adds the participant, monitors the waiting room, and retrieves the session summary for billing once the call ends. Through Jentic, the agent finds each Coviu operation by intent and executes it without holding raw OAuth credentials.

Example prompt: Search Jentic for 'create telehealth session', execute POST /sessions, then POST /sessions/{id}/participants for the patient, and finally GET /sessions/{id}/summary after the call closes.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /sessions | Create a new video session |
| GET | /sessions/{session_id} | Get a specific session |
| POST | /sessions/{session_id}/participants | Add a participant to a session |
| GET | /waiting/{teamId} | List currently waiting calls |
| GET | /sessions/{session_id}/summary | Retrieve session summary data |
| POST | /auth/token | Obtain access token via OAuth client credentials |

## Key resources

- **Sessions** — Create, list, modify, and cancel video consultation sessions
- **Participants** — Add, list, update, and remove participants from a session
- **Waiting** — Monitor active waiting room queues and individual calls
- **Collections** — Retrieve clinical collection submissions, files, and recordings

## Why Jentic

- **Setup:** Wiring the Coviu Telehealth Video API by hand means picking among its OAuth2 client-credentials, basic, and bearer auth options, pinning the v1 host, and coding your own session and participant requests. Through Jentic you install once, import the Coviu API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Coviu puts the session id in the URL path (/sessions/{session_id}/participants, /sessions/{session_id}/summary), so a rule can pin your agent to one session: it acts only on that session. You choose the operations it may call, so it stays limited to the reads and updates you allow.
- **Credential handling:** Your Coviu credential 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 'create a telehealth session' or 'add a participant to a session', and Jentic returns the matching Coviu operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Whereby API** — Whereby provides embeddable video rooms with a similar room-URL model.
- **Zoom Meetings API** — Zoom Meetings is a general-purpose video conferencing API also used in some telehealth deployments.
- **Twilio API** — Twilio sends SMS and email reminders containing the Coviu session link.

## FAQ

### Why is there no official OpenAPI spec for Coviu Telehealth Video API?

Coviu does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Coviu Telehealth Video 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 Coviu Telehealth Video API use?

Coviu supports OAuth 2.0 client credentials, HTTP Basic with client ID and client secret, or bearer token. The token endpoint is POST /auth/token. Through Jentic, credentials are stored encrypted and the bearer token is fetched and rotated automatically.

### Can I create a video consultation through the Coviu API?

Yes. POST /sessions creates a new session and returns a roomUrl that the patient and clinician load to start the call. Optional parameters control duration, host name, and recording settings.

### How do I monitor the Coviu waiting room programmatically?

Call GET /waiting/{teamId} to list everyone currently queued, or GET /waiting/{teamId}/queue/{queueId} for a specific queue. The response includes how long each caller has been waiting, which is useful for triage dashboards.

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

The OpenAPI spec does not declare numeric rate limits. Coviu enforces fair-use limits in production; in practice polling endpoints like /waiting at 30-60 second intervals is safe. Back off on 429 responses.

### How do I download a recording from a completed session through Jentic?

Search Jentic for 'download coviu recording', load the GET /collections/{teamId}/collection/{collectionId}/recording/{submissionId} schema, and execute with the team and submission identifiers. Jentic streams the audio file response back to the agent.

### Can I limit what my agent is allowed to do with the Coviu Telehealth Video API?

Yes. Jentic One runs self-hosted, so your own rules decide which Coviu operations and credentials the agent may use. Because Coviu puts the session id in the URL path, such as /sessions/{session_id}/participants and /sessions/{session_id}/summary, you can pin the agent to a single session so it acts only on that call. You also choose the operations it may reach, keeping it to the reads and updates you allow, for example letting it monitor GET /waiting/{teamId} without granting it POST /sessions.