KugelAudio Audio API

The Audio API from KugelAudio — 1 operation(s) for audio.

OpenAPI Specification

kugelaudio-audio-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: KugelAudio TTS 11labs Audio API
  description: 'Unified API: REST + WebSocket + ElevenLabs + Vapi'
  version: 2.0.0
tags:
- name: Audio
paths:
  /v1/audio/transcriptions:
    post:
      summary: Transcribe
      operationId: transcribe_v1_audio_transcriptions_post
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_transcribe_v1_audio_transcriptions_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TranscriptionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Audio
components:
  schemas:
    WordTimestamp:
      properties:
        word:
          type: string
          title: Word
        start_s:
          type: number
          title: Start S
        end_s:
          type: number
          title: End S
        confidence:
          type: number
          maximum: 1.0
          minimum: 0.0
          title: Confidence
      additionalProperties: true
      type: object
      required:
      - word
      - start_s
      - end_s
      - confidence
      title: WordTimestamp
      description: One transcribed word with timing and confidence.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    TranscriptionResponse:
      properties:
        transcript:
          type: string
          title: Transcript
        language:
          type: string
          title: Language
        duration_s:
          type: number
          title: Duration S
        word_timestamps:
          items:
            $ref: '#/components/schemas/WordTimestamp'
          type: array
          title: Word Timestamps
        hints:
          $ref: '#/components/schemas/ResponseHints'
        model:
          type: string
          title: Model
          default: parakeet-tdt-0.6b-v3
        processing_ms:
          anyOf:
          - type: number
          - type: 'null'
          title: Processing Ms
      additionalProperties: true
      type: object
      required:
      - transcript
      - language
      - duration_s
      title: TranscriptionResponse
      description: 'Response from ``POST /v1/audio/transcriptions``.


        Fields beyond this declared subset (e.g. ``entities``,

        ``audio_quality``) are preserved by ``extra="allow"`` and reach the

        caller verbatim — the ingress is a passthrough.'
    Body_transcribe_v1_audio_transcriptions_post:
      properties:
        file:
          anyOf:
          - type: string
            contentMediaType: application/octet-stream
          - type: 'null'
          title: File
        language:
          anyOf:
          - type: string
          - type: 'null'
          title: Language
        prompt:
          anyOf:
          - type: string
          - type: 'null'
          title: Prompt
        response_format:
          anyOf:
          - type: string
          - type: 'null'
          title: Response Format
      type: object
      title: Body_transcribe_v1_audio_transcriptions_post
    ResponseHints:
      properties:
        entity_in_progress:
          type: boolean
          title: Entity In Progress
          default: false
      additionalProperties: true
      type: object
      title: ResponseHints
      description: Protocol hints for the voice-agent consumer.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError