Suki provides the clinical intelligence infrastructure used by leading healthcare software providers and vendors to build applications on top of Suki capabilities. As a trusted partner, we are committed to providing a stable and reliable platform that you can build on with confidence. This page explains:Documentation Index
Fetch the complete documentation index at: https://developer.suki.ai/llms.txt
Use this file to discover all available pages before exploring further.
- How Suki versions APIs and SDKs
- How changes are labeled and published
- Where to find release information
- How to plan upgrades and migrations
- Why we publish updates this way
Why we publish updates this way
Many integrations use more than one Suki product, such as ambient workflows, form filling, dictation, and SDKs. To support that model, Suki publishes updates through two channels:Monthly release notes
Cross-product visibility each month: what shipped across ambient, form filling, dictation, and SDKs, with paths into deeper docs.
Product changelogs
Version-level history per product: labels, tags, breaking-change callouts, snippets, and migration pointers. Open each changelog from the Release notes hub.
- What changed
- Whether your integration is affected
- Where to find implementation details
Release notes provide a workflow-level summary. Changelogs provide product-specific technical detail.
Versioning
Suki uses semantic versioning (SemVer) for SDKs and documented release trains: For example:MAJOR.MINOR.PATCHExample:
3.1.0| Version segment | Meaning |
|---|---|
| Major | Breaking or incompatible changes that might require migration work or regression testing |
| Minor | Backward-compatible features or capabilities |
| Patch | Backward-compatible fixes and documentation updates |
Product versioning
- SDKs
- APIs
SDKs, including the Web SDK, Mobile SDK, Headless Web SDK, and Dictation SDK, are released as versioned npm packages.A major version increase usually indicates that code or configuration changes are required. When applicable, changelog entries include migration guidance.
Breaking and non-breaking changes
Use the following guidance when reviewing API changes.Usually Non-Breaking Changes
These changes are typically backward compatible:
- New optional request or response fields
- New endpoints
- Performance improvements
- Documentation clarifications
Potentially Breaking Changes
Review these changes carefully before upgrading:
- New required fields
- Renamed fields
- Removed endpoints or fields
- Stricter validation
- Changed default behavior
- Any update marked as Breaking changes
Where changes are published
| Channel | Purpose |
|---|---|
| Release notes | Monthly summaries across workflows such as ambient, form filling, and dictation |
| Announcements | Site-wide notices and operational updates |
| Product changelogs | Product-specific version history, release details, and migration guidance |
Product changelogs
We maintain dedicated changelogs for each of our product lines. This helps you understand the specific changes and updates for each product. For regular updates, we highly recommend subscribing to the Release notes hub to receive monthly updates across products. How to subscribe:| Option | What to do |
|---|---|
| RSS | Open the Release notes hub and use the RSS button to subscribe to the monthly feed. |
| Subscribe | Open the Release notes hub and use Subscribe to get monthly updates by email across products. |
How to read monthly release notes
Monthly release notes are organized by calendar month and workflow area, not by a single platform-wide version number. To review a monthly release:- Open the month from the Release notes hub.
- Review the available section headings for that month.
- Use product badges to identify the products relevant to your integration.
- Read the Why it matters section when available.
- Follow links to changelogs, guides, or API reference documentation before updating production integrations.
Monthly release note sections
| Section | Description |
|---|---|
| What’s new | New capabilities, workflows, SDKs, or API families |
| What’s enhanced | Improvements to existing functionality, including additive features and reliability updates |
| What’s changed | Behavioral updates, terminology changes, operational notes, or partner-facing adjustments |
| What’s removed | Deprecations and removals, including migration recommendations when available |
Important:
- Not every release includes every section.
- Monthly release notes supplement changelogs. They do not replace detailed version history.
Changelog policy
Each product changelog is the authoritative source for that product line. Changelog entries include:- A release label such as
v3.1.0 - Tags that summarize the update
- Clear identification of breaking changes
- Integration examples and code snippets when applicable
Release notes and changelogs
Use release notes to understand:What changed this month across the workflows my organization uses?
What changed in this specific SDK or API release, and what updates are required in my integration?