Transcription State Manager

List all dictation sessions

{
  "data": [
    {
      "dictation_id": "dict-cc3f91",
      "field_id": "field_visit_notes",
      "route_id": "route-visit-form",
      "state": "completed",
      "started_at": "2026-03-26T09:45:00Z",
      "stopped_at": "2026-03-26T09:46:20Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 11
  }
}

Get a specific dictation session and its current state

{
  "dictation_id": "dict-cc3f91",
  "field_id": "field_visit_notes",
  "route_id": "route-visit-form",
  "state": "dictating",
  "state_stream_url": "/api/v1/transcription-sessions/dict-cc3f91/stream",
  "started_at": "2026-03-26T09:45:00Z",
  "stopped_at": null
}

Start a new dictation session for a given field context

{
  "field_id": "field_visit_notes",
  "route_id": "route-visit-form",
  "draft_id": "draft-88ab12",
  "context_label": "Visit Notes"
}

{
  "dictation_id": "dict-ff5a03",
  "state": "dictating",
  "started_at": "2026-03-26T11:05:00Z"
}

Update metadata or state (e.g. pause) of an active dictation session

{
  "state": "paused"
}

{
  "dictation_id": "dict-ff5a03",
  "state": "paused",
  "updated_at": "2026-03-26T11:06:00Z"
}

Cancel and remove a dictation session, discarding any partial transcription

{
  "dictation_id": "dict-ff5a03",
  "cancelled": true,
  "partial_discarded": true
}

Stop dictation and commit the transcription

{
  "dictation_id": "dict-ff5a03",
  "state": "completed",
  "stopped_at": "2026-03-26T11:07:15Z",
  "committed_text": "Patient reported improved mobility since last visit."
}

SSE stream of real-time dictation state changes and interim transcription results

{
  "event": "interim_result",
  "dictation_id": "dict-ff5a03",
  "text": "Patient reported improved mobility",
  "is_final": false,
  "timestamp": "2026-03-26T11:06:30Z"
}

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}