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

# User posts

> Fetches a public Threads account's posts by username — the threads on its Threads tab, newest first (a pinned post comes first on page 1), 15 per page with a `cursor` for the next. Replies are not included (see `/v1/threads/post`). Each post has its id, link, text, date, author, like, reply, repost, quote and share counts, images, videos and carousels (with alt text), mentions and links, its topic, link preview, text attachment, GIFs and stickers, music, podcast or episode, an embedded Instagram post, the quoted post, and pinned, spoiler and AI-label flags. Also returns the account (id, name, picture, verified, private, follower count). A private account returns no posts. Only publicly available data is returned.

<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/threads/user/posts. Here are the details:

  Endpoint: GET https://api.scraperize.com/v1/threads/user/posts
  Description: Fetches a public Threads account's posts by username — the threads on its Threads tab, newest first (a pinned post comes first on page 1), 15 per page with a `cursor` for the next. Replies are not included (see `/v1/threads/post`). Each post has its id, link, text, date, author, like, reply, repost, quote and share counts, images, videos and carousels (with alt text), mentions and links, its topic, link preview, text attachment, GIFs and stickers, music, podcast or episode, an embedded Instagram post, the quoted post, and pinned, spoiler and AI-label flags. Also returns the account (id, name, picture, verified, private, follower count). A private account returns no posts. Only publicly available data is returned.

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

  Parameters:
  - handle (string) [required]: The Threads username, e.g. `zuck` (an `@handle` or `threads.com/@...` URL also works).
  - cursor (string): The `cursor` from the previous page, to get the next one.
  - 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": {
      "user": {
        "id": "63055343223",
        "handle": "zuck",
        "fullName": "Mark Zuckerberg",
        "url": "https://www.threads.com/@zuck",
        "profilePicUrl": "https://scontent-los4-1.cdninstagram.com/v/t51.82787-19/825322135_17989325280103224_1252773933700107438_n.jpg?stp=dst-jpg_s150x150_tt6&efg=eyJ2ZW5jb2RlX3RhZyI6I…",
        "isVerified": true,
        "isPrivate": false,
        "followerCount": 5754774
      },
      "posts": [
        {
          "id": "4006434140014576097",
          "code": "DeZtp-TkQHh",
          "url": "https://www.threads.com/@zuck/post/DeZtp-TkQHh",
          "text": "Introducing Muse Wonder, our new family of frontier models with state of the art performance for personal and professional agentic work.",
          "createdAt": "2026-10-12T16:56:29.000Z",
          "isEdited": false,
          "language": null,
          "author": {
            "id": "63055343223",
            "handle": "zuck",
            "url": "https://www.threads.com/@zuck",
            "fullName": "Mark Zuckerberg",
            "profilePicUrl": "https://scontent-los4-1.cdninstagram.com/v/t51.82787-19/825322135_17989325280103224_1252773933700107438_n.jpg?stp=dst-jpg_s206x206_tt6&_nc_cat=107&ccb=7-5&_nc_s…",
            "isVerified": true
          },
          "mediaType": "image",
          "media": [
            {
              "type": "image",
              "url": "https://scontent-los4-1.cdninstagram.com/v/t51.82787-15/844965867_17991705567103224_8296143909108287920_n.webp?_nc_cat=109&ig_cache_key=NDAwNjQzNDE0MDAxNDU3NjA5…",
              "thumbnailUrl": null,
              "width": 2160,
              "height": 3260,
              "altText": null,
              "hasAudio": null
            }
          ],
          "likeCount": 2075,
          "replyCount": 457,
          "repostCount": 163,
          "quoteCount": 59,
          "shareCount": 142,
          "countsHidden": false,
          "mentions": [],
          "links": [],
          "topic": null,
          "linkPreview": null,
          "textAttachment": null,
          "gif": null,
          "stickers": [],
          "music": null,
          "podcast": null,
          "podcastEpisode": null,
          "instagramPost": null,
          "quotedPost": null,
          "isQuotedPostUnavailable": false,
          "isReply": false,
          "replyToAuthor": null,
          "rootPostAuthor": null,
          "isPinned": false,
          "isPinnedReply": false,
          "isSpoiler": false,
          "replyControl": "everyone",
          "aiDetectionMethod": null
        }
      ],
      "count": 15,
      "cursor": "AQHT4MAGHbQVkD07zuZQoX_OblA2Yn8tt43VFAZK_FW-npgofrOrHHvHCvV9Zao7uhTwkfV568eoBlo7nSQ7DkFPRw",
      "hasMore": true,
      "fetchedAt": "2026-10-19T09:39:17.188Z"
    },
    "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/threads/user/posts
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
paths:
  /v1/threads/user/posts:
    get:
      tags:
        - Threads
      summary: User posts
      description: >-
        Fetches a public Threads account's posts by username — the threads on
        its Threads tab, newest first (a pinned post comes first on page 1), 15
        per page with a `cursor` for the next. Replies are not included (see
        `/v1/threads/post`). Each post has its id, link, text, date, author,
        like, reply, repost, quote and share counts, images, videos and
        carousels (with alt text), mentions and links, its topic, link preview,
        text attachment, GIFs and stickers, music, podcast or episode, an
        embedded Instagram post, the quoted post, and pinned, spoiler and
        AI-label flags. Also returns the account (id, name, picture, verified,
        private, follower count). A private account returns no posts. Only
        publicly available data is returned.
      parameters:
        - name: handle
          in: query
          required: true
          description: >-
            The Threads username, e.g. `zuck` (an `@handle` or
            `threads.com/@...` URL also works).
          schema:
            type: string
          example: zuck
        - name: cursor
          in: query
          required: false
          description: The `cursor` from the previous page, to get the next one.
          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 account and one page of its threads.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      user:
                        type: object
                        nullable: true
                      posts:
                        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:
                  user:
                    id: '63055343223'
                    handle: zuck
                    fullName: Mark Zuckerberg
                    url: https://www.threads.com/@zuck
                    profilePicUrl: >-
                      https://scontent-los4-1.cdninstagram.com/v/t51.82787-19/825322135_17989325280103224_1252773933700107438_n.jpg?stp=dst-jpg_s150x150_tt6&efg=eyJ2ZW5jb2RlX3RhZyI6InByb2ZpbGVfcGljLmRqYW5nby4xMDgwLmMyIn0&_nc_ht=scontent-los4-1.cdninstagram.com&_nc_cat=100&_nc_oc=Q6cZ2gEboLW4DKSrHcbpie-oRsUc60RTmYQWBM0pj9ZWDp1dEZiiZqWFM-K_Cc5F0BkdqAo&_nc_ohc=Mt_GHrIBPnQQ7kNvwG-U6x1&_nc_gid=z3S0kptOVvPuvMskG4Z6fg&edm=APs17CUBAAAA&ccb=7-5&oh=00_AQP9O5zQCaVXPzqj-f24bfnlW0f2Aab1XHCMv2ssIK4XNg&oe=6ADBC72B&_nc_sid=10d13b
                    isVerified: true
                    isPrivate: false
                    followerCount: 5754774
                  posts:
                    - id: '4006434140014576097'
                      code: DeZtp-TkQHh
                      url: https://www.threads.com/@zuck/post/DeZtp-TkQHh
                      text: >-
                        Introducing Muse Wonder, our new family of frontier
                        models with state of the art performance for personal
                        and professional agentic work.
                      createdAt: '2026-10-12T16:56:29.000Z'
                      isEdited: false
                      language: null
                      author:
                        id: '63055343223'
                        handle: zuck
                        url: https://www.threads.com/@zuck
                        fullName: Mark Zuckerberg
                        profilePicUrl: >-
                          https://scontent-los4-1.cdninstagram.com/v/t51.82787-19/825322135_17989325280103224_1252773933700107438_n.jpg?stp=dst-jpg_s206x206_tt6&_nc_cat=107&ccb=7-5&_nc_sid=30ff31&efg=eyJ2ZW5jb2RlX3RhZyI6InByb2ZpbGVfcGljLnd3dy4xMDgwLkMzIn0%3D&_nc_ohc=dyzJhQmgZIYQ7kNvwEbGzZs&_nc_oc=AdrmmK8SKqPWnJP2BIHndf5olhoKhAY_ScJ5Yc96s4qGIi_j3tY7ArgaLpO70P6zLC0&_nc_zt=24&_nc_ht=scontent-los4-1.cdninstagram.com&_nc_gid=i16onB2g271e7SdKdtt4bw&_nc_ss=7c289&oh=00_AQNU_p4HyYLwezfau8UT8GinYAcnIY3tR7o8Mo_NJkfL6g&oe=6ADBC72B
                        isVerified: true
                      mediaType: image
                      media:
                        - type: image
                          url: >-
                            https://scontent-los4-1.cdninstagram.com/v/t51.82787-15/844965867_17991705567103224_8296143909108287920_n.webp?_nc_cat=109&ig_cache_key=NDAwNjQzNDE0MDAxNDU3NjA5Nw%3D%3D.3-ccb7-5&ccb=7-5&_nc_sid=58cdad&efg=eyJ2ZW5jb2RlX3RhZyI6IkZFRUQueHBpZHMuMjE2MC5zZHIucmVndWxhcl9waG90by5DMyJ9&_nc_ohc=AlVTUhTGdD8Q7kNvwE73Qa-&_nc_oc=Adp-ix74SF9PaysrJvJ6rwYVbcEvzFCK6fruNSGSjYylq1CGKlsBjU5CQ5iCc0gdmMw&_nc_zt=23&_nc_ht=scontent-los4-1.cdninstagram.com&_nc_gid=i16onB2g271e7SdKdtt4bw&_nc_ss=7c289&oh=00_AQNxcYkhEAjRexZ6IgacF_g3Nb2LCm587Gom-9FliAirjg&oe=6ADBCEF0
                          thumbnailUrl: null
                          width: 2160
                          height: 3260
                          altText: null
                          hasAudio: null
                      likeCount: 2075
                      replyCount: 457
                      repostCount: 163
                      quoteCount: 59
                      shareCount: 142
                      countsHidden: false
                      mentions: []
                      links: []
                      topic: null
                      linkPreview: null
                      textAttachment: null
                      gif: null
                      stickers: []
                      music: null
                      podcast: null
                      podcastEpisode: null
                      instagramPost: null
                      quotedPost: null
                      isQuotedPostUnavailable: false
                      isReply: false
                      replyToAuthor: null
                      rootPostAuthor: null
                      isPinned: false
                      isPinnedReply: false
                      isSpoiler: false
                      replyControl: everyone
                      aiDetectionMethod: null
                    - id: '4006376160339141718'
                      code: DeZgeQhm6RW
                      url: https://www.threads.com/@zuck/post/DeZgeQhm6RW
                      text: Muse ordered me 🍉 how thoughtful!
                      createdAt: '2026-10-12T15:01:17.000Z'
                      isEdited: false
                      language: null
                      author:
                        id: '63055343223'
                        handle: zuck
                        url: https://www.threads.com/@zuck
                        fullName: Mark Zuckerberg
                        profilePicUrl: >-
                          https://scontent-los4-1.cdninstagram.com/v/t51.82787-19/825322135_17989325280103224_1252773933700107438_n.jpg?stp=dst-jpg_s206x206_tt6&_nc_cat=107&ccb=7-5&_nc_sid=30ff31&efg=eyJ2ZW5jb2RlX3RhZyI6InByb2ZpbGVfcGljLnd3dy4xMDgwLkMzIn0%3D&_nc_ohc=dyzJhQmgZIYQ7kNvwEbGzZs&_nc_oc=AdrmmK8SKqPWnJP2BIHndf5olhoKhAY_ScJ5Yc96s4qGIi_j3tY7ArgaLpO70P6zLC0&_nc_zt=24&_nc_ht=scontent-los4-1.cdninstagram.com&_nc_gid=i16onB2g271e7SdKdtt4bw&_nc_ss=7c289&oh=00_AQNU_p4HyYLwezfau8UT8GinYAcnIY3tR7o8Mo_NJkfL6g&oe=6ADBC72B
                        isVerified: true
                      mediaType: image
                      media:
                        - type: image
                          url: >-
                            https://scontent-los4-1.cdninstagram.com/v/t51.82787-15/843592055_17991691623103224_8086321653765802754_n.webp?_nc_cat=102&ig_cache_key=NDAwNjM3NjE2MDMzOTE0MTcxOA%3D%3D.3-ccb7-5&ccb=7-5&_nc_sid=58cdad&efg=eyJ2ZW5jb2RlX3RhZyI6IkZFRUQueHBpZHMuMTUwMC5zZHIucmVndWxhcl9waG90by5DMyJ9&_nc_ohc=CmgthCChTzwQ7kNvwFkGqD9&_nc_oc=Ado6tYo6WPbYedKNyu1tazFLtjYP2A0Y6qr0Wf0YOr5pGj--DGEN5I06K_sC-3eoBRA&_nc_zt=23&_nc_ht=scontent-los4-1.cdninstagram.com&_nc_gid=i16onB2g271e7SdKdtt4bw&_nc_ss=7c289&oh=00_AQNPqd3evL5LgIOtxv80YYcMrhaMgXwiGx0fPduwuuFm-A&oe=6ADBCDE8
                          thumbnailUrl: null
                          width: 1500
                          height: 2000
                          altText: null
                          hasAudio: null
                      likeCount: 1576
                      replyCount: 469
                      repostCount: 108
                      quoteCount: 37
                      shareCount: 72
                      countsHidden: false
                      mentions: []
                      links: []
                      topic: null
                      linkPreview: null
                      textAttachment: null
                      gif: null
                      stickers: []
                      music: null
                      podcast: null
                      podcastEpisode: null
                      instagramPost: null
                      quotedPost: null
                      isQuotedPostUnavailable: false
                      isReply: false
                      replyToAuthor: null
                      rootPostAuthor: null
                      isPinned: false
                      isPinnedReply: false
                      isSpoiler: false
                      replyControl: everyone
                      aiDetectionMethod: null
                    - id: '3996155940894885511'
                      code: Dd1MqfcG0aH
                      url: https://www.threads.com/@zuck/post/Dd1MqfcG0aH
                      text: >-
                        We believe superintelligence will create significant new
                        opportunities for all people and businesses. Meta
                        already serves billions of people at scale and helps
                        hundreds of millions of businesses reach customers.
                        Today we are starting the next major pillar of our
                        business, Meta Enterprise Platform, to help businesses
                        use AI to grow and transform in new ways as well.
                      createdAt: '2026-09-28T12:35:32.000Z'
                      isEdited: false
                      language: null
                      author:
                        id: '63055343223'
                        handle: zuck
                        url: https://www.threads.com/@zuck
                        fullName: Mark Zuckerberg
                        profilePicUrl: >-
                          https://scontent-los4-1.cdninstagram.com/v/t51.82787-19/825322135_17989325280103224_1252773933700107438_n.jpg?stp=dst-jpg_s206x206_tt6&_nc_cat=107&ccb=7-5&_nc_sid=30ff31&efg=eyJ2ZW5jb2RlX3RhZyI6InByb2ZpbGVfcGljLnd3dy4xMDgwLkMzIn0%3D&_nc_ohc=dyzJhQmgZIYQ7kNvwEbGzZs&_nc_oc=AdrmmK8SKqPWnJP2BIHndf5olhoKhAY_ScJ5Yc96s4qGIi_j3tY7ArgaLpO70P6zLC0&_nc_zt=24&_nc_ht=scontent-los4-1.cdninstagram.com&_nc_gid=i16onB2g271e7SdKdtt4bw&_nc_ss=7c289&oh=00_AQNU_p4HyYLwezfau8UT8GinYAcnIY3tR7o8Mo_NJkfL6g&oe=6ADBC72B
                        isVerified: true
                      mediaType: text
                      media: []
                      likeCount: 2744
                      replyCount: 2658
                      repostCount: 173
                      quoteCount: 160
                      shareCount: 180
                      countsHidden: false
                      mentions: []
                      links: []
                      topic: null
                      linkPreview: null
                      textAttachment: null
                      gif: null
                      stickers: []
                      music: null
                      podcast: null
                      podcastEpisode: null
                      instagramPost: null
                      quotedPost: null
                      isQuotedPostUnavailable: false
                      isReply: false
                      replyToAuthor: null
                      rootPostAuthor: null
                      isPinned: false
                      isPinnedReply: false
                      isSpoiler: false
                      replyControl: everyone
                      aiDetectionMethod: null
                  count: 15
                  cursor: >-
                    AQHT4MAGHbQVkD07zuZQoX_OblA2Yn8tt43VFAZK_FW-npgofrOrHHvHCvV9Zao7uhTwkfV568eoBlo7nSQ7DkFPRw
                  hasMore: true
                  fetchedAt: '2026-10-19T09:39:17.188Z'
                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: No Threads profile found for that handle.
          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.
          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.