swagger.yaml

openapi: 3.0.0
servers:
  - url: https://api.twitch.tv/helix
    description: Production API
externalDocs:
  description: Official documentation
  url: https://dev.twitch.tv/docs/api/
info:
  title: Twitch Helix API
  description: The Twitch API is a RESTful API that lets developers build creative
    integrations for the broader Twitch community. THIS DOCUMENTATION IS NEITHER
    MAINTAINED BY OR AFFILIATED WITH TWITCH
  termsOfService: https://www.twitch.tv/p/en/legal/developer-agreement/
  contact:
    name: TwitchDev
    url: https://dev.twitch.tv/support/
    email: developers@twitch.tv
  version: 2024‑03‑07
paths:
  /channels/commercial:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Start Commercial
      description: Starts a commercial on the specified channel.
      tags:
        - Ads
      security:
        - oauth:
            - channel:edit:commercial
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        length:
                          type: number
                          example: 60
                        message:
                          type: string
                        retry_after:
                          type: number
                          example: 480
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
  /channels/ads:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Ad Schedule
      description: Returns ad schedule related information.
      tags:
        - Ads
      security:
        - oauth:
            - channel:read:ads
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /channels/ads/schedule/snooze:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Snooze Next Ad
      description: Pushes back the timestamp of the upcoming automatic mid-roll ad by
        5 minutes.
      tags:
        - Ads
      security:
        - oauth:
            - channel:manage:ads
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /analytics/extensions:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Extension Analytics
      description: Gets an analytics report for one or more extensions.
      tags:
        - Analytics
      security:
        - oauth:
            - analytics:read:extensions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        extension_id:
                          type: string
                          example: efgh
                        URL:
                          type: string
                          example: https://twitch-piper-reports.s3-us-west-2.amazonaws.com/dynamic/LoL%20ADC...
                        type:
                          type: string
                          example: overview_v2
                        date_range:
                          type: object
                          properties:
                            started_at:
                              type: string
                              example: 2018-03-01T00:00:00Z
                            ended_at:
                              type: string
                              example: 2018-06-01T00:00:00Z
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudWxsLCJhIjp7Ik9mZnNldCI6NX19
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: extension_id
          in: query
          schema:
            type: string
        - name: type
          in: query
          schema:
            type: string
        - name: started_at
          in: query
          schema:
            type: string
        - name: ended_at
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /analytics/games:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Game Analytics
      description: Gets an analytics report for one or more games.
      tags:
        - Analytics
      security:
        - oauth:
            - analytics:read:games
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        game_id:
                          type: string
                          example: "493057"
                        URL:
                          type: string
                          example: https://twitch-piper-reports.s3-us-west-2.amazonaws.com/games/66170/overview/15183...
                        type:
                          type: string
                          example: overview_v2
                        date_range:
                          type: object
                          properties:
                            started_at:
                              type: string
                              example: 2018-01-01T00:00:00Z
                            ended_at:
                              type: string
                              example: 2018-03-01T00:00:00Z
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: game_id
          in: query
          schema:
            type: string
        - name: type
          in: query
          schema:
            type: string
        - name: started_at
          in: query
          schema:
            type: string
        - name: ended_at
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /bits/leaderboard:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Bits Leaderboard
      description: Gets the Bits leaderboard for the authenticated broadcaster.
      tags:
        - Bits
      security:
        - oauth:
            - bits:read
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        user_id:
                          type: string
                          example: "158010205"
                        user_login:
                          type: string
                          example: tundracowboy
                        user_name:
                          type: string
                          example: TundraCowboy
                        rank:
                          type: number
                          example: 1
                        score:
                          type: number
                          example: 12543
                  date_range:
                    type: object
                    properties:
                      started_at:
                        type: string
                        example: 2018-02-05T08:00:00Z
                      ended_at:
                        type: string
                        example: 2018-02-12T08:00:00Z
                  total:
                    type: number
                    example: 2
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: count
          in: query
          schema:
            type: string
        - name: period
          in: query
          schema:
            type: string
        - name: started_at
          in: query
          schema:
            type: string
        - name: user_id
          in: query
          schema:
            type: string
  /bits/cheermotes:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Cheermotes
      description: Gets a list of Cheermotes that users can use to cheer Bits.
      tags:
        - Bits
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        prefix:
                          type: string
                          example: Cheer
                        tiers:
                          type: array
                          items:
                            type: object
                            properties:
                              min_bits:
                                type: number
                                example: 1
                              id:
                                type: string
                                example: "1"
                              color:
                                type: string
                                example: "#979797"
                              images:
                                type: object
                                properties:
                                  dark:
                                    type: object
                                    properties:
                                      animated:
                                        type: object
                                        properties:
                                          "1":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/animated/1/1.gif
                                          "2":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/animated/1/2.gif
                                          "3":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/animated/1/3.gif
                                          "4":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/animated/1/4.gif
                                          "1.5":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/animated/1/1.5.gif
                                      static:
                                        type: object
                                        properties:
                                          "1":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/static/1/1.png
                                          "2":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/static/1/2.png
                                          "3":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/static/1/3.png
                                          "4":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/static/1/4.png
                                          "1.5":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/static/1/1.5.png
                                  light:
                                    type: object
                                    properties:
                                      animated:
                                        type: object
                                        properties:
                                          "1":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/animated/1/1.gif
                                          "2":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/animated/1/2.gif
                                          "3":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/animated/1/3.gif
                                          "4":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/animated/1/4.gif
                                          "1.5":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/animated/1/1.5.gif
                                      static:
                                        type: object
                                        properties:
                                          "1":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/static/1/1.png
                                          "2":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/static/1/2.png
                                          "3":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/static/1/3.png
                                          "4":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/static/1/4.png
                                          "1.5":
                                            type: string
                                            example: https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/static/1/1.5.png
                              can_cheer:
                                type: boolean
                                example: true
                              show_in_bits_card:
                                type: boolean
                                example: true
                        type:
                          type: string
                          example: global_first_party
                        order:
                          type: number
                          example: 1
                        last_updated:
                          type: string
                          example: 2018-05-22T00:06:04Z
                        is_charitable:
                          type: boolean
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /extensions/transactions:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Extension Transactions
      description: Gets an extension’s list of transactions.
      tags:
        - Bits
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 74c52265-e214-48a6-91b9-23b6014e8041
                        timestamp:
                          type: string
                          example: 2019-01-28T04:15:53.325Z
                        broadcaster_id:
                          type: string
                          example: "439964613"
                        broadcaster_login:
                          type: string
                          example: chikuseuma
                        broadcaster_name:
                          type: string
                          example: chikuseuma
                        user_id:
                          type: string
                          example: "424596340"
                        user_login:
                          type: string
                          example: quotrok
                        user_name:
                          type: string
                          example: quotrok
                        product_type:
                          type: string
                          example: BITS_IN_EXTENSION
                        product_data:
                          type: object
                          properties:
                            domain:
                              type: string
                              example: twitch.ext.uo6dggojyb8d6soh92zknwmi5ej1q2
                            sku:
                              type: string
                              example: testSku100
                            cost:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 100
                                type:
                                  type: string
                                  example: bits
                            inDevelopment:
                              type: boolean
                            displayName:
                              type: string
                              example: Test Product 100
                            expiration:
                              type: string
                            broadcast:
                              type: boolean
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: cursorString
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: extension_id
          in: query
          schema:
            type: string
        - name: id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /channels:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Channel Information
      description: Gets information about one or more channels.
      tags:
        - Channels
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_id:
                          type: string
                          example: "141981764"
                        broadcaster_login:
                          type: string
                          example: twitchdev
                        broadcaster_name:
                          type: string
                          example: TwitchDev
                        broadcaster_language:
                          type: string
                          example: en
                        game_id:
                          type: string
                          example: "509670"
                        game_name:
                          type: string
                          example: Science & Technology
                        title:
                          type: string
                          example: TwitchDev Monthly Update // May 6, 2021
                        delay:
                          type: number
                        tags:
                          type: array
                          items:
                            type: string
                            example: DevsInTheKnow
                        content_classification_labels:
                          type: array
                          items:
                            type: string
                            example: Gambling
                        is_branded_content:
                          type: boolean
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
    patch:
      summary: Modify Channel Information
      description: Updates a channel’s properties.
      tags:
        - Channels
      security:
        - oauth:
            - channel:manage:broadcast
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /channels/editors:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Channel Editors
      description: Gets the broadcaster’s list editors.
      tags:
        - Channels
      security:
        - oauth:
            - channel:read:editors
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        user_id:
                          type: string
                          example: "182891647"
                        user_name:
                          type: string
                          example: mauerbac
                        created_at:
                          type: string
                          example: 2019-02-15T21:19:50.380833Z
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /channels/followed:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Followed Channels
      description: Gets a list of broadcasters that the specified user follows. You
        can also use this endpoint to see whether a user follows a specific
        broadcaster.
      tags:
        - Channels
      security:
        - oauth:
            - user:read:follows
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: user_id
          in: query
          schema:
            type: string
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /channels/followers:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Channel Followers
      description: Gets a list of users that follow the specified broadcaster. You can
        also use this endpoint to see whether a specific user follows the
        broadcaster.
      tags:
        - Channels
      security:
        - oauth:
            - moderator:read:followers
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: user_id
          in: query
          schema:
            type: string
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /channel_points/custom_rewards:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Create Custom Rewards
      description: Creates a Custom Reward in the broadcaster’s channel.
      tags:
        - Channel Points
      security:
        - oauth:
            - channel:manage:redemptions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_name:
                          type: string
                          example: torpedo09
                        broadcaster_login:
                          type: string
                          example: torpedo09
                        broadcaster_id:
                          type: string
                          example: "274637212"
                        id:
                          type: string
                          example: afaa7e34-6b17-49f0-a19a-d1e76eaaf673
                        image:
                          type: string
                        background_color:
                          type: string
                          example: "#00E5CB"
                        is_enabled:
                          type: boolean
                          example: true
                        cost:
                          type: number
                          example: 50000
                        title:
                          type: string
                          example: game analysis 1v1
                        prompt:
                          type: string
                        is_user_input_required:
                          type: boolean
                        max_per_stream_setting:
                          type: object
                          properties:
                            is_enabled:
                              type: boolean
                            max_per_stream:
                              type: number
                        max_per_user_per_stream_setting:
                          type: object
                          properties:
                            is_enabled:
                              type: boolean
                            max_per_user_per_stream:
                              type: number
                        global_cooldown_setting:
                          type: object
                          properties:
                            is_enabled:
                              type: boolean
                            global_cooldown_seconds:
                              type: number
                        is_paused:
                          type: boolean
                        is_in_stock:
                          type: boolean
                          example: true
                        default_image:
                          type: object
                          properties:
                            url_1x:
                              type: string
                              example: https://static-cdn.jtvnw.net/custom-reward-images/default-1.png
                            url_2x:
                              type: string
                              example: https://static-cdn.jtvnw.net/custom-reward-images/default-2.png
                            url_4x:
                              type: string
                              example: https://static-cdn.jtvnw.net/custom-reward-images/default-4.png
                        should_redemptions_skip_request_queue:
                          type: boolean
                        redemptions_redeemed_current_stream:
                          type: string
                        cooldown_expires_at:
                          type: string
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
    delete:
      summary: Delete Custom Reward
      description: Deletes a custom reward that the broadcaster created.
      tags:
        - Channel Points
      security:
        - oauth:
            - channel:manage:redemptions
      responses:
        "204":
          description: Deleted
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: id
          in: query
          schema:
            type: string
    get:
      summary: Get Custom Reward
      description: Gets a list of custom rewards that the specified broadcaster created.
      tags:
        - Channel Points
      security:
        - oauth:
            - channel:read:redemptions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_name:
                          type: string
                          example: torpedo09
                        broadcaster_login:
                          type: string
                          example: torpedo09
                        broadcaster_id:
                          type: string
                          example: "274637212"
                        id:
                          type: string
                          example: 92af127c-7326-4483-a52b-b0da0be61c01
                        image:
                          type: string
                        background_color:
                          type: string
                          example: "#00E5CB"
                        is_enabled:
                          type: boolean
                          example: true
                        cost:
                          type: number
                          example: 50000
                        title:
                          type: string
                          example: game analysis
                        prompt:
                          type: string
                        is_user_input_required:
                          type: boolean
                        max_per_stream_setting:
                          type: object
                          properties:
                            is_enabled:
                              type: boolean
                            max_per_stream:
                              type: number
                        max_per_user_per_stream_setting:
                          type: object
                          properties:
                            is_enabled:
                              type: boolean
                            max_per_user_per_stream:
                              type: number
                        global_cooldown_setting:
                          type: object
                          properties:
                            is_enabled:
                              type: boolean
                            global_cooldown_seconds:
                              type: number
                        is_paused:
                          type: boolean
                        is_in_stock:
                          type: boolean
                          example: true
                        default_image:
                          type: object
                          properties:
                            url_1x:
                              type: string
                              example: https://static-cdn.jtvnw.net/custom-reward-images/default-1.png
                            url_2x:
                              type: string
                              example: https://static-cdn.jtvnw.net/custom-reward-images/default-2.png
                            url_4x:
                              type: string
                              example: https://static-cdn.jtvnw.net/custom-reward-images/default-4.png
                        should_redemptions_skip_request_queue:
                          type: boolean
                        redemptions_redeemed_current_stream:
                          type: string
                        cooldown_expires_at:
                          type: string
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: id
          in: query
          schema:
            type: string
        - name: only_manageable_rewards
          in: query
          schema:
            type: string
    patch:
      summary: Update Custom Reward
      description: Updates a custom reward.
      tags:
        - Channel Points
      security:
        - oauth:
            - channel:manage:redemptions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_name:
                          type: string
                          example: torpedo09
                        broadcaster_login:
                          type: string
                          example: torpedo09
                        broadcaster_id:
                          type: string
                          example: "274637212"
                        id:
                          type: string
                          example: 92af127c-7326-4483-a52b-b0da0be61c01
                        image:
                          type: string
                        background_color:
                          type: string
                          example: "#00E5CB"
                        is_enabled:
                          type: boolean
                        cost:
                          type: number
                          example: 30000
                        title:
                          type: string
                          example: game analysis 2v2
                        prompt:
                          type: string
                        is_user_input_required:
                          type: boolean
                        max_per_stream_setting:
                          type: object
                          properties:
                            is_enabled:
                              type: boolean
                              example: true
                            max_per_stream:
                              type: number
                              example: 60
                        max_per_user_per_stream_setting:
                          type: object
                          properties:
                            is_enabled:
                              type: boolean
                            max_per_user_per_stream:
                              type: number
                        global_cooldown_setting:
                          type: object
                          properties:
                            is_enabled:
                              type: boolean
                            global_cooldown_seconds:
                              type: number
                        is_paused:
                          type: boolean
                        is_in_stock:
                          type: boolean
                        default_image:
                          type: object
                          properties:
                            url_1x:
                              type: string
                              example: https://static-cdn.jtvnw.net/custom-reward-images/default-1.png
                            url_2x:
                              type: string
                              example: https://static-cdn.jtvnw.net/custom-reward-images/default-2.png
                            url_4x:
                              type: string
                              example: https://static-cdn.jtvnw.net/custom-reward-images/default-4.png
                        should_redemptions_skip_request_queue:
                          type: boolean
                          example: true
                        redemptions_redeemed_current_stream:
                          type: number
                          example: 60
                        cooldown_expires_at:
                          type: string
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: id
          in: query
          schema:
            type: string
  /channel_points/custom_rewards/redemptions:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Custom Reward Redemption
      description: Gets a list of redemptions for a custom reward.
      tags:
        - Channel Points
      security:
        - oauth:
            - channel:read:redemptions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_name:
                          type: string
                          example: torpedo09
                        broadcaster_login:
                          type: string
                          example: torpedo09
                        broadcaster_id:
                          type: string
                          example: "274637212"
                        id:
                          type: string
                          example: 17fa2df1-ad76-4804-bfa5-a40ef63efe63
                        user_login:
                          type: string
                          example: torpedo09
                        user_id:
                          type: string
                          example: "274637212"
                        user_name:
                          type: string
                          example: torpedo09
                        user_input:
                          type: string
                        status:
                          type: string
                          example: CANCELED
                        redeemed_at:
                          type: string
                          example: 2020-07-01T18:37:32Z
                        reward:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 92af127c-7326-4483-a52b-b0da0be61c01
                            title:
                              type: string
                              example: game analysis
                            prompt:
                              type: string
                            cost:
                              type: number
                              example: 50000
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudWxsLCJhIjp7IkN1cnNvciI6Ik1UZG1ZVEprWmpFdFlXUTNOaTAwT0RBMExXSm1ZVFV0WVRRd1pXWTJNMlZtWlRZelgxOHlNREl3TFRBM0xUQXhWREU0T2pNM09qTXlMakl6TXpFeU56RTFOMW89In19
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: reward_id
          in: query
          schema:
            type: string
        - name: status
          in: query
          schema:
            type: string
        - name: id
          in: query
          schema:
            type: string
        - name: sort
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
    patch:
      summary: Update Redemption Status
      description: Updates a redemption’s status.
      tags:
        - Channel Points
      security:
        - oauth:
            - channel:manage:redemptions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_name:
                          type: string
                          example: torpedo09
                        broadcaster_login:
                          type: string
                          example: torpedo09
                        broadcaster_id:
                          type: string
                          example: "274637212"
                        id:
                          type: string
                          example: 17fa2df1-ad76-4804-bfa5-a40ef63efe63
                        user_id:
                          type: string
                          example: "274637212"
                        user_name:
                          type: string
                          example: torpedo09
                        user_login:
                          type: string
                          example: torpedo09
                        user_input:
                          type: string
                        status:
                          type: string
                          example: CANCELED
                        redeemed_at:
                          type: string
                          example: 2020-07-01T18:37:32Z
                        reward:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 92af127c-7326-4483-a52b-b0da0be61c01
                            title:
                              type: string
                              example: game analysis
                            prompt:
                              type: string
                            cost:
                              type: number
                              example: 50000
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: id
          in: query
          schema:
            type: string
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: reward_id
          in: query
          schema:
            type: string
  /charity/campaigns:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Charity Campaign
      description: Gets information about the broadcaster’s active charity campaign.
      tags:
        - Charity
      security:
        - oauth:
            - channel:read:charity
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 123-abc-456-def
                        broadcaster_id:
                          type: string
                          example: "123456"
                        broadcaster_name:
                          type: string
                          example: SunnySideUp
                        broadcaster_login:
                          type: string
                          example: sunnysideup
                        charity_name:
                          type: string
                          example: Example name
                        charity_description:
                          type: string
                          example: Example description
                        charity_logo:
                          type: string
                          example: https://abc.cloudfront.net/ppgf/1000/100.png
                        charity_website:
                          type: string
                          example: https://www.example.com
                        current_amount:
                          type: object
                          properties:
                            value:
                              type: number
                              example: 86000
                            decimal_places:
                              type: number
                              example: 2
                            currency:
                              type: string
                              example: USD
                        target_amount:
                          type: object
                          properties:
                            value:
                              type: number
                              example: 1500000
                            decimal_places:
                              type: number
                              example: 2
                            currency:
                              type: string
                              example: USD
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /charity/donations:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Charity Campaign Donations
      description: Gets the list of donations that users have made to the
        broadcaster’s active charity campaign.
      tags:
        - Charity
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: a1b2c3-aabb-4455-d1e2f3
                        campaign_id:
                          type: string
                          example: 123-abc-456-def
                        user_id:
                          type: string
                          example: "5678"
                        user_login:
                          type: string
                          example: cool_user
                        user_name:
                          type: string
                          example: Cool_User
                        amount:
                          type: object
                          properties:
                            value:
                              type: number
                              example: 500
                            decimal_places:
                              type: number
                              example: 2
                            currency:
                              type: string
                              example: USD
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudWxsLCJhIjp7Ik9mZnNldCI6NX19
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /chat/chatters:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Chatters
      description: Gets the list of users that are connected to the broadcaster’s chat
        session.
      tags:
        - Chat
      security:
        - oauth:
            - moderator:read:chatters
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        user_id:
                          type: string
                          example: "128393656"
                        user_login:
                          type: string
                          example: smittysmithers
                        user_name:
                          type: string
                          example: smittysmithers
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudWxsLCJhIjp7Ik9mZnNldCI6NX19
                  total:
                    type: number
                    example: 8
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /chat/emotes:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Channel Emotes
      description: Gets the broadcaster’s list of custom emotes.
      tags:
        - Chat
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "304456832"
                        name:
                          type: string
                          example: twitchdevPitchfork
                        images:
                          type: object
                          properties:
                            url_1x:
                              type: string
                              example: https://static-cdn.jtvnw.net/emoticons/v2/304456832/static/light/1.0
                            url_2x:
                              type: string
                              example: https://static-cdn.jtvnw.net/emoticons/v2/304456832/static/light/2.0
                            url_4x:
                              type: string
                              example: https://static-cdn.jtvnw.net/emoticons/v2/304456832/static/light/3.0
                        tier:
                          type: string
                          example: "1000"
                        emote_type:
                          type: string
                          example: subscriptions
                        emote_set_id:
                          type: string
                          example: "301590448"
                        format:
                          type: array
                          items:
                            type: string
                            example: static
                        scale:
                          type: array
                          items:
                            type: string
                            example: "1.0"
                        theme_mode:
                          type: array
                          items:
                            type: string
                            example: light
                  template:
                    type: string
                    example: https://static-cdn.jtvnw.net/emoticons/v2/{{id}}/{{format}}/{{theme_mode}}/{{scale}}
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /chat/emotes/global:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Global Emotes
      description: Gets all global emotes.
      tags:
        - Chat
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "196892"
                        name:
                          type: string
                          example: TwitchUnity
                        images:
                          type: object
                          properties:
                            url_1x:
                              type: string
                              example: https://static-cdn.jtvnw.net/emoticons/v2/196892/static/light/1.0
                            url_2x:
                              type: string
                              example: https://static-cdn.jtvnw.net/emoticons/v2/196892/static/light/2.0
                            url_4x:
                              type: string
                              example: https://static-cdn.jtvnw.net/emoticons/v2/196892/static/light/3.0
                        format:
                          type: array
                          items:
                            type: string
                            example: static
                        scale:
                          type: array
                          items:
                            type: string
                            example: "1.0"
                        theme_mode:
                          type: array
                          items:
                            type: string
                            example: light
                  template:
                    type: string
                    example: https://static-cdn.jtvnw.net/emoticons/v2/{{id}}/{{format}}/{{theme_mode}}/{{scale}}
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
  /chat/emotes/set:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Emote Sets
      description: Gets emotes for one or more specified emote sets.
      tags:
        - Chat
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "304456832"
                        name:
                          type: string
                          example: twitchdevPitchfork
                        images:
                          type: object
                          properties:
                            url_1x:
                              type: string
                              example: https://static-cdn.jtvnw.net/emoticons/v2/304456832/static/light/1.0
                            url_2x:
                              type: string
                              example: https://static-cdn.jtvnw.net/emoticons/v2/304456832/static/light/2.0
                            url_4x:
                              type: string
                              example: https://static-cdn.jtvnw.net/emoticons/v2/304456832/static/light/3.0
                        emote_type:
                          type: string
                          example: subscriptions
                        emote_set_id:
                          type: string
                          example: "301590448"
                        owner_id:
                          type: string
                          example: "141981764"
                        format:
                          type: array
                          items:
                            type: string
                            example: static
                        scale:
                          type: array
                          items:
                            type: string
                            example: "1.0"
                        theme_mode:
                          type: array
                          items:
                            type: string
                            example: light
                  template:
                    type: string
                    example: https://static-cdn.jtvnw.net/emoticons/v2/{{id}}/{{format}}/{{theme_mode}}/{{scale}}
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: emote_set_id
          in: query
          schema:
            type: string
  /chat/badges:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Channel Chat Badges
      description: Gets the broadcaster’s list of custom chat badges.
      tags:
        - Chat
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        set_id:
                          type: string
                          example: bits
                        versions:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: "1"
                              image_url_1x:
                                type: string
                                example: https://static-cdn.jtvnw.net/badges/v1/743a0f3b-84b3-450b-96a0-503d7f4a9764/1
                              image_url_2x:
                                type: string
                                example: https://static-cdn.jtvnw.net/badges/v1/743a0f3b-84b3-450b-96a0-503d7f4a9764/2
                              image_url_4x:
                                type: string
                                example: https://static-cdn.jtvnw.net/badges/v1/743a0f3b-84b3-450b-96a0-503d7f4a9764/3
                              title:
                                type: string
                                example: cheer 1
                              description:
                                type: string
                                example: cheer 1
                              click_action:
                                type: string
                                example: visit_url
                              click_url:
                                type: string
                                example: https://bits.twitch.tv
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /chat/badges/global:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Global Chat Badges
      description: Gets Twitch’s list of chat badges.
      tags:
        - Chat
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        set_id:
                          type: string
                          example: vip
                        versions:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: "1"
                              image_url_1x:
                                type: string
                                example: https://static-cdn.jtvnw.net/badges/v1/b817aba4-fad8-49e2-b88a-7cc744dfa6ec/1
                              image_url_2x:
                                type: string
                                example: https://static-cdn.jtvnw.net/badges/v1/b817aba4-fad8-49e2-b88a-7cc744dfa6ec/2
                              image_url_4x:
                                type: string
                                example: https://static-cdn.jtvnw.net/badges/v1/b817aba4-fad8-49e2-b88a-7cc744dfa6ec/3
                              title:
                                type: string
                                example: VIP
                              description:
                                type: string
                                example: VIP
                              click_action:
                                type: string
                                example: visit_url
                              click_url:
                                type: string
                                example: https://help.twitch.tv/customer/en/portal/articles/659115-twitch-chat-badges-guide
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
  /chat/settings:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Chat Settings
      description: Gets the broadcaster’s chat settings.
      tags:
        - Chat
      security:
        - oauth:
            - moderator:read:chat_settings
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_id:
                          type: string
                          example: "713936733"
                        slow_mode:
                          type: boolean
                        slow_mode_wait_time:
                          type: string
                        follower_mode:
                          type: boolean
                          example: true
                        follower_mode_duration:
                          type: number
                        subscriber_mode:
                          type: boolean
                        emote_mode:
                          type: boolean
                        unique_chat_mode:
                          type: boolean
                        non_moderator_chat_delay:
                          type: boolean
                          example: true
                        non_moderator_chat_delay_duration:
                          type: number
                          example: 4
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
    patch:
      summary: Update Chat Settings
      description: Updates the broadcaster’s chat settings.
      tags:
        - Chat
      security:
        - oauth:
            - moderator:manage:chat_settings
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_id:
                          type: string
                          example: "1234"
                        moderator_id:
                          type: string
                          example: "5678"
                        slow_mode:
                          type: boolean
                          example: true
                        slow_mode_wait_time:
                          type: number
                          example: 10
                        follower_mode:
                          type: boolean
                        follower_mode_duration:
                          type: string
                        subscriber_mode:
                          type: boolean
                        emote_mode:
                          type: boolean
                        unique_chat_mode:
                          type: boolean
                        non_moderator_chat_delay:
                          type: boolean
                        non_moderator_chat_delay_duration:
                          type: string
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
  /chat/emotes/user:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get User Emotes
      description: BETA Retrieves emotes available to the user across all channels.
      tags:
        - Chat
      security:
        - oauth:
            - user:read:emotes
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        emote_set_id:
                          type: string
                        emote_type:
                          type: string
                          example: hypetrain
                        format:
                          type: array
                          items:
                            type: string
                            example: static
                        id:
                          type: string
                          example: "304420818"
                        name:
                          type: string
                          example: HypeLol
                        owner_id:
                          type: string
                          example: "477339272"
                        scale:
                          type: array
                          items:
                            type: string
                            example: "1.0"
                        theme_mode:
                          type: array
                          items:
                            type: string
                            example: light
                  template:
                    type: string
                    example: https://static-cdn.jtvnw.net/emoticons/v2/{{id}}/{{format}}/{{theme_mode}}/{{scale}}
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudWxsLJxhIjoiIn0gf5
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: user_id
          in: query
          schema:
            type: string
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /chat/announcements:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Send Chat Announcement
      description: Sends an announcement to the broadcaster’s chat room.
      tags:
        - Chat
      security:
        - oauth:
            - moderator:manage:announcements
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
  /chat/shoutouts:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Send a Shoutout
      description: Sends a Shoutout to the specified broadcaster.
      tags:
        - Chat
      security:
        - oauth:
            - moderator:manage:shoutouts
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: from_broadcaster_id
          in: query
          schema:
            type: string
        - name: to_broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
  /chat/messages:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Send Chat Message
      description: NEW Sends a message to the broadcaster’s chat room.
      tags:
        - Chat
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        message_id:
                          type: string
                          example: abc-123-def
                        is_sent:
                          type: boolean
                          example: true
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
  /chat/color:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get User Chat Color
      description: Gets the color used for the user’s name in chat.
      tags:
        - Chat
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        user_id:
                          type: string
                          example: "11111"
                        user_name:
                          type: string
                          example: SpeedySpeedster1
                        user_login:
                          type: string
                          example: speedyspeedster1
                        color:
                          type: string
                          example: "#9146FF"
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: user_id
          in: query
          schema:
            type: string
    put:
      summary: Update User Chat Color
      description: Updates the color used for the user’s name in chat.
      tags:
        - Chat
      security:
        - oauth:
            - user:manage:chat_color
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: user_id
          in: query
          schema:
            type: string
        - name: color
          in: query
          schema:
            type: string
  /clips:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Create Clip
      description: Creates a clip from the broadcaster’s stream.
      tags:
        - Clips
      security:
        - oauth:
            - clips:edit
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: FiveWordsForClipSlug
                        edit_url:
                          type: string
                          example: http://clips.twitch.tv/FiveWordsForClipSlug/edit
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: has_delay
          in: query
          schema:
            type: string
    get:
      summary: Get Clips
      description: Gets one or more video clips.
      tags:
        - Clips
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: AwkwardHelplessSalamanderSwiftRage
                        url:
                          type: string
                          example: https://clips.twitch.tv/AwkwardHelplessSalamanderSwiftRage
                        embed_url:
                          type: string
                          example: https://clips.twitch.tv/embed?clip=AwkwardHelplessSalamanderSwiftRage
                        broadcaster_id:
                          type: string
                          example: "67955580"
                        broadcaster_name:
                          type: string
                          example: ChewieMelodies
                        creator_id:
                          type: string
                          example: "53834192"
                        creator_name:
                          type: string
                          example: BlackNova03
                        video_id:
                          type: string
                          example: "205586603"
                        game_id:
                          type: string
                          example: "488191"
                        language:
                          type: string
                          example: en
                        title:
                          type: string
                          example: babymetal
                        view_count:
                          type: number
                          example: 10
                        created_at:
                          type: string
                          example: 2017-11-30T22:34:18Z
                        thumbnail_url:
                          type: string
                          example: https://clips-media-assets.twitch.tv/157589949-preview-480x272.jpg
                        duration:
                          type: number
                          example: 60
                        vod_offset:
                          type: number
                          example: 480
                        is_featured:
                          type: boolean
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: game_id
          in: query
          schema:
            type: string
        - name: id
          in: query
          schema:
            type: string
        - name: started_at
          in: query
          schema:
            type: string
        - name: ended_at
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: before
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
        - name: is_featured
          in: query
          schema:
            type: string
  /eventsub/conduits:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Conduits
      description: NEW Gets the conduits for a client ID.
      tags:
        - Conduits
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 26b1c993-bfcf-44d9-b876-379dacafe75a
                        shard_count:
                          type: number
                          example: 15
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
    post:
      summary: Create Conduits
      description: NEW Creates a new conduit.
      tags:
        - Conduits
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: bfcfc993-26b1-b876-44d9-afe75a379dac
                        shard_count:
                          type: number
                          example: 5
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
    patch:
      summary: Update Conduits
      description: NEW Updates a conduit’s shard count.
      tags:
        - Conduits
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: bfcfc993-26b1-b876-44d9-afe75a379dac
                        shard_count:
                          type: number
                          example: 5
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
    delete:
      summary: Delete Conduit
      description: NEW Deletes a specified conduit.
      tags:
        - Conduits
      security:
        - oauth: []
      responses:
        "204":
          description: Deleted
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: id
          in: query
          schema:
            type: string
  /eventsub/conduits/shards:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Conduit Shards
      description: NEW Gets a lists of all shards for a conduit.
      tags:
        - Conduits
      security:
        - oauth: []
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: conduit_id
          in: query
          schema:
            type: string
        - name: status
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
    patch:
      summary: Update Conduit Shards
      description: NEW Updates shard(s) for a conduit.
      tags:
        - Conduits
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "0"
                        status:
                          type: string
                          example: enabled
                        transport:
                          type: object
                          properties:
                            method:
                              type: string
                              example: webhook
                            callback:
                              type: string
                              example: https://this-is-a-callback.com
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "3"
                        message:
                          type: string
                          example: The shard id is outside the conduit's range
                        code:
                          type: string
                          example: invalid_parameter
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
  /content_classification_labels:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Content Classification Labels
      description: Gets information about Twitch content classification labels.
      tags:
        - CCLs
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: DrugsIntoxication
                        description:
                          type: string
                          example: Excessive tobacco glorification or promotion, any marijuana
                            consumption/use, legal drug and alcohol induced
                            intoxication, discussions of illegal drugs.
                        name:
                          type: string
                          example: Drugs, Intoxication, or Excessive Tobacco Use
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: locale
          in: query
          schema:
            type: string
  /entitlements/drops:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Drops Entitlements
      description: Gets an organization’s list of entitlements that have been granted
        to a game, a user, or both.
      tags:
        - Entitlements
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: fb78259e-fb81-4d1b-8333-34a06ffc24c0
                        benefit_id:
                          type: string
                          example: 74c52265-e214-48a6-91b9-23b6014e8041
                        timestamp:
                          type: string
                          example: 2019-01-28T04:17:53.325Z
                        user_id:
                          type: string
                          example: "25009227"
                        game_id:
                          type: string
                          example: "33214"
                        fulfillment_status:
                          type: string
                          example: CLAIMED
                        last_updated:
                          type: string
                          example: 2019-01-28T04:17:53.325Z
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudW...
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: id
          in: query
          schema:
            type: string
        - name: user_id
          in: query
          schema:
            type: string
        - name: game_id
          in: query
          schema:
            type: string
        - name: fulfillment_status
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
    patch:
      summary: Update Drops Entitlements
      description: Updates the Drop entitlement’s fulfillment status.
      tags:
        - Entitlements
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        status:
                          type: string
                          example: SUCCESS
                        ids:
                          type: array
                          items:
                            type: string
                            example: fb78259e-fb81-4d1b-8333-34a06ffc24c0
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
  /extensions/configurations:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Extension Configuration Segment
      description: Gets the specified configuration segment from the specified extension.
      tags:
        - Extensions
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        segment:
                          type: string
                          example: global
                        content:
                          type: string
                          example: hello config!
                        version:
                          type: string
                          example: 0.0.1
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: extension_id
          in: query
          schema:
            type: string
        - name: segment
          in: query
          schema:
            type: string
    put:
      summary: Set Extension Configuration Segment
      description: Updates a configuration segment.
      tags:
        - Extensions
      security:
        - oauth: []
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
  /extensions/required_configuration:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    put:
      summary: Set Extension Required Configuration
      description: Updates the extension’s required_configuration string.
      tags:
        - Extensions
      security:
        - oauth: []
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /extensions/pubsub:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Send Extension PubSub Message
      description: Sends a message to one or more viewers.
      tags:
        - Extensions
      security:
        - oauth: []
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
  /extensions/live:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Extension Live Channels
      description: Gets a list of broadcasters that are streaming live and have
        installed or activated the extension.
      tags:
        - Extensions
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_id:
                          type: string
                          example: "252766116"
                        broadcaster_name:
                          type: string
                          example: swoosh_xii
                        game_name:
                          type: string
                          example: Tom Clancy's Rainbow Six Siege
                        game_id:
                          type: string
                          example: "460630"
                        title:
                          type: string
                          example: "[PS4] ITA/ENG UNRANKED CHILLIN' (SUB 1/15) - !instagram !donation
                            !sens !team !youtube"
                  pagination:
                    type: string
                    example: YVc1emRHRnNiQ015TmpJek5qazVOVHBoYWpKbGRIZDFaR0Z5YjNCMGN6UTJNMkZ1TUdwM2FHWnBZbm8yYW5rNjoy
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: extension_id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /extensions/jwt/secrets:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Extension Secrets
      description: Gets an extension’s list of shared secrets.
      tags:
        - Extensions
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        format_version:
                          type: number
                          example: 1
                        secrets:
                          type: array
                          items:
                            type: object
                            properties:
                              content:
                                type: string
                                example: secret
                              active_at:
                                type: string
                                example: 2021-03-29T06:58:40.858343036Z
                              expires_at:
                                type: string
                                example: 2121-03-05T06:58:40.858343036Z
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
    post:
      summary: Create Extension Secret
      description: Creates a shared secret used to sign and verify JWT tokens.
      tags:
        - Extensions
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        format_version:
                          type: number
                          example: 1
                        secrets:
                          type: array
                          items:
                            type: object
                            properties:
                              content:
                                type: string
                                example: old-secret
                              active_at:
                                type: string
                                example: 2021-03-29T06:58:40.858343036Z
                              expires_at:
                                type: string
                                example: 2021-04-22T05:21:54.99261682Z
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: extension_id
          in: query
          schema:
            type: string
        - name: delay
          in: query
          schema:
            type: string
  /extensions/chat:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Send Extension Chat Message
      description: Sends a message to the specified broadcaster’s chat room.
      tags:
        - Extensions
      security:
        - oauth: []
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /extensions:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Extensions
      description: Gets information about an extension.
      tags:
        - Extensions
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        author_name:
                          type: string
                          example: Twitch Developers
                        bits_enabled:
                          type: boolean
                          example: true
                        can_install:
                          type: boolean
                        configuration_location:
                          type: string
                          example: hosted
                        description:
                          type: string
                          example: An extension for testing all the features that we add to extensions
                        eula_tos_url:
                          type: string
                        has_chat_support:
                          type: boolean
                          example: true
                        icon_url:
                          type: string
                          example: https://extensions-discovery-images.twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.8/logob6c995d8-8b45-48cc-a748-b256e92ac1cd
                        icon_urls:
                          type: object
                          properties:
                            100x100:
                              type: string
                              example: https://extensions-discovery-images.twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.8/logob6c995d8-8b45-48cc-a748-b256e92ac1cd
                            24x24:
                              type: string
                              example: https://extensions-discovery-images.twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.8/taskbar905b19da-e7e5-4d8f-beb7-f543a861ac1e
                            300x200:
                              type: string
                              example: https://extensions-discovery-images.twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.8/discoveryd9545b2c-5474-46d7-a523-1c3835d862ce
                        id:
                          type: string
                          example: pgn0bjv51epi7eaekt53tovjnc82qo
                        name:
                          type: string
                          example: Official Developers Demo
                        privacy_policy_url:
                          type: string
                        request_identity_link:
                          type: boolean
                          example: true
                        screenshot_urls:
                          type: array
                          items:
                            type: string
                            example: https://extensions-discovery-images.twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.8/screenshotbdec475d-3d2f-4378-b334-941dfddc897a
                        state:
                          type: string
                          example: Released
                        subscriptions_support_level:
                          type: string
                          example: optional
                        summary:
                          type: string
                          example: Test ALL the extensions features!
                        support_email:
                          type: string
                          example: dx-extensions-test-dev@justin.tv
                        version:
                          type: string
                          example: 0.0.9
                        viewer_summary:
                          type: string
                          example: Test ALL the extensions features!
                        views:
                          type: object
                          properties:
                            mobile:
                              type: object
                              properties:
                                viewer_url:
                                  type: string
                                  example: https://pgn0bjv51epi7eaekt53tovjnc82qo.ext-twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.9/f9a0d8aae0f9dd0b2d6ef3416b96bc79/index.html
                            panel:
                              type: object
                              properties:
                                viewer_url:
                                  type: string
                                  example: https://pgn0bjv51epi7eaekt53tovjnc82qo.ext-twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.9/f9a0d8aae0f9dd0b2d6ef3416b96bc79/index.html
                                height:
                                  type: number
                                  example: 300
                                can_link_external_content:
                                  type: boolean
                            video_overlay:
                              type: object
                              properties:
                                viewer_url:
                                  type: string
                                  example: https://pgn0bjv51epi7eaekt53tovjnc82qo.ext-twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.9/f9a0d8aae0f9dd0b2d6ef3416b96bc79/index.html
                                can_link_external_content:
                                  type: boolean
                            component:
                              type: object
                              properties:
                                viewer_url:
                                  type: string
                                  example: https://pgn0bjv51epi7eaekt53tovjnc82qo.ext-twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.9/f9a0d8aae0f9dd0b2d6ef3416b96bc79/index.html
                                aspect_width:
                                  type: number
                                aspect_height:
                                  type: number
                                aspect_ratio_x:
                                  type: number
                                  example: 48000
                                aspect_ratio_y:
                                  type: number
                                  example: 36000
                                autoscale:
                                  type: boolean
                                  example: true
                                scale_pixels:
                                  type: number
                                  example: 1024
                                target_height:
                                  type: number
                                  example: 5333
                                size:
                                  type: number
                                zoom:
                                  type: boolean
                                zoom_pixels:
                                  type: number
                                can_link_external_content:
                                  type: boolean
                        allowlisted_config_urls:
                          type: array
                          items:
                            type: string
                        allowlisted_panel_urls:
                          type: array
                          items:
                            type: string
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: extension_id
          in: query
          schema:
            type: string
        - name: extension_version
          in: query
          schema:
            type: string
  /extensions/released:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Released Extensions
      description: Gets information about a released extension.
      tags:
        - Extensions
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        author_name:
                          type: string
                          example: Twitch Developer Experience
                        bits_enabled:
                          type: boolean
                          example: true
                        can_install:
                          type: boolean
                        configuration_location:
                          type: string
                          example: hosted
                        description:
                          type: string
                          example: An extension for testing all the features that we add to extensions
                        eula_tos_url:
                          type: string
                        has_chat_support:
                          type: boolean
                          example: true
                        icon_url:
                          type: string
                          example: https://extensions-discovery-images.twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.8/logob6c995d8-8b45-48cc-a748-b256e92ac1cd
                        icon_urls:
                          type: object
                          properties:
                            100x100:
                              type: string
                              example: https://extensions-discovery-images.twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.8/logob6c995d8-8b45-48cc-a748-b256e92ac1cd
                            24x24:
                              type: string
                              example: https://extensions-discovery-images.twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.8/taskbar905b19da-e7e5-4d8f-beb7-f543a861ac1e
                            300x200:
                              type: string
                              example: https://extensions-discovery-images.twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.8/discoveryd9545b2c-5474-46d7-a523-1c3835d862ce
                        id:
                          type: string
                          example: pgn0bjv51epi7eaekt53tovjnc82qo
                        name:
                          type: string
                          example: Official Developer Experience Demo
                        privacy_policy_url:
                          type: string
                        request_identity_link:
                          type: boolean
                          example: true
                        screenshot_urls:
                          type: array
                          items:
                            type: string
                            example: https://extensions-discovery-images.twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.8/screenshotbdec475d-3d2f-4378-b334-941dfddc897a
                        state:
                          type: string
                          example: Released
                        subscriptions_support_level:
                          type: string
                          example: optional
                        summary:
                          type: string
                          example: Test ALL the extensions features!
                        support_email:
                          type: string
                          example: dx-extensions-test-dev@justin.tv
                        version:
                          type: string
                          example: 0.0.9
                        viewer_summary:
                          type: string
                          example: Test ALL the extensions features!
                        views:
                          type: object
                          properties:
                            mobile:
                              type: object
                              properties:
                                viewer_url:
                                  type: string
                                  example: https://pgn0bjv51epi7eaekt53tovjnc82qo.ext-twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.9/f9a0d8aae0f9dd0b2d6ef3416b96bc79/index.html
                            panel:
                              type: object
                              properties:
                                viewer_url:
                                  type: string
                                  example: https://pgn0bjv51epi7eaekt53tovjnc82qo.ext-twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.9/f9a0d8aae0f9dd0b2d6ef3416b96bc79/index.html
                                height:
                                  type: number
                                  example: 300
                                can_link_external_content:
                                  type: boolean
                            video_overlay:
                              type: object
                              properties:
                                viewer_url:
                                  type: string
                                  example: https://pgn0bjv51epi7eaekt53tovjnc82qo.ext-twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.9/f9a0d8aae0f9dd0b2d6ef3416b96bc79/index.html
                                can_link_external_content:
                                  type: boolean
                            component:
                              type: object
                              properties:
                                viewer_url:
                                  type: string
                                  example: https://pgn0bjv51epi7eaekt53tovjnc82qo.ext-twitch.tv/pgn0bjv51epi7eaekt53tovjnc82qo/0.0.9/f9a0d8aae0f9dd0b2d6ef3416b96bc79/index.html
                                aspect_width:
                                  type: number
                                aspect_height:
                                  type: number
                                aspect_ratio_x:
                                  type: number
                                  example: 48000
                                aspect_ratio_y:
                                  type: number
                                  example: 36000
                                autoscale:
                                  type: boolean
                                  example: true
                                scale_pixels:
                                  type: number
                                  example: 1024
                                target_height:
                                  type: number
                                  example: 5333
                                size:
                                  type: number
                                zoom:
                                  type: boolean
                                zoom_pixels:
                                  type: number
                                can_link_external_content:
                                  type: boolean
                        allowlisted_config_urls:
                          type: array
                          items:
                            type: string
                        allowlisted_panel_urls:
                          type: array
                          items:
                            type: string
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: extension_id
          in: query
          schema:
            type: string
        - name: extension_version
          in: query
          schema:
            type: string
  /bits/extensions:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Extension Bits Products
      description: Gets the list of Bits products that belongs to the extension.
      tags:
        - Extensions
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        sku:
                          type: string
                          example: "1010"
                        cost:
                          type: object
                          properties:
                            amount:
                              type: number
                              example: 990
                            type:
                              type: string
                              example: bits
                        in_development:
                          type: boolean
                          example: true
                        display_name:
                          type: string
                          example: Rusty Crate 2
                        expiration:
                          type: string
                          example: 2021-05-18T09:10:13.397Z
                        is_broadcast:
                          type: boolean
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: should_include_all
          in: query
          schema:
            type: string
    put:
      summary: Update Extension Bits Product
      description: Adds or updates a Bits product that the extension created.
      tags:
        - Extensions
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        sku:
                          type: string
                          example: "1010"
                        cost:
                          type: object
                          properties:
                            amount:
                              type: number
                              example: 990
                            type:
                              type: string
                              example: bits
                        in_development:
                          type: boolean
                          example: true
                        display_name:
                          type: string
                          example: Rusty Crate 2
                        expiration:
                          type: string
                          example: 2021-05-18T09:10:13.397Z
                        is_broadcast:
                          type: boolean
                          example: true
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
  /eventsub/subscriptions:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Create EventSub Subscription
      description: Creates an EventSub subscription.
      tags:
        - EventSub
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 26b1c993-bfcf-44d9-b876-379dacafe75a
                        status:
                          type: string
                          example: webhook_callback_verification_pending
                        type:
                          type: string
                          example: user.update
                        version:
                          type: string
                          example: "1"
                        condition:
                          type: object
                          properties:
                            user_id:
                              type: string
                              example: "1234"
                        created_at:
                          type: string
                          example: 2020-11-10T14:32:18.730260295Z
                        transport:
                          type: object
                          properties:
                            method:
                              type: string
                              example: webhook
                            callback:
                              type: string
                              example: https://this-is-a-callback.com
                        cost:
                          type: number
                          example: 1
                  total:
                    type: number
                    example: 1
                  total_cost:
                    type: number
                    example: 1
                  max_total_cost:
                    type: number
                    example: 10000
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
    delete:
      summary: Delete EventSub Subscription
      description: Deletes an EventSub subscription.
      tags:
        - EventSub
      security:
        - oauth: []
      responses:
        "204":
          description: Deleted
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: id
          in: query
          schema:
            type: string
    get:
      summary: Get EventSub Subscriptions
      description: Gets a list of EventSub subscriptions that the client in the access
        token created.
      tags:
        - EventSub
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: number
                    example: 2
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 26b1c993-bfcf-44d9-b876-379dacafe75a
                        status:
                          type: string
                          example: enabled
                        type:
                          type: string
                          example: stream.online
                        version:
                          type: string
                          example: "1"
                        condition:
                          type: object
                          properties:
                            broadcaster_user_id:
                              type: string
                              example: "1234"
                        created_at:
                          type: string
                          example: 2020-11-10T20:08:33.12345678Z
                        transport:
                          type: object
                          properties:
                            method:
                              type: string
                              example: webhook
                            callback:
                              type: string
                              example: https://this-is-a-callback.com
                        cost:
                          type: number
                          example: 1
                  total_cost:
                    type: number
                    example: 1
                  max_total_cost:
                    type: number
                    example: 10000
                  pagination:
                    type: object
                    properties: {}
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: status
          in: query
          schema:
            type: string
        - name: type
          in: query
          schema:
            type: string
        - name: user_id
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /games/top:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Top Games
      description: Gets information about all broadcasts on Twitch.
      tags:
        - Games
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "493057"
                        name:
                          type: string
                          example: "PUBG: BATTLEGROUNDS"
                        box_art_url:
                          type: string
                          example: https://static-cdn.jtvnw.net/ttv-boxart/493057-{width}x{height}.jpg
                        igdb_id:
                          type: string
                          example: "27789"
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudWxsLCJhIjp7Ik9mZnNldCI6MjB9fQ==
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
        - name: before
          in: query
          schema:
            type: string
  /games:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Games
      description: Gets information about specified games.
      tags:
        - Games
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "33214"
                        name:
                          type: string
                          example: Fortnite
                        box_art_url:
                          type: string
                          example: https://static-cdn.jtvnw.net/ttv-boxart/33214-{width}x{height}.jpg
                        igdb_id:
                          type: string
                          example: "1905"
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudWxsLCJhIjp7IkN
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: id
          in: query
          schema:
            type: string
        - name: name
          in: query
          schema:
            type: string
        - name: igdb_id
          in: query
          schema:
            type: string
  /goals:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Creator Goals
      description: Gets the broadcaster’s list of active goals.
      tags:
        - Goals
      security:
        - oauth:
            - channel:read:goals
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 1woowvbkiNv8BRxEWSqmQz6Zk92
                        broadcaster_id:
                          type: string
                          example: "141981764"
                        broadcaster_name:
                          type: string
                          example: TwitchDev
                        broadcaster_login:
                          type: string
                          example: twitchdev
                        type:
                          type: string
                          example: follower
                        description:
                          type: string
                          example: Follow goal for Helix testing
                        current_amount:
                          type: number
                          example: 27062
                        target_amount:
                          type: number
                          example: 30000
                        created_at:
                          type: string
                          example: 2021-08-16T17:22:23Z
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /guest_star/channel_settings:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Channel Guest Star Settings
      description: BETA Gets the channel settings for configuration of the Guest Star
        feature for a particular host.
      tags:
        - Guest Star
      security:
        - oauth:
            - channel:read:guest_star
            - moderator:read:guest_star
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        is_moderator_send_live_enabled:
                          type: boolean
                          example: true
                        slot_count:
                          type: number
                          example: 4
                        is_browser_source_audio_enabled:
                          type: boolean
                          example: true
                        layout:
                          type: string
                          example: TILED_LAYOUT
                        browser_source_token:
                          type: string
                          example: eihq8rew7q3hgierufhi3q
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
    put:
      summary: Update Channel Guest Star Settings
      description: BETA Mutates the channel settings for configuration of the Guest
        Star feature for a particular host.
      tags:
        - Guest Star
      security:
        - oauth:
            - channel:manage:guest_star
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /guest_star/session:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Guest Star Session
      description: BETA Gets information about an ongoing Guest Star session for a
        particular channel.
      tags:
        - Guest Star
      security:
        - oauth:
            - channel:read:guest_star
            - moderator:read:guest_star
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
    post:
      summary: Create Guest Star Session
      description: BETA Programmatically creates a Guest Star session on behalf of the
        broadcaster.
      tags:
        - Guest Star
      security:
        - oauth:
            - channel:manage:guest_star
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
    delete:
      summary: End Guest Star Session
      description: BETA Programmatically ends a Guest Star session on behalf of the
        broadcaster.
      tags:
        - Guest Star
      security:
        - oauth:
            - channel:manage:guest_star
      responses:
        "204":
          description: Deleted
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: session_id
          in: query
          schema:
            type: string
  /guest_star/invites:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Guest Star Invites
      description: BETA Provides the caller with a list of pending invites to a Guest
        Star session.
      tags:
        - Guest Star
      security:
        - oauth:
            - channel:read:guest_star
            - moderator:read:guest_star
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        user_id:
                          type: string
                          example: "144601104"
                        invited_at:
                          type: string
                          example: 2023-01-02T04:16:53.325Z
                        status:
                          type: string
                          example: INVITED
                        is_audio_enabled:
                          type: boolean
                        is_video_enabled:
                          type: boolean
                          example: true
                        is_audio_available:
                          type: boolean
                          example: true
                        is_video_available:
                          type: boolean
                          example: true
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
        - name: session_id
          in: query
          schema:
            type: string
    post:
      summary: Send Guest Star Invite
      description: BETA Sends an invite to a specified guest on behalf of the
        broadcaster for a Guest Star session in progress.
      tags:
        - Guest Star
      security:
        - oauth:
            - channel:manage:guest_star
            - moderator:manage:guest_star
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
        - name: session_id
          in: query
          schema:
            type: string
        - name: guest_id
          in: query
          schema:
            type: string
    delete:
      summary: Delete Guest Star Invite
      description: BETA Revokes a previously sent invite for a Guest Star session.
      tags:
        - Guest Star
      security:
        - oauth:
            - channel:manage:guest_star
            - moderator:manage:guest_star
      responses:
        "204":
          description: Deleted
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
        - name: session_id
          in: query
          schema:
            type: string
        - name: guest_id
          in: query
          schema:
            type: string
  /guest_star/slot:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Assign Guest Star Slot
      description: BETA Allows a previously invited user to be assigned a slot within
        the active Guest Star session.
      tags:
        - Guest Star
      security:
        - oauth:
            - channel:manage:guest_star
            - moderator:manage:guest_star
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      code:
                        type: string
                        example: USER_NOT_READY
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
        - name: session_id
          in: query
          schema:
            type: string
        - name: guest_id
          in: query
          schema:
            type: string
        - name: slot_id
          in: query
          schema:
            type: string
    patch:
      summary: Update Guest Star Slot
      description: BETA Allows a user to update the assigned slot for a particular
        user within the active Guest Star session.
      tags:
        - Guest Star
      security:
        - oauth:
            - channel:manage:guest_star
            - moderator:manage:guest_star
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
        - name: session_id
          in: query
          schema:
            type: string
        - name: source_slot_id
          in: query
          schema:
            type: string
        - name: destination_slot_id
          in: query
          schema:
            type: string
    delete:
      summary: Delete Guest Star Slot
      description: BETA Allows a caller to remove a slot assignment from a user
        participating in an active Guest Star session.
      tags:
        - Guest Star
      security:
        - oauth:
            - channel:manage:guest_star
            - moderator:manage:guest_star
      responses:
        "204":
          description: Deleted
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
        - name: session_id
          in: query
          schema:
            type: string
        - name: guest_id
          in: query
          schema:
            type: string
        - name: slot_id
          in: query
          schema:
            type: string
        - name: should_reinvite_guest
          in: query
          schema:
            type: string
  /guest_star/slot_settings:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    patch:
      summary: Update Guest Star Slot Settings
      description: BETA Allows a user to update slot settings for a particular guest
        within a Guest Star session.
      tags:
        - Guest Star
      security:
        - oauth:
            - channel:manage:guest_star
            - moderator:manage:guest_star
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
        - name: session_id
          in: query
          schema:
            type: string
        - name: slot_id
          in: query
          schema:
            type: string
        - name: is_audio_enabled
          in: query
          schema:
            type: string
        - name: is_video_enabled
          in: query
          schema:
            type: string
        - name: is_live
          in: query
          schema:
            type: string
        - name: volume
          in: query
          schema:
            type: string
  /hypetrain/events:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Hype Train Events
      description: Gets information about the broadcaster’s current or most recent
        Hype Train event.
      tags:
        - Hype Train
      security:
        - oauth:
            - channel:read:hype_train
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 1b0AsbInCHZW2SQFQkCzqN07Ib2
                        event_type:
                          type: string
                          example: hypetrain.progression
                        event_timestamp:
                          type: string
                          example: 2020-04-24T20:07:24Z
                        version:
                          type: string
                          example: "1.0"
                        event_data:
                          type: object
                          properties:
                            broadcaster_id:
                              type: string
                              example: "270954519"
                            cooldown_end_time:
                              type: string
                              example: 2020-04-24T20:13:21.003802269Z
                            expires_at:
                              type: string
                              example: 2020-04-24T20:12:21.003802269Z
                            goal:
                              type: number
                              example: 1800
                            id:
                              type: string
                              example: 70f0c7d8-ff60-4c50-b138-f3a352833b50
                            last_contribution:
                              type: object
                              properties:
                                total:
                                  type: number
                                  example: 200
                                type:
                                  type: string
                                  example: BITS
                                user:
                                  type: string
                                  example: "134247454"
                            level:
                              type: number
                              example: 2
                            started_at:
                              type: string
                              example: 2020-04-24T20:05:47.30473127Z
                            top_contributions:
                              type: array
                              items:
                                type: object
                                properties:
                                  total:
                                    type: number
                                    example: 600
                                  type:
                                    type: string
                                    example: BITS
                                  user:
                                    type: string
                                    example: "134247450"
                            total:
                              type: number
                              example: 600
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudWxsLCJhIjp7IkN1cnNvciI6IjI3MDk1NDUxOToxNTg3NzU4ODQ0OjFiMEFzYkluQ0haVzJTUUZRa0N6cU4wN0liMiJ9fQ
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /moderation/enforcements/status:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Check AutoMod Status
      description: Checks whether AutoMod would flag the specified message for review.
      tags:
        - Moderation
      security:
        - oauth:
            - moderation:read
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        msg_id:
                          type: string
                          example: "123"
                        is_permitted:
                          type: boolean
                          example: true
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /moderation/automod/message:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Manage Held AutoMod Messages
      description: Allow or deny the message that AutoMod flagged for review.
      tags:
        - Moderation
      security:
        - oauth:
            - moderator:manage:automod
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
  /moderation/automod/settings:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get AutoMod Settings
      description: Gets the broadcaster’s AutoMod settings.
      tags:
        - Moderation
      security:
        - oauth:
            - moderator:read:automod_settings
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_id:
                          type: string
                          example: "1234"
                        moderator_id:
                          type: string
                          example: "5678"
                        overall_level:
                          type: string
                        disability:
                          type: number
                        aggression:
                          type: number
                        sexuality_sex_or_gender:
                          type: number
                        misogyny:
                          type: number
                        bullying:
                          type: number
                        swearing:
                          type: number
                        race_ethnicity_or_religion:
                          type: number
                        sex_based_terms:
                          type: number
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
    put:
      summary: Update AutoMod Settings
      description: Updates the broadcaster’s AutoMod settings.
      tags:
        - Moderation
      security:
        - oauth:
            - moderator:manage:automod_settings
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_id:
                          type: string
                          example: "1234"
                        moderator_id:
                          type: string
                          example: "5678"
                        overall_level:
                          type: number
                          example: 3
                        disability:
                          type: number
                          example: 3
                        aggression:
                          type: number
                          example: 3
                        sexuality_sex_or_gender:
                          type: number
                          example: 3
                        misogyny:
                          type: number
                          example: 3
                        bullying:
                          type: number
                          example: 2
                        swearing:
                          type: number
                        race_ethnicity_or_religion:
                          type: number
                          example: 3
                        sex_based_terms:
                          type: number
                          example: 3
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
  /moderation/banned:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Banned Users
      description: Gets all users that the broadcaster banned or put in a timeout.
      tags:
        - Moderation
      security:
        - oauth:
            - moderation:read
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        user_id:
                          type: string
                          example: "423374343"
                        user_login:
                          type: string
                          example: glowillig
                        user_name:
                          type: string
                          example: glowillig
                        expires_at:
                          type: string
                          example: 2022-03-15T02:00:28Z
                        created_at:
                          type: string
                          example: 2022-03-15T01:30:28Z
                        reason:
                          type: string
                          example: Does not like pineapple on pizza.
                        moderator_id:
                          type: string
                          example: "141981764"
                        moderator_login:
                          type: string
                          example: twitchdev
                        moderator_name:
                          type: string
                          example: TwitchDev
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudWxsLCJhIjp7IkN1cnNvciI6IjEwMDQ3MzA2NDo4NjQwNjU3MToxSVZCVDFKMnY5M1BTOXh3d1E0dUdXMkJOMFcifX0
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: user_id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
        - name: before
          in: query
          schema:
            type: string
  /moderation/bans:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Ban User
      description: Bans a user from participating in a broadcaster’s chat room or puts
        them in a timeout.
      tags:
        - Moderation
      security:
        - oauth:
            - moderator:manage:banned_users
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_id:
                          type: string
                          example: "1234"
                        moderator_id:
                          type: string
                          example: "5678"
                        user_id:
                          type: string
                          example: "9876"
                        created_at:
                          type: string
                          example: 2021-09-28T18:22:31Z
                        end_time:
                          type: string
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
    delete:
      summary: Unban User
      description: Removes the ban or timeout that was placed on the specified user.
      tags:
        - Moderation
      security:
        - oauth:
            - moderator:manage:banned_users
      responses:
        "204":
          description: Deleted
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
        - name: user_id
          in: query
          schema:
            type: string
  /moderation/unban_requests:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Unban Requests
      description: BETA Gets a list of unban requests for a broadcaster’s channel.
      tags:
        - Moderation
      security:
        - oauth:
            - moderator:read:unban_requests
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 92af127c-7326-4483-a52b-b0da0be61c01
                        broadcaster_name:
                          type: string
                          example: torpedo09
                        broadcaster_login:
                          type: string
                          example: torpedo09
                        broadcaster_id:
                          type: string
                          example: "274637212"
                        moderator_id:
                          type: string
                          example: "141981764"
                        moderator_login:
                          type: string
                          example: twitchdev
                        moderator_name:
                          type: string
                          example: TwitchDev
                        user_id:
                          type: string
                          example: "424596340"
                        user_login:
                          type: string
                          example: quotrok
                        user_name:
                          type: string
                          example: quotrok
                        text:
                          type: string
                          example: Please unban me from the channel?
                        status:
                          type: string
                          example: pending
                        created_at:
                          type: string
                          example: 2022-08-07T02:07:55Z
                        resolved_at:
                          type: string
                        resolution_text:
                          type: string
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudWxsLCJhIjp7IkN1cnNvciI6IjEwMDQ3MzA2NDo4NjQwNjU3MToxSVZCVDFKMnY5M1BTOXh3d1E0dUdXMkJOMFcifX0
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
        - name: status
          in: query
          schema:
            type: string
        - name: user_id
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
    patch:
      summary: Resolve Unban Requests
      description: BETA Resolves an unban request by approving or denying it.
      tags:
        - Moderation
      security:
        - oauth:
            - moderator:manage:unban_requests
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 92af127c-7326-4483-a52b-b0da0be61c01
                        broadcaster_name:
                          type: string
                          example: torpedo09
                        broadcaster_login:
                          type: string
                          example: torpedo09
                        broadcaster_id:
                          type: string
                          example: "274637212"
                        moderator_id:
                          type: string
                          example: "141981764"
                        moderator_login:
                          type: string
                          example: twitchdev
                        moderator_name:
                          type: string
                          example: TwitchDev
                        user_id:
                          type: string
                          example: "424596340"
                        user_login:
                          type: string
                          example: quotrok
                        user_name:
                          type: string
                          example: quotrok
                        text:
                          type: string
                          example: Please unban me from the channel?
                        status:
                          type: string
                          example: approved
                        created_at:
                          type: string
                          example: 2022-08-07T02:07:55Z
                        resolved_at:
                          type: string
                          example: 2022-08-09T02:07:55Z
                        resolution_text:
                          type: string
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
        - name: unban_request_id
          in: query
          schema:
            type: string
        - name: status
          in: query
          schema:
            type: string
        - name: resolution_text
          in: query
          schema:
            type: string
  /moderation/blocked_terms:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Blocked Terms
      description: Gets the broadcaster’s list of non-private, blocked words or phrases.
      tags:
        - Moderation
      security:
        - oauth:
            - moderator:read:blocked_terms
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_id:
                          type: string
                          example: "1234"
                        moderator_id:
                          type: string
                          example: "5678"
                        id:
                          type: string
                          example: 520e4d4e-0cda-49c7-821e-e5ef4f88c2f2
                        text:
                          type: string
                          example: A phrase I’m not fond of
                        created_at:
                          type: string
                          example: 2021-09-29T19:45:37Z
                        updated_at:
                          type: string
                          example: 2021-09-29T19:45:37Z
                        expires_at:
                          type: string
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudWxsLCJhIjp7IkN1cnNvciI6I...
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
    post:
      summary: Add Blocked Term
      description: Adds a word or phrase to the broadcaster’s list of blocked terms.
      tags:
        - Moderation
      security:
        - oauth:
            - moderator:manage:blocked_terms
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_id:
                          type: string
                          example: "713936733"
                        moderator_id:
                          type: string
                          example: "713936733"
                        id:
                          type: string
                          example: 3bb6e5d3-afb1-416c-ad4e-21af970ccfe7
                        text:
                          type: string
                          example: A phrase I’m not fond of
                        created_at:
                          type: string
                          example: 2021-09-29T15:36:45Z
                        updated_at:
                          type: string
                          example: 2021-09-29T15:36:45Z
                        expires_at:
                          type: string
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
    delete:
      summary: Remove Blocked Term
      description: Removes the word or phrase from the broadcaster’s list of blocked terms.
      tags:
        - Moderation
      security:
        - oauth:
            - moderator:manage:blocked_terms
      responses:
        "204":
          description: Deleted
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
        - name: id
          in: query
          schema:
            type: string
  /moderation/chat:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    delete:
      summary: Delete Chat Messages
      description: Removes a single chat message or all chat messages from the
        broadcaster’s chat room.
      tags:
        - Moderation
      security:
        - oauth:
            - moderator:manage:chat_messages
      responses:
        "204":
          description: Deleted
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
        - name: message_id
          in: query
          schema:
            type: string
  /moderation/channels:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Moderated Channels
      description: Gets a list of channels that the specified user has moderator
        privileges in.
      tags:
        - Moderation
      security:
        - oauth:
            - user:read:moderated_channels
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_id:
                          type: string
                          example: "12345"
                        broadcaster_login:
                          type: string
                          example: grateful_broadcaster
                        broadcaster_name:
                          type: string
                          example: Grateful_Broadcaster
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudWxsLCJhIjp7IkN1cnNvciI6IjEwMDQ3MzA2NDo4NjQwNjU3MToxSVZCVDFKMnY5M1BTOXh3d1E0dUdXMkJOMFcifX0
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: user_id
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
  /moderation/moderators:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Moderators
      description: Gets all users allowed to moderate the broadcaster’s chat room.
      tags:
        - Moderation
      security:
        - oauth:
            - moderation:read
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        user_id:
                          type: string
                          example: "424596340"
                        user_login:
                          type: string
                          example: quotrok
                        user_name:
                          type: string
                          example: quotrok
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudWxsLCJhIjp7IkN1cnNvciI6IjEwMDQ3MzA2NDo4NjQwNjU3MToxSVZCVDFKMnY5M1BTOXh3d1E0dUdXMkJOMFcifX0
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: user_id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
    post:
      summary: Add Channel Moderator
      description: Adds a moderator to the broadcaster’s chat room.
      tags:
        - Moderation
      security:
        - oauth:
            - channel:manage:moderators
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: user_id
          in: query
          schema:
            type: string
    delete:
      summary: Remove Channel Moderator
      description: Removes a moderator from the broadcaster’s chat room.
      tags:
        - Moderation
      security:
        - oauth:
            - channel:manage:moderators
      responses:
        "204":
          description: Deleted
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: user_id
          in: query
          schema:
            type: string
  /channels/vips:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get VIPs
      description: Gets a list of the broadcaster’s VIPs.
      tags:
        - Moderation
      security:
        - oauth:
            - channel:read:vips
            - channel:manage:vips
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        user_id:
                          type: string
                          example: "11111"
                        user_name:
                          type: string
                          example: UserDisplayName
                        user_login:
                          type: string
                          example: userloginname
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudWxsLCJhIjp7Ik9mZnNldCI6NX19
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: user_id
          in: query
          schema:
            type: string
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
    post:
      summary: Add Channel VIP
      description: Adds the specified user as a VIP in the broadcaster’s channel.
      tags:
        - Moderation
      security:
        - oauth:
            - channel:manage:vips
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: user_id
          in: query
          schema:
            type: string
        - name: broadcaster_id
          in: query
          schema:
            type: string
    delete:
      summary: Remove Channel VIP
      description: Removes the specified user as a VIP in the broadcaster’s channel.
      tags:
        - Moderation
      security:
        - oauth:
            - channel:manage:vips
      responses:
        "204":
          description: Deleted
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: user_id
          in: query
          schema:
            type: string
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /moderation/shield_mode:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    put:
      summary: Update Shield Mode Status
      description: Activates or deactivates the broadcaster’s Shield Mode.
      tags:
        - Moderation
      security:
        - oauth:
            - moderator:manage:shield_mode
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        is_active:
                          type: boolean
                        moderator_id:
                          type: string
                          example: "98765"
                        moderator_name:
                          type: string
                          example: SimplySimple
                        moderator_login:
                          type: string
                          example: simplysimple
                        last_activated_at:
                          type: string
                          example: 2022-07-26T17:16:03.123Z
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
    get:
      summary: Get Shield Mode Status
      description: Gets the broadcaster’s Shield Mode activation status.
      tags:
        - Moderation
      security:
        - oauth:
            - moderator:read:shield_mode
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        is_active:
                          type: boolean
                          example: true
                        moderator_id:
                          type: string
                          example: "98765"
                        moderator_name:
                          type: string
                          example: SimplySimple
                        moderator_login:
                          type: string
                          example: simplysimple
                        last_activated_at:
                          type: string
                          example: 2022-07-26T17:16:03.123Z
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: moderator_id
          in: query
          schema:
            type: string
  /polls:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Polls
      description: Gets a list of polls that the broadcaster created.
      tags:
        - Polls
      security:
        - oauth:
            - channel:read:polls
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: ed961efd-8a3f-4cf5-a9d0-e616c590cd2a
                        broadcaster_id:
                          type: string
                          example: "55696719"
                        broadcaster_name:
                          type: string
                          example: TwitchDev
                        broadcaster_login:
                          type: string
                          example: twitchdev
                        title:
                          type: string
                          example: Heads or Tails?
                        choices:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: 4c123012-1351-4f33-84b7-43856e7a0f47
                              title:
                                type: string
                                example: Heads
                              votes:
                                type: number
                              channel_points_votes:
                                type: number
                              bits_votes:
                                type: number
                        bits_voting_enabled:
                          type: boolean
                        bits_per_vote:
                          type: number
                        channel_points_voting_enabled:
                          type: boolean
                        channel_points_per_vote:
                          type: number
                        status:
                          type: string
                          example: ACTIVE
                        duration:
                          type: number
                          example: 1800
                        started_at:
                          type: string
                          example: 2021-03-19T06:08:33.871278372Z
                  pagination:
                    type: object
                    properties: {}
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
    post:
      summary: Create Poll
      description: Creates a poll that viewers in the broadcaster’s channel can vote on.
      tags:
        - Polls
      security:
        - oauth:
            - channel:manage:polls
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: ed961efd-8a3f-4cf5-a9d0-e616c590cd2a
                        broadcaster_id:
                          type: string
                          example: "141981764"
                        broadcaster_name:
                          type: string
                          example: TwitchDev
                        broadcaster_login:
                          type: string
                          example: twitchdev
                        title:
                          type: string
                          example: Heads or Tails?
                        choices:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: 4c123012-1351-4f33-84b7-43856e7a0f47
                              title:
                                type: string
                                example: Heads
                              votes:
                                type: number
                              channel_points_votes:
                                type: number
                              bits_votes:
                                type: number
                        bits_voting_enabled:
                          type: boolean
                        bits_per_vote:
                          type: number
                        channel_points_voting_enabled:
                          type: boolean
                          example: true
                        channel_points_per_vote:
                          type: number
                          example: 100
                        status:
                          type: string
                          example: ACTIVE
                        duration:
                          type: number
                          example: 1800
                        started_at:
                          type: string
                          example: 2021-03-19T06:08:33.871278372Z
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
    patch:
      summary: End Poll
      description: End an active poll.
      tags:
        - Polls
      security:
        - oauth:
            - channel:manage:polls
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: ed961efd-8a3f-4cf5-a9d0-e616c590cd2a
                        broadcaster_id:
                          type: string
                          example: "141981764"
                        broadcaster_name:
                          type: string
                          example: TwitchDev
                        broadcaster_login:
                          type: string
                          example: twitchdev
                        title:
                          type: string
                          example: Heads or Tails?
                        choices:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: 4c123012-1351-4f33-84b7-43856e7a0f47
                              title:
                                type: string
                                example: Heads
                              votes:
                                type: number
                              channel_points_votes:
                                type: number
                              bits_votes:
                                type: number
                        bits_voting_enabled:
                          type: boolean
                        bits_per_vote:
                          type: number
                        channel_points_voting_enabled:
                          type: boolean
                          example: true
                        channel_points_per_vote:
                          type: number
                          example: 100
                        status:
                          type: string
                          example: TERMINATED
                        duration:
                          type: number
                          example: 1800
                        started_at:
                          type: string
                          example: 2021-03-19T06:08:33.871278372Z
                        ended_at:
                          type: string
                          example: 2021-03-19T06:11:26.746889614Z
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
  /predictions:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Predictions
      description: Gets a list of Channel Points Predictions that the broadcaster created.
      tags:
        - Predictions
      security:
        - oauth:
            - channel:read:predictions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: d6676d5c-c86e-44d2-bfc4-100fb48f0656
                        broadcaster_id:
                          type: string
                          example: "55696719"
                        broadcaster_name:
                          type: string
                          example: TwitchDev
                        broadcaster_login:
                          type: string
                          example: twitchdev
                        title:
                          type: string
                          example: Will there be any leaks today?
                        winning_outcome_id:
                          type: string
                        outcomes:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: 021e9234-5893-49b4-982e-cfe9a0aaddd9
                              title:
                                type: string
                                example: Yes
                              users:
                                type: number
                              channel_points:
                                type: number
                              top_predictors:
                                type: string
                              color:
                                type: string
                                example: BLUE
                        prediction_window:
                          type: number
                          example: 600
                        status:
                          type: string
                          example: ACTIVE
                        created_at:
                          type: string
                          example: 2021-04-28T16:03:06.320848689Z
                        ended_at:
                          type: string
                        locked_at:
                          type: string
                  pagination:
                    type: object
                    properties: {}
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
    post:
      summary: Create Prediction
      description: Create a Channel Points Prediction.
      tags:
        - Predictions
      security:
        - oauth:
            - channel:manage:predictions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: bc637af0-7766-4525-9308-4112f4cbf178
                        broadcaster_id:
                          type: string
                          example: "141981764"
                        broadcaster_name:
                          type: string
                          example: TwitchDev
                        broadcaster_login:
                          type: string
                          example: twitchdev
                        title:
                          type: string
                          example: Any leeks in the stream?
                        winning_outcome_id:
                          type: string
                        outcomes:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: 73085848-a94d-4040-9d21-2cb7a89374b7
                              title:
                                type: string
                                example: Yes, give it time.
                              users:
                                type: number
                              channel_points:
                                type: number
                              top_predictors:
                                type: string
                              color:
                                type: string
                                example: BLUE
                        prediction_window:
                          type: number
                          example: 120
                        status:
                          type: string
                          example: ACTIVE
                        created_at:
                          type: string
                          example: 2021-04-28T17:11:22.595914172Z
                        ended_at:
                          type: string
                        locked_at:
                          type: string
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
    patch:
      summary: End Prediction
      description: Locks, resolves, or cancels a Channel Points Prediction.
      tags:
        - Predictions
      security:
        - oauth:
            - channel:manage:predictions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: bc637af0-7766-4525-9308-4112f4cbf178
                        broadcaster_id:
                          type: string
                          example: "141981764"
                        broadcaster_name:
                          type: string
                          example: TwitchDev
                        broadcaster_login:
                          type: string
                          example: twitchdev
                        title:
                          type: string
                          example: Will we win all the games?
                        winning_outcome_id:
                          type: string
                          example: 73085848-a94d-4040-9d21-2cb7a89374b7
                        outcomes:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: 73085848-a94d-4040-9d21-2cb7a89374b7
                              title:
                                type: string
                                example: yes
                              users:
                                type: number
                              channel_points:
                                type: number
                              top_predictors:
                                type: string
                              color:
                                type: string
                                example: BLUE
                        prediction_window:
                          type: number
                          example: 120
                        status:
                          type: string
                          example: RESOLVED
                        created_at:
                          type: string
                          example: 2021-04-28T21:48:19.480371331Z
                        ended_at:
                          type: string
                          example: 2021-04-28T21:54:24.026833954Z
                        locked_at:
                          type: string
                          example: 2021-04-28T21:48:34.636685705Z
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
  /raids:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Start a raid
      description: Raid another channel by sending the broadcaster’s viewers to the
        targeted channel.
      tags:
        - Raids
      security:
        - oauth:
            - channel:manage:raids
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        created_at:
                          type: string
                          example: 2022-02-18T07:20:50.52Z
                        is_mature:
                          type: boolean
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: from_broadcaster_id
          in: query
          schema:
            type: string
        - name: to_broadcaster_id
          in: query
          schema:
            type: string
    delete:
      summary: Cancel a raid
      description: Cancel a pending raid.
      tags:
        - Raids
      security:
        - oauth:
            - channel:manage:raids
      responses:
        "204":
          description: Deleted
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /schedule:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Channel Stream Schedule
      description: Gets the broadcaster’s streaming schedule.
      tags:
        - Schedule
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      segments:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: eyJzZWdtZW50SUQiOiJlNGFjYzcyNC0zNzFmLTQwMmMtODFjYS0yM2FkYTc5NzU5ZDQiLCJpc29ZZWFyIjoyMDIxLCJpc29XZWVrIjoyNn0=
                            start_time:
                              type: string
                              example: 2021-07-01T18:00:00Z
                            end_time:
                              type: string
                              example: 2021-07-01T19:00:00Z
                            title:
                              type: string
                              example: TwitchDev Monthly Update // July 1, 2021
                            canceled_until:
                              type: string
                            category:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: "509670"
                                name:
                                  type: string
                                  example: Science & Technology
                            is_recurring:
                              type: boolean
                      broadcaster_id:
                        type: string
                        example: "141981764"
                      broadcaster_name:
                        type: string
                        example: TwitchDev
                      broadcaster_login:
                        type: string
                        example: twitchdev
                      vacation:
                        type: string
                  pagination:
                    type: object
                    properties: {}
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: id
          in: query
          schema:
            type: string
        - name: start_time
          in: query
          schema:
            type: string
        - name: utc_offset
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /schedule/icalendar:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Channel iCalendar
      description: Gets the broadcaster’s streaming schedule as an iCalendar.
      tags:
        - Schedule
      security:
        - oauth: []
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /schedule/settings:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    patch:
      summary: Update Channel Stream Schedule
      description: Updates the broadcaster’s schedule settings, such as scheduling a
        vacation.
      tags:
        - Schedule
      security:
        - oauth:
            - channel:manage:schedule
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: is_vacation_enabled
          in: query
          schema:
            type: string
        - name: vacation_start_time
          in: query
          schema:
            type: string
        - name: vacation_end_time
          in: query
          schema:
            type: string
        - name: timezone
          in: query
          schema:
            type: string
  /schedule/segment:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Create Channel Stream Schedule Segment
      description: Adds a single or recurring broadcast to the broadcaster’s streaming
        schedule.
      tags:
        - Schedule
      security:
        - oauth:
            - channel:manage:schedule
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      segments:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: eyJzZWdtZW50SUQiOiJlNGFjYzcyNC0zNzFmLTQwMmMtODFjYS0yM2FkYTc5NzU5ZDQiLCJpc29ZZWFyIjoyMDIxLCJpc29XZWVrIjoyNn0=
                            start_time:
                              type: string
                              example: 2021-07-01T18:00:00Z
                            end_time:
                              type: string
                              example: 2021-07-01T19:00:00Z
                            title:
                              type: string
                              example: TwitchDev Monthly Update // July 1, 2021
                            canceled_until:
                              type: string
                            category:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: "509670"
                                name:
                                  type: string
                                  example: Science & Technology
                            is_recurring:
                              type: boolean
                      broadcaster_id:
                        type: string
                        example: "141981764"
                      broadcaster_name:
                        type: string
                        example: TwitchDev
                      broadcaster_login:
                        type: string
                        example: twitchdev
                      vacation:
                        type: string
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
    patch:
      summary: Update Channel Stream Schedule Segment
      description: Updates a scheduled broadcast segment.
      tags:
        - Schedule
      security:
        - oauth:
            - channel:manage:schedule
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      segments:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: eyJzZWdtZW50SUQiOiJlNGFjYzcyNC0zNzFmLTQwMmMtODFjYS0yM2FkYTc5NzU5ZDQiLCJpc29ZZWFyIjoyMDIxLCJpc29XZWVrIjoyNn0=
                            start_time:
                              type: string
                              example: 2021-07-01T18:00:00Z
                            end_time:
                              type: string
                              example: 2021-07-01T20:00:00Z
                            title:
                              type: string
                              example: TwitchDev Monthly Update // July 1, 2021
                            canceled_until:
                              type: string
                            category:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: "509670"
                                name:
                                  type: string
                                  example: Science & Technology
                            is_recurring:
                              type: boolean
                      broadcaster_id:
                        type: string
                        example: "141981764"
                      broadcaster_name:
                        type: string
                        example: TwitchDev
                      broadcaster_login:
                        type: string
                        example: twitchdev
                      vacation:
                        type: string
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: id
          in: query
          schema:
            type: string
    delete:
      summary: Delete Channel Stream Schedule Segment
      description: Deletes a broadcast from the broadcaster’s streaming schedule.
      tags:
        - Schedule
      security:
        - oauth:
            - channel:manage:schedule
      responses:
        "204":
          description: Deleted
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: id
          in: query
          schema:
            type: string
  /search/categories:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Search Categories
      description: Gets the games or categories that match the specified query.
      tags:
        - Search
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "33214"
                        name:
                          type: string
                          example: Fortnite
                        box_art_url:
                          type: string
                          example: https://static-cdn.jtvnw.net/ttv-boxart/33214-52x72.jpg
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudWxsLCJhIjp7IkN
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: query
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /search/channels:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Search Channels
      description: Gets the channels that match the specified query and have streamed
        content within the past 6 months.
      tags:
        - Search
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_language:
                          type: string
                          example: en
                        broadcaster_login:
                          type: string
                          example: loserfruit
                        display_name:
                          type: string
                          example: Loserfruit
                        game_id:
                          type: string
                          example: "498000"
                        game_name:
                          type: string
                          example: House Flipper
                        id:
                          type: string
                          example: "41245072"
                        is_live:
                          type: boolean
                        tag_ids:
                          type: array
                          items:
                            type: string
                        tags:
                          type: array
                          items:
                            type: string
                        thumbnail_url:
                          type: string
                          example: https://static-cdn.jtvnw.net/jtv_user_pictures/fd17325a-7dc2-46c6-8617-e90ec259501c-profile_image-300x300.png
                        title:
                          type: string
                          example: loserfruit
                        started_at:
                          type: string
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: Mg==
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: query
          in: query
          schema:
            type: string
        - name: live_only
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /streams/key:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Stream Key
      description: Gets the channel’s stream key.
      tags:
        - Streams
      security:
        - oauth:
            - channel:read:stream_key
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        stream_key:
                          type: string
                          example: live_44322889_a34ub37c8ajv98a0
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /streams:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Streams
      description: Gets a list of all streams.
      tags:
        - Streams
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "123456789"
                        user_id:
                          type: string
                          example: "98765"
                        user_login:
                          type: string
                          example: sandysanderman
                        user_name:
                          type: string
                          example: SandySanderman
                        game_id:
                          type: string
                          example: "494131"
                        game_name:
                          type: string
                          example: Little Nightmares
                        type:
                          type: string
                          example: live
                        title:
                          type: string
                          example: hablamos y le damos a Little Nightmares 1
                        tags:
                          type: array
                          items:
                            type: string
                            example: Español
                        viewer_count:
                          type: number
                          example: 78365
                        started_at:
                          type: string
                          example: 2021-03-10T15:04:21Z
                        language:
                          type: string
                          example: es
                        thumbnail_url:
                          type: string
                          example: https://static-cdn.jtvnw.net/previews-ttv/live_user_auronplay-{width}x{height}.jpg
                        tag_ids:
                          type: array
                          items:
                            type: string
                        is_mature:
                          type: boolean
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjp7IkN1cnNvciI6ImV5SnpJam8zT0RNMk5TNDBORFF4TlRjMU1UY3hOU3dpWkNJNlptRnNjMlVzSW5RaU9uUnlkV1Y5In0sImEiOnsiQ3Vyc29yIjoiZXlKeklqb3hOVGs0TkM0MU56RXhNekExTVRZNU1ESXNJbVFpT21aaGJITmxMQ0owSWpwMGNuVmxmUT09In19
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: user_id
          in: query
          schema:
            type: string
        - name: user_login
          in: query
          schema:
            type: string
        - name: game_id
          in: query
          schema:
            type: string
        - name: type
          in: query
          schema:
            type: string
        - name: language
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: before
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /streams/followed:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Followed Streams
      description: Gets the list of broadcasters that the user follows and that are
        streaming live.
      tags:
        - Streams
      security:
        - oauth:
            - user:read:follows
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "42170724654"
                        user_id:
                          type: string
                          example: "132954738"
                        user_login:
                          type: string
                          example: aws
                        user_name:
                          type: string
                          example: AWS
                        game_id:
                          type: string
                          example: "417752"
                        game_name:
                          type: string
                          example: Talk Shows & Podcasts
                        type:
                          type: string
                          example: live
                        title:
                          type: string
                          example: AWS Howdy Partner! Y'all welcome ExtraHop to the show!
                        viewer_count:
                          type: number
                          example: 20
                        started_at:
                          type: string
                          example: 2021-03-31T20:57:26Z
                        language:
                          type: string
                          example: en
                        thumbnail_url:
                          type: string
                          example: https://static-cdn.jtvnw.net/previews-ttv/live_user_aws-{width}x{height}.jpg
                        tag_ids:
                          type: array
                          items:
                            type: string
                        tags:
                          type: array
                          items:
                            type: string
                            example: English
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjp7IkN1cnNvciI6ImV5SnpJam8zT0RNMk5TNDBORFF4TlRjMU1UY3hOU3dpWkNJNlptRnNjMlVzSW5RaU9uUnlkV1Y5In0sImEiOnsiQ3Vyc29yIjoiZXlKeklqb3hOVGs0TkM0MU56RXhNekExTVRZNU1ESXNJbVFpT21aaGJITmxMQ0owSWpwMGNuVmxmUT09In19
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: user_id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /streams/markers:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Create Stream Marker
      description: Adds a marker to a live stream.
      tags:
        - Streams
      security:
        - oauth:
            - channel:manage:broadcast
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                          example: 123
                        created_at:
                          type: string
                          example: 2018-08-20T20:10:03Z
                        description:
                          type: string
                          example: hello, this is a marker!
                        position_seconds:
                          type: number
                          example: 244
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
    get:
      summary: Get Stream Markers
      description: Gets a list of markers from the user’s most recent stream or from
        the specified VOD/video.
      tags:
        - Streams
      security:
        - oauth:
            - user:read:broadcast
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        user_id:
                          type: string
                          example: "123"
                        user_name:
                          type: string
                          example: TwitchName
                        user_login:
                          type: string
                          example: twitchname
                        videos:
                          type: array
                          items:
                            type: object
                            properties:
                              video_id:
                                type: string
                                example: "456"
                              markers:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: 106b8d6243a4f883d25ad75e6cdffdc4
                                    created_at:
                                      type: string
                                      example: 2018-08-20T20:10:03Z
                                    description:
                                      type: string
                                      example: hello, this is a marker!
                                    position_seconds:
                                      type: number
                                      example: 244
                                    URL:
                                      type: string
                                      example: https://twitch.tv/twitchname/manager/highlighter/456?t=0h4m06s
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiIjpudWxsLCJhIjoiMjk1MjA0Mzk3OjI1Mzpib29rbWFyazoxMDZiOGQ1Y
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: user_id
          in: query
          schema:
            type: string
        - name: video_id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: before
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /subscriptions:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Broadcaster Subscriptions
      description: Gets a list of users that subscribe to the specified broadcaster.
      tags:
        - Subscriptions
      security:
        - oauth:
            - channel:read:subscriptions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_id:
                          type: string
                          example: "141981764"
                        broadcaster_login:
                          type: string
                          example: twitchdev
                        broadcaster_name:
                          type: string
                          example: TwitchDev
                        gifter_id:
                          type: string
                          example: "12826"
                        gifter_login:
                          type: string
                          example: twitch
                        gifter_name:
                          type: string
                          example: Twitch
                        is_gift:
                          type: boolean
                          example: true
                        tier:
                          type: string
                          example: "1000"
                        plan_name:
                          type: string
                          example: Channel Subscription (twitchdev)
                        user_id:
                          type: string
                          example: "527115020"
                        user_name:
                          type: string
                          example: twitchgaming
                        user_login:
                          type: string
                          example: twitchgaming
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: xxxx
                  total:
                    type: number
                    example: 13
                  points:
                    type: number
                    example: 13
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: user_id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
        - name: before
          in: query
          schema:
            type: string
  /subscriptions/user:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Check User Subscription
      description: Checks whether the user subscribes to the broadcaster’s channel.
      tags:
        - Subscriptions
      security:
        - oauth:
            - user:read:subscriptions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_id:
                          type: string
                          example: "149747285"
                        broadcaster_name:
                          type: string
                          example: TwitchPresents
                        broadcaster_login:
                          type: string
                          example: twitchpresents
                        is_gift:
                          type: boolean
                        tier:
                          type: string
                          example: "1000"
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: user_id
          in: query
          schema:
            type: string
  /tags/streams:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get All Stream Tags
      description: Gets the list of all stream tags that Twitch defines. You can also
        filter the list by one or more tag IDs.
      tags:
        - Tags
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        tag_id:
                          type: string
                          example: 621fb5bf-5498-4d8f-b4ac-db4d40d401bf
                        is_auto:
                          type: boolean
                        localization_names:
                          type: object
                          properties:
                            bg-bg:
                              type: string
                              example: Изчистване на 1 кредит
                            cs-cz:
                              type: string
                              example: 1 čistý kredit
                            da-dk:
                              type: string
                              example: 1 credit klaret
                            de-de:
                              type: string
                              example: Mit 1 Leben abschließen
                            el-gr:
                              type: string
                              example: 1 μόνο πίστωση
                            en-us:
                              type: string
                              example: 1 Credit Clear
                        localization_descriptions:
                          type: object
                          properties:
                            bg-bg:
                              type: string
                              example: За потоци с акцент върху завършване на аркадна игра с монети, в която
                                не се използва продължаване
                            cs-cz:
                              type: string
                              example: Pro vysílání s důrazem na plnění mincových arkádových her bez použití
                                pokračování.
                            da-dk:
                              type: string
                              example: Til streams med vægt på at gennemføre et arkadespil uden at bruge
                                continues
                            de-de:
                              type: string
                              example: Für Streams mit dem Ziel, ein Coin-op-Arcade-Game mit nur einem Leben
                                abzuschließen.
                            el-gr:
                              type: string
                              example: Για μεταδόσεις με έμφαση στην ολοκλήρωση παλαιού τύπου ηλεκτρονικών
                                παιχνιδιών που λειτουργούν με κέρμα, χωρίς να
                                χρησιμοποιούν συνέχειες
                            en-us:
                              type: string
                              example: For streams with an emphasis on completing a coin-op arcade game
                                without using any continues
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        example: eyJiI...
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: tag_id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
  /streams/tags:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Stream Tags
      description: Gets the list of stream tags that the broadcaster or Twitch added
        to their channel.
      tags:
        - Tags
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        tag_id:
                          type: string
                          example: 6ea6bca4-4712-4ab9-a906-e3336a9d8039
                        is_auto:
                          type: boolean
                          example: true
                        localization_names:
                          type: object
                          properties:
                            bg-bg:
                              type: string
                              example: английски
                            cs-cz:
                              type: string
                              example: Angličtina
                            da-dk:
                              type: string
                              example: Engelsk
                            de-de:
                              type: string
                              example: Englisch
                            el-gr:
                              type: string
                              example: Αγγλικά
                            en-us:
                              type: string
                              example: English
                        localization_descriptions:
                          type: object
                          properties:
                            bg-bg:
                              type: string
                              example: За потоци с използване на английски
                            cs-cz:
                              type: string
                              example: Pro vysílání obsahující angličtinu.
                            da-dk:
                              type: string
                              example: Til streams, hvori der indgår engelsk
                            de-de:
                              type: string
                              example: Für Streams auf Englisch.
                            el-gr:
                              type: string
                              example: Για μεταδόσεις που περιλαμβάνουν τη χρήση Αγγλικών
                            en-us:
                              type: string
                              example: For streams featuring the use of English
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /teams/channel:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Channel Teams
      description: Gets the list of Twitch teams that the broadcaster is a member of.
      tags:
        - Teams
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        broadcaster_id:
                          type: string
                          example: "96909659"
                        broadcaster_name:
                          type: string
                          example: CSharpFritz
                        broadcaster_login:
                          type: string
                          example: csharpfritz
                        background_image_url:
                          type: string
                        banner:
                          type: string
                        created_at:
                          type: string
                          example: 2019-02-11T12:09:22Z
                        updated_at:
                          type: string
                          example: 2020-11-18T15:56:41Z
                        info:
                          type: string
                          example: <p>An outgoing and enthusiastic group of friendly channels that write
                            code, teach about technology, and promote the
                            technical community.</p>
                        thumbnail_url:
                          type: string
                          example: https://static-cdn.jtvnw.net/jtv_user_pictures/team-livecoders-team_logo_image-bf1d9a87ca81432687de60e24ad9593d-600x600.png
                        team_name:
                          type: string
                          example: livecoders
                        team_display_name:
                          type: string
                          example: Live Coders
                        id:
                          type: string
                          example: "6358"
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
  /teams:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Teams
      description: Gets information about the specified Twitch team.
      tags:
        - Teams
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        users:
                          type: array
                          items:
                            type: object
                            properties:
                              user_id:
                                type: string
                                example: "278217731"
                              user_name:
                                type: string
                                example: mastermndio
                              user_login:
                                type: string
                                example: mastermndio
                        background_image_url:
                          type: string
                        banner:
                          type: string
                        created_at:
                          type: string
                          example: 2019-02-11T12:09:22Z
                        updated_at:
                          type: string
                          example: 2020-11-18T15:56:41Z
                        info:
                          type: string
                          example: <p>An outgoing and enthusiastic group of friendly channels that write
                            code, teach about technology, and promote the
                            technical community.</p>
                        thumbnail_url:
                          type: string
                          example: https://static-cdn.jtvnw.net/jtv_user_pictures/team-livecoders-team_logo_image-bf1d9a87ca81432687de60e24ad9593d-600x600.png
                        team_name:
                          type: string
                          example: livecoders
                        team_display_name:
                          type: string
                          example: Live Coders
                        id:
                          type: string
                          example: "6358"
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: name
          in: query
          schema:
            type: string
        - name: id
          in: query
          schema:
            type: string
  /users:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Users
      description: Gets information about one or more users.
      tags:
        - Users
      security:
        - oauth:
            - user:read:email
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "141981764"
                        login:
                          type: string
                          example: twitchdev
                        display_name:
                          type: string
                          example: TwitchDev
                        type:
                          type: string
                        broadcaster_type:
                          type: string
                          example: partner
                        description:
                          type: string
                          example: Supporting third-party developers building Twitch integrations from
                            chatbots to game integrations.
                        profile_image_url:
                          type: string
                          example: https://static-cdn.jtvnw.net/jtv_user_pictures/8a6381c7-d0c0-4576-b179-38bd5ce1d6af-profile_image-300x300.png
                        offline_image_url:
                          type: string
                          example: https://static-cdn.jtvnw.net/jtv_user_pictures/3f13ab61-ec78-4fe6-8481-8682cb3b0ac2-channel_offline_image-1920x1080.png
                        view_count:
                          type: number
                          example: 5980557
                        email:
                          type: string
                          example: not-real@email.com
                        created_at:
                          type: string
                          example: 2016-12-14T20:32:28Z
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: id
          in: query
          schema:
            type: string
        - name: login
          in: query
          schema:
            type: string
    put:
      summary: Update User
      description: Updates the user’s information.
      tags:
        - Users
      security:
        - oauth:
            - user:edit
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "44322889"
                        login:
                          type: string
                          example: dallas
                        display_name:
                          type: string
                          example: dallas
                        type:
                          type: string
                          example: staff
                        broadcaster_type:
                          type: string
                          example: affiliate
                        description:
                          type: string
                          example: BaldAngel
                        profile_image_url:
                          type: string
                          example: https://static-cdn.jtvnw.net/jtv_user_pictures/4d1f36cbf1f0072d-profile_image-300x300.png
                        offline_image_url:
                          type: string
                          example: https://static-cdn.jtvnw.net/jtv_user_pictures/dallas-channel_offline_image-2e82c1df2a464df7-1920x1080.jpeg
                        view_count:
                          type: number
                          example: 6995
                        email:
                          type: string
                          example: not-real@email.com
                        created_at:
                          type: string
                          example: 2013-06-03T19:12:02.580593Z
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: description
          in: query
          schema:
            type: string
  /users/blocks:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get User Block List
      description: Gets the list of users that the broadcaster has blocked.
      tags:
        - Users
      security:
        - oauth:
            - user:read:blocked_users
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        user_id:
                          type: string
                          example: "135093069"
                        user_login:
                          type: string
                          example: bluelava
                        display_name:
                          type: string
                          example: BlueLava
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: broadcaster_id
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
    put:
      summary: Block User
      description: Blocks the specified user from interacting with or having contact
        with the broadcaster.
      tags:
        - Users
      security:
        - oauth:
            - user:manage:blocked_users
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: target_user_id
          in: query
          schema:
            type: string
        - name: source_context
          in: query
          schema:
            type: string
        - name: reason
          in: query
          schema:
            type: string
    delete:
      summary: Unblock User
      description: Removes the user from the broadcaster’s list of blocked users.
      tags:
        - Users
      security:
        - oauth:
            - user:manage:blocked_users
      responses:
        "204":
          description: Deleted
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: target_user_id
          in: query
          schema:
            type: string
  /users/extensions/list:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get User Extensions
      description: Gets a list of all extensions (both active and inactive) that the
        broadcaster has installed.
      tags:
        - Users
      security:
        - oauth:
            - user:read:broadcast
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: wi08ebtatdc7oj83wtl9uxwz807l8b
                        version:
                          type: string
                          example: 1.1.8
                        name:
                          type: string
                          example: Streamlabs Leaderboard
                        can_activate:
                          type: boolean
                          example: true
                        type:
                          type: array
                          items:
                            type: string
                            example: panel
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
  /users/extensions:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get User Active Extensions
      description: Gets the active extensions that the broadcaster has installed for
        each configuration.
      tags:
        - Users
      security:
        - oauth:
            - channel:manage:extensions
            - user:read:broadcast
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      panel:
                        type: object
                        properties:
                          "1":
                            type: object
                            properties:
                              active:
                                type: boolean
                                example: true
                              id:
                                type: string
                                example: rh6jq1q334hqc2rr1qlzqbvwlfl3x0
                              version:
                                type: string
                                example: 1.1.0
                              name:
                                type: string
                                example: TopClip
                          "2":
                            type: object
                            properties:
                              active:
                                type: boolean
                                example: true
                              id:
                                type: string
                                example: wi08ebtatdc7oj83wtl9uxwz807l8b
                              version:
                                type: string
                                example: 1.1.8
                              name:
                                type: string
                                example: Streamlabs Leaderboard
                          "3":
                            type: object
                            properties:
                              active:
                                type: boolean
                                example: true
                              id:
                                type: string
                                example: naty2zwfp7vecaivuve8ef1hohh6bo
                              version:
                                type: string
                                example: 1.0.9
                              name:
                                type: string
                                example: Streamlabs Stream Schedule & Countdown
                      overlay:
                        type: object
                        properties:
                          "1":
                            type: object
                            properties:
                              active:
                                type: boolean
                                example: true
                              id:
                                type: string
                                example: zfh2irvx2jb4s60f02jq0ajm8vwgka
                              version:
                                type: string
                                example: 1.0.19
                              name:
                                type: string
                                example: Streamlabs
                      component:
                        type: object
                        properties:
                          "1":
                            type: object
                            properties:
                              active:
                                type: boolean
                                example: true
                              id:
                                type: string
                                example: lqnf3zxk0rv0g7gq92mtmnirjz2cjj
                              version:
                                type: string
                                example: 0.0.1
                              name:
                                type: string
                                example: Dev Experience Test
                              x:
                                type: number
                              y:
                                type: number
                          "2":
                            type: object
                            properties:
                              active:
                                type: boolean
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: user_id
          in: query
          schema:
            type: string
    put:
      summary: Update User Extensions
      description: Updates an installed extension’s information.
      tags:
        - Users
      security:
        - oauth:
            - channel:manage:extensions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      panel:
                        type: object
                        properties:
                          "1":
                            type: object
                            properties:
                              active:
                                type: boolean
                                example: true
                              id:
                                type: string
                                example: rh6jq1q334hqc2rr1qlzqbvwlfl3x0
                              version:
                                type: string
                                example: 1.1.0
                              name:
                                type: string
                                example: TopClip
                          "2":
                            type: object
                            properties:
                              active:
                                type: boolean
                                example: true
                              id:
                                type: string
                                example: wi08ebtatdc7oj83wtl9uxwz807l8b
                              version:
                                type: string
                                example: 1.1.8
                              name:
                                type: string
                                example: Streamlabs Leaderboard
                          "3":
                            type: object
                            properties:
                              active:
                                type: boolean
                                example: true
                              id:
                                type: string
                                example: naty2zwfp7vecaivuve8ef1hohh6bo
                              version:
                                type: string
                                example: 1.0.9
                              name:
                                type: string
                                example: Streamlabs Stream Schedule & Countdown
                      overlay:
                        type: object
                        properties:
                          "1":
                            type: object
                            properties:
                              active:
                                type: boolean
                                example: true
                              id:
                                type: string
                                example: zfh2irvx2jb4s60f02jq0ajm8vwgka
                              version:
                                type: string
                                example: 1.0.19
                              name:
                                type: string
                                example: Streamlabs
                      component:
                        type: object
                        properties:
                          "1":
                            type: object
                            properties:
                              active:
                                type: boolean
                                example: true
                              id:
                                type: string
                                example: lqnf3zxk0rv0g7gq92mtmnirjz2cjj
                              version:
                                type: string
                                example: 0.0.1
                              name:
                                type: string
                                example: Dev Experience Test
                              x:
                                type: number
                              y:
                                type: number
                          "2":
                            type: object
                            properties:
                              active:
                                type: boolean
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
  /videos:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    get:
      summary: Get Videos
      description: Gets information about one or more published videos.
      tags:
        - Videos
      security:
        - oauth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "335921245"
                        stream_id:
                          type: string
                        user_id:
                          type: string
                          example: "141981764"
                        user_login:
                          type: string
                          example: twitchdev
                        user_name:
                          type: string
                          example: TwitchDev
                        title:
                          type: string
                          example: Twitch Developers 101
                        description:
                          type: string
                          example: Welcome to Twitch development! Here is a quick overview of our products
                            and information to help you get started.
                        created_at:
                          type: string
                          example: 2018-11-14T21:30:18Z
                        published_at:
                          type: string
                          example: 2018-11-14T22:04:30Z
                        url:
                          type: string
                          example: https://www.twitch.tv/videos/335921245
                        thumbnail_url:
                          type: string
                          example: https://static-cdn.jtvnw.net/cf_vods/d2nvs31859zcd8/twitchdev/335921245/ce0f3a7f-57a3-4152-bc06-0c6610189fb3/thumb/index-0000000000-%{width}x%{height}.jpg
                        viewable:
                          type: string
                          example: public
                        view_count:
                          type: number
                          example: 1863062
                        language:
                          type: string
                          example: en
                        type:
                          type: string
                          example: upload
                        duration:
                          type: string
                          example: 3m21s
                        muted_segments:
                          type: array
                          items:
                            type: object
                            properties:
                              duration:
                                type: number
                                example: 30
                              offset:
                                type: number
                                example: 120
                  pagination:
                    type: object
                    properties: {}
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: id
          in: query
          schema:
            type: string
        - name: user_id
          in: query
          schema:
            type: string
        - name: game_id
          in: query
          schema:
            type: string
        - name: language
          in: query
          schema:
            type: string
        - name: period
          in: query
          schema:
            type: string
        - name: sort
          in: query
          schema:
            type: string
        - name: type
          in: query
          schema:
            type: string
        - name: first
          in: query
          schema:
            type: string
        - name: after
          in: query
          schema:
            type: string
        - name: before
          in: query
          schema:
            type: string
    delete:
      summary: Delete Videos
      description: Deletes one or more videos.
      tags:
        - Videos
      security:
        - oauth:
            - channel:manage:videos
      responses:
        "204":
          description: Deleted
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: id
          in: query
          schema:
            type: string
  /whispers:
    parameters:
      - in: header
        name: client_id
        required: true
        schema:
          type: string
    post:
      summary: Send Whisper
      description: Sends a whisper message to the specified user.
      tags:
        - Whispers
      security:
        - oauth:
            - user:manage:whispers
      responses:
        "200":
          description: OK
        "401":
          description: "Unauthenticated: Missing/invalid Token"
        "404":
          description: Not Found
        "500":
          description: "Internal Server Error: Something bad happened on our side"
      parameters:
        - name: from_user_id
          in: query
          schema:
            type: string
        - name: to_user_id
          in: query
          schema:
            type: string
