> ## 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.

# Post comments

> Fetches the comments on a public Facebook post or reel. Pass `url` OR `feedbackId` (the post's feedback id from `/facebook/post` — faster). Each comment includes text, author, timestamp, reaction count + per-type breakdown, reply count, any media attachment, and its permalink. Returns a `paging.cursor` / `paging.hasNextPage` for the next page, plus the `feedbackId` to reuse.

<Info>
  **Cost: 1 credit** per successful request. Errors and cache hits (`cache_max_age`) are free.
</Info>

<Accordion title="Copy for AI assistant" icon="sparkles">
  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/facebook/post/comments. Here are the details:

  Endpoint: GET https://api.scraperize.com/v1/facebook/post/comments
  Description: Fetches the comments on a public Facebook post or reel. Pass `url` OR `feedbackId` (the post's feedback id from `/facebook/post` — faster). Each comment includes text, author, timestamp, reaction count + per-type breakdown, reply count, any media attachment, and its permalink. Returns a `paging.cursor` / `paging.hasNextPage` for the next page, plus the `feedbackId` to reuse.

  Required Headers:
  - x-api-key: Your API key

  Parameters:
  - url (string): **Required — provide one of `url` or `feedbackId`.** Public Facebook post/reel URL.
  - feedbackId (string): **Required — provide one of `url` or `feedbackId`.** The post's feedback id (from /facebook/post) — faster than url.
  - cursor (string): The `paging.cursor` from a previous call, to fetch the next 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": {
      "comments": [
        {
          "id": "Y29tbWVudDoxNjkzMjY0MTA1NDkzNDU2XzE0MTM4MTE4MTQxMjc1MTg=",
          "legacyId": "1413811814127518",
          "text": "Meanwhile Ronaldo has never lost any FIFA world cup finals he played.  🔥",
          "author": {
            "id": "pfbid02eQDMoFm69PSpmkbZDEHP5QTEBxQAv7Wt4wWS4FzjaL5sQfJCAfS4qJBSAQ7mGmF4l",
            "name": "Ribesh Chhetri",
            "shortName": "Ribesh",
            "url": "https://www.facebook.com/ribesh.chhetri",
            "avatarUrl": "https://scontent-los4-1.xx.fbcdn.net/v/t1.6435-1/140304033_4896315097105613_3903629056200245534_n.jpg?stp=cp0_dst-jpg_tt6&cstp=mx819x819&ctp=s32x32&_nc_cat=107&…",
            "verified": false,
            "gender": "MALE",
            "isPage": false
          },
          "createdAt": "2026-07-21T14:07:04.000Z",
          "createdTimestamp": 1784642824,
          "reactionCount": 346,
          "reactionsByType": [
            {
              "type": "Like",
              "count": 161
            }
          ],
          "replyCount": 28,
          "feedbackId": "ZmVlZGJhY2s6MTY5MzI2NDEwNTQ5MzQ1Nl8xNDEzODExODE0MTI3NTE4",
          "expansionToken": "MjoxNzkxMjExMzk3OgF_gL5-Wlc5Bzrc13LRiJnZRMT7tSt4CzZW6TgSucXv79qCnud4Sq39l_anvEhoIH1yGIBV6sfIbkm6FVTQH9EtVy4oteqRt5QONNbUFWfmDhNcl5yr3uMzyBCh7R908AjVtdjbBlT3v0xa…",
          "url": "https://www.facebook.com/reel/1549207066583030/?comment_id=1413811814127518",
          "depth": 0,
          "isAuthorOriginalPoster": false,
          "attachments": []
        }
      ],
      "commentCount": 10,
      "paging": {
        "cursor": "MToxNzkxMjExMzk3OgF_FGr6iQFHo5LPuxb-_0zYRiTdafeVXNCo9f4vv13s5acda125lFvO9pS3kAwZaeIg0XomWE2PCa9NB4HUdXV7w4Z7uuzufuOKpGZAv5pMUwoZsH-pbwF4IHl5Vw3E9WVoxKf6X-gAQ6n7…",
        "hasNextPage": true
      },
      "feedbackId": "ZmVlZGJhY2s6MTY5MzI2NDEwNTQ5MzQ1Ng==",
      "fetchedAt": "2026-10-05T14:43:18.396Z"
    },
    "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.
  ```
</Accordion>


## OpenAPI

````yaml /api-reference/openapi.json get /v1/facebook/post/comments
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
paths:
  /v1/facebook/post/comments:
    get:
      tags:
        - Facebook
      summary: Post comments
      description: >-
        Fetches the comments on a public Facebook post or reel. Pass `url` OR
        `feedbackId` (the post's feedback id from `/facebook/post` — faster).
        Each comment includes text, author, timestamp, reaction count + per-type
        breakdown, reply count, any media attachment, and its permalink. Returns
        a `paging.cursor` / `paging.hasNextPage` for the next page, plus the
        `feedbackId` to reuse.
      parameters:
        - name: url
          in: query
          required: false
          description: >-
            **Required — provide one of `url` or `feedbackId`.** Public Facebook
            post/reel URL.
          schema:
            type: string
          example: https://www.facebook.com/reel/1549207066583030
        - name: feedbackId
          in: query
          required: false
          description: >-
            **Required — provide one of `url` or `feedbackId`.** The post's
            feedback id (from /facebook/post) — faster than url.
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          description: The `paging.cursor` from a previous call, to fetch the next 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: The comments.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      comments:
                        type: array
                        items:
                          type: object
                      commentCount:
                        type: integer
                      paging:
                        type: object
                        properties:
                          cursor:
                            type: string
                            nullable: true
                          hasNextPage:
                            type: boolean
                      feedbackId:
                        type: string
                        nullable: true
                      fetchedAt:
                        type: string
                        format: date-time
                  meta:
                    type: object
                    description: >-
                      requestId + credit/caching metadata (creditsCharged,
                      creditsRemaining, cached, cachedAt).
                required:
                  - data
                  - meta
              example:
                data:
                  comments:
                    - id: Y29tbWVudDoxNjkzMjY0MTA1NDkzNDU2XzE0MTM4MTE4MTQxMjc1MTg=
                      legacyId: '1413811814127518'
                      text: >-
                        Meanwhile Ronaldo has never lost any FIFA world cup
                        finals he played.  🔥
                      author:
                        id: >-
                          pfbid02eQDMoFm69PSpmkbZDEHP5QTEBxQAv7Wt4wWS4FzjaL5sQfJCAfS4qJBSAQ7mGmF4l
                        name: Ribesh Chhetri
                        shortName: Ribesh
                        url: https://www.facebook.com/ribesh.chhetri
                        avatarUrl: >-
                          https://scontent-los4-1.xx.fbcdn.net/v/t1.6435-1/140304033_4896315097105613_3903629056200245534_n.jpg?stp=cp0_dst-jpg_tt6&cstp=mx819x819&ctp=s32x32&_nc_cat=107&ccb=1-7&_nc_sid=e99d92&_nc_ohc=yb77A97c9d8Q7kNvwGMSTt8&_nc_oc=Adp9_wfyD_PYxmQpV0FfJaA35jEqghHRODmtMvqT5Hyxd6deCnKcpxkRfAKe1IhF1ek&_nc_zt=24&_nc_ht=scontent-los4-1.xx&_nc_gid=Nwt4peo_wBdHc47ogjq9Fg&_nc_ss=7c289&oh=00_AQOoexZ7YK7DJ0w6HzDBPuJj1TvkRPxMZgs_fLzdX4sukw&oe=6AEB2517
                        verified: false
                        gender: MALE
                        isPage: false
                      createdAt: '2026-07-21T14:07:04.000Z'
                      createdTimestamp: 1784642824
                      reactionCount: 346
                      reactionsByType:
                        - type: Like
                          count: 161
                        - type: Love
                          count: 11
                        - type: Care
                          count: 0
                      replyCount: 28
                      feedbackId: ZmVlZGJhY2s6MTY5MzI2NDEwNTQ5MzQ1Nl8xNDEzODExODE0MTI3NTE4
                      expansionToken: >-
                        MjoxNzkxMjExMzk3OgF_gL5-Wlc5Bzrc13LRiJnZRMT7tSt4CzZW6TgSucXv79qCnud4Sq39l_anvEhoIH1yGIBV6sfIbkm6FVTQH9EtVy4oteqRt5QONNbUFWfmDhNcl5yr3uMzyBCh7R908AjVtdjbBlT3v0xaXvtttZbzhmS4TEnieU7ctPae5dum_nP7jOtHjKSkVVP53tJJWufenNO3uxSVyC2MMNrTPUhKt4p1xm6QYK2McmtwnZAhnCDuC9iEncmNjNa8N5ODNt8XY-q6pbVJ3NLFdMdgBPB7fp2EEzgzxnN6nARIxlGRjvS-2avT9YBLnV2SwjQVqz-OWKMcrgxxkSn8cC_ftbPUP-kZg2EFfPWOYfCGo-QWr2MSTqABFJG1N7oKObi5t2epFEgihzK4ZZWPpjyNdrw73gWGdx89JQyX5frhHd9n8QkN-MmQguCgudPOm49aU3VZxCdG3U7vhdyap91SKh97tIkJbtKqeeqSxxQNS7fNpR8Ob9aApEHkdzUxlXWK8sgPdEDjJ9ivbW1HlFebxxXHffPiERGbheVUJn9S_6WHcS2Xgkyf61fhrRX0Blc3Zerh-Xf7Nm8dNEw3kos6VhKj-2EgIGm-fP0kP90m9lbK-iN2atqnGfn3cyl8CMlU2ZKa6ZcotQvS2B5wewYJc7qEHIop2HwfGWZ7-v8JNb6QLXNiPZEBX8kUUWCU_LC-sYY
                      url: >-
                        https://www.facebook.com/reel/1549207066583030/?comment_id=1413811814127518
                      depth: 0
                      isAuthorOriginalPoster: false
                      attachments: []
                    - id: Y29tbWVudDoxNjkzMjY0MTA1NDkzNDU2XzE3NDUwNTIyMTY3NTY3NTU=
                      legacyId: '1745052216756755'
                      text: >-
                        "Everyone knows that Messi is favored by FIFA, so
                        Ronaldo, you're still the greatest of all time" 😊
                      author:
                        id: '100095372325816'
                        name: PAul le Géant
                        shortName: PAul
                        url: >-
                          https://www.facebook.com/people/PAul-le-G%C3%A9ant/100095372325816/
                        avatarUrl: >-
                          https://scontent-los4-1.xx.fbcdn.net/v/t39.30808-1/790268773_906586135863789_9117451633597992102_n.jpg?stp=c0.0.543.543a_cp0_dst-jpg_tt6&cstp=mx543x543&ctp=s32x32&_nc_cat=107&ccb=1-7&_nc_sid=1d2534&_nc_ohc=8BjlE7zxoykQ7kNvwF_rq-w&_nc_oc=AdoyKPA3lBHwQuVmEbcQ3oBtlIVUk1ett5AVxGeE1Yboy0pN5w9A5TpP-oEU-8KnU80&_nc_zt=24&_nc_ht=scontent-los4-1.xx&_nc_gid=Nwt4peo_wBdHc47ogjq9Fg&_nc_ss=7c289&oh=00_AQOoadvUYSclwh2pngqM6Mq9Qxfo9Tf3sfASS0kRESIbrA&oe=6AC9758F
                        verified: false
                        gender: MALE
                        isPage: false
                      createdAt: '2026-07-21T14:16:53.000Z'
                      createdTimestamp: 1784643413
                      reactionCount: 384
                      reactionsByType:
                        - type: Like
                          count: 298
                        - type: Love
                          count: 41
                        - type: Care
                          count: 9
                      replyCount: 39
                      feedbackId: ZmVlZGJhY2s6MTY5MzI2NDEwNTQ5MzQ1Nl8xNzQ1MDUyMjE2NzU2NzU1
                      expansionToken: >-
                        MjoxNzkxMjExMzk3OgF_HIAX-f0wTYZqa3QX3TjwNoBCTq4GPTzR62zawBtiYeBVxalDarnwQ5pSPMlo79S1hiwbCHY8oz0D-EPKliRAP8VlbB18sUvcmsKBK28xR7Jz7ZzUIeblBoAgmhYboZ5ICMxqos7qrKbIzHP0YkIWrIcJiIISi_9sEuhKTTkh5BkltkFSMtJ8PKg_AVD0zXPKUTDvaO0gSLlpfFbYCfgfd5fGZQIPn2fzvIvghmBewaO7oDiiEqUDGaOz165Jdun9fx4PtKixXyaRgOgxxXRq1jT7SYmXorxE7bC5nMG5B4uTkOjpY7wwb4Ha_oW5Ag5saX_oTLGXVHHqPTQGsWnKdkjAGl1ytN-xEyi8PLIK2NykiCQjQQ6oF9J-ysJem4UlPFuYP6tQEFX7gb532m7Av8Be5Ys5GFABmWUqru_vV2aLnNHiFFupDYng8-CFhgncx9PIEpcwN0ha0rvkFlUXlpPRZQtmZtGcnS0EFACpvPWukcP7KUYEF9PUR9w04_NIpBpZR6gN-S78GMpWkAEwC5KMlzGggoDFz_r5AVVVtTqnYiPOBQIiKloWj3iq2ait-3fCw5QBUYKGGwcoWkUDrANHfvm_aV6OZrImW5uQ8JCFhdmfLXeTvgUs5hGKKUGx81e_kTZzk30KKjZYgfcSpsMDgMjxED30MxanFN6DlVwDVkDmcIlu-atwAB0mvY0
                      url: >-
                        https://www.facebook.com/reel/1549207066583030/?comment_id=1745052216756755
                      depth: 0
                      isAuthorOriginalPoster: false
                      attachments: []
                    - id: Y29tbWVudDoxNjkzMjY0MTA1NDkzNDU2XzEwMjU4NzI3MDAxOTAyNDY=
                      legacyId: '1025872700190246'
                      text: If Messi wouldn't born Ronaldo would be the goat
                      author:
                        id: '61554105182262'
                        name: Denlex Triippieer
                        shortName: Denlex
                        url: >-
                          https://www.facebook.com/people/Denlex-Triippieer/61554105182262/
                        avatarUrl: >-
                          https://scontent-los4-1.xx.fbcdn.net/v/t39.30808-1/733557643_122280531416136839_4457820044621939827_n.jpg?stp=c170.0.440.440a_cp0_dst-jpg_tt6&cstp=mx440x440&ctp=s32x32&_nc_cat=101&ccb=1-7&_nc_sid=1d2534&_nc_ohc=8ndpUMHZ5ksQ7kNvwHQclmr&_nc_oc=AdqscMbbsdseFpUHThBIHYyTcv91yYqMUthfGQG2pyzG26aLBj__A37NJI4n5VNuJT8&_nc_zt=24&_nc_ht=scontent-los4-1.xx&_nc_gid=Nwt4peo_wBdHc47ogjq9Fg&_nc_ss=7c289&oh=00_AQOjuyjhqRRFWO8QaXql4JYjoeeHZYzf4nVfX0WwQgVPNw&oe=6AC9706F
                        verified: false
                        gender: MALE
                        isPage: false
                      createdAt: '2026-07-21T14:15:27.000Z'
                      createdTimestamp: 1784643327
                      reactionCount: 192
                      reactionsByType:
                        - type: Like
                          count: 157
                        - type: Love
                          count: 19
                        - type: Care
                          count: 5
                      replyCount: 25
                      feedbackId: ZmVlZGJhY2s6MTY5MzI2NDEwNTQ5MzQ1Nl8xMDI1ODcyNzAwMTkwMjQ2
                      expansionToken: >-
                        MjoxNzkxMjExMzk3OgF_-dACXEeP2He2UF5Yi-dLrqd_Wy4G2XqsNO-nmnIcek0abxPSi39wIbbTWTEO4Y3C9q0eAFaWOWvG7C24AmEUhNunmmUcFGvDED7WnsK4S4Zka0bOnjqjaWiB_nZqhceavc2ufSNHDk847b2nn7vAAnbOSnBOpnoTCRHL0ED2v_pDKIgKfr5J6bys46dNWzr2O0ojexksMzwe0tZckCds7EE4wTme8lMZTlJ5cr7G8u9nxSj2c8d8HxYDfyapHJd-VUcdCDvvhkqUa_zR7ImWwFqe775nWTQtrHY5fQWcl8uJRDtMuZV9l-dHE5BcKyWQ2RnT6aEOxRD4ChDBZM59NWHTXXS2CGp_BS8BSKtuDbttiTK5d9Ek1I72U4LBIh4iOO5qabvqtxMPJCZt1pfP2jobdpSBpGnslLkMQnbi6HYcaa8AnPLpu4hoXg6IVP0eaaOVBkE2_JzhPvxfh3pwBVMybEjq9PavAb_GqzqFA8O5efcq1RnbEYWwxYjO6JkYZONxqGw0Bfh_QNIUcgV6mBZCF_fejHln24c5anmX4NcHZ_e6NMNgmQ6FTUZx5ihlxEqXDeZhLZ5-ijc1UvwqtmQjvpL75IUrEA55S4kCYMuI0Hvu1TboCLbgHKhIspJAtkIqudhpdZMES57HEWEsBbOvrju0dXqVvVGy3KmNp5ETisbzTYs-IuGR2-zyBto
                      url: >-
                        https://www.facebook.com/reel/1549207066583030/?comment_id=1025872700190246
                      depth: 0
                      isAuthorOriginalPoster: false
                      attachments: []
                  commentCount: 10
                  paging:
                    cursor: >-
                      MToxNzkxMjExMzk3OgF_FGr6iQFHo5LPuxb-_0zYRiTdafeVXNCo9f4vv13s5acda125lFvO9pS3kAwZaeIg0XomWE2PCa9NB4HUdXV7w4Z7uuzufuOKpGZAv5pMUwoZsH-pbwF4IHl5Vw3E9WVoxKf6X-gAQ6n7PYvwbHD0Pl_q1XxQc0GVt2nHY4qrDWKmCetpnFSsLkfd00dDNlKHpR3YudHWHUFCctRR5eObEfr4d5QhnoLyaq8F_xo1tvQot-CpSVF_xw-MctN47lQ3LDggTiUkSLCgpe6mc45dzw567rOocIpYIZ8GfaCRV1DRR0KH-V1Ki5g2gVdXB1ar_zW9ybniNZvwxBFc6LDozUnjit0WVDoo5c38Hnr5Q4ozdZUdbpS3MY01G0nyyhGXvV7gZnuaZWE1KHZZf_mfnGWWXNtMXOF5WZHhN0izjrauzxi2awKZOAXzx7Klg6WRXWs
                    hasNextPage: true
                  feedbackId: ZmVlZGJhY2s6MTY5MzI2NDEwNTQ5MzQ1Ng==
                  fetchedAt: '2026-10-05T14:43:18.396Z'
                meta:
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
                  creditsCharged: 1
                  creditsRemaining: 4999
                  cached: false
        '400':
          description: Invalid or expired cursor.
          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: Post/reel not found, or feedback id invalid.
          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 (missing url and feedbackId).
          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: 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.