🏠 Overview › 🔌 API Contracts ›🔌 Native Speech API Bridge

Native Speech API Bridge

API Contract

REST /api/v1/speech-bridge 7 endpoints
GET /api/v1/speech-bridge/api/v1/speech-bridge/configs

List all platform speech bridge configurations

Public

Response Example

{
  "data": [
    {
      "config_id": "bridge-cfg-ios",
      "platform": "ios",
      "language": "en-NO",
      "on_device_recognition": true,
      "requires_network": false,
      "created_at": "2026-01-15T07:00:00Z"
    },
    {
      "config_id": "bridge-cfg-android",
      "platform": "android",
      "language": "en-NO",
      "on_device_recognition": false,
      "requires_network": true,
      "created_at": "2026-01-15T07:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 2
  }
}
GET /api/v1/speech-bridge/api/v1/speech-bridge/configs/:id

Get a specific platform speech bridge configuration

Public

Response Example

{
  "config_id": "bridge-cfg-ios",
  "platform": "ios",
  "language": "en-NO",
  "on_device_recognition": true,
  "requires_network": false,
  "audio_encoding": "LINEAR16",
  "sample_rate_hertz": 16000,
  "created_at": "2026-01-15T07:00:00Z"
}
POST /api/v1/speech-bridge/api/v1/speech-bridge/configs

Create a new platform speech configuration for the native bridge

Public

Request Example

{
  "platform": "web",
  "language": "nb-NO",
  "on_device_recognition": false,
  "requires_network": true,
  "audio_encoding": "WEBM_OPUS",
  "sample_rate_hertz": 48000
}

Response Example

{
  "config_id": "bridge-cfg-web",
  "platform": "web",
  "language": "nb-NO",
  "on_device_recognition": false,
  "requires_network": true,
  "created_at": "2026-03-26T11:20:00Z"
}
PUT /api/v1/speech-bridge/api/v1/speech-bridge/configs/:id

Update an existing platform speech bridge configuration

Public

Request Example

{
  "language": "en-GB",
  "sample_rate_hertz": 44100
}

Response Example

{
  "config_id": "bridge-cfg-web",
  "platform": "web",
  "language": "en-GB",
  "sample_rate_hertz": 44100,
  "updated_at": "2026-03-26T11:25:00Z"
}
DELETE /api/v1/speech-bridge/api/v1/speech-bridge/configs/:id

Remove a platform speech bridge configuration

Public

Response Example

{
  "config_id": "bridge-cfg-web",
  "deleted": true
}
POST /api/v1/speech-bridge/api/v1/speech-bridge/sessions

Start a native speech bridge session with the given options

Public

Request Example

{
  "config_id": "bridge-cfg-ios",
  "continuous": true,
  "interim_results": true,
  "context_phrases": [
    "visit notes",
    "medication",
    "assessment"
  ]
}

Response Example

{
  "bridge_session_id": "bs-29fe73",
  "status": "active",
  "platform": "ios",
  "started_at": "2026-03-26T11:30:00Z"
}
DELETE /api/v1/speech-bridge/api/v1/speech-bridge/sessions/:id

Stop and close a native speech bridge session

Public

Response Example

{
  "bridge_session_id": "bs-29fe73",
  "status": "stopped",
  "stopped_at": "2026-03-26T11:32:00Z"
}

Additional Metadata

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