> ## 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.

# Agent Skills

> Install Suki agent skills so your AI coding agent loads the documented workflow, endpoints, and accuracy rules for each product before it writes code

Agent skills are `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.

```bash All skills (recommended) theme={"theme":{"light":"one-light","dark":"material-theme-darker"}}
npx skills add https://developer.suki.ai
```

```bash One skill theme={"theme":{"light":"one-light","dark":"material-theme-darker"}}
npx skills add https://developer.suki.ai --skill suki-ambient
```

```bash Preview the list theme={"theme":{"light":"one-light","dark":"material-theme-darker"}}
npx skills add https://developer.suki.ai --list
```

Skills install at project level by default. Add `-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](https://developer.suki.ai/.well-known/agent-skills/suki-platform/SKILL.md)**
>
> 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](https://developer.suki.ai/.well-known/agent-skills/suki-ambient/SKILL.md)**
>
> `suki-ambient`
>
> Use for ambient clinical notes through the Ambient APIs or any Ambient SDK, from session creation to the retrieved note.

> **[Form Filling](https://developer.suki.ai/.well-known/agent-skills/suki-form-filling/SKILL.md)**
>
> `suki-form-filling`
>
> Use for structured medical form output through the Form filling APIs or SDK.

> **[Dictation](https://developer.suki.ai/.well-known/agent-skills/suki-dictation/SKILL.md)**
>
> `suki-dictation`
>
> Use for real-time speech-to-text through the Dictation SDK, Web SDK, or APIs. Not for note generation.

> **[Patient Summary](https://developer.suki.ai/.well-known/agent-skills/suki-patient-summary/SKILL.md)**
>
> `suki-patient-summary`
>
> Use to ingest FHIR R4 data and generate full or pre-visit summaries.

> **[Audio Streaming](https://developer.suki.ai/.well-known/agent-skills/suki-audio-streaming/SKILL.md)**
>
> `suki-audio-streaming`
>
> Use with a product skill to implement or debug WebSocket audio streaming.

> **[Webhooks](https://developer.suki.ai/.well-known/agent-skills/suki-webhooks/SKILL.md)**
>
> `suki-webhooks`
>
> Use 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](https://developer.suki.ai/.well-known/agent-skills/suki-web-sdk/SKILL.md)**
>
> `suki-web-sdk`
>
> Use to embed Suki's prebuilt UI, with Ambient, Dictation, Form filling, and Patient Summary built in.

> **[Headless Web SDK](https://developer.suki.ai/.well-known/agent-skills/suki-headless-web-sdk/SKILL.md)**
>
> `suki-headless-web-sdk`
>
> Use to build your own Ambient UI with React hooks. Not for the headed Web SDK or Dictation SDK.

> **[Mobile SDK](https://developer.suki.ai/.well-known/agent-skills/suki-mobile-sdk/SKILL.md)**
>
> `suki-mobile-sdk`
>
> Use for Ambient or Form filling in a native iOS app.

> **[Dictation SDK](https://developer.suki.ai/.well-known/agent-skills/suki-dictation-sdk/SKILL.md)**
>
> `suki-dictation-sdk`
>
> Use to embed hosted Dictation in in-field or scratchpad mode.

> **[Form Filling SDK](https://developer.suki.ai/.well-known/agent-skills/suki-form-filling-sdk/SKILL.md)**
>
> `suki-form-filling-sdk`
>
> Use 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](https://developer.suki.ai/.well-known/agent-skills/suki-ambient-api/SKILL.md)**
>
> `suki-ambient-api`
>
> Use to call REST and `/ws/stream` directly, from session creation to the note.

> **[Form Filling API](https://developer.suki.ai/.well-known/agent-skills/suki-form-filling-api/SKILL.md)**
>
> `suki-form-filling-api`
>
> Use to call REST and `/ws/stream` directly with template IDs or dynamic schemas.

> **[Dictation API](https://developer.suki.ai/.well-known/agent-skills/suki-dictation-api/SKILL.md)**
>
> `suki-dictation-api`
>
> Use to call REST and `/ws/transcribe` directly for partial and final transcripts.

> **[Patient Summary API](https://developer.suki.ai/.well-known/agent-skills/suki-patient-summary-api/SKILL.md)**
>
> `suki-patient-summary-api`
>
> Use to call CKG ingestion and summary endpoints directly. Not for the Web SDK UI.

Agents can read the same list in machine-readable form from the [Agent skills index](https://developer.suki.ai/.well-known/agent-skills/index.json).

## 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/transcribe` with different message shapes.
* For direct API integrations, use staging unless you ask for production. The hosts are listed in the [FAQ for AI agents](https://developer.suki.ai/documentation/references/ai-agents-faq.md).
* If you do not have credentials yet, stop and complete [Partner onboarding](https://developer.suki.ai/documentation/get-started/partner-onboarding.md).

## 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:

```bash Terminal theme={"theme":{"light":"one-light","dark":"material-theme-darker"}}
npx skills update
```

To update one skill, add its name, for example `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 as `AGENTS.md` or a Cursor rule:

```md AGENTS.md theme={"theme":{"light":"one-light","dark":"material-theme-darker"}}
## Suki integration
Before changing Suki integration code, load the matching Suki skill
(start with suki-platform if the product is unclear). Check endpoints,
fields, and options against the Suki docs, and mark anything you cannot
find as BLOCKED instead of inventing it.
```

## Next steps

 **[Agent plugins](https://developer.suki.ai/documentation/references/agent-plugins.md)** - Install the Suki Cookbook plugin for short recipe skills in Cursor, Claude Code, or Codex.

 **[Documentation MCP](https://developer.suki.ai/documentation/references/mcp.md)** - Let the agent look up exact fields and pages while it works.

 **[Integration prompts](https://developer.suki.ai/documentation/references/integration-prompts.md)** - Start a task with a skill, staging, and a completion check.

 **[FAQ for AI agents](https://developer.suki.ai/documentation/references/ai-agents-faq.md)** - Environments, the OpenAPI spec, and 401 errors.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.