components:
  securitySchemes:
    oauth:
      type: oauth2
      description: Twitch APIs use OAuth 2.0 access tokens to access resources. If
        you’re not already familiar with the specification, reading it may help
        you better understand how to get access tokens to use with the Twitch
        API.
      flows:
        implicit:
          authorizationUrl: https://id.twitch.tv/oauth2/authorize
          scopes:
            channel:edit:commercial: Run commercials on a channel.
            channel:read:ads: Read the ads schedule and details on your channel.
            channel:manage:ads: Manage ads schedule on a channel.
            analytics:read:extensions: View analytics data for the Twitch Extensions owned
              by the authenticated account.
            analytics:read:games: View analytics data for the games owned by the
              authenticated account.
            bits:read: View Bits information for a channel.
            channel:manage:broadcast: Manage a channel’s broadcast configuration, including
              updating channel configuration and managing stream markers and
              stream tags.
            channel:read:editors: View a list of users with the editor role for a channel.
            user:read:follows: View the list of channels a user follows.
            moderator:read:followers: Read the followers of a broadcaster.
            channel:manage:redemptions: Manage Channel Points custom rewards and their
              redemptions on a channel.
            channel:read:redemptions: View Channel Points custom rewards and their
              redemptions on a channel.
            channel:read:charity: Read charity campaign details and user donations on your channel.
            moderator:read:chatters: View the chatters in a broadcaster’s chat room.
            moderator:read:chat_settings: View a broadcaster’s chat room settings.
            user:read:emotes: View emotes available to a user
            moderator:manage:chat_settings: Manage a broadcaster’s chat room settings.
            moderator:manage:announcements: Send announcements in channels where you have the moderator role.
            moderator:manage:shoutouts: Manage a broadcaster’s shoutouts.
            user:manage:chat_color: Update the color used for the user’s name in chat.
            clips:edit: Manage Clips for a channel.
            channel:read:goals: View Creator Goals for a channel.
            channel:read:guest_star: Read Guest Star details for your channel.
            moderator:read:guest_star: Read Guest Star details for channels where you are a
              Guest Star moderator.
            channel:manage:guest_star: Manage Guest Star for your channel.
            moderator:manage:guest_star: Manage Guest Star for channels where you are a
              Guest Star moderator.
            channel:read:hype_train: View Hype Train information for a channel.
            moderation:read: View a channel’s moderation data including Moderators, Bans,
              Timeouts, and Automod settings.
            moderator:manage:automod: Manage messages held for review by AutoMod in channels
              where you are a moderator.
            moderator:read:automod_settings: View a broadcaster’s AutoMod settings.
            moderator:manage:automod_settings: Manage a broadcaster’s AutoMod settings.
            moderator:manage:banned_users: Ban and unban users.
            moderator:read:unban_requests: View a broadcaster’s unban requests.
            moderator:manage:unban_requests: Manage a broadcaster’s unban requests.
            moderator:read:blocked_terms: View a broadcaster’s list of blocked terms.
            moderator:manage:blocked_terms: Manage a broadcaster’s list of blocked terms.
            moderator:manage:chat_messages: Delete chat messages in channels where you have the moderator role
            user:read:moderated_channels: Read the list of channels you have moderator privileges in.
            channel:manage:moderators: Add or remove the moderator role from users in your channel.
            channel:read:vips: Read the list of VIPs in your channel.
            channel:manage:vips: Add or remove the VIP role from users in your channel.
            moderator:manage:shield_mode: Manage a broadcaster’s Shield Mode status.
            moderator:read:shield_mode: View a broadcaster’s Shield Mode status.
            channel:read:polls: View a channel’s polls.
            channel:manage:polls: Manage a channel’s polls.
            channel:read:predictions: View a channel’s Channel Points Predictions.
            channel:manage:predictions: Manage of channel’s Channel Points Predictions
            channel:manage:raids: Manage a channel raiding another channel.
            channel:manage:schedule: Manage a channel’s stream schedule.
            channel:read:stream_key: View an authorized user’s stream key.
            user:read:broadcast: View a user’s broadcasting configuration, including
              Extension configurations.
            channel:read:subscriptions: View a list of all subscribers to a channel and
              check if a user is subscribed to a channel.
            user:read:subscriptions: View if an authorized user is subscribed to specific channels.
            user:read:email: View a user’s email address.
            user:edit: Manage a user object.
            user:read:blocked_users: View the block list of a user.
            user:manage:blocked_users: Manage the block list of a user.
            channel:manage:extensions: Manage a channel’s Extension configuration, including
              activating Extensions.
            channel:manage:videos: Manage a channel’s videos, including deleting videos.
            user:manage:whispers: Read whispers that you send and receive, and send whispers
              on your behalf.
        authorizationCode:
          authorizationUrl: https://id.twitch.tv/oauth2/authorize
          tokenUrl: https://id.twitch.tv/oauth2/token
          scopes:
            channel:edit:commercial: Run commercials on a channel.
            channel:read:ads: Read the ads schedule and details on your channel.
            channel:manage:ads: Manage ads schedule on a channel.
            analytics:read:extensions: View analytics data for the Twitch Extensions owned
              by the authenticated account.
            analytics:read:games: View analytics data for the games owned by the
              authenticated account.
            bits:read: View Bits information for a channel.
            channel:manage:broadcast: Manage a channel’s broadcast configuration, including
              updating channel configuration and managing stream markers and
              stream tags.
            channel:read:editors: View a list of users with the editor role for a channel.
            user:read:follows: View the list of channels a user follows.
            moderator:read:followers: Read the followers of a broadcaster.
            channel:manage:redemptions: Manage Channel Points custom rewards and their
              redemptions on a channel.
            channel:read:redemptions: View Channel Points custom rewards and their
              redemptions on a channel.
            channel:read:charity: Read charity campaign details and user donations on your channel.
            moderator:read:chatters: View the chatters in a broadcaster’s chat room.
            moderator:read:chat_settings: View a broadcaster’s chat room settings.
            user:read:emotes: View emotes available to a user
            moderator:manage:chat_settings: Manage a broadcaster’s chat room settings.
            moderator:manage:announcements: Send announcements in channels where you have the moderator role.
            moderator:manage:shoutouts: Manage a broadcaster’s shoutouts.
            user:manage:chat_color: Update the color used for the user’s name in chat.
            clips:edit: Manage Clips for a channel.
            channel:read:goals: View Creator Goals for a channel.
            channel:read:guest_star: Read Guest Star details for your channel.
            moderator:read:guest_star: Read Guest Star details for channels where you are a
              Guest Star moderator.
            channel:manage:guest_star: Manage Guest Star for your channel.
            moderator:manage:guest_star: Manage Guest Star for channels where you are a
              Guest Star moderator.
            channel:read:hype_train: View Hype Train information for a channel.
            moderation:read: View a channel’s moderation data including Moderators, Bans,
              Timeouts, and Automod settings.
            moderator:manage:automod: Manage messages held for review by AutoMod in channels
              where you are a moderator.
            moderator:read:automod_settings: View a broadcaster’s AutoMod settings.
            moderator:manage:automod_settings: Manage a broadcaster’s AutoMod settings.
            moderator:manage:banned_users: Ban and unban users.
            moderator:read:unban_requests: View a broadcaster’s unban requests.
            moderator:manage:unban_requests: Manage a broadcaster’s unban requests.
            moderator:read:blocked_terms: View a broadcaster’s list of blocked terms.
            moderator:manage:blocked_terms: Manage a broadcaster’s list of blocked terms.
            moderator:manage:chat_messages: Delete chat messages in channels where you have the moderator role
            user:read:moderated_channels: Read the list of channels you have moderator privileges in.
            channel:manage:moderators: Add or remove the moderator role from users in your channel.
            channel:read:vips: Read the list of VIPs in your channel.
            channel:manage:vips: Add or remove the VIP role from users in your channel.
            moderator:manage:shield_mode: Manage a broadcaster’s Shield Mode status.
            moderator:read:shield_mode: View a broadcaster’s Shield Mode status.
            channel:read:polls: View a channel’s polls.
            channel:manage:polls: Manage a channel’s polls.
            channel:read:predictions: View a channel’s Channel Points Predictions.
            channel:manage:predictions: Manage of channel’s Channel Points Predictions
            channel:manage:raids: Manage a channel raiding another channel.
            channel:manage:schedule: Manage a channel’s stream schedule.
            channel:read:stream_key: View an authorized user’s stream key.
            user:read:broadcast: View a user’s broadcasting configuration, including
              Extension configurations.
            channel:read:subscriptions: View a list of all subscribers to a channel and
              check if a user is subscribed to a channel.
            user:read:subscriptions: View if an authorized user is subscribed to specific channels.
            user:read:email: View a user’s email address.
            user:edit: Manage a user object.
            user:read:blocked_users: View the block list of a user.
            user:manage:blocked_users: Manage the block list of a user.
            channel:manage:extensions: Manage a channel’s Extension configuration, including
              activating Extensions.
            channel:manage:videos: Manage a channel’s videos, including deleting videos.
            user:manage:whispers: Read whispers that you send and receive, and send whispers
              on your behalf.
        clientCredentials:
          tokenUrl: https://id.twitch.tv/oauth2/token
          scopes: {}