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

# Extract Bing Search

> Get the organic results and the AI Overview, Bing's AI summary, from a Bing results page for a query, by country.

Extract the organic results and the AI Overview from a Bing results page (`bing.com/search`). The AI Overview is Bing's AI summary at the top of the results page. The fields have the same names and shapes as the [Google Search](https://cloro.dev/docs/api-reference/endpoint/monitor-google.md) fields.

This endpoint is not [Bing AI Mode](https://cloro.dev/docs/api-reference/endpoint/monitor-bing-aimode.md). Bing AI Mode returns the AI answer page at `bing.com/copilotsearch` for a `prompt`. Bing Search returns the results page for a `query`.

## Request parameters

`query` and `country` are required. The `include` flags are optional. There is no `state`, `location`, `device` or `pages`.

* **`query`**: Bing puts the query in the page URL, so the limit is 3,500 characters after URL encoding. This is the same limit as the [Bing AI Mode `prompt`](https://cloro.dev/docs/api-reference/endpoint/monitor-bing-aimode#request-parameters). A longer query returns a `400` with the message `Query is too long (max 3,500 characters, fewer for non-Latin scripts)`.
* **`country`**: sets Bing's market. All countries except `CN`, `KR` and `RU`. [`GET /v1/countries?model=bing`](https://cloro.dev/docs/api-reference/endpoint/countries) returns the list.
* **`include.aioverview`**: `true` or `{"markdown": true}`. It returns `result.aioverview`, and `{"markdown": true}` also returns `result.aioverview.markdown`. It adds +2 credits, as on Google Search. The add-on is charged also when Bing shows no AI summary.
* **`include.html`**: returns a URL to the results page that Bing rendered.

For async requests, send the same body as `payload` with `taskType: "BING"` to [`POST /v1/async/task`](https://cloro.dev/docs/api-reference/endpoint/create-async-task) or [`POST /v1/async/task/batch`](https://cloro.dev/docs/api-reference/endpoint/create-batch-tasks).

## Response schema

Includes the [common response fields](https://cloro.dev/docs/guides/making-requests/sync.md#common-response-fields) plus these fields:

| Field | Description |
| - | - |
| `result.organicResults` | The organic results of the first results page: `position`, `title`, `link`, `displayedLink`, `snippet`, `page` and, when Bing shows one, `date`. See [Google organic results](https://cloro.dev/docs/api-reference/endpoint/google/organic-results.md) for the fields. `link` is the destination URL, not Bing's click-tracking URL |
| `result.aioverview` | Bing's AI summary: `text`, `sources`, `citationPills` and, with `include.aioverview.markdown`, `markdown`. See [Google AI Overview](https://cloro.dev/docs/api-reference/endpoint/google/ai-overview) for the fields. A source has `description: null` when Bing shows no snippet for it. Only when `include.aioverview` is set, and omitted when Bing shows no AI summary |
| `result.html` | An array with a URL to the full page that Bing rendered. Only when `include.html` is `true` |

## Example

```json Request theme={null}
{
  "query": "how to remove rust from cast iron",
  "country": "US",
  "include": {
    "aioverview": true,
    "html": true
  }
}
```

```json Response theme={null}
{
  "success": true,
  "result": {
    "organicResults": [
      {
        "position": 1,
        "title": "How to Clean a Rusty Cast-Iron Skillet - Martha Stewart",
        "link": "https://www.marthastewart.com/how-to-clean-rusty-cast-iron-skillet-8408007",
        "displayedLink": "https://www.marthastewart.com",
        "snippet": "To remove rust, scrub the skillet with steel wool, soak it in a vinegar solution, and re-season it afterward. Prevent rust …",
        "page": 1
      },
      {
        "position": 2,
        "title": "10 Simple Ways to Remove Rust from Cast Iron - Tips Bulletin",
        "link": "https://www.tipsbulletin.com/how-to-remove-rust-from-cast-iron/",
        "displayedLink": "https://www.tipsbulletin.com › how-to-remove-rust-from-cast-iron",
        "snippet": "Learn 10 simple ways to clean rust from cast iron pans, pots, grills, and stoves. Find out how to prevent rust with …",
        "page": 1
      },
      {
        "position": 3,
        "title": "How To Clean Rust Off A Cast-Iron Pan - Southern Living",
        "link": "https://www.southernliving.com/how-to-clean-rust-off-a-cast-iron-pan-11856490",
        "displayedLink": "https://www.southernliving.com",
        "snippet": "Key Takeaways Scrub rust with vinegar or baking soda, then wash and dry the pan thoroughly. Re-season the pan …",
        "page": 1
      }
    ],
    "aioverview": {
      "text": "Rust can be safely removed from cast iron using abrasives, vinegar, or salt, followed by thorough drying and re-seasoning to restore its non-stick surface. ...",
      "sources": [
        {
          "label": "How Do You Remove Rust from Cast Iron Without Damaging It?",
          "url": "https://ironpatina.com/how-to-remove-rust-from-cast-iron-cookware-complete-guide-proven-techniques/",
          "description": null,
          "position": 1
        },
        {
          "label": "How to Remove Rust from a Cast Iron Skillet: 11 Steps",
          "url": "https://www.wikihow.com/Remove-Rust-from-a-Cast-Iron-Skillet",
          "description": null,
          "position": 2
        },
        {
          "label": "How to Remove Rust from Cast Iron - Bob Vila",
          "url": "https://www.bobvila.com/articles/how-to-remove-rust-from-cast-iron/",
          "description": null,
          "position": 3
        }
      ],
      "citationPills": [
        {
          "label": "How Do You Remove Rust from Cast Iron Without Damaging It?",
          "citationPillId": 1,
          "url": "https://ironpatina.com/how-to-remove-rust-from-cast-iron-cookware-complete-guide-proven-techniques/",
          "domain": "ironpatina.com",
          "position": 1
        },
        {
          "label": "How to Remove Rust from a Cast Iron Skillet: 11 Steps",
          "citationPillId": 1,
          "url": "https://www.wikihow.com/Remove-Rust-from-a-Cast-Iron-Skillet",
          "domain": "wikihow.com",
          "position": 2
        },
        {
          "label": "How to Remove Rust from Cast Iron - Bob Vila",
          "citationPillId": 1,
          "url": "https://www.bobvila.com/articles/how-to-remove-rust-from-cast-iron/",
          "domain": "bobvila.com",
          "position": 3
        }
      ]
    },
    "html": [
      "https://cdn.cloro.dev/results/5d0f3c8e-2b7a-4c1e-9f64-8a3e1b7d2c90/page-1.html"
    ]
  }
}
```

The chip in this example shows `ironpatina.com +2`, so its three sources share `citationPillId: 1`.


## OpenAPI

````yaml api-reference/openapi.json POST /v1/monitor/bing
openapi: 3.1.0
info:
  title: cloro
  description: >-
    API for monitoring AI responses across different providers and regions. One
    request returns the engine's answer as structured JSON: parsed text, cited
    sources, brand entities, shopping results, and ads, geo-targeted by country;
    coverage varies by provider (`GET /v1/countries?model=<provider>` lists it).


    ## Authentication


    Send your API key as `Authorization: Bearer <key>`. Keys are self-serve from
    the [dashboard](https://dashboard.cloro.dev/api-keys) and every account
    starts on a free tier of 500 monthly credits. One key grants every endpoint;
    there are no per-key scopes today.


    ## Versioning and deprecation


    The version is in the URL path. Every endpoint lives under `/v1/`; there is
    no version header or query parameter.


    Within a version, changes are additive: new endpoints, new optional request
    fields, and new response fields can appear at any time. A client must ignore
    response fields it does not recognize. A breaking change gets a new version
    path (`/v2/`) rather than reusing an existing one.


    A deprecated endpoint says so in its own responses, not only in a changelog:
    `Deprecation` (RFC 9745) carries the date the deprecation took effect,
    `Sunset` (RFC 8594) the date the endpoint stops responding, and a `Link`
    header with `rel="deprecation"` points at the replacement. There is a
    minimum of six months between the two dates for any generally available
    endpoint. Nothing is deprecated today.


    ## Rate limits


    Every authenticated response carries `X-RateLimit-Limit` and
    `X-RateLimit-Remaining`, so a client can self-throttle from the response it
    already has. Scrape endpoints (`/v1/monitor/*` except
    `/v1/monitor/google/goto`) also send the `X-Concurrency-*` headers once a
    request passes validation, and the `X-Credits-*` headers on a `200`. Every
    response carries `X-Request-ID` and `X-Latency-Ms`.


    A `429` has one of three codes: `RATE_LIMIT_EXCEEDED` (one-second window,
    clears almost immediately), `CONCURRENCY_LIMIT_EXCEEDED` (scrape endpoints;
    clears when your in-flight jobs finish) or `QUEUE_LIMIT_EXCEEDED` (async
    submission; clears as queued tasks start processing). None carries
    `Retry-After`, and the IETF `RateLimit-*` header names are not sent.


    ## Errors


    Every 4xx and 5xx response uses the `Error` envelope: `{ "success": false,
    "error": { "code", "message", "details", "timestamp" } }`. `error` is always
    an object. Branch on `error.code`, a stable machine-readable identifier;
    `message` is for a human reading a log, and `details` appears only when
    there is extra context. A `503` (`SERVICE_UNAVAILABLE`) is temporary: retry
    after the number of seconds in its `Retry-After` header.
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 1.0.0
  contact:
    name: cloro support
    email: support@cloro.dev
  termsOfService: https://cloro.dev/terms/
servers:
  - url: https://api.cloro.dev
    description: Production server
security:
  - bearerAuth: []
paths:
  /v1/monitor/bing:
    post:
      summary: Monitor Bing Search Results
      description: >-
        Extract the organic results and the AI Overview (Bing's AI summary) from
        a Bing results page (bing.com/search), in the country you select. This
        is not Bing AI Mode: for the AI answer page at bing.com/copilotsearch,
        use `POST /v1/monitor/bing/aimode`.
      operationId: monitorBing
      requestBody:
        description: Request parameters for monitoring Bing search results
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BingMonitorRequest'
            example:
              query: how to remove rust from cast iron
              country: US
              include:
                aioverview: true
        required: true
      responses:
        '200':
          description: successful Bing Search monitoring response
          headers:
            X-Concurrency-Limit:
              description: Maximum number of concurrent requests allowed
              schema:
                type: integer
                example: 10
            X-Concurrency-Current:
              description: Current number of concurrent requests
              schema:
                type: integer
                example: 3
            X-Concurrency-Remaining:
              description: Number of remaining concurrent slots available
              schema:
                type: integer
                example: 7
            X-Credits-Remaining:
              description: Number of credits remaining in user account
              schema:
                type: integer
                example: 4
            X-Credits-Charged:
              description: Number of credits charged for this request
              schema:
                type: integer
                example: 7
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-Request-ID:
              $ref: '#/components/headers/XRequestId'
            X-Latency-Ms:
              $ref: '#/components/headers/XLatencyMs'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BingMonitorResponse'
        '400':
          description: Bad Request - Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Unauthorized - Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Forbidden - Insufficient credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '429':
          description: Too Many Requests
          headers:
            X-Concurrency-Limit:
              description: Maximum number of concurrent requests allowed
              schema:
                type: integer
                example: 10
            X-Concurrency-Current:
              description: Current number of concurrent requests
              schema:
                type: integer
                example: 11
            X-Concurrency-Remaining:
              description: Number of remaining concurrent slots available
              schema:
                type: integer
                example: 0
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-Request-ID:
              $ref: '#/components/headers/XRequestId'
            X-Latency-Ms:
              $ref: '#/components/headers/XLatencyMs'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentLimitError'
        '499':
          description: Client Closed Request - Request was canceled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CanceledError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
components:
  schemas:
    BingMonitorRequest:
      required:
        - query
        - country
      type: object
      properties:
        query:
          description: >-
            The search query. Bing puts the query in the page URL, so the limit
            is 3,500 characters after URL encoding. A letter, digit or space
            counts as 1, most punctuation as 3, an accented or Cyrillic letter
            as 6, and a Chinese, Japanese or Korean character as 9. A longer
            query returns a 400 error: "Query is too long (max 3,500 characters,
            fewer for non-Latin scripts)".
          type: string
          minLength: 1
          maxLength: 3500
          example: how to remove rust from cast iron
        country:
          $ref: '#/components/schemas/CountryCode'
          description: >-
            Country/region code, using ISO 3166-1 alpha-2 country codes. The
            country sets Bing's market. Bing Search accepts all countries except
            CN, KR and RU. `GET /v1/countries?model=bing` returns the list.
        include:
          description: Optional flags for including additional response data
          type: object
          properties:
            html:
              description: >-
                Include a URL to the full HTML of the results page that Bing
                rendered
              type: boolean
              default: false
              example: false
            aioverview:
              description: >-
                Include the AI Overview, Bing's AI summary at the top of the
                results page, as `result.aioverview`. `true`, `{}` and
                `{"markdown": false}` return it without `markdown`. Send
                `{"markdown": true}` to also get `result.aioverview.markdown`.
                Paid add-on: +2 credits
                ([pricing](/guides/providers#provider-list-and-base-costs)).
              oneOf:
                - type: boolean
                - type: object
                  properties:
                    markdown:
                      description: >-
                        Include the AI Overview formatted as Markdown in
                        `result.aioverview.markdown`. Only `true` turns it on.
                      type: boolean
                      default: false
                      example: true
                  additionalProperties: false
              example: true
          additionalProperties: false
      additionalProperties: false
    BingMonitorResponse:
      required:
        - success
        - result
      type: object
      properties:
        success:
          type: boolean
          example: true
        result:
          description: Bing search results data
          type: object
          required:
            - organicResults
          properties:
            organicResults:
              type: array
              description: >-
                Organic results of the first results page, in the shape of the
                Google Search `organicResults`
              items:
                type: object
                required:
                  - position
                  - title
                  - link
                  - displayedLink
                  - snippet
                  - page
                properties:
                  position:
                    type: number
                    description: Position in search results (1-indexed)
                    example: 1
                  title:
                    type: string
                    description: Title of the search result
                    example: How to Clean a Rusty Cast-Iron Skillet - Martha Stewart
                  link:
                    type: string
                    description: URL of the search result, not Bing's click-tracking URL
                    example: >-
                      https://www.marthastewart.com/how-to-clean-rusty-cast-iron-skillet-8408007
                  displayedLink:
                    type: string
                    description: URL as Bing displays it in the results
                    example: https://www.marthastewart.com
                  snippet:
                    type: string
                    description: Text snippet under the result, without the date
                    example: >-
                      To remove rust, scrub the skillet with steel wool, soak it
                      in a vinegar solution, and re-season it afterward. Prevent
                      rust …
                  date:
                    type: string
                    description: >-
                      Date that Bing shows before the snippet. Omitted when Bing
                      shows none.
                    example: Aug 2, 2026
                  page:
                    type: number
                    description: Results page of this result. Always 1
                    example: 1
            aioverview:
              type: object
              description: >-
                The AI Overview, Bing's AI summary at the top of the results
                page, in the shape of the Google AI Overview. Only when
                `include.aioverview` is set. Omitted when Bing shows no AI
                summary for the query.
              required:
                - text
                - sources
              properties:
                text:
                  type: string
                  description: AI Overview text, without the citation chips
                  example: >-
                    Rust can be safely removed from cast iron using abrasives,
                    vinegar, or salt, followed by thorough drying and
                    re-seasoning to restore its non-stick surface...
                sources:
                  type: array
                  description: >-
                    The references of the AI summary in Bing's order, then any
                    other page that a citation chip links
                  items:
                    type: object
                    required:
                      - position
                      - label
                      - url
                      - description
                    properties:
                      position:
                        type: integer
                        description: 1-based position of the source in this array
                        example: 1
                      label:
                        type: string
                        description: Title of the source page
                        example: >-
                          How Do You Remove Rust from Cast Iron Without Damaging
                          It?
                      url:
                        type: string
                        description: URL of the source page
                        example: >-
                          https://ironpatina.com/how-to-remove-rust-from-cast-iron-cookware-complete-guide-proven-techniques/
                      description:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Snippet that Bing shows for the source. `null` when
                          Bing shows none.
                        example: null
                citationPills:
                  type: array
                  description: >-
                    Inline citation chips in the AI summary. Each entry is one
                    (chip, source) pair: when a chip cites N sources, the array
                    has N entries with the same `citationPillId`. Group by
                    `citationPillId` to get the chips. Omitted when the summary
                    has no chips.
                  items:
                    type: object
                    required:
                      - label
                      - citationPillId
                      - url
                      - domain
                      - position
                    properties:
                      label:
                        type: string
                        description: >-
                          Title of the cited source, the same as its `label` in
                          `sources`
                        example: >-
                          How Do You Remove Rust from Cast Iron Without Damaging
                          It?
                      citationPillId:
                        type: integer
                        description: >-
                          1-based ordinal that all entries from the same chip
                          share
                        example: 1
                      url:
                        type: string
                        description: Direct URL of the cited source
                        example: >-
                          https://ironpatina.com/how-to-remove-rust-from-cast-iron-cookware-complete-guide-proven-techniques/
                      domain:
                        type: string
                        description: Host extracted from `url`, for grouping and display
                        example: ironpatina.com
                      position:
                        type: integer
                        description: >-
                          1-based position of this source in the sibling
                          `sources` array
                        example: 1
                markdown:
                  type: string
                  description: >-
                    The AI Overview formatted as Markdown, with each chip
                    replaced by links to its sources. Only when
                    `include.aioverview.markdown` is `true`
                  example: >-
                    ## **Rust can be safely removed from cast iron using
                    abrasives, vinegar, or salt...
            html:
              type: array
              description: >-
                A URL to the full HTML of the results page that Bing rendered.
                Only when `include.html` is `true`
              items:
                type: string
                format: uri
              example:
                - >-
                  https://cdn.cloro.dev/results/5d0f3c8e-2b7a-4c1e-9f64-8a3e1b7d2c90/page-1.html
    ValidationError:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
              example: VALIDATION_ERROR
            message:
              type: string
              example: Request validation failed
            details:
              type: array
              description: >-
                One entry per invalid field. Sent on request-body validation
                errors.
              items:
                type: object
                properties:
                  field:
                    type: string
                    example: prompt
                  message:
                    type: string
                    example: Prompt cannot be empty
            timestamp:
              type: string
              format: date-time
              example: '2025-01-15T12:00:00.000Z'
    AuthenticationError:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - MISSING_API_KEY
                - INVALID_API_KEY_FORMAT
                - INVALID_OR_EXPIRED_API_KEY
              example: MISSING_API_KEY
            message:
              type: string
              example: Missing or invalid API key
            timestamp:
              type: string
              format: date-time
              example: '2025-01-15T12:00:00.000Z'
    ForbiddenError:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - INSUFFICIENT_CREDITS
              example: INSUFFICIENT_CREDITS
            message:
              type: string
              example: Insufficient credits
            timestamp:
              type: string
              format: date-time
              example: '2025-01-15T12:00:00.000Z'
    ConcurrentLimitError:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
              example: CONCURRENCY_LIMIT_EXCEEDED
            message:
              type: string
              example: Concurrency limit exceeded
            details:
              type: object
              properties:
                limit:
                  type: number
                  example: 10
            timestamp:
              type: string
              format: date-time
              example: '2025-01-15T12:00:00.000Z'
    CanceledError:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
              example: REQUEST_CANCELED
            message:
              type: string
              example: Request was canceled by client
            timestamp:
              type: string
              format: date-time
              example: '2025-01-15T12:00:00.000Z'
    InternalError:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
              example: INTERNAL_SERVER_ERROR
            message:
              type: string
              description: >-
                For example `Maximum retries exceeded` when every attempt
                failed, or `Internal server error` for an unexpected failure.
              example: Maximum retries exceeded
            timestamp:
              type: string
              format: date-time
              example: '2025-01-15T12:00:00.000Z'
    CountryCode:
      description: ISO 3166-1 alpha-2 country code.
      type: string
      enum:
        - AD
        - AE
        - AF
        - AG
        - AI
        - AL
        - AM
        - AO
        - AQ
        - AR
        - AS
        - AT
        - AU
        - AW
        - AX
        - AZ
        - BA
        - BB
        - BD
        - BE
        - BF
        - BG
        - BH
        - BI
        - BJ
        - BL
        - BM
        - BN
        - BO
        - BQ
        - BR
        - BS
        - BT
        - BV
        - BW
        - BY
        - BZ
        - CA
        - CC
        - CD
        - CF
        - CG
        - CH
        - CI
        - CK
        - CL
        - CM
        - CN
        - CO
        - CR
        - CU
        - CV
        - CW
        - CX
        - CY
        - CZ
        - DE
        - DJ
        - DK
        - DM
        - DO
        - DZ
        - EC
        - EE
        - EG
        - EH
        - ER
        - ES
        - ET
        - FI
        - FJ
        - FK
        - FM
        - FO
        - FR
        - GA
        - GB
        - GD
        - GE
        - GF
        - GG
        - GH
        - GI
        - GL
        - GM
        - GN
        - GP
        - GQ
        - GR
        - GS
        - GT
        - GU
        - GW
        - GY
        - HK
        - HM
        - HN
        - HR
        - HT
        - HU
        - ID
        - IE
        - IL
        - IM
        - IN
        - IO
        - IQ
        - IR
        - IS
        - IT
        - JE
        - JM
        - JO
        - JP
        - KE
        - KG
        - KH
        - KI
        - KM
        - KN
        - KP
        - KR
        - KW
        - KY
        - KZ
        - LA
        - LB
        - LC
        - LI
        - LK
        - LR
        - LS
        - LT
        - LU
        - LV
        - LY
        - MA
        - MC
        - MD
        - ME
        - MF
        - MG
        - MH
        - MK
        - ML
        - MM
        - MN
        - MO
        - MP
        - MQ
        - MR
        - MS
        - MT
        - MU
        - MV
        - MW
        - MX
        - MY
        - MZ
        - NA
        - NC
        - NE
        - NF
        - NG
        - NI
        - NL
        - 'NO'
        - NP
        - NR
        - NU
        - NZ
        - OM
        - PA
        - PE
        - PF
        - PG
        - PH
        - PK
        - PL
        - PM
        - PN
        - PR
        - PS
        - PT
        - PW
        - PY
        - QA
        - RE
        - RO
        - RS
        - RU
        - RW
        - SA
        - SB
        - SC
        - SD
        - SE
        - SG
        - SH
        - SI
        - SJ
        - SK
        - SL
        - SM
        - SN
        - SO
        - SR
        - SS
        - ST
        - SV
        - SX
        - SY
        - SZ
        - TC
        - TD
        - TF
        - TG
        - TH
        - TJ
        - TK
        - TL
        - TM
        - TN
        - TO
        - TR
        - TT
        - TV
        - TW
        - TZ
        - UA
        - UG
        - UM
        - US
        - UY
        - UZ
        - VA
        - VC
        - VE
        - VG
        - VI
        - VN
        - VU
        - WF
        - WS
        - XK
        - YE
        - YT
        - ZA
        - ZM
        - ZW
      example: US
  headers:
    XRateLimitLimit:
      description: Requests allowed in the current window.
      schema:
        type: integer
        example: 1000
    XRateLimitRemaining:
      description: Requests left in the current window.
      schema:
        type: integer
        example: 997
    XRequestId:
      description: Unique ID for this request. Support uses it to find your request.
      schema:
        type: string
        format: uuid
        example: b0864943-5d45-4796-bc64-f052661256f0
    XLatencyMs:
      description: >-
        Milliseconds the API spent on the request, from arrival to the start of
        the response. Excludes network transit.
      schema:
        type: integer
        example: 3420
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        cloro API key as a bearer token. One key grants every endpoint in this
        spec; per-key scopes are not available, so a client cannot request a
        narrower permission. Keys are created and revoked in the
        [dashboard](https://dashboard.cloro.dev/api-keys).

````

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