Suki AI

Suki AI Sessions API

Ambient Session Lifecycle

GitHub OpenAPI

Operations 10

POST /ambient/sessions Create Ambient Session #
POST /ambient/sessions/{sessionId}/context Seed Session Context #
PATCH /ambient/sessions/{sessionId}/context Update Session Context #
POST /ambient/sessions/{sessionId}/end End Ambient Session #
GET /ambient/sessions/{sessionId}/status Get Ambient Session Status #
POST /form-filling/sessions Create Form Filling Session #
POST /form-filling/sessions/{sessionId}/context Seed Form Filling Context #
PATCH /form-filling/sessions/{sessionId}/context Update Form Filling Context #
POST /form-filling/sessions/{sessionId}/end End Form Filling Session #
GET /form-filling/sessions/{sessionId}/status Get Form Filling Status #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/suki-ai/refs/heads/main/openapi/suki-ai-sessions-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/suki-ai-sessions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

suki-ai-sessions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Suki Ai Sessions API
  version: 1.0.0
  contact:
    name: Suki for Partners
    url: https://developer.suki.ai
  description: 'Operations tagged Sessions across 2 of this provider''s published API definitions: suki-ai-ambient-api-openapi.yml, suki-ai-form-filling-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://sdp.suki-stage.com/api/v1
  description: Suki Speech Service staging environment
security:
- SdpSukiToken: []
tags:
- name: Sessions
  description: Ambient Session Lifecycle
paths:
  /ambient/sessions:
    post:
      tags:
      - Sessions
      summary: Create Ambient Session
      description: Create a new ambient documentation session for a provider and encounter.
      operationId: createAmbientSession
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AmbientSessionCreate'
      responses:
        '201':
          description: Session created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmbientSession'
        '401':
          $ref: '#/components/responses/Unauthorized'
    servers:
    - url: https://sdp.suki-stage.com/api/v1
      description: Suki Speech Service staging environment
  /ambient/sessions/{sessionId}/context:
    post:
      tags:
      - Sessions
      summary: Seed Session Context
      operationId: seedAmbientSessionContext
      parameters:
      - $ref: '#/components/parameters/SessionId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionContext'
      responses:
        '200':
          description: Context applied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionContext'
    patch:
      tags:
      - Sessions
      summary: Update Session Context
      operationId: updateAmbientSessionContext
      parameters:
      - $ref: '#/components/parameters/SessionId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionContext'
      responses:
        '200':
          description: Context updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionContext'
    servers:
    - url: https://sdp.suki-stage.com/api/v1
      description: Suki Speech Service staging environment
  /ambient/sessions/{sessionId}/end:
    post:
      tags:
      - Sessions
      summary: End Ambient Session
      operationId: endAmbientSession
      parameters:
      - $ref: '#/components/parameters/SessionId'
      responses:
        '200':
          description: Session ended; note generation queued
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmbientSession'
    servers:
    - url: https://sdp.suki-stage.com/api/v1
      description: Suki Speech Service staging environment
  /ambient/sessions/{sessionId}/status:
    get:
      tags:
      - Sessions
      summary: Get Ambient Session Status
      operationId: getAmbientSessionStatus
      parameters:
      - $ref: '#/components/parameters/SessionId'
      responses:
        '200':
          description: Current session and note generation status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionStatus'
    servers:
    - url: https://sdp.suki-stage.com/api/v1
      description: Suki Speech Service staging environment
  /form-filling/sessions:
    post:
      tags:
      - Sessions
      summary: Create Form Filling Session
      operationId: createFormFillingSession
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormFillingSessionCreate'
      responses:
        '201':
          description: Session created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormFillingSession'
    servers:
    - url: https://sdp.suki-stage.com/api/v1
      description: Suki Speech Service staging environment
  /form-filling/sessions/{sessionId}/context:
    post:
      tags:
      - Sessions
      summary: Seed Form Filling Context
      operationId: seedFormFillingContext
      parameters:
      - $ref: '#/components/parameters/SessionId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormFillingContext'
      responses:
        '200':
          description: Context applied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormFillingContext'
    patch:
      tags:
      - Sessions
      summary: Update Form Filling Context
      operationId: updateFormFillingContext
      parameters:
      - $ref: '#/components/parameters/SessionId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormFillingContext'
      responses:
        '200':
          description: Context updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormFillingContext'
    servers:
    - url: https://sdp.suki-stage.com/api/v1
      description: Suki Speech Service staging environment
  /form-filling/sessions/{sessionId}/end:
    post:
      tags:
      - Sessions
      summary: End Form Filling Session
      operationId: endFormFillingSession
      parameters:
      - $ref: '#/components/parameters/SessionId'
      responses:
        '200':
          description: Session ended; structured data queued
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormFillingSession'
    servers:
    - url: https://sdp.suki-stage.com/api/v1
      description: Suki Speech Service staging environment
  /form-filling/sessions/{sessionId}/status:
    get:
      tags:
      - Sessions
      summary: Get Form Filling Status
      operationId: getFormFillingStatus
      parameters:
      - $ref: '#/components/parameters/SessionId'
      responses:
        '200':
          description: Processing status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormFillingStatus'
    servers:
    - url: https://sdp.suki-stage.com/api/v1
      description: Suki Speech Service staging environment
