SpeechRecognitionRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/auphonic/main/json-schema/auphonic-speech-recognition-request-schema.json",
  "title": "SpeechRecognitionRequest",
  "description": "Speech recognition configuration, only available for paying users (other users get a 400 error).\nFor external services (Google, Amazon, Speechmatics), provide `uuid`.\nFor Auphonic Whisper, omit `uuid` and provide `language`.\n\n**Note:** Speech recognition output formats (subtitle, speech, transcript) are defined via\n`output_files`, not here. Add an output file with the appropriate format (e.g. `subtitle`, `speech`, `transcript`)\nto get the desired output.\n",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/auphonic-openapi.yaml#/components/schemas/SpeechRecognitionRequest",
  "type": "object",
  "properties": {
    "uuid": {
      "type": "string",
      "description": "UUID of external speech recognition service (omit for Auphonic Whisper)"
    },
    "language": {
      "type": "string",
      "description": "Language code for speech recognition. Required. Use `auto` for automatic language detection.\n\n**Whisper (built-in):** Uses ISO 639-1 two-letter codes.\nAvailable: auto, af, am, ar, as, az, ba, be, bg, bn, bo, br, bs, ca, cs, cy, da, de, el, en, es, et, eu, fa, fi, fo, fr, gl, gu, ha, haw, he, hi, hr, ht, hu, hy, id, is, it, ja, jw, ka, kk, km, kn, ko, la, lb, ln, lo, lt, lv, mg, mi, mk, ml, mn, mr, ms, mt, my, ne, nl, nn, no, oc, pa, pl, ps, pt, ro, ru, sa, sd, si, sk, sl, sn, so, sq, sr, su, sv, sw, ta, te, tg, th, tk, tl, tr, tt, uk, ur, uz, vi, yi, yo.\n\n**External services** (Google, Amazon, Speechmatics): May use locale codes (e.g. en-US, de-DE).\n"
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Keywords and phrases to improve recognition accuracy"
    },
    "shownotes": {
      "type": "boolean",
      "description": "Enable automatic shownotes and chapter generation (restricted to paying users)"
    },
    "shownotes_summary_example": {
      "type": "string",
      "description": "Example summary to guide shownotes generation style"
    },
    "speaker_diarization_num_speakers": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Number of speakers for speaker diarization (Whisper only)"
    },
    "speaker_diarization_names": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      },
      "description": "Speaker names for speaker diarization (Whisper only)"
    }
  }
}