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

# Channel Shorts

> Fetches a YouTube channel's Shorts (its Shorts tab), 48 per page, newest first or most popular first: each Short's id, URL, title, view count (rounded, as YouTube shows it), its cover image and its first frame at full size. The response also carries a summary of the channel (id, handle, name, avatar, verified, subscribers). Pass exactly one of `channelId` or `handle`; pass the returned `cursor` back (with the same channel) for the next page — it keeps the sort. A channel without a Shorts tab returns no Shorts. For a Short's exact views, likes, date or length, use `/v1/youtube/video`. Only publicly available data is returned.

> [!NOTE]
>
> **Cost: 1 credit** per successful request. Errors and cache hits (`cache_max_age`) are free.

> [accordion] Copy for AI assistant
>
> Paste this into ChatGPT, Claude or your coding assistant to generate working code for this endpoint (use the copy button).
>
> ```text Prompt
> I want to make an API call to /v1/youtube/channel/shorts. Here are the details:
>
> Endpoint: GET https://api.scraperize.com/v1/youtube/channel/shorts
> Description: Fetches a YouTube channel's Shorts (its Shorts tab), 48 per page, newest first or most popular first: each Short's id, URL, title, view count (rounded, as YouTube shows it), its cover image and its first frame at full size. The response also carries a summary of the channel (id, handle, name, avatar, verified, subscribers). Pass exactly one of `channelId` or `handle`; pass the returned `cursor` back (with the same channel) for the next page — it keeps the sort. A channel without a Shorts tab returns no Shorts. For a Short's exact views, likes, date or length, use `/v1/youtube/video`. Only publicly available data is returned.
>
> Required Headers:
> - x-api-key: Your API key
>
> Parameters:
> - channelId (string): The channel id: `UC` followed by 22 characters, e.g. `UCX6OQ3DkcsbYNE6H8uQQuVA`.
> - handle (string): The channel handle, with or without `@`, e.g. `MrBeast`.
> - sort (select): `newest` (default) or `popular` (most viewed first). Optional with a cursor — the cursor keeps its sort.
> - cursor (string): The `cursor` from the previous page, to get the next one. Omit for the first page.
> - cache_max_age (select): Optional. Return a cached result if one this age or newer exists — served for **0 credits** with `meta.cached=true` and `meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and refreshes the cache. Omit to always scrape fresh.
>
> Example Response:
> {
>   "data": {
>     "channel": {
>       "id": "UCX6OQ3DkcsbYNE6H8uQQuVA",
>       "handle": "MrBeast",
>       "name": "MrBeast",
>       "url": "https://www.youtube.com/@MrBeast",
>       "avatarUrl": "https://yt3.googleusercontent.com/nxYrc_1_2f77DoBadyxMTmv7ZpRZapHR5jbuYe7PlPd5cIRJxtNNEYyOC0ZsxaDyJJzXrnJiuDE=s900-c-k-c0x00ffffff-no-rj",
>       "isVerified": true,
>       "subscriberCount": 525000000
>     },
>     "sort": "newest",
>     "shorts": [
>       {
>         "id": "41UzbuW6wJs",
>         "url": "https://www.youtube.com/shorts/41UzbuW6wJs",
>         "title": "Can A Robot Do My Chores?",
>         "viewCount": 61000000,
>         "viewCountText": "61M views",
>         "thumbnailUrl": "https://i.ytimg.com/vi/41UzbuW6wJs/sardefault.jpg?sqp=-oaymwEdCJUDENAFSFWQAgHyq4qpAwwIARUAAIhCcAHAAQY=&rs=AOn4CLCxAJ6m3hdnkUoqzR3qnfBt10eCuQ",
>         "thumbnails": [
>           {
>             "url": "https://i.ytimg.com/vi/41UzbuW6wJs/sardefault.jpg?sqp=-oaymwEdCJUDENAFSFWQAgHyq4qpAwwIARUAAIhCcAHAAQY=&rs=AOn4CLCxAJ6m3hdnkUoqzR3qnfBt10eCuQ",
>             "width": 405,
>             "height": 720
>           }
>         ],
>         "frameUrl": "https://i.ytimg.com/vi/41UzbuW6wJs/frame0.jpg"
>       }
>     ],
>     "count": 48,
>     "cursor": "eyJrIjoiQG1yYmVhc3QiLCJjIjoiNHFtRnNnTERDeElZVlVOWU5rOVJNMFJyWTNOaVdVNUZOa2c0ZFZGUmRWWkJHcVlMT0dkaE1rTkNjWHBEUmt0M1EwUkxkRU5CYjJ0T2JVcHNUMFJzYkU1dFJYUk5SRUYzVFVN…",
>     "hasMore": true,
>     "fetchedAt": "2026-11-05T07:58:43.797Z"
>   },
>   "meta": {
>     "requestId": "req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f",
>     "creditsCharged": 1,
>     "creditsRemaining": 4999,
>     "cached": false
>   }
> }
>
> Please help me write code in my preferred programming language to make this API call and handle the response appropriately. Include error handling and best practices.
> ```


## OpenAPI

````yaml /api-reference/openapi.json get /v1/youtube/channel/shorts
openapi: 3.0.3
info:
  title: Scraperize API
  version: 1.0.0
  description: >-
    Extract public data from social media platforms as clean JSON. Endpoints are
    split by platform and by what they return, e.g. `GET /v1/twitter/tweet`.


    ## Authentication

    Send your API key in the `x-api-key` header (or `Authorization: Bearer
    <key>`). Create keys in your dashboard.


    ## Credits

    Each successful live scrape costs **1 credit**. Credits are prepaid and
    never expire.


    ## Caching

    Every endpoint accepts an optional `cache_max_age`
    (`1d`|`3d`|`7d`|`14d`|`30d`). A cache hit within that window is returned for
    **0 credits**.


    ## Responses

    Success returns `{ "data": …, "meta": { "requestId", … } }`. Errors return
    `{ "error": { "code", "message", "requestId" } }` with a matching HTTP
    status. `meta` on a scrape carries `creditsCharged`, `creditsRemaining`,
    `cached`, and (on a hit) `cachedAt`.


    ## Rate limits

    Requests are limited per team per minute; over the limit returns `429` with
    a `Retry-After` header.
servers:
  - url: https://api.scraperize.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Twitter
    description: Twitter / X scraping endpoints
  - name: Facebook
    description: Facebook scraping endpoints
  - name: Linkme
    description: Linkme (link.me) scraping endpoints
  - name: Amazon
    description: Amazon (creator shop / storefront) scraping endpoints
  - name: Linkbio
    description: Linkbio (lnk.bio) scraping endpoints
  - name: Pillar
    description: Pillar (pillar.io) scraping endpoints
  - name: Komi
    description: Komi (komi.io) scraping endpoints
  - name: Linktree
    description: Linktree (linktr.ee) scraping endpoints
  - name: Kick
    description: Kick (kick.com) scraping endpoints
  - name: Snapchat
    description: Snapchat (snapchat.com) scraping endpoints
  - name: Telegram
    description: Telegram (t.me) scraping endpoints
  - name: LinkedIn
    description: LinkedIn scraping endpoints
  - name: Twitch
    description: Twitch scraping endpoints
  - name: TikTok
    description: TikTok (tiktok.com) scraping endpoints
  - name: Instagram
    description: Instagram scraping endpoints
  - name: Lagos Life
    description: Lagos Life scraping endpoints
  - name: Bluesky
    description: Bluesky (bsky.app) scraping endpoints
  - name: Threads
    description: Threads (threads.com) scraping endpoints
  - name: Reddit
    description: Reddit (reddit.com) scraping endpoints
  - name: Rumble
    description: Rumble (rumble.com) scraping endpoints
  - name: Truth Social
    description: Truth Social (truthsocial.com) scraping endpoints
  - name: YouTube
    description: YouTube (youtube.com) scraping endpoints
paths:
  /v1/youtube/channel/shorts:
    get:
      tags:
        - YouTube
      summary: Channel Shorts
      description: >-
        Fetches a YouTube channel's Shorts (its Shorts tab), 48 per page, newest
        first or most popular first: each Short's id, URL, title, view count
        (rounded, as YouTube shows it), its cover image and its first frame at
        full size. The response also carries a summary of the channel (id,
        handle, name, avatar, verified, subscribers). Pass exactly one of
        `channelId` or `handle`; pass the returned `cursor` back (with the same
        channel) for the next page — it keeps the sort. A channel without a
        Shorts tab returns no Shorts. For a Short's exact views, likes, date or
        length, use `/v1/youtube/video`. Only publicly available data is
        returned.
      parameters:
        - name: channelId
          in: query
          required: false
          description: >-
            The channel id: `UC` followed by 22 characters, e.g.
            `UCX6OQ3DkcsbYNE6H8uQQuVA`.
          schema:
            type: string
          example: UCX6OQ3DkcsbYNE6H8uQQuVA
        - name: handle
          in: query
          required: false
          description: The channel handle, with or without `@`, e.g. `MrBeast`.
          schema:
            type: string
          example: MrBeast
        - name: sort
          in: query
          required: false
          description: >-
            `newest` (default) or `popular` (most viewed first). Optional with a
            cursor — the cursor keeps its sort.
          schema:
            type: string
            enum:
              - newest
              - popular
            default: newest
        - name: cursor
          in: query
          required: false
          description: >-
            The `cursor` from the previous page, to get the next one. Omit for
            the first page.
          schema:
            type: string
        - name: cache_max_age
          in: query
          required: false
          description: >-
            Optional. Return a cached result if one this age or newer exists —
            served for **0 credits** with `meta.cached=true` and
            `meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and
            refreshes the cache. Omit to always scrape fresh.
          schema:
            type: string
            enum:
              - 1d
              - 3d
              - 7d
              - 14d
              - 30d
          example: 7d
      responses:
        '200':
          description: One page of the channel's Shorts (empty when it has none).
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      channel:
                        type: object
                      sort:
                        type: string
                        enum:
                          - newest
                          - popular
                      shorts:
                        type: array
                        items:
                          type: object
                      count:
                        type: integer
                      cursor:
                        type: string
                        nullable: true
                      hasMore:
                        type: boolean
                      fetchedAt:
                        type: string
                        format: date-time
                  meta:
                    type: object
                    description: >-
                      requestId + credit/caching metadata (creditsCharged,
                      creditsRemaining, cached, cachedAt).
                required:
                  - data
                  - meta
              example:
                data:
                  channel:
                    id: UCX6OQ3DkcsbYNE6H8uQQuVA
                    handle: MrBeast
                    name: MrBeast
                    url: https://www.youtube.com/@MrBeast
                    avatarUrl: >-
                      https://yt3.googleusercontent.com/nxYrc_1_2f77DoBadyxMTmv7ZpRZapHR5jbuYe7PlPd5cIRJxtNNEYyOC0ZsxaDyJJzXrnJiuDE=s900-c-k-c0x00ffffff-no-rj
                    isVerified: true
                    subscriberCount: 525000000
                  sort: newest
                  shorts:
                    - id: 41UzbuW6wJs
                      url: https://www.youtube.com/shorts/41UzbuW6wJs
                      title: Can A Robot Do My Chores?
                      viewCount: 61000000
                      viewCountText: 61M views
                      thumbnailUrl: >-
                        https://i.ytimg.com/vi/41UzbuW6wJs/sardefault.jpg?sqp=-oaymwEdCJUDENAFSFWQAgHyq4qpAwwIARUAAIhCcAHAAQY=&rs=AOn4CLCxAJ6m3hdnkUoqzR3qnfBt10eCuQ
                      thumbnails:
                        - url: >-
                            https://i.ytimg.com/vi/41UzbuW6wJs/sardefault.jpg?sqp=-oaymwEdCJUDENAFSFWQAgHyq4qpAwwIARUAAIhCcAHAAQY=&rs=AOn4CLCxAJ6m3hdnkUoqzR3qnfBt10eCuQ
                          width: 405
                          height: 720
                        - url: >-
                            https://i.ytimg.com/vi/41UzbuW6wJs/sardefault.jpg?sqp=-oaymwEgCJUDEOAESFWQAgHyq4qpAw8IARUAAIhCcAHAAQbIAQE=&rs=AOn4CLA2uqUxKLKg9wKmzgbOEjWXHTKGLg
                          width: 405
                          height: 608
                      frameUrl: https://i.ytimg.com/vi/41UzbuW6wJs/frame0.jpg
                    - id: mND4T0lzg_g
                      url: https://www.youtube.com/shorts/mND4T0lzg_g
                      title: How People Treat You Based on Subscribers
                      viewCount: 35000000
                      viewCountText: 35M views
                      thumbnailUrl: >-
                        https://i.ytimg.com/vi/mND4T0lzg_g/sardefault.jpg?sqp=-oaymwEdCJUDENAFSFWQAgHyq4qpAwwIARUAAIhCcAHAAQY=&rs=AOn4CLDsFeGhMrxAOhLBR9u58BQ95qjUJg
                      thumbnails:
                        - url: >-
                            https://i.ytimg.com/vi/mND4T0lzg_g/sardefault.jpg?sqp=-oaymwEdCJUDENAFSFWQAgHyq4qpAwwIARUAAIhCcAHAAQY=&rs=AOn4CLDsFeGhMrxAOhLBR9u58BQ95qjUJg
                          width: 405
                          height: 720
                        - url: >-
                            https://i.ytimg.com/vi/mND4T0lzg_g/sardefault.jpg?sqp=-oaymwEgCJUDEOAESFWQAgHyq4qpAw8IARUAAIhCcAHAAQbIAQE=&rs=AOn4CLAItUaIBHR1w_d7GCLXkBg_TMnLFg
                          width: 405
                          height: 608
                      frameUrl: https://i.ytimg.com/vi/mND4T0lzg_g/frame0.jpg
                    - id: Y8IJi7iP5vk
                      url: https://www.youtube.com/shorts/Y8IJi7iP5vk
                      title: Last To Fall Wins
                      viewCount: 147000000
                      viewCountText: 147M views
                      thumbnailUrl: >-
                        https://i.ytimg.com/vi/Y8IJi7iP5vk/sardefault.jpg?sqp=-oaymwEdCJUDENAFSFWQAgHyq4qpAwwIARUAAIhCcAHAAQY=&rs=AOn4CLBCD5kD2ChNG0mXy-4Md6e0t61Umw
                      thumbnails:
                        - url: >-
                            https://i.ytimg.com/vi/Y8IJi7iP5vk/sardefault.jpg?sqp=-oaymwEdCJUDENAFSFWQAgHyq4qpAwwIARUAAIhCcAHAAQY=&rs=AOn4CLBCD5kD2ChNG0mXy-4Md6e0t61Umw
                          width: 405
                          height: 720
                        - url: >-
                            https://i.ytimg.com/vi/Y8IJi7iP5vk/sardefault.jpg?sqp=-oaymwEgCJUDEOAESFWQAgHyq4qpAw8IARUAAIhCcAHAAQbIAQE=&rs=AOn4CLBcp-8ISZwy1fk_k0byjYRGedMx4g
                          width: 405
                          height: 608
                      frameUrl: https://i.ytimg.com/vi/Y8IJi7iP5vk/frame0.jpg
                  count: 48
                  cursor: >-
                    eyJrIjoiQG1yYmVhc3QiLCJjIjoiNHFtRnNnTERDeElZVlVOWU5rOVJNMFJyWTNOaVdVNUZOa2c0ZFZGUmRWWkJHcVlMT0dkaE1rTkNjWHBEUmt0M1EwUkxkRU5CYjJ0T2JVcHNUMFJzYkU1dFJYUk5SRUYzVFVNd2VWbFVRWHBNVjBWNFRWZFpkRTE2UW0xYVJFMDBUVlJLYlU1NlRUQkZiMGxKVVZkT1YwOUdXbXRXTUhNeFRrZGFXazU2YUV4VFZGSkhUVlpHY1U1VVZubFBXRlV5VVROYVlWSkZkSHBoZWtKSFZraE9VbUp1VWt4U1J6UjZWV3BHYzFwcVRuRlZiVnBSVFd0ek1tUXdlREJWYW1oRVZsZGFVMDVZV210alNFNW9WVWhLYjFvelVuaE1XRkp4WTBoSk1WZEZNWE5XYldRMVVsWkNjbGd4V1hSTVZXZ3paV3BvUTJSNmF6QlZiVlpYVkVoS1ZFMVZkelJVUkVKeVducEdObVF6Y0ZwVWJIQkVaVlk0ZUZadE9YWlVia1pLVGtVNVQxRnRjRFpoUjFwSVRrUkNVR1ZJVG1wV2JsWktZVVprYjFSR1pFbGthbEozVjFaQ2VXVlZkelZXYlRWcVl6RlNhV0ZyTlhCamJVNTFXbFZzVWxac1VqUmtNWEJXWlc1U2ExVnJaRE5PVjA1eFZXdDRTbU51VlhsVFJtaHpaR3RzY0ZORmFHeGFWVTR5V1ZSYWNtRnVXbkZUVlZwclpFWndNbEZ1WXpWaWVrNVFVbTE0UmxONmJHWlZiVFYyVW5wS2QwNUhlRXRqYlhCdlVWUlZlVlpIV1hSYVZrSk1XV3RvV1U1dVFtRlRWamxYV1dwV2MyUlhNWFpWYWxKU1RUSldlRlJWTVVsYU1Gb3hWR3BhYjAwemF6UlhWWGN4VWtWU1JXUXlhRU5QUlVwU1ZFUkpOR1JWY0ZwalJ6bFJWMnBuZVZGck1VeGpiRVV5VGtoR1YyRXlSbXhVZVRGeFkyeGFhRmd6Um5oWGFURTFWRlpvV2xKRWJGZFZhMnd6WkROQ00xSklUbEppVmtsM1pESTVSVk5zUW05YVNFbzBUMGQwYVdKWFRYbE9lbEpMVWxSa1dFNHhWbEJVU0U1WVYwVm5lazVWWkVWaVZscE5VMWhSZDFZeFVtaFhiVGsyVG1reFdHVlhPWGhXVm13d1RtdGtSRkl5YkhKTk1XaHFVMnRzUzFaSVNtNU5XRUpGVDFaU1NFNUVWbXBXYmtWMFkwY3hVR1JGY0VWUk1tUnhaRzVHTlZscVJtaFNNRFZ3VjFWME5sbHJlSEJPTUhCMlZtMUthRlJyZERWVlZHUnhWMVk1YUZKdVNsTmFWR2hWVXpFNVJHTllWblpoYm1SSlYxZE5NMU15VW1sVGEzQkZaRWRqZEUxV2JGVmhSMWt6WkZkU2JGSnJkRVJPVkZKMVlqQndOVmRXV2xCU1ZFNUxaRWRXY0dWWGRGTldNV3QzVEZkNE5FNVdSbkZsU0ZwS1lqTndjbFV3T1ZSbFJVcHVVMGRrVFdGdWNGZFZWV1I1VlZWd2NWTnJVbWhqTTBwR1ltdE9WRnBYZEd0bGJFSm1XVmhvV1dGcmNGcGFlbFp6VWtkcmRGSkVXa1JoV0d4UVlXcHNlRk5VU2sxaE1FWnhWVWRXTlZSclkzaGpSVTVyVVhwV1lWTXphRFZoTUhSTVdtcENhbFl4VFRSV2FUQjVaVlZXTUZnd1RrUmhTRUpOV2xab1YwMHhSbXBUUlRVeVZWWkNTR1ZXT1ZaUFJHZ3dXV3RrU2xkVVpFOVRWbXhQVFVVNVJGVkZhRkJQVkVwV1lVUnNXbUZIZEVSTmVscHdaRWRvYjA5VWJIQlVWMngwVGxkR2RrMHpUakpPVnpGMVVUTldhMDlIYnpCT1ZtUTFZbFk1UlZRd1duWk5SbHBDWlZkc1RsVXlkSFZYV0VKcVRGTXhhMUpJWTNoTlJWcEpUV3BqTW1WcmNIRlVSWFF6Vm10V2RWUkhkRTVUVnpGS1ZEQkdTRTVXVWsxWGJHeHpWV3M1VTJSSVpGTmhNbkI1Vm01Vk0wOUZVa1ZrVlVaNlUyMTBVbEpxU1RWVFdGRjVZak5rYzFFeGNIZFBSWEJGVWxoR1NXSXdiRVJTYWtaSVRWWlNkbGR1Y0d0YWJIQjZUVEpvV1ZaWVozZFhiV2d6WVd0d1ZWUldjRFpoYld4bVVrZHNORnBVVW5oVk1uUkhZa2MwTlZOWVVscFlNRXAwWXpOTk0yTXdNVWhaTTJzeFdWaENOVmd6YUZkT2JWWlpWVlpDYVZWRlNuUk5SMWt6VkZka1JXUllTbFZTYTJONFlVaGtTMVV5VGxaUmJHZDVaVzV3YUdOdGFEQldiazVaWVc1b1JtRkZPVU5qUkdRMFdIcEtTMDlHYkhkTVdIQkxVekZvVkdSWFRrZE5WMngyVlVkU05GTlZVbTFVYTJSMlZqQTFiMkZFVW5sVU1XUnhUVE5rZGxaR1l6UlpNRTV6VXpKYVRGWlljRmhXVlRWWlRUSjBVMUl5U201aU1Fa3dXbTVDU2t4VlkzbGhhemw2VlhwYVJGVnNTbWxsVms1YVYydDBTVlpYVG5CalZYaHFaRlpPZFV4VVRtbFRiR2h1UjBGUkpUTkUiLCJjaCI6eyJpZCI6IlVDWDZPUTNEa2NzYllORTZIOHVRUXVWQSIsImhhbmRsZSI6Ik1yQmVhc3QiLCJuYW1lIjoiTXJCZWFzdCIsInVybCI6Imh0dHBzOi8vd3d3LnlvdXR1YmUuY29tL0BNckJlYXN0IiwiYXZhdGFyVXJsIjoiaHR0cHM6Ly95dDMuZ29vZ2xldXNlcmNvbnRlbnQuY29tL254WXJjXzFfMmY3N0RvQmFkeXhNVG12N1pwUlphcEhSNWpidVllN1BsUGQ1Y0lSSnh0Tk5FWXlPQzBac3hhRHlKSnpYcm5KaXVERT1zOTAwLWMtay1jMHgwMGZmZmZmZi1uby1yaiIsImlzVmVyaWZpZWQiOnRydWUsInN1YnNjcmliZXJDb3VudCI6NTI1MDAwMDAwfSwicyI6Im5ld2VzdCJ9
                  hasMore: true
                  fetchedAt: '2026-11-05T07:58:43.797Z'
                meta:
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
                  creditsCharged: 1
                  creditsRemaining: 4999
                  cached: false
        '400':
          description: Invalid or expired cursor (or one for another channel or sort).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: BAD_REQUEST
                  message: The request was invalid.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '401':
          description: Missing, invalid, or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: UNAUTHORIZED
                  message: API key required — pass it in the `x-api-key` header.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '402':
          description: Not enough credits for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: INSUFFICIENT_CREDITS
                  message: >-
                    This request costs 1 credit, but your balance is 0. Top up
                    to continue.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '404':
          description: No YouTube channel found (it may not exist or have been removed).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: NOT_FOUND
                  message: >-
                    The requested content was not found (it may not exist, be
                    deleted, or be private).
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '422':
          description: >-
            Invalid query parameters (pass exactly one of channelId or handle;
            sort is newest or popular).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: VALIDATION_ERROR
                  message: Request validation failed
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
                  details:
                    - path: url
                      message: url is required
        '429':
          description: Over the per-minute rate limit — honour `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: RATE_LIMITED
                  message: >-
                    Rate limit exceeded — max 100 requests per 60s. Retry in
                    ~30s.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '503':
          description: >-
            Temporarily unavailable — retry after `Retry-After`. `error.code`
            tells you why: `UPSTREAM_BLOCKED` (the source blocked this request),
            `EXTRACTION_FAILED` (the source returned unexpected data),
            `PLATFORM_UNAVAILABLE` (the source is down), or
            `SERVICE_UNAVAILABLE` (we are at capacity).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: UPSTREAM_BLOCKED
                  message: >-
                    The source is temporarily unavailable. Please try again
                    shortly.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: NOT_FOUND
            message:
              type: string
              example: The requested content was not found.
            requestId:
              type: string
              example: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
            details:
              type: array
              items:
                type: object
              description: Present on validation errors.
          required:
            - code
            - message
            - requestId
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your API key. Send it in the `x-api-key` header (or `Authorization:
        Bearer <key>`). Create and manage keys from your dashboard.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.