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

# Batch scrape results

> Read the finished pages of a batch scrape, a page of results at a time. Send one request and get JSON back. Examples in cURL, TypeScript and Python.

## Price

Free.

See [Pricing](https://docs.stophy.dev/account/pricing.md).

## Pages

A full answer holds a `cursor`. Send it back as the `cursor` parameter, with the same filters, to read the next page. When the answer has no `cursor`, you have read everything.

```bash cURL theme={null}
curl https://api.stophy.dev/v1/batch/scrape/job__SDlT-N1YqzQRoYCvKUTAg/results \
  -H "Authorization: Bearer $STOPHY_API_KEY"
```

```typescript TypeScript theme={null}
const response = await fetch("https://api.stophy.dev/v1/batch/scrape/job__SDlT-N1YqzQRoYCvKUTAg/results", {
  headers: {
    Authorization: `Bearer ${process.env.STOPHY_API_KEY}`,
  },
});
console.log(await response.json());
```

```python Python theme={null}
import os

import requests

response = requests.get(
    "https://api.stophy.dev/v1/batch/scrape/job__SDlT-N1YqzQRoYCvKUTAg/results",
    headers={"Authorization": f"Bearer {os.environ['STOPHY_API_KEY']}"},
)
print(response.json())
```

```json 200 theme={null}
{
  "success": true,
  "data": {
    "id": "job__SDlT-N1YqzQRoYCvKUTAg",
    "status": "completed",
    "total": 2,
    "completed": 2,
    "failed": 0,
    "creditsUsed": 1,
    "costUsd": 0.002,
    "errors": [],
    "results": [
      {
        "markdown": "# bunfig.toml\n\n> Configure Bun's behavior using its configuration file bunfig.toml\n\n`bunfig.toml` is Bun's…",
        "isTruncated": false,
        "metadata": {
          "title": "bunfig.toml",
          "sourceURL": "https://bun.com/docs/runtime/bunfig",
          "url": "https://bun.com/docs/runtime/bunfig",
          "statusCode": 200,
          "contentType": "text/markdown",
          "cacheState": "hit",
          "cachedAt": "2026-11-16T09:58:50.588Z",
          "proxyUsed": "basic"
        },
        "url": "https://bun.com/docs/runtime/bunfig",
        "creditsUsed": 1,
        "costUsd": 0.001
      }
    ]
  },
  "costUsd": 0,
  "creditsUsed": 0,
  "requestId": "b5799a70-26f1-4200-81e2-6e574dd8a780"
}
```


## OpenAPI

````yaml api-reference/openapi.json GET /v1/batch/scrape/{id}/results
openapi: 3.1.0
info:
  title: Stophy API
  version: '1'
  description: >-
    Each operation shows its method and its input: a JSON object body, path and
    query parameters, or a file upload.


    Responses leave out empty values: null, empty strings, empty objects and
    empty nested lists are not sent.


    Text comes back whole. To get shorter responses, add
    ?maxTextLength=<characters> to the URL. Every text value longer than that is
    cut and ends with …. A screenshot is never cut, and a page whose text was
    cut has isTruncated set to true.


    x-cost-usd is what one call costs, in dollars. Every call costs the same,
    whatever it returns, unless an operation's description says it costs per 10
    results, or per hour of audio. Then x-cost-usd is the lowest price and
    x-cost-usd-max the most one call can cost. Where an operation takes limit,
    send it to return fewer results and pay for fewer.


    When a response has a cursor, send it back unchanged with the same input to
    get the next page. When it has a page, send the next page number.
servers:
  - url: https://api.stophy.dev
security:
  - apiKey: []
paths:
  /v1/batch/scrape/{id}/results:
    get:
      summary: Read the finished pages of a batch scrape, a page of results at a time
      description: Costs $0 per 1,000 calls. Pages with cursor.
      operationId: batchScrapeResults
      parameters:
        - $ref: '#/components/parameters/MaxTextLength'
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: limit
          in: query
          required: false
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: The data, and what this call cost in dollars.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestId'
            x-credits-used:
              $ref: '#/components/headers/CreditsUsed'
            x-cost-usd:
              $ref: '#/components/headers/CostUsd'
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            x-cache:
              $ref: '#/components/headers/Cache'
            x-cache-age:
              $ref: '#/components/headers/CacheAge'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - costUsd
                  - creditsUsed
                  - requestId
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    additionalProperties: false
                    properties:
                      id:
                        type: string
                      status:
                        type: string
                        enum:
                          - scraping
                          - completed
                          - cancelled
                          - failed
                      total:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      completed:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      failed:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      creditsUsed:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      costUsd:
                        type: number
                      message:
                        type: string
                      position:
                        type: integer
                        minimum: 1
                        maximum: 9007199254740991
                      errors:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          properties:
                            url:
                              type: string
                            code:
                              type: string
                            message:
                              type: string
                            retryable:
                              type: boolean
                              default: false
                            at:
                              type: number
                          required:
                            - retryable
                      results:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          properties:
                            markdown:
                              type: string
                            pages:
                              description: >-
                                For a PDF read with the pdf parser and pages
                                true: each page's markdown.
                              type: array
                              items:
                                type: object
                                additionalProperties: false
                                properties:
                                  pageNumber:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  markdown:
                                    type: string
                                required:
                                  - pageNumber
                            blocks:
                              description: >-
                                For a PDF read with the pdf parser and blocks
                                true: each title, section header or run of text
                                with its page, order, bbox and span.
                              type: array
                              items:
                                type: object
                                propertyNames:
                                  type: string
                                additionalProperties:
                                  $ref: >-
                                    #/components/schemas/batchScrapeResults.schema0
                            summary:
                              description: A short summary of the page.
                              type: string
                            answer:
                              description: >-
                                The answer to the question format. Left out,
                                with a warning, when the page does not state
                                one.
                              type: string
                            product:
                              description: >-
                                The product the page sells: title, brand,
                                category, url, description and variants, each
                                with its price, sale, availability and images.
                                Left out, with a warning, when the page is not a
                                product page.
                              type: object
                              propertyNames:
                                type: string
                              additionalProperties: {}
                            menu:
                              description: >-
                                The menu on the page: isMenu, confidence,
                                merchant, currency and sections with their
                                items. Left out, with a warning, when the page
                                is not a menu.
                              type: object
                              propertyNames:
                                type: string
                              additionalProperties: {}
                            html:
                              type: string
                            rawHtml:
                              type: string
                            audio:
                              description: >-
                                A link to the audio of a YouTube video as an M4A
                                file. The link works for 1 hour.
                              type: string
                              format: uri
                            video:
                              description: >-
                                A link to a YouTube video as an MP4 file with
                                sound, in the best single-file quality YouTube
                                offers. The link works for 1 hour.
                              type: string
                              format: uri
                            rawBase64:
                              description: >-
                                The bytes the site sent, Base64 encoded, without
                                a data: prefix. metadata.contentType says what
                                they are. Always read live.
                              type: string
                            links:
                              type: array
                              items:
                                type: string
                            images:
                              type: array
                              items:
                                type: string
                            screenshot:
                              description: >-
                                A link to a JPEG of the page. The link works for
                                7 days.
                              type: string
                              format: uri
                            screenshotCropped:
                              description: >-
                                true when the page was taller than the
                                screenshot, so the bottom is cut off.
                              type: boolean
                            highlights:
                              description: >-
                                The passages that best match the highlights
                                query, best first.
                              type: array
                              items:
                                type: object
                                additionalProperties: false
                                properties:
                                  section:
                                    type: string
                                  text:
                                    type: string
                                required: []
                            network:
                              description: >-
                                The JSON responses the page loaded while it
                                rendered, with their bodies.
                              type: array
                              items:
                                type: object
                                additionalProperties: false
                                properties:
                                  url:
                                    type: string
                                  method:
                                    type: string
                                  status:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  contentType:
                                    type: string
                                  body:
                                    type: string
                                required:
                                  - status
                            branding:
                              description: >-
                                The page's look: colorScheme, logo, colors
                                (hex), fonts, typography, spacing, components,
                                images and layout. Each field is left out or
                                null when the page does not show it.
                              type: object
                              additionalProperties: false
                              properties:
                                colorScheme:
                                  type: string
                                  enum:
                                    - light
                                    - dark
                                logo:
                                  type: string
                                colors:
                                  type: object
                                  additionalProperties: false
                                  properties:
                                    primary:
                                      type: string
                                      pattern: ^#[0-9a-f]{6}$
                                    secondary:
                                      type: string
                                      pattern: ^#[0-9a-f]{6}$
                                    accent:
                                      type: string
                                      pattern: ^#[0-9a-f]{6}$
                                    background:
                                      type: string
                                      pattern: ^#[0-9a-f]{6}$
                                    textPrimary:
                                      type: string
                                      pattern: ^#[0-9a-f]{6}$
                                    textSecondary:
                                      type: string
                                      pattern: ^#[0-9a-f]{6}$
                                    link:
                                      type: string
                                      pattern: ^#[0-9a-f]{6}$
                                    success:
                                      type: string
                                      pattern: ^#[0-9a-f]{6}$
                                    warning:
                                      type: string
                                      pattern: ^#[0-9a-f]{6}$
                                    error:
                                      type: string
                                      pattern: ^#[0-9a-f]{6}$
                                  required: []
                                fonts:
                                  type: array
                                  items:
                                    type: object
                                    additionalProperties: false
                                    properties:
                                      family:
                                        type: string
                                        minLength: 1
                                    required:
                                      - family
                                typography:
                                  type: object
                                  additionalProperties: false
                                  properties:
                                    fontFamilies:
                                      type: object
                                      additionalProperties: false
                                      properties:
                                        primary:
                                          type: string
                                          minLength: 1
                                        heading:
                                          type: string
                                          minLength: 1
                                        code:
                                          type: string
                                          minLength: 1
                                      required: []
                                    fontSizes:
                                      type: object
                                      additionalProperties: false
                                      properties:
                                        h1:
                                          type: string
                                          minLength: 1
                                        h2:
                                          type: string
                                          minLength: 1
                                        h3:
                                          type: string
                                          minLength: 1
                                        body:
                                          type: string
                                          minLength: 1
                                      required: []
                                    fontWeights:
                                      type: object
                                      additionalProperties: false
                                      properties:
                                        light:
                                          type: integer
                                          minimum: -9007199254740991
                                          maximum: 9007199254740991
                                        regular:
                                          type: integer
                                          minimum: -9007199254740991
                                          maximum: 9007199254740991
                                        medium:
                                          type: integer
                                          minimum: -9007199254740991
                                          maximum: 9007199254740991
                                        bold:
                                          type: integer
                                          minimum: -9007199254740991
                                          maximum: 9007199254740991
                                      required: []
                                    lineHeights:
                                      type: object
                                      additionalProperties: false
                                      properties:
                                        heading:
                                          type: string
                                          minLength: 1
                                        body:
                                          type: string
                                          minLength: 1
                                      required: []
                                  required: []
                                spacing:
                                  type: object
                                  additionalProperties: false
                                  properties:
                                    baseUnit:
                                      type: integer
                                      minimum: -9007199254740991
                                      maximum: 9007199254740991
                                    borderRadius:
                                      type: string
                                      minLength: 1
                                    padding:
                                      type: object
                                      propertyNames:
                                        type: string
                                      additionalProperties:
                                        type: string
                                        minLength: 1
                                    margins:
                                      type: object
                                      propertyNames:
                                        type: string
                                      additionalProperties:
                                        type: string
                                        minLength: 1
                                  required: []
                                components:
                                  type: object
                                  additionalProperties: false
                                  properties:
                                    buttonPrimary:
                                      type: object
                                      additionalProperties: false
                                      properties:
                                        background:
                                          type: string
                                          pattern: ^#[0-9a-f]{6}$
                                        textColor:
                                          type: string
                                          pattern: ^#[0-9a-f]{6}$
                                        borderRadius:
                                          type: string
                                          minLength: 1
                                      required: []
                                    buttonSecondary:
                                      type: object
                                      additionalProperties: false
                                      properties:
                                        background:
                                          type: string
                                          pattern: ^#[0-9a-f]{6}$
                                        textColor:
                                          type: string
                                          pattern: ^#[0-9a-f]{6}$
                                        borderColor:
                                          type: string
                                          pattern: ^#[0-9a-f]{6}$
                                        borderRadius:
                                          type: string
                                          minLength: 1
                                      required: []
                                    input:
                                      type: object
                                      propertyNames:
                                        type: string
                                      additionalProperties:
                                        type: string
                                        minLength: 1
                                  required: []
                                icons:
                                  type: object
                                  propertyNames:
                                    type: string
                                  additionalProperties:
                                    type: string
                                    minLength: 1
                                images:
                                  type: object
                                  additionalProperties: false
                                  properties:
                                    logo:
                                      type: string
                                    favicon:
                                      type: string
                                    ogImage:
                                      type: string
                                  required: []
                                animations:
                                  type: object
                                  propertyNames:
                                    type: string
                                  additionalProperties:
                                    type: string
                                    minLength: 1
                                layout:
                                  type: object
                                  propertyNames:
                                    type: string
                                  additionalProperties:
                                    type: string
                                    minLength: 1
                                personality:
                                  type: object
                                  propertyNames:
                                    type: string
                                  additionalProperties:
                                    type: string
                                    minLength: 1
                              required:
                                - colorScheme
                            networkDropped:
                              description: >-
                                How many JSON responses were left out because
                                the page loaded too many or they were too big.
                              type: integer
                              exclusiveMinimum: 0
                              maximum: 9007199254740991
                            json:
                              description: >-
                                What you asked for with the json format. A page
                                from a site Stophy reads natively, such as a
                                Reddit post, comes back as its own data. Any
                                other page comes back as the fields in your
                                schema or prompt, each null when the page does
                                not state it.
                              type: object
                              propertyNames:
                                type: string
                              additionalProperties: {}
                            changeTracking:
                              description: >-
                                new the first time your key reads this page,
                                same when nothing changed, changed with a
                                unified diff of the markdown when something did.
                                With json mode, json holds each field's previous
                                and current value.
                              type: object
                              additionalProperties: false
                              properties:
                                status:
                                  type: string
                                  enum:
                                    - new
                                    - same
                                    - changed
                                previousAt:
                                  type: string
                                  format: date-time
                                  pattern: >-
                                    ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                                diff:
                                  type: string
                                json:
                                  type: object
                                  propertyNames:
                                    type: string
                                  additionalProperties:
                                    type: object
                                    additionalProperties: false
                                    properties:
                                      previous:
                                        $ref: >-
                                          #/components/schemas/batchScrapeResults.schema0
                                      current:
                                        $ref: >-
                                          #/components/schemas/batchScrapeResults.schema0
                                    required: []
                              required:
                                - status
                            attributes:
                              description: >-
                                The values the attributes format read, one entry
                                per selector.
                              type: array
                              items:
                                type: object
                                additionalProperties: false
                                properties:
                                  selector:
                                    type: string
                                  attribute:
                                    type: string
                                  values:
                                    type: array
                                    items:
                                      type: string
                                required: []
                            actions:
                              description: >-
                                What the screenshot, scrape, executeJavascript
                                and pdf actions captured, each in the order the
                                actions ran: screenshots and pdfs as links that
                                work for 7 days, scrapes as the page url and
                                html at that point, javascriptReturns as the
                                type and value each script returned.
                              type: object
                              additionalProperties: false
                              properties:
                                screenshots:
                                  type: array
                                  items:
                                    type: string
                                    format: uri
                                scrapes:
                                  type: array
                                  items:
                                    type: object
                                    additionalProperties: false
                                    properties:
                                      url:
                                        type: string
                                      html:
                                        type: string
                                    required: []
                                javascriptReturns:
                                  type: array
                                  items:
                                    type: object
                                    additionalProperties: false
                                    properties:
                                      type:
                                        type: string
                                      value: {}
                                    required: []
                                pdfs:
                                  type: array
                                  items:
                                    type: string
                                    format: uri
                              required: []
                            warning:
                              description: >-
                                Set when an action failed: it names the action
                                and says why. The rest of the answer is the page
                                as it stood before that action.
                              type: string
                            isTruncated:
                              type: boolean
                            nextOffset:
                              description: >-
                                Where the next part of the text starts, when
                                more follows. Send it as offset, with the same
                                maxChars, to read on.
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            metadata:
                              type: object
                              additionalProperties:
                                anyOf:
                                  - type: string
                                  - type: number
                                  - type: array
                                    items:
                                      type: string
                              description: >-
                                Facts about the page: sourceURL is the address
                                you sent and url is where it ended up after
                                redirects. Named page facts such as ogTitle,
                                publishedTime or keywords appear when the page
                                has them, and every meta tag also appears under
                                its own name, such as og:title.
                              properties:
                                title:
                                  type: string
                                description:
                                  type: string
                                language:
                                  type: string
                                ogImage:
                                  type: string
                                sourceURL:
                                  type: string
                                url:
                                  type: string
                                statusCode:
                                  type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                contentType:
                                  type: string
                                cacheState:
                                  type: string
                                  enum:
                                    - hit
                                    - miss
                                    - stale
                                cachedAt:
                                  type: string
                                  format: date-time
                                  pattern: >-
                                    ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                                numPages:
                                  type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                totalPages:
                                  type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                ocrPages:
                                  description: >-
                                    PDF pages whose text was read from their
                                    picture.
                                  type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                proxyUsed:
                                  description: >-
                                    Which read got the page: basic or enhanced.
                                    null when a stored copy does not say.
                                  type: string
                                  enum:
                                    - basic
                                    - enhanced
                              required:
                                - statusCode
                                - cacheState
                            url:
                              type: string
                            creditsUsed:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            costUsd:
                              type: number
                          required:
                            - isTruncated
                            - metadata
                            - creditsUsed
                            - costUsd
                      cursor:
                        type: string
                    required:
                      - status
                      - total
                      - completed
                      - failed
                      - creditsUsed
                      - costUsd
                      - results
                      - errors
                  creditsUsed:
                    type: integer
                  costUsd:
                    type: number
                    description: What this call cost, in dollars.
                  requestId:
                    type: string
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
components:
  parameters:
    MaxTextLength:
      name: maxTextLength
      in: query
      required: false
      description: >-
        Cut every text value in the response to this many characters. A value
        that was cut ends with …, and a page whose text was cut has isTruncated
        set to true. A screenshot is never cut. Leave it out to get the full
        text.
      schema:
        type: integer
        minimum: 1
  headers:
    RequestId:
      description: The request id. Quote it when you report a problem.
      schema:
        type: string
    CreditsUsed:
      description: >-
        Older header: what this call cost, as whole steps of $0.002. Use
        x-cost-usd.
      schema:
        type: integer
    CostUsd:
      description: What this call cost, in dollars.
      schema:
        type: string
    RateLimitLimit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window.
      schema:
        type: integer
    RateLimitReset:
      description: Unix time in seconds when the current window resets.
      schema:
        type: integer
    Cache:
      description: hit if this result came from the cache, miss if it was fetched live.
      schema:
        type: string
    CacheAge:
      description: Seconds since the returned result was written to the cache.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  schemas:
    batchScrapeResults.schema0:
      anyOf:
        - type: string
        - type: number
        - type: boolean
        - type: 'null'
        - type: array
          items:
            $ref: '#/components/schemas/batchScrapeResults.schema0'
        - type: object
          propertyNames:
            type: string
          additionalProperties:
            $ref: '#/components/schemas/batchScrapeResults.schema0'
    Error:
      type: object
      required:
        - success
        - error
        - code
      properties:
        success:
          const: false
        error:
          type: string
          description: What went wrong and what to do next.
        code:
          type: string
          enum:
            - apiKeyRequired
            - busy
            - checkRunning
            - cliSessionCompleted
            - cliSessionExists
            - cliSessionNotFound
            - forbidden
            - freeLimit
            - insufficientCredits
            - internalError
            - inviteClaimed
            - inviteDisabled
            - inviteExpired
            - inviteUsedUp
            - invalidCliSession
            - invalidCliVerifier
            - invalidRequest
            - jobFinished
            - methodNotAllowed
            - notFound
            - payloadTooLarge
            - profileBusy
            - profileTooLarge
            - prohibitedPermission
            - promptInjectionDetected
            - rateLimited
            - sourceChanged
            - sourceRefused
            - siteNotRead
            - sourceTimeout
            - sourceUnavailable
            - unauthorized
            - unsupportedMediaType
        retryable:
          type: boolean
          description: true when trying again can help.
        retryAfterSeconds:
          type: integer
        requestId:
          type: string
        requiredCredits:
          type: number
          description: >-
            Older field: the most the call can cost, in $0.002 steps. Sent when
            the balance is too low.
        availableCredits:
          type: number
          description: 'Older field: the balance in $0.002 steps. Sent with requiredCredits.'
        requiredUsd:
          type: number
          description: >-
            The most the call can cost, in dollars. Sent when the balance is too
            low.
        availableUsd:
          type: number
          description: What is left on the account, in dollars. Sent with requiredUsd.
        billingUrl:
          type: string
          description: Where to add money. Sent with requiredUsd.
        signupUrl:
          type: string
          const: https://stophy.dev/signup
          description: >-
            Where a person gets a key. Sent with apiKeyRequired, freeLimit and
            an invalid key.
        signup:
          type: string
          const: POST https://api.stophy.dev/v1/signup
          description: >-
            The call that gets an agent a key with no human. Sent next to
            signupUrl.
  responses:
    Error:
      description: The request failed. Retry-After says when trying again can help.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

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