> ## Documentation Index
> Fetch the complete documentation index at: https://docs.poix.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get popular videos

> Get popular videos with filters



## OpenAPI

````yaml get /popularVideos
openapi: 3.1.0
info:
  version: 1.0.0
  title: Poix API
servers:
  - url: https://api.poix.io
    description: Production server
security: []
paths:
  /popularVideos:
    get:
      summary: Get poplar videos
      description: Get popular videos with filters
      operationId: getPopularVideos
      parameters:
        - schema:
            type: string
            enum:
              - af
              - am
              - ar
              - as
              - az
              - be
              - bg
              - bn
              - bs
              - ca
              - cs
              - da
              - de
              - el
              - en-GB
              - en-IN
              - en
              - es
              - es-419
              - es-US
              - et
              - eu
              - fa
              - fi
              - fil
              - fr-CA
              - fr
              - gl
              - gu
              - hi
              - hr
              - hu
              - hy
              - id
              - is
              - it
              - iw
              - ja
              - ka
              - kk
              - km
              - kn
              - ko
              - ky
              - lo
              - lt
              - lv
              - mk
              - ml
              - mn
              - mr
              - ms
              - my
              - 'no'
              - ne
              - nl
              - or
              - pa
              - pl
              - pt
              - pt-PT
              - ro
              - ru
              - si
              - sk
              - sl
              - sq
              - sr-Latn
              - sr
              - sv
              - sw
              - ta
              - te
              - th
              - tr
              - uk
              - ur
              - uz
              - vi
              - zh-CN
              - zh-HK
              - zh-TW
              - zu
            description: The language to retrieve localized data in.
          required: false
          description: The language to retrieve localized data in.
          name: hl
          in: query
        - schema:
            type: string
            enum:
              - AD
              - AE
              - AF
              - AG
              - AI
              - AL
              - AM
              - AN
              - AO
              - AQ
              - AR
              - AS
              - AT
              - AU
              - AW
              - AX
              - AZ
              - BA
              - BB
              - BD
              - BE
              - BF
              - BG
              - BH
              - BI
              - BJ
              - BM
              - BN
              - BO
              - BR
              - BS
              - BT
              - BV
              - BW
              - BY
              - BZ
              - CA
              - CC
              - CD
              - CF
              - CG
              - CH
              - CI
              - CK
              - CL
              - CM
              - CN
              - CO
              - CR
              - CU
              - CV
              - CX
              - CY
              - CZ
              - DE
              - DJ
              - DK
              - DM
              - DO
              - DZ
              - EC
              - EE
              - EG
              - EH
              - ER
              - ES
              - ET
              - EU
              - FI
              - FJ
              - FK
              - FM
              - FO
              - FR
              - GA
              - GB
              - GD
              - GE
              - GF
              - GG
              - GH
              - GI
              - GL
              - GM
              - GN
              - GP
              - GQ
              - GR
              - GS
              - GT
              - GU
              - GW
              - GY
              - HK
              - HM
              - HN
              - HR
              - HT
              - HU
              - ID
              - IE
              - IL
              - IM
              - IN
              - IO
              - IQ
              - IR
              - IS
              - IT
              - JE
              - JM
              - JO
              - JP
              - KE
              - KG
              - KH
              - KI
              - KM
              - KN
              - KP
              - KR
              - KW
              - KY
              - KZ
              - LA
              - LB
              - LC
              - LI
              - LK
              - LR
              - LS
              - LT
              - LU
              - LV
              - LY
              - MA
              - MC
              - MD
              - ME
              - MG
              - MH
              - MK
              - ML
              - MM
              - MN
              - MO
              - MP
              - MQ
              - MR
              - MS
              - MT
              - MU
              - MV
              - MW
              - MX
              - MY
              - MZ
              - NA
              - NC
              - NE
              - NF
              - NG
              - NI
              - NL
              - 'NO'
              - NP
              - NR
              - NU
              - NZ
              - OM
              - PA
              - PE
              - PF
              - PG
              - PH
              - PK
              - PL
              - PM
              - PN
              - PR
              - PS
              - PT
              - PW
              - PY
              - QA
              - RE
              - RO
              - RS
              - RU
              - RW
              - SA
              - SB
              - SC
              - SD
              - SE
              - SG
              - SH
              - SI
              - SJ
              - SK
              - SL
              - SM
              - SN
              - SO
              - SR
              - ST
              - SV
              - SY
              - SZ
              - TC
              - TD
              - TF
              - TG
              - TH
              - TJ
              - TK
              - TL
              - TM
              - TN
              - TO
              - TR
              - TT
              - TV
              - TW
              - TZ
              - UA
              - UG
              - UM
              - US
              - UY
              - UZ
              - VA
              - VC
              - VE
              - VG
              - VI
              - VN
              - VU
              - WF
              - WS
              - XK
              - YE
              - YT
              - ZA
              - ZM
              - ZW
            description: >-
              Instructs the API to return results for videos that can be viewed
              in the specified country. The parameter value is an ISO 3166-1
              alpha-2 country code.
          required: false
          description: >-
            Instructs the API to return results for videos that can be viewed in
            the specified country. The parameter value is an ISO 3166-1 alpha-2
            country code.
          name: regionCode
          in: query
        - schema:
            type: string
            enum:
              - '0'
              - '1'
              - '2'
              - '10'
              - '15'
              - '17'
              - '18'
              - '19'
              - '20'
              - '21'
              - '22'
              - '23'
              - '24'
              - '25'
              - '26'
              - '27'
              - '28'
              - '29'
              - '30'
              - '31'
              - '32'
              - '33'
              - '34'
              - '35'
              - '36'
              - '37'
              - '38'
              - '39'
              - '40'
              - '41'
              - '42'
              - '43'
              - '44'
            description: Filters video search results based on their category.
          required: false
          description: Filters video search results based on their category.
          name: videoCategoryId
          in: query
        - schema:
            type: string
            description: >-
              An array of fields to include in the response. If not provided,
              all fields will be returned.
          required: false
          description: >-
            An array of fields to include in the response. If not provided, all
            fields will be returned.
          name: fields
          in: query
        - schema:
            type: string
            default: '50'
            description: >-
              Specifies the maximum number of items that should be returned in
              the result set.
          required: false
          description: >-
            Specifies the maximum number of items that should be returned in the
            result set.
          name: maxResults
          in: query
        - schema:
            type: string
            description: >-
              The page token to get the next page of comment threads if
              available
          required: false
          description: The page token to get the next page of comment threads if available
          name: pageToken
          in: query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalResults:
                    type: number
                    description: Total number of popular videos returned.
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: The unique ID of the video.
                        publishedAt:
                          type: string
                          description: The date and time when the video was published.
                        channelId:
                          type: string
                          description: The ID of the channel that owns the video.
                        title:
                          type: string
                          description: The title of the video.
                        description:
                          type: string
                          description: The description of the video.
                        thumbnails:
                          type: object
                          properties:
                            default:
                              type: object
                              properties:
                                url:
                                  type: string
                                  description: The URL of the thumbnail image.
                                width:
                                  type: number
                                  description: The width of the thumbnail image.
                                height:
                                  type: number
                                  description: The height of the thumbnail image.
                              required:
                                - url
                                - width
                                - height
                            medium:
                              type: object
                              properties:
                                url:
                                  type: string
                                  description: The URL of the thumbnail image.
                                width:
                                  type: number
                                  description: The width of the thumbnail image.
                                height:
                                  type: number
                                  description: The height of the thumbnail image.
                              required:
                                - url
                                - width
                                - height
                            high:
                              type: object
                              properties:
                                url:
                                  type: string
                                  description: The URL of the thumbnail image.
                                width:
                                  type: number
                                  description: The width of the thumbnail image.
                                height:
                                  type: number
                                  description: The height of the thumbnail image.
                              required:
                                - url
                                - width
                                - height
                          required:
                            - default
                            - medium
                            - high
                          description: >-
                            The thumbnails for the video, available in different
                            sizes.
                        channelTitle:
                          type: string
                          description: The title of the channel that owns the video.
                        tags:
                          type: array
                          items:
                            type: string
                          description: An array of tags associated with the video.
                        categoryId:
                          type: string
                          description: The ID of the category the video belongs to.
                        defaultLanguage:
                          type: string
                          description: The default language of the video.
                        defaultAudioLanguage:
                          type: string
                          description: The default audio language of the video.
                        viewCount:
                          type: string
                          description: The number of views the video has received.
                        likeCount:
                          type: string
                          description: The number of likes the video has received.
                        commentCount:
                          type: string
                          description: The number of comments on the video.
                        topicCategories:
                          type: array
                          items:
                            type: string
                          description: >-
                            An array of topic categories associated with the
                            video.
                        uploadStatus:
                          type: string
                          description: The upload status of the video.
                        privacyStatus:
                          type: string
                          description: The privacy status of the video.
                        license:
                          type: string
                          description: The license type of the video.
                        embeddable:
                          type: boolean
                          description: Indicates if the video can be embedded.
                        publicStatsViewable:
                          type: boolean
                          description: >-
                            Indicates if the video statistics are publicly
                            viewable.
                        madeForKids:
                          type: boolean
                          description: Indicates if the video is made for kids.
                        hasPaidProductPlacement:
                          type: boolean
                          description: Indicates if the video has paid product placement.
                        localizations:
                          type: object
                          additionalProperties:
                            type: object
                            properties:
                              title:
                                type: string
                                description: The localized title of the video.
                              description:
                                type: string
                                description: The localized description of the video.
                            required:
                              - title
                              - description
                          description: Localized titles and descriptions for the video.
                        categoryTitle:
                          type: string
                          description: The title of the category the video belongs to.
                        duration:
                          type: string
                          description: The duration of the video.
                        parsedDuration:
                          type: number
                          description: The parsed duration of the video in seconds.
                        captionsUrl:
                          type: string
                          description: The URL for the video captions, if available.
                        videoFileUrl:
                          type: string
                          description: The URL for the video file, if available.
                        audioFileUrl:
                          type: string
                          description: The URL for the audio file, if available.
                      required:
                        - id
                    description: Array of popular video objects.
                required:
                  - totalResults
                  - data
              example:
                totalResults: 200
                resultsPerPage: 5
                nextPageToken: CAUQAA
                data:
                  - id: snX5YyflrGw
                    publishedAt: '2024-09-28T16:00:00Z'
                    channelId: UCX6OQ3DkcsbYNE6H8uQQuVA
                    title: 100 Identical Twins Fight For $250,000
                    description: >-
                      I’ve never seen this many twins in one place before lol

                      Our brand new flavor is here: Cookies & Creme, made with
                      rich chocolatey filling, studded with crunchy cookie
                      pieces and real creamy white chocolate. Now available at
                      Walmart & Target!
                      https://feastables.com/products/cookies-creme


                      Lunch just got better. #LeaveNoCrumbs
                      https://lunchly.com/pages/lunchly-locator


                      New Merch - https://mrbeast.store


                      Check out Viewstats! - https://www.viewstats.com/


                      SUBSCRIBE OR I TAKE YOUR DOG

                      ╔═╦╗╔╦╗╔═╦═╦╦╦╦╗╔═╗

                      ║╚╣║║║╚╣╚╣╔╣╔╣║╚╣═╣ 

                      ╠╗║╚╝║║╠╗║╚╣║║║║║═╣

                      ╚═╩══╩═╩═╩═╩╝╚╩═╩═╝


                      For any questions or inquiries regarding this video,
                      please reach out to chucky@mrbeastbusiness.com


                      Music Provided by https://www.extrememusic.com


                      ----------------------------------------------------------------

                      follow all of these or i will kick you


                      • Facebook - https://www.facebook.com/MrBeast6000/

                      • Twitter - https://twitter.com/MrBeast

                      •  Instagram - https://www.instagram.com/mrbeast

                      •  Im Hiring! - https://www.mrbeastjobs.com/
                    thumbnails:
                      default:
                        url: https://i.ytimg.com/vi/snX5YyflrGw/default.jpg
                        width: 120
                        height: 90
                      medium:
                        url: https://i.ytimg.com/vi/snX5YyflrGw/mqdefault.jpg
                        width: 320
                        height: 180
                      high:
                        url: https://i.ytimg.com/vi/snX5YyflrGw/hqdefault.jpg
                        width: 480
                        height: 360
                      standard:
                        url: https://i.ytimg.com/vi/snX5YyflrGw/sddefault.jpg
                        width: 640
                        height: 480
                      maxres:
                        url: https://i.ytimg.com/vi/snX5YyflrGw/maxresdefault.jpg
                        width: 1280
                        height: 720
                    channelTitle: MrBeast
                    categoryId: '24'
                    defaultLanguage: en
                    defaultAudioLanguage: en
                    viewCount: '16837247'
                    likeCount: '937850'
                    commentCount: '4378'
                    topicCategories:
                      - https://en.wikipedia.org/wiki/Entertainment
                      - https://en.wikipedia.org/wiki/Television_program
                    uploadStatus: processed
                    privacyStatus: public
                    license: youtube
                    embeddable: true
                    publicStatsViewable: true
                    madeForKids: false
                    hasPaidProductPlacement: false
                    categoryTitle: Entertainment
                    duration: PT35M40S
                    parsedDuration: 2140
                    captionsUrl: http://localhost:9999/captions/snX5YyflrGw
                    videoFileUrl: http://localhost:9999/files/video/snX5YyflrGw
                    audioFileUrl: http://localhost:9999/files/audio/snX5YyflrGw
                  - id: 9ZXzsjeRtdk
                    publishedAt: '2024-09-28T15:00:25Z'
                    channelId: UCnmGIkw-KdI0W5siakKPKog
                    title: I Tried Every Airbnb Category
                    description: OMG! a rat!
                    thumbnails:
                      default:
                        url: https://i.ytimg.com/vi/9ZXzsjeRtdk/default.jpg
                        width: 120
                        height: 90
                      medium:
                        url: https://i.ytimg.com/vi/9ZXzsjeRtdk/mqdefault.jpg
                        width: 320
                        height: 180
                      high:
                        url: https://i.ytimg.com/vi/9ZXzsjeRtdk/hqdefault.jpg
                        width: 480
                        height: 360
                      standard:
                        url: https://i.ytimg.com/vi/9ZXzsjeRtdk/sddefault.jpg
                        width: 640
                        height: 480
                      maxres:
                        url: https://i.ytimg.com/vi/9ZXzsjeRtdk/maxresdefault.jpg
                        width: 1280
                        height: 720
                    channelTitle: Ryan Trahan
                    tags:
                      - Ryan
                      - Trahan
                      - airbnb
                      - I tried every airbnb category
                      - weird hotel
                      - I stayed in
                    categoryId: '24'
                    defaultAudioLanguage: en
                    viewCount: '1434842'
                    likeCount: '82676'
                    commentCount: '6748'
                    topicCategories:
                      - https://en.wikipedia.org/wiki/Lifestyle_(sociology)
                      - https://en.wikipedia.org/wiki/Tourism
                    uploadStatus: processed
                    privacyStatus: public
                    license: youtube
                    embeddable: true
                    publicStatsViewable: true
                    madeForKids: false
                    hasPaidProductPlacement: false
                    categoryTitle: Entertainment
                    duration: PT27M15S
                    parsedDuration: 1635
                    captionsUrl: http://localhost:9999/captions/9ZXzsjeRtdk
                    videoFileUrl: http://localhost:9999/files/video/9ZXzsjeRtdk
                    audioFileUrl: http://localhost:9999/files/audio/9ZXzsjeRtdk
                  - id: QMe-ce78GJk
                    publishedAt: '2024-09-27T22:33:10Z'
                    channelId: UCXoMM35ugF5iOzAEb-PmfRA
                    title: >-
                      Hurricane Helene Historic Storm Surge Devastates Cedar
                      Key, Florida
                    description: >-
                      Stop data brokers from exposing your personal information.
                      Go to my sponsor https://aura.com/jp to get a 14-day free
                      trial and see how much of yours is being sold!


                      Witness the full fury of Hurricane Helene as it slams into
                      Cedar Key, Florida! This powerful Category 4 storm
                      unleashes a historic storm surge, causing widespread
                      devastation. Homes and businesses are ripped apart,
                      leaving generations of residents in shock. Many have never
                      seen a surge this high, even those whose families have
                      lived in Cedar Key since the 1800s.


                      This video documents the destruction and the heartbreak
                      left in the wake of Hurricane Helene.


                      00:00 Intro

                      01:35 Before the Hurricane

                      02:24 Storm surge begins

                      03:37 Peak storm surge

                      06:59 The morning after at the Faraway Inn

                      08:22 Historic downtown lost a lot of history

                      10:25 Cedar Key's future
                    thumbnails:
                      default:
                        url: https://i.ytimg.com/vi/QMe-ce78GJk/default.jpg
                        width: 120
                        height: 90
                      medium:
                        url: https://i.ytimg.com/vi/QMe-ce78GJk/mqdefault.jpg
                        width: 320
                        height: 180
                      high:
                        url: https://i.ytimg.com/vi/QMe-ce78GJk/hqdefault.jpg
                        width: 480
                        height: 360
                      standard:
                        url: https://i.ytimg.com/vi/QMe-ce78GJk/sddefault.jpg
                        width: 640
                        height: 480
                      maxres:
                        url: https://i.ytimg.com/vi/QMe-ce78GJk/maxresdefault.jpg
                        width: 1280
                        height: 720
                    channelTitle: Jonathan Petramala
                    tags:
                      - hurricane helene
                      - hurricane storm surge
                      - hurricane damage
                      - category 4 hurricane footage
                      - category 4 hurricane
                      - storm surge
                      - major hurricane helene
                      - florida hurricane
                      - natural disaster
                      - cedar key
                      - cedar key florida
                      - cedar key hurricane damage
                      - devastation in cedar key
                      - hurricane helene live
                      - hurricane
                      - reed timmer
                      - ryan hall
                      - ryan hall y'all
                      - hurricane hits florida
                      - storm surge florida
                      - storm surge video
                    categoryId: '25'
                    defaultAudioLanguage: en-US
                    viewCount: '2092695'
                    likeCount: '25252'
                    commentCount: '3703'
                    uploadStatus: processed
                    privacyStatus: public
                    license: youtube
                    embeddable: true
                    publicStatsViewable: true
                    madeForKids: false
                    hasPaidProductPlacement: true
                    categoryTitle: News & Politics
                    duration: PT11M32S
                    parsedDuration: 692
                    captionsUrl: http://localhost:9999/captions/QMe-ce78GJk
                    videoFileUrl: http://localhost:9999/files/video/QMe-ce78GJk
                    audioFileUrl: http://localhost:9999/files/audio/QMe-ce78GJk
                  - id: BLCOufzhaMY
                    publishedAt: '2024-09-28T15:01:07Z'
                    channelId: UCo8bcnLyZH8tBIH9V1mLgqQ
                    title: We Made It This Far
                    description: >-
                      Thank you for 10 years!!

                      Instagram ➤ https://www.instagram.com/theodd1sout/

                      TikTok ➤ https://www.tiktok.com/@theoddtiktoksout

                      Twitter ➤ https://twitter.com/theodd1sout


                      ART TEAM:

                      Emilee Dummer ➤ https://www.instagram.com/edummerart/

                      Kelly Jensen ➤ https://www.instagram.com/kelly_anne_art/

                      Claire Anne ➤
                      https://www.instagram.com/claireanneillustration

                      Amelia Rosenbalm ➤ https://www.instagram.com/galloame/

                      Rikikuniyuki_art ➤
                      https://www.instagram.com/rikikuniyuki_art/
                    thumbnails:
                      default:
                        url: https://i.ytimg.com/vi/BLCOufzhaMY/default.jpg
                        width: 120
                        height: 90
                      medium:
                        url: https://i.ytimg.com/vi/BLCOufzhaMY/mqdefault.jpg
                        width: 320
                        height: 180
                      high:
                        url: https://i.ytimg.com/vi/BLCOufzhaMY/hqdefault.jpg
                        width: 480
                        height: 360
                      standard:
                        url: https://i.ytimg.com/vi/BLCOufzhaMY/sddefault.jpg
                        width: 640
                        height: 480
                      maxres:
                        url: https://i.ytimg.com/vi/BLCOufzhaMY/maxresdefault.jpg
                        width: 1280
                        height: 720
                    channelTitle: TheOdd1sOut
                    categoryId: '23'
                    defaultAudioLanguage: en
                    viewCount: '883139'
                    likeCount: '127631'
                    commentCount: '11297'
                    topicCategories:
                      - https://en.wikipedia.org/wiki/Entertainment
                      - https://en.wikipedia.org/wiki/Film
                    uploadStatus: processed
                    privacyStatus: public
                    license: youtube
                    embeddable: true
                    publicStatsViewable: true
                    madeForKids: false
                    hasPaidProductPlacement: false
                    categoryTitle: Comedy
                    duration: PT1M39S
                    parsedDuration: 99
                    captionsUrl: http://localhost:9999/captions/BLCOufzhaMY
                    videoFileUrl: http://localhost:9999/files/video/BLCOufzhaMY
                    audioFileUrl: http://localhost:9999/files/audio/BLCOufzhaMY
                  - id: V9PVRfjEBTI
                    publishedAt: '2024-09-27T15:00:38Z'
                    channelId: UCDGmojLIoWpXok597xYo8cg
                    title: Billie Eilish - BIRDS OF A FEATHER (Official Music Video)
                    description: >-
                      Listen to HIT ME HARD AND SOFT:
                      http://BillieEilish.lnk.to/HITMEHARDARDANDSOFT

                      Download BIRDS OF A FEATHER Live from Billie’s Amazon
                      Music Songline performance:
                      https://billieeilish.lnk.to/BIRDSOFAFEATHER-AMAZONDOWNLOAD 

                      Get tickets: https://BillieEilish.lnk.to/TourDates 

                       Follow Billie Eilish: 

                      TikTok: https://BillieEilish.lnk.to/TikTok 

                      Instagram: https://BillieEilish.lnk.to/Instagram 

                      Facebook: https://BillieEilish.lnk.to/Facebook 

                      Twitter: https://BillieEilish.lnk.to/Twitter 

                      YouTube:    / billieeilish   

                      WhatsApp: https://BillieEilish.lnk.to/WhatsApp 

                      Email: https://BillieEilish.lnk.to/SignUp 

                      Store: https://BillieEilish.lnk.to/Store 

                      Cell: +1 (310) 807-3956


                      Music video by Billie Eilish performing BIRDS OF A
                      FEATHER.© 2024 Darkroom/Interscope Records
                    thumbnails:
                      default:
                        url: https://i.ytimg.com/vi/V9PVRfjEBTI/default.jpg
                        width: 120
                        height: 90
                      medium:
                        url: https://i.ytimg.com/vi/V9PVRfjEBTI/mqdefault.jpg
                        width: 320
                        height: 180
                      high:
                        url: https://i.ytimg.com/vi/V9PVRfjEBTI/hqdefault.jpg
                        width: 480
                        height: 360
                      standard:
                        url: https://i.ytimg.com/vi/V9PVRfjEBTI/sddefault.jpg
                        width: 640
                        height: 480
                      maxres:
                        url: https://i.ytimg.com/vi/V9PVRfjEBTI/maxresdefault.jpg
                        width: 1280
                        height: 720
                    channelTitle: BillieEilishVEVO
                    tags:
                      - Billie Eilish
                      - Darkroom/Interscope Records
                      - Alternative
                    categoryId: '10'
                    defaultAudioLanguage: en
                    viewCount: '5055455'
                    likeCount: '567926'
                    commentCount: '27854'
                    topicCategories:
                      - https://en.wikipedia.org/wiki/Independent_music
                      - https://en.wikipedia.org/wiki/Music
                      - https://en.wikipedia.org/wiki/Pop_music
                    uploadStatus: processed
                    privacyStatus: public
                    license: youtube
                    embeddable: true
                    publicStatsViewable: true
                    madeForKids: false
                    hasPaidProductPlacement: false
                    categoryTitle: Music
                    duration: PT3M51S
                    parsedDuration: 231
                    captionsUrl: http://localhost:9999/captions/V9PVRfjEBTI
                    videoFileUrl: http://localhost:9999/files/video/V9PVRfjEBTI
                    audioFileUrl: http://localhost:9999/files/audio/V9PVRfjEBTI
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      issues:
                        type: array
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                            maximum:
                              type: number
                            type:
                              type: string
                            inclusive:
                              type: boolean
                            exact:
                              type: boolean
                            message:
                              type: string
                            path:
                              type: array
                              items:
                                type: string
                            received:
                              type: string
                            options:
                              type: array
                              items:
                                type: string
                          required:
                            - code
                            - message
                            - path
                      name:
                        type: string
                        enum:
                          - ZodError
                    required:
                      - issues
                      - name
                required:
                  - success
                  - error
              example:
                success: false
                error:
                  issues:
                    - received: subscriberCount
                      code: invalid_enum_value
                      options:
                        - publishedAt
                        - channelId
                        - title
                        - description
                        - thumbnails
                        - channelTitle
                        - tags
                        - categoryId
                        - defaultLanguage
                        - defaultAudioLanguage
                        - viewCount
                        - likeCount
                        - commentCount
                        - topicCategories
                        - uploadStatus
                        - privacyStatus
                        - license
                        - embeddable
                        - publicStatsViewable
                        - madeForKids
                        - hasPaidProductPlacement
                        - localizations
                        - categoryTitle
                        - duration
                        - parsedDuration
                        - captionsUrl
                        - videoFileUrl
                        - audioFileUrl
                      path:
                        - fields
                        - 0
                      message: >-
                        Invalid enum value. Expected 'publishedAt' | 'channelId'
                        | 'title' | 'description' | 'thumbnails' |
                        'channelTitle' | 'tags' | 'categoryId' |
                        'defaultLanguage' | 'defaultAudioLanguage' | 'viewCount'
                        | 'likeCount' | 'commentCount' | 'topicCategories' |
                        'uploadStatus' | 'privacyStatus' | 'license' |
                        'embeddable' | 'publicStatsViewable' | 'madeForKids' |
                        'hasPaidProductPlacement' | 'localizations' |
                        'categoryTitle' | 'duration' | 'parsedDuration' |
                        'captionsUrl' | 'videoFileUrl' | 'audioFileUrl',
                        received 'subscriberCount'
                  name: ZodError
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                    required:
                      - message
                required:
                  - error
              example:
                error:
                  message: Forbidden
      security:
        - Bearer: []
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````