Hot Mic Streams API

openapi: 3.2.0
info:
  title: Hot Mic Streams API
  version: '2026-10-12'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-12: 13 operation(s) read from 5 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
  - https://hotmic.io/docs/api/index
  - https://hotmic.io/docs/api/show-series
  - https://hotmic.io/docs/sdks/ios/headless
  - https://hotmic.io/docs/sdks/javascript/headless
servers:
- url: https://public-api.hotmic.io
security:
- apiKey: []
tags:
- name: Streams
paths:
  /streams:
    get:
      operationId: get_streams
      tags:
      - Streams
      summary: GET /streams
      x-source: https://hotmic.io/docs/api
      parameters:
      - name: cursor
        in: query
        required: false
        schema:
          type: string
      - name: desc
        in: query
        required: false
        schema:
          type: string
      - name: ids
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: string
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: pagination
        in: query
        required: false
        schema:
          type: string
      - name: skip
        in: query
        required: false
        schema:
          type: string
      - name: state
        in: query
        required: false
        schema:
          type: string
      - name: userId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStreamsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl nodejs javascript python ruby curl --location --request GET 'https://public-api.hotmic.io/streams?limit=Integer&state=string&userId=String&ids=String&orderBy=string&desc=Boolean&cursor=string&skip=Integer&pagination=string'  --header 'Accept: application/json'  --header 'x-api-key: String' var request = require ( 'request' ); \n var options = { \n 'method' : 'GET' , \n 'url' : 'https://public-ap"
  /streams/{id}:
    put:
      operationId: put_streams_id
      tags:
      - Streams
      summary: Update a Stream
      description: Update stream information, such as title or invite link.
      x-source: https://hotmic.io/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutStreamsIdRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutStreamsIdResponse'
      x-evidence:
        kind: documentation
    get:
      operationId: get_streams_id
      tags:
      - Streams
      summary: GET /streams/{id}
      x-source: https://hotmic.io/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStreamsIdResponse'
      x-evidence:
        kind: code-example
        language: ruby
        snippet: URI ( "https://public-api.hotmic.io/streams/:id"
  /streams/{id}/session:
    post:
      operationId: post_streams_id_session
      tags:
      - Streams
      summary: POST /streams/{id}/session
      x-source: https://hotmic.io/docs/sdks/ios/headless
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /streams/{id}/{id}:
    get:
      operationId: get_streams_id_id
      tags:
      - Streams
      summary: GET /streams/{id}/{id}
      x-source: https://hotmic.io/docs/sdks/ios/headless
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at id
components:
  schemas:
    PutStreamsIdResponse:
      type: object
      properties:
        _id:
          type: string
          description: ID of the stream
        user_id:
          type: string
          description: User ID of the host
        title:
          type: string
          description: Title of the stream
        thumbnail:
          type: string
          description: Thumbnail URL
        scheduled_date:
          type: string
          description: Scheduled date
        state:
          type: string
          description: State of the stream
        invite_link:
          type: string
          description: Invite link
    GetStreamsIdResponse:
      type: object
      properties:
        _id:
          type: string
        user_id:
          type: string
        title:
          type: string
        thumbnail:
          type: string
        scheduled_date:
          type: string
          format: date-time
        state:
          type: string
        type:
          type: string
        description:
          type: string
        hls_url:
          type: string
        event_id:
          type: string
        live_date:
          type: string
          format: date-time
        duration:
          type: number
        vod_url:
          type: string
        last_updated:
          type: string
          format: date-time
        invite_link:
          type: string
    PutStreamsIdRequest:
      type: object
      properties:
        title:
          type: string
          description: The title of the stream
        user_id:
          type: string
          description: Update the user_id of the owner of the stream
        thumbnail:
          type: string
          description: Update the url to the stream thumbnail
        scheduled_date:
          type: string
          description: Update the scheduled_date of the stream (ISO-8601)
        description:
          type: string
          description: Update the description of the event
        invite_link:
          type: string
          description: Update the invite link for the hosts
    GetStreamsResponse:
      type: object
      properties:
        links:
          type: object
          properties:
            next:
              type: string
            self:
              type: string
        limit:
          type: integer
        count:
          type: integer
        results:
          type: array
          items:
            type: object
            properties:
              _id:
                type: string
              user_id:
                type: string
              title:
                type: string
              thumbnail:
                type: string
              scheduled_date:
                type: string
                format: date-time
              state:
                type: string
              type:
                type: string
              description:
                type: string
              event_id:
                type: string
              live_date:
                type: string
                format: date-time
              duration:
                type: number
              user:
                type: object
                properties:
                  _id:
                    type: string
                  followers:
                    type: integer
                  display_name:
                    type: string
                  profile_pic:
                    type: string
              last_updated:
                type: string
                format: date-time
              video_url:
                type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key