> ## Documentation Index
> Fetch the complete documentation index at: https://dragonwingdocs.qualcomm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Check service health

> Returns the current health status, uptime, active session count, and version.



## OpenAPI

````yaml /Ubuntu/ai-workflows/api-specs/audio-analytics/openapi.yaml get /health
openapi: 3.0.3
info:
  title: Audio Analytics API
  version: 1.0.0
  description: >
    REST API providing AI-powered audio processing: speech recognition (ASR),

    text translation (T2T), and speech synthesis (TTS).


    ## Services


    | Service | Endpoint prefix | Description |

    |---------|----------------|-------------|

    | ASR | `/transcriptions/` | Whisper-based speech-to-text (file or live
    WebSocket streaming) |

    | T2T | `/translations/` | Opus/NLLB text translation (batch supported) |

    | TTS | `/tts/` | MeloTTS speech synthesis; returns raw PCM audio |


    ## Audio formats (ASR input)

    - WAV, 16-bit PCM; 16 kHz mono recommended; max 25 MB


    ## TTS output

    - Supported sample rates: 44100, 22050, 16000 Hz (auto-resampled)


    ## WebSocket streaming sequence


    ```

    App                                           Server
     |===POST /transcriptions/create================>|
     |<==200 {session_id, state: asr_initialized}====|
     |
     |===WS /stream=================================>|
     |<==  {state: connection_established}===========|
     |
     |===WS {transcriptions_session_audio} (loop)===>|
     |<===WS {transcript.event,     speech_start}====|
     |<===WS {transcript.text.delta, ...}============|  (zero or more)
     |<===WS {transcript.event,     speech_end}======|
     |<===WS {transcript.text.done,  ...}============|
     |
     |===POST /transcriptions/close=================>|  (after transcript.text.done)
    ```


    ## Authentication

    None required.
  contact:
    name: Qualcomm Support Forums
    url: https://mysupport.qualcomm.com/supportforums/s/
  license:
    name: BSD-3-Clause-Clear
    url: https://opensource.org/licenses/BSD-3-Clause-Clear
servers:
  - url: http://{device-ip}:{device-port}/audio-analytics/v1/api
    description: Audio Analytics API Server
    variables:
      device-ip:
        description: IP address and port of the host device running the Audio Analytics API
        default: localhost
      device-port:
        default: '8085'
security: []
tags:
  - name: Health
    description: Service health and status endpoints
  - name: Transcriptions
    description: Speech-to-text audio transcription (ASR)
  - name: Translations
    description: Text-to-text translation between languages
  - name: TTS
    description: Text-to-speech synthesis
  - name: WebSocket
    description: Real-time streaming communication
paths:
  /health:
    get:
      tags:
        - Health
      summary: Check service health
      description: >-
        Returns the current health status, uptime, active session count, and
        version.
      operationId: healthCheck
      responses:
        '200':
          description: Service is healthy and operational
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
              example:
                status: ok
                uptime: 12345
                active_sessions: 2
                version: 1.0.0
        '503':
          description: Service is unavailable or unhealthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  message: Server is down or overloaded
                  type: service_unavailable
                  param: null
                  code: null
components:
  schemas:
    HealthResponse:
      type: object
      description: Service health status information
      properties:
        status:
          type: string
          description: Health status indicator
          enum:
            - ok
            - degraded
            - error
          example: ok
        uptime:
          type: integer
          description: Service uptime in seconds
          example: 12345
        active_sessions:
          type: integer
          description: Number of currently active transcription sessions
          example: 2
        version:
          type: string
          description: Service version identifier
          example: 1.0.0
      required:
        - status
    ErrorResponse:
      type: object
      description: Standard error response structure
      properties:
        error:
          type: object
          properties:
            message:
              type: string
              description: Human-readable error message
              example: Invalid request, missing 'file' parameter
            type:
              type: string
              description: Error type or category
              example: invalid_request_error
            param:
              type: string
              nullable: true
              description: Parameter related to the error (if applicable)
              example: file
            code:
              type: string
              nullable: true
              description: Error code (if applicable)
              example: null
          required:
            - message
            - type
      required:
        - error

````