{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/pipeshub/json-schema/pipeshub-speech-capabilities-response-schema.json",
  "title": "SpeechCapabilitiesResponse",
  "description": "Reports whether the server has a TTS/STT provider configured. When a\nbucket is `null` the chat UI falls back to the browser's Web Speech\nAPI for that capability.\n",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/pipeshub-conversational-speech-api-openapi.yml#/components/schemas/SpeechCapabilitiesResponse",
  "type": "object",
  "properties": {
    "tts": {
      "allOf": [
        {
          "$ref": "#/$defs/SpeechCapabilitySummary"
        }
      ]
    },
    "stt": {
      "allOf": [
        {
          "$ref": "#/$defs/SpeechCapabilitySummary"
        }
      ]
    }
  },
  "$defs": {
    "SpeechCapabilitySummary": {
      "type": "object",
      "description": "Public summary of an active speech provider. Secrets (api keys,\norganization ids, etc.) are never included. The server always picks\nthe config flagged `isDefault` in `aiModels`; when no entry is\nflagged, the first configured entry is used and `isDefault` is\nreported as `false` so the chat UI can surface the fallback.\n",
      "required": [
        "provider"
      ],
      "properties": {
        "provider": {
          "type": "string",
          "description": "Provider id (e.g. `openAI`, `gemini`, `whisper`, `wispr`)."
        },
        "model": {
          "type": [
            "string",
            "null"
          ],
          "description": "Active (default) model id the server will dispatch to. Same\nvalue as `defaultModel`; retained for backwards compatibility\nwith older chat clients.\n"
        },
        "defaultModel": {
          "type": [
            "string",
            "null"
          ],
          "description": "Model id the server will use when no explicit `model` is passed\nto `/chat/speak` or `/chat/transcribe`. Chosen as the first\nentry from the configured comma-separated `configuration.model`\nlist.\n"
        },
        "models": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "All model ids the active provider config exposes. Order matches\nthe admin's comma-separated `configuration.model` value; the\nfirst entry is the default.\n"
        },
        "isDefault": {
          "type": "boolean",
          "description": "`true` when the returned config was picked because it is\nflagged `isDefault` in `aiModels`; `false` when no entry was\nflagged and the server fell back to the first configured one.\n"
        },
        "modelKey": {
          "type": [
            "string",
            "null"
          ],
          "description": "Stable identifier assigned to the config entry by the admin\nUI. Useful for tying the capability summary back to a specific\nrow under `/services/aiModels`.\n"
        },
        "friendlyName": {
          "type": [
            "string",
            "null"
          ],
          "description": "Optional display name configured by the admin."
        }
      }
    }
  }
}