Documentation
Build telehealth consults into your own product. Start with getting started, then read the guide for whatever you are wiring next. Every operation is in the API reference.
- Getting startedMint a test key, make your first call, and drive a whole consult against the sandbox.
- AuthenticationAPI keys and OAuth clients, how each is minted and rotated, and what live mode asks for first.
- Scopes and organizationsWhat a credential may do, who it may do it for, and how a clinic grants you access.
- Test modeThe sandbox, the simulated clinician and pharmacy, and how to drive a whole consult without one.
- CasesFiling an asynchronous consult, the statuses it moves through, and what falls out of a decision.
- Patients and consentsCreating the identity a case is filed under, recording what the patient accepted, and honouring a deletion request.
- FilesReserving an upload, PUTting the bytes, confirming, and the one id that changes on the way.
- VisitsBooking a video consult with a licensed clinician, moving or cancelling it, and the short-lived link the patient joins through.
- WebhooksRegistering an endpoint, verifying a signature, and what happens when your receiver is down.
- Events and realtimeThe event catalog, polling as the backstop, and a subscribe-only channel for the moments you want live.
- BillingWhat gets charged, how to read the usage ledger, and how an invoice reconciles to it.
- ErrorsThe problem body every failure answers with, the machine codes to switch on, and what each one means you should do.
- Rate limits and idempotencyThe per-credential limit, and the header every write requires so a retry never creates a second row.
- PaginationOne cursor envelope for every list, why there is no total, and how to page a backfill.
- VersioningWhat we may change without telling you, what we may not, and how long a deprecation runs.
- MCP serverThe Model Context Protocol door at mcp.cuvo.co, the tools behind it, and how an agent authenticates.
- SDKsThe TypeScript and Python clients, what each adds over raw fetch, and how their types stay honest.
- CLIThe cuvo command, how it signs you in, and how an operation becomes a command.