SKILL.md files that give your AI coding agent the documented workflow for one Suki product: which calls to make, in what order, which environment to use, and which mistakes to avoid. Install them first, so the agent starts from Suki’s workflow instead of guessing from general knowledge.
Install skills
Run the command from your project root. Installing every skill is the recommended option, because an agent reads only each skill’s name and description up front and loads the full instructions when a task matches.-g to install them for your user account across all projects instead. On product hubs, the Install Skill control next to the page title opens the one-skill command for that product.
Choose a skill
Platform Router
Start here
suki-platform: Use when you have not chosen a product, SDK, or API. The agent uses it to pick the right product skill below, then loads that skill for the actual integration.Workflow skills
Recommended when you know the job but have not chosen between an SDK and the Partner APIs. Ambient, Form filling, Dictation, and Patient Summary cover both paths and point the agent to the dedicated SDK or API skill once you decide. Audio Streaming and Webhooks add to a product skill.
Ambient
suki-ambientUse for ambient clinical notes through the Ambient APIs or any Ambient SDK, from session creation to the retrieved note.
Form Filling
suki-form-fillingUse for structured medical form output through the Form filling APIs or SDK.
Dictation
suki-dictationUse for real-time speech-to-text through the Dictation SDK, Web SDK, or APIs. Not for note generation.
Patient Summary
suki-patient-summaryUse to ingest FHIR R4 data and generate full or pre-visit summaries.
Audio Streaming
suki-audio-streamingUse with a product skill to implement or debug WebSocket audio streaming.
Webhooks
suki-webhooksUse to receive notifications, verify HMAC signatures, and handle retries.SDK skills
Use these after you choose an SDK. They keep the agent on SDK classes and hooks instead of raw API calls.
Web SDK
suki-web-sdkUse to embed Suki’s prebuilt UI, with Ambient, Dictation, Form filling, and Patient Summary built in.Headless Web SDK
suki-headless-web-sdkUse to build your own Ambient UI with React hooks. Not for the headed Web SDK or Dictation SDK.
Mobile SDK
suki-mobile-sdkUse for Ambient or Form filling in a native iOS app.Dictation SDK
suki-dictation-sdkUse to embed hosted Dictation in in-field or scratchpad mode.
Form Filling SDK
suki-form-filling-sdkUse to embed hosted Form filling. Prefer it over the APIs when you want Suki’s UI.API skills
Use these when your backend calls the Partner APIs directly. They are not for SDK integrations.
Ambient API
suki-ambient-apiUse to call REST and /ws/stream directly, from session creation to the note.Form Filling API
suki-form-filling-apiUse to call REST and /ws/stream directly with template IDs or dynamic schemas.Dictation API
suki-dictation-apiUse to call REST and /ws/transcribe directly for partial and final transcripts.Patient Summary API
suki-patient-summary-apiUse to call CKG ingestion and summary endpoints directly. Not for the Web SDK UI.How skills keep agents accurate
Each skill includes accuracy rules that tell the agent to check the docs instead of guessing. The platform router sets these rules for every product:- Do not invent endpoints, SDK methods, or WebSocket message types.
- Keep Ambient, Form filling, Dictation, and Patient Summary distinct. Ambient and Form filling stream on
/ws/stream, and Dictation streams on/ws/transcribewith different message shapes. - For direct API integrations, use staging unless you ask for production. The hosts are listed in the FAQ for AI agents.
- If you do not have credentials yet, stop and complete Partner onboarding.
Keep skills up to date
Suki rebuilds the skills from the published documentation, so update them after a release to pick up new endpoints, options, and rules:Terminal
npx skills update suki-ambient.
Tell every session to use the skills
Agents load a skill when the task matches its description. To make sure they always check Suki skills before touching integration code, add a short instruction to your project rules file, such asAGENTS.md or a Cursor rule:
AGENTS.md
