API directory · Partner API for embedded ambient clinical documentation
Twofold API
A documented Partner API (v2) for embedding Twofold's AI scribe inside your own product: OAuth 2.0 provider linking, patient sync, recording launch, webhooks and note/transcript retrieval. Public docs, a full staging environment and self-serve console access.
Short answer
What does the Twofold API give a developer?
A documented Partner API (v2) for embedding Twofold's AI scribe inside your own product: OAuth 2.0 provider linking, patient sync, recording launch, webhooks and note/transcript retrieval. Public docs, a full staging environment and self-serve console access.
Base URL: Production: https://partner-api.trytwofold.com/v2 · Staging: https://partner-api.staging.trytwofold.com/v2 (fully separate environment)
Auth: OAuth 2.0: providers link their Twofold account via a standard consent screen; server-to-server calls send a partner API key as bearer token plus a Twofold-Client-Id header (your partnerId)
Cite as: Twofold API listing, Compare Healthcare API, last reviewed 2026-09-01.
Endpoints
Copied from the vendor's own reference. Where a path is described rather than published, the description is what the vendor states.
| Method | Endpoint | Mode | Purpose |
|---|---|---|---|
| GET | /oauth/authorize + token exchange | Auth | Link a provider's Twofold account to a user in your system through a standard OAuth 2.0 consent flow. |
| GET | /v2/partner/users | Session | List linked providers with link status and access level; cursor-paginated (limit default 25, max 100). |
| POST | Patient sync (keyed by your own patient ids) | Batch | Keep each provider's Twofold patient list in sync with your system, keyed by your external ids. |
| GET | Launch page (app.trytwofold.com/launch) | Session | Open Twofold from your UI with the right provider, patient and appointment pre-selected to start a recording. |
| POST | Webhooks | Streaming | Receive note lifecycle events — started, finished generating, edited, deleted — as sealed webhook payloads. |
| GET | Notes & transcripts retrieval | Session | Pull finished notes and transcripts back into your product and route sections via your own template section ids. |
Published rate limits
Numbers the vendor states publicly. Anything unpublished should be made contractual before you plan capacity.
| Per API key | 100 requests/second (burst 200); 429 returns Retry-After |
|---|---|
| Per linked provider | 10 requests/second (burst 20) |
Published pricing
List prices as published on the vendor's own pricing page at the verification date. Follow the source link before you quote these to anyone.
| Published product price | $49 per user per month billed annually; $69 month-to-month |
|---|---|
| Introductory offer | Free for one week, then $19 for the first month |
| API / partner tier | Quoted, not published |
Data handling and compliance
The three answers a health-system security review will ask you for, as published.
| BAA | Included on plans; BAA documented in the help centre |
|---|---|
| Retention | Stated zero-retention posture: audio and session data deleted after processing |
| Data scoping | Per-provider tokens only — no cross-provider queries; your side aggregates across providers |
How to integrate the Twofold API
An ordered path based on the public documentation, written for an engineering team scoping the work.
- 01
Get a partner organization
Twofold provisions your partnerId (prtn_…) and console access; you write your base note templates in the console before linking anyone.
- 02
Build on staging first
Production is gated until you validate on staging — a fully separate environment with its own accounts and environment-tagged credentials.
- 03
Link a provider
Run the OAuth 2.0 consent flow to connect a clinician's Twofold account to a user in your system.
- 04
Sync patients and launch
Push patients keyed by your own ids, then open the launch page with provider, patient and appointment pre-selected.
- 05
Consume webhooks
Handle note started/finished/edited/deleted events; verify the sealed payload before processing.
- 06
Fetch and route notes
Pull the finished note and transcript, and route each section by your template section ids into your own note model and review UI.
What the documentation does not warn you about
The judgement an endpoint list cannot give you.
Write your base templates before linking your first provider: linking replaces a provider's Twofold template library with yours, and an empty template set means an empty template picker and no way to record. Also note the per-provider data model — the same patient seen by three providers is three Twofold patients, and aggregation is your job.
Primary sources for this listing
Every fact above traces to one of these pages. If one has changed, tell us and the listing is re-verified.
- Partner API documentation https://partners.trytwofold.com/docs
- Rate limits https://partners.trytwofold.com/docs/rate-limits
- Authentication https://partners.trytwofold.com/docs/authentication
- Webhooks https://partners.trytwofold.com/docs/webhooks
- Pricing explained https://www.trytwofold.com/blog/twofold-pricing-explained
- BAA help article https://help.trytwofold.com/en/articles/9792865-business-associate-agreement-baa
Evidence & sources
Standards the integration steps above assume. Vendor-specific evidence is the primary source list on this page.
U.S. Department of Health & Human Services · Regulation · Tier A — primary documentation
Supports: The contractual clauses a documentation vendor's BAA must contain.
U.S. Department of Health & Human Services · Regulation · Tier A — primary documentation
Supports: Administrative, physical and technical safeguards a vendor handling recorded encounter audio must implement.
HL7 International · Standard · Tier A — primary documentation
Supports: Resource definitions (DocumentReference, Composition, Encounter, Condition, MedicationRequest) that clinical documentation output must map onto.
Source tiers are defined on the methodology page. Outbound links are unaffiliated and carry no commercial relationship.
Frequently asked questions
- Does Twofold have a public API?
- A documented Partner API (v2) for embedding Twofold's AI scribe inside your own product: OAuth 2.0 provider linking, patient sync, recording launch, webhooks and note/transcript retrieval. Public docs, a full staging environment and self-serve console access.
- How do you authenticate with the Twofold API?
- OAuth 2.0: providers link their Twofold account via a standard consent screen; server-to-server calls send a partner API key as bearer token plus a Twofold-Client-Id header (your partnerId)
- What are the Twofold API rate limits?
- Per API key: 100 requests/second (burst 200); 429 returns Retry-After. Per linked provider: 10 requests/second (burst 20)
- How much does the Twofold API cost?
- Published product price: $49 per user per month billed annually; $69 month-to-month. Introductory offer: Free for one week, then $19 for the first month. API / partner tier: Quoted, not published
- Can you evaluate Twofold without a sales conversation?
- Yes — full staging environment (separate database, accounts and credentials), self-serve console, no sales conversation required