components:
  schemas:
    AmbientSession:
      type: object
      properties:
        sessionId:
          type: string
          format: uuid
        providerId:
          type: string
        encounterId:
          type: string
        status:
          type: string
          enum:
          - created
          - recording
          - ended
          - processing
          - complete
          - failed
        createdAt:
          type: string
          format: date-time
        audioWebsocketUrl:
          type: string
          format: uri
    SessionStatus:
      type: object
      properties:
        sessionId:
          type: string
          format: uuid
        status:
          type: string
        progress:
          type: integer
          minimum: 0
          maximum: 100
        eta:
          type: integer
          description: Estimated seconds until note is ready
    AmbientSessionCreate:
      type: object
      required:
      - providerId
      - encounterId
      properties:
        providerId:
          type: string
        encounterId:
          type: string
        specialty:
          type: string
          example: family-medicine
        encounterType:
          type: string
          example: office-visit
        visitType:
          type: string
          example: new-patient
        languageCode:
          type: string
          example: en-US
        problemBasedCharting:
          type: boolean
          default: true
    SessionContext:
      type: object
      properties:
        patient:
          type: object
          properties:
            mrn:
              type: string
            sex:
              type: string
            birthDate:
              type: string
              format: date
            problems:
              type: array
              items:
                type: string
        priorNote:
          type: string
        loincSections:
          type: array
          items:
            type: string
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
    FormFillingStatus:
      type: object
      properties:
        sessionId:
          type: string
          format: uuid
        status:
          type: string
        progress:
          type: integer
          minimum: 0
          maximum: 100
    FormFillingSessionCreate:
      type: object
      required:
      - providerId
      - templateId
      properties:
        providerId:
          type: string
        templateId:
          type: string
        languageCode:
          type: string
          example: en-US
    FormFillingContext:
      type: object
      properties:
        patient:
          type: object
          properties:
            mrn:
              type: string
            sex:
              type: string
            birthDate:
              type: string
              format: date
        priorAnswers:
          type: object
          additionalProperties: true
    FormFillingSession:
      type: object
      properties:
        sessionId:
          type: string
          format: uuid
        templateId:
          type: string
        status:
          type: string
          enum:
          - created
          - recording
          - ended
          - processing
          - complete
        audioWebsocketUrl:
          type: string
          format: uri
        createdAt:
          type: string
          format: date-time
  parameters:
    SessionId:
      name: sessionId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  responses:
    Unauthorized:
      description: Missing or invalid sdp_suki_token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    SdpSukiToken:
      type: apiKey
      in: header
      name: sdp_suki_token
x-refined-from:
- suki-ai-ambient-api-openapi.yml
- suki-ai-form-filling-api-openapi.yml