openapi: 3.1.0
info:
  title: Hot Mic API Reference REST endpoints, webhooks, authentication, and tags. Build server-s API
  version: '2026-10-12'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-12: 3 operation(s) read from 1 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Hot Mic has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 4
    documentation: 9
    pages-with-code: 3
    pages-read: 5
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-12'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://hotmic.io/docs/api/show-series
  x-docs-section: api
servers:
- url: https://public-api.hotmic.io
paths:
  /studio/show-series:
    get:
      operationId: get_studio_show_series
      tags:
      - Studio
      summary: GET /studio/show-series
      x-source: https://hotmic.io/docs/api/show-series
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStudioShowSeriesResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl nodejs javascript python ruby curl --location --request GET 'https://public-api.hotmic.io/studio/show-series'  --header\
          \ 'Accept: application/json'  --header 'x-api-key: String' var request = require ( 'request' ); \n var options = { \n 'method' : 'GET'\
          \ , \n 'url' : 'https://public-api.hotmic.io/studio/show-series' , \n 'headers' : { \n 'Accept' : 'application/json' , \n 'x-api-key'\
          \ : 'String' \n } \n"
    post:
      operationId: post_studio_show_series
      tags:
      - Studio
      summary: POST /studio/show-series is accepted as an alias for PUT
      x-source: https://hotmic.io/docs/api/show-series
      parameters:
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: The API key provided to you by HotMic.
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        description: Must be application/json.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostStudioShowSeriesRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostStudioShowSeriesResponse'
      x-evidence:
        kind: documentation
    put:
      operationId: put_studio_show_series
      tags:
      - Studio
      summary: Replace the Show Series Catalogue
      x-source: https://hotmic.io/docs/api/show-series
      parameters:
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: The API key provided to you by HotMic.
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        description: Must be application/json.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutStudioShowSeriesRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutStudioShowSeriesResponse'
      x-evidence:
        kind: documentation
security:
- apiKey: []
components:
  schemas:
    GetStudioShowSeriesResponse:
      type: object
      properties:
        enabled:
          type: boolean
        options:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              show_series_id:
                type: string
              show_series_namespace:
                type: string
              seasons:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    show_season_id:
                      type: string
                    show_season_namespace:
                      type: string
    PostStudioShowSeriesRequest:
      type: object
      properties:
        enabled:
          type: boolean
          description: Turns the Show / Series picker on/off in the studio.
        options:
          type: array
          description: The full catalogue (array of objects). Each item must have a non-empty name; other fields are stored and returned as‑is.
      required:
      - enabled
      - options
    PostStudioShowSeriesResponse:
      type: object
      properties:
        show_series:
          type: object
          description: The updated Show Series catalogue.
    PutStudioShowSeriesRequest:
      type: object
      properties:
        enabled:
          type: boolean
          description: Turns the Show / Series picker on/off in the studio.
        options:
          type: array
          description: The full catalogue (array of objects). Each item must have a non-empty name; other fields are stored and returned as‑is.
      required:
      - enabled
      - options
    PutStudioShowSeriesResponse:
      type: object
      properties:
        show_series:
          type: object
          description: The updated Show Series catalogue.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
tags:
- name: Studio