Piloterr Proshop API

The Proshop API from Piloterr — 2 operation(s) for proshop.

GitHub OpenAPI

Operations 4

POST /v2/proshop/search Proshop Search #
GET /v2/proshop/product Proshop Product #
POST /v2/proshop/product Proshop Product #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/piloterr-com:piloterr-com-proshop-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

piloterr-com-proshop-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Piloterr API Reference Proshop API
  description: Complete API reference documentation.
  version: 1.0.0
servers:
- url: https://api.piloterr.com
  description: API Server
tags:
- name: Proshop
paths:
  /v2/proshop/search:
    get:
      summary: Proshop Search
      description: 'Search proshop.dk by keyword or search URL. Returns product cards with DKK prices and pagination.


        **Credit cost:** 1 credit per call'
      operationId: get-proshop-search
      security:
      - ApiKeyAuth: []
      parameters:
      - name: query
        in: query
        required: true
        description: 'Keyword or a full Proshop search URL with s=. A product URL is rejected.


          **Examples:**


          ```

          ssd

          ```


          ```

          https://www.proshop.dk/?s=ssd

          ```'
        schema:
          type: string
          description: 'Keyword or a full Proshop search URL with s=. A product URL is rejected.


            **Examples:**


            ```

            ssd

            ```


            ```

            https://www.proshop.dk/?s=ssd

            ```'
      - name: page
        in: query
        required: false
        description: Page number starting at 1. Proshop sends this as pn.
        schema:
          type: number
          minimum: 1
          maximum: 500
          description: Page number starting at 1. Proshop sends this as pn.
      - name: return_page_source
        in: query
        required: false
        description: 'When true, return the raw HTML as {"result": "..."}.'
        schema:
          type: boolean
          description: 'When true, return the raw HTML as {"result": "..."}.'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/is_async'
      - $ref: '#/components/parameters/soft_fail'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        url:
                          type: string
                        name:
                          type: string
                        price:
                          type: integer
                        summary:
                          type: string
                        currency:
                          type: string
                        in_stock:
                          type: boolean
                        image_url:
                          type: string
                        availability:
                          type: string
                        price_ex_vat:
                          type: integer
                        price_display:
                          type: string
                        price_ex_vat_display:
                          type: string
                  pagination:
                    type: object
                    properties:
                      next:
                        type: string
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_pages:
                        type: integer
                      total_results:
                        type: integer
              examples:
                Search ssd on proshop.dk:
                  value:
                    results:
                    - id: '3071602'
                      url: https://www.proshop.dk/SSD/Verbatim-Vi550-S3-SSD-512GB-SATA-600-25/3071602
                      name: Verbatim Vi550 S3 SSD - 512GB - SATA-600 - 2.5"
                      price: 580
                      summary: 'SSD (Solid State Drive), 512 GB, intern, overførselshastighed: 520 MB/s (læs) / 500 MB/s (skriv), IOPS: 75413 IOPS (læs) / 86756 IOPS (skriv), størrelse: 2.5", SATA-600 tilslutning, farve: sort'
                      currency: DKK
                      in_stock: true
                      image_url: https://www.proshop.dk/Images/174x116/3071602_95234c5c86d9.jpg
                      availability: På lager – Levering i morgen (bestil inden kl. 22)
                      price_ex_vat: 464
                      price_display: 580,00 kr.
                      price_ex_vat_display: 464,00 kr.
                    pagination:
                      next: https://www.proshop.dk/?s=ssd&pn=2
                      page: 1
                      per_page: 25
                      total_pages: 95
                      total_results: 2364
        '400':
          description: Bad Request — missing or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
        '401':
          description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidKey:
                  value:
                    error: Invalid API Key
                planRateLimit:
                  value:
                    error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
                keyQuota:
                  value:
                    error: 'Rate limit exceeded for the API key: quota monthly'
        '402':
          description: Payment Required — your subscription or credit balance is insufficient.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Payment required
        '500':
          description: Internal Server Error — something went wrong on our side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Error
      tags:
      - Proshop
    post:
      summary: Proshop Search
      description: 'Search proshop.dk by keyword or search URL. Returns product cards with DKK prices and pagination.


        **Credit cost:** 1 credit per call'
      operationId: post-proshop-search
      security:
      - ApiKeyAuth: []
      parameters:
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/is_async'
      - $ref: '#/components/parameters/soft_fail'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
                  description: 'Keyword or a full Proshop search URL with s=. A product URL is rejected.


                    **Examples:**


                    ```

                    ssd

                    ```


                    ```

                    https://www.proshop.dk/?s=ssd

                    ```'
                page:
                  type: number
                  minimum: 1
                  maximum: 500
                  description: Page number starting at 1. Proshop sends this as pn.
                return_page_source:
                  type: boolean
                  description: 'When true, return the raw HTML as {"result": "..."}.'
              required:
              - query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        url:
                          type: string
                        name:
                          type: string
                        price:
                          type: integer
                        summary:
                          type: string
                        currency:
                          type: string
                        in_stock:
                          type: boolean
                        image_url:
                          type: string
                        availability:
                          type: string
                        price_ex_vat:
                          type: integer
                        price_display:
                          type: string
                        price_ex_vat_display:
                          type: string
                  pagination:
                    type: object
                    properties:
                      next:
                        type: string
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_pages:
                        type: integer
                      total_results:
                        type: integer
              examples:
                Search ssd on proshop.dk:
                  value:
                    results:
                    - id: '3071602'
                      url: https://www.proshop.dk/SSD/Verbatim-Vi550-S3-SSD-512GB-SATA-600-25/3071602
                      name: Verbatim Vi550 S3 SSD - 512GB - SATA-600 - 2.5"
                      price: 580
                      summary: 'SSD (Solid State Drive), 512 GB, intern, overførselshastighed: 520 MB/s (læs) / 500 MB/s (skriv), IOPS: 75413 IOPS (læs) / 86756 IOPS (skriv), størrelse: 2.5", SATA-600 tilslutning, farve: sort'
                      currency: DKK
                      in_stock: true
                      image_url: https://www.proshop.dk/Images/174x116/3071602_95234c5c86d9.jpg
                      availability: På lager – Levering i morgen (bestil inden kl. 22)
                      price_ex_vat: 464
                      price_display: 580,00 kr.
                      price_ex_vat_display: 464,00 kr.
                    pagination:
                      next: https://www.proshop.dk/?s=ssd&pn=2
                      page: 1
                      per_page: 25
                      total_pages: 95
                      total_results: 2364
        '400':
          description: Bad Request — missing or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
        '401':
          description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidKey:
                  value:
                    error: Invalid API Key
                planRateLimit:
                  value:
                    error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
                keyQuota:
                  value:
                    error: 'Rate limit exceeded for the API key: quota monthly'
        '402':
          description: Payment Required — your subscription or credit balance is insufficient.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Payment required
        '500':
          description: Internal Server Error — something went wrong on our side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Error
      tags:
      - Proshop
  /v2/proshop/product:
    get:
      summary: Proshop Product
      description: 'Read one proshop.dk product page. Flat JSON with DKK price, EAN, specs, and stock text.


        **Credit cost:** 1 credit per call'
      operationId: get-proshop-product
      security:
      - ApiKeyAuth: []
      parameters:
      - name: query
        in: query
        required: true
        description: 'Proshop product id, or a product URL. The id is the last path segment.


          **Examples:**


          ```

          3071602

          ```


          ```

          https://www.proshop.dk/SSD/Verbatim-Vi550-S3-SSD-512GB-SATA-600-25/3071602

          ```'
        schema:
          type: string
          description: 'Proshop product id, or a product URL. The id is the last path segment.


            **Examples:**


            ```

            3071602

            ```


            ```

            https://www.proshop.dk/SSD/Verbatim-Vi550-S3-SSD-512GB-SATA-600-25/3071602

            ```'
      - name: return_page_source
        in: query
        required: false
        description: 'When true, return the raw HTML as {"result": "..."}.'
        schema:
          type: boolean
          description: 'When true, return the raw HTML as {"result": "..."}.'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/is_async'
      - $ref: '#/components/parameters/soft_fail'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  ean:
                    type: string
                  mpn:
                    type: string
                  sku:
                    type: string
                  url:
                    type: string
                  name:
                    type: string
                  brand:
                    type: string
                  price:
                    type: integer
                  images:
                    type: array
                    items:
                      type: string
                  summary:
                    type: string
                  currency:
                    type: string
                  in_stock:
                    type: boolean
                  image_url:
                    type: string
                  breadcrumbs:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: string
                        name:
                          type: string
                  availability:
                    type: string
                  price_ex_vat:
                    type: integer
                  price_display:
                    type: string
                  specifications:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        value:
                          type: string
                  price_ex_vat_display:
                    type: string
              examples:
                Verbatim Vi550 512GB on proshop.dk:
                  value:
                    id: '3071602'
                    ean: 0023942493525
                    mpn: '49352'
                    sku: '3071602'
                    url: https://www.proshop.dk/3071602
                    name: Verbatim Vi550 S3 SSD - 512GB - SATA-600 - 2.5"
                    brand: Verbatim
                    price: 580
                    images:
                    - https://www.proshop.dk/Images/915x900/3071602_95234c5c86d9.jpg
                    - https://www.proshop.dk/Images/915x900/3071602_349c4c4c7a0f.jpg
                    - https://www.proshop.dk/Images/915x900/3071602_14c535b3fa39.jpg
                    - https://www.proshop.dk/Images/915x900/3071602_ca0e5223d5b8.jpg
                    summary: 'SSD (Solid State Drive), 512 GB, intern, overførselshastighed: 520 MB/s (læs) / 500 MB/s (skriv), IOPS: 75413 IOPS (læs) / 86756 IOPS (skriv), størrelse: 2.5", SATA-600 tilslutning, farve: sort'
                    currency: DKK
                    in_stock: true
                    image_url: https://www.proshop.dk/Images/915x900/3071602_95234c5c86d9.jpg
                    breadcrumbs:
                    - url: https://www.proshop.dk/
                      name: Forside
                    - url: https://www.proshop.dk/Hardware
                      name: Hardware
                    - url: https://www.proshop.dk/SSD
                      name: SSD
                    - url: https://www.proshop.dk/SSD/Verbatim
                      name: Verbatim SSD
                    availability: 15+ stk. på lager – Levering i morgen (bestil inden kl. 22)
                    price_ex_vat: 464
                    price_display: 580,00 kr.
                    specifications:
                    - name: Producent
                      value: Verbatim
                    - name: Varenummer
                      value: '3071602'
                    - name: Model
                      value: '49352'
                    - name: Ean
                      value: 0023942493525
                    - name: Til producentens hjemmeside
                      value: www.verbatim-europe.co.uk/en/prod/vi550-...
                    - name: Produktbeskrivelse
                      value: Verbatim Vi550 - SSD - 512 GB - SATA 6Gb/s
                    - name: Type
                      value: Solid state-drev - intern
                    - name: Kapacitet
                      value: 512 GB
                    - name: Model
                      value: 2.5"
                    - name: Grænseflade
                      value: SATA 6Gb/s
                    - name: Dataoverførselshastighed
                      value: 600 MBps
                    - name: Egenskaber
                      value: 3D NAND Technology, Phison PS3111 controller, S.M.A.R.T.
                    - name: Dimensioner (B x D x H)
                      value: 71 mm x 100 mm x 7 mm
                    - name: Enhedstype
                      value: Solid state-drev - intern
                    - name: Bredde
                      value: 71 mm
                    - name: Dybde
                      value: 100 mm
                    - name: Højde
                      value: 7 mm
                    - name: SSD-udholdenhed
                      value: 360 TB
                    - name: Overføringshastighed, drev
                      value: 600 MBps (ekstern)
                    - name: Intern datahastighed
                      value: 560 MBps (læs) / 535 MBps (skriv)
                    - name: 4KB Random Read
                      value: 75413 IOPS
                    - name: 4KB Random Write
                      value: 86756 IOPS
                    - name: MTBF (forventet tid mellem fejl)
                      value: 2,000,000 timer
                    - name: Interface
                      value: 1 x SATA 6 Gb/s
                    - name: Kompatibel bås
                      value: 2.5"
                    - name: Strømforbrug
                      value: 1430 mW (læs) 1670 mW (skriv) 320 mW (ledig)
                    - name: Overensstemmelsesstandarder
                      value: RoHS
                    - name: Min. driftstemperatur
                      value: 0 °C
                    - name: Maks. driftstemperatur
                      value: 70 °C
                    - name: Min. lagertemperatur
                      value: -40 °C
                    - name: Maks. Opbevaringstemperatur
                      value: 85 °C
                    - name: Modstandsdygtighed over for stød (operativ)
                      value: 1500 g @ 0,5 ms halvsinuskurve
                    price_ex_vat_display: 464,00 kr.
        '400':
          description: Bad Request — missing or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
        '401':
          description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidKey:
                  value:
                    error: Invalid API Key
                planRateLimit:
                  value:
                    error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
                keyQuota:
                  value:
                    error: 'Rate limit exceeded for the API key: quota monthly'
        '402':
          description: Payment Required — your subscription or credit balance is insufficient.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Payment required
        '500':
          description: Internal Server Error — something went wrong on our side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Error
      tags:
      - Proshop
    post:
      summary: Proshop Product
      description: 'Read one proshop.dk product page. Flat JSON with DKK price, EAN, specs, and stock text.


        **Credit cost:** 1 credit per call'
      operationId: post-proshop-product
      security:
      - ApiKeyAuth: []
      parameters:
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/is_async'
      - $ref: '#/components/parameters/soft_fail'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
                  description: 'Proshop product id, or a product URL. The id is the last path segment.


                    **Examples:**


                    ```

                    3071602

                    ```


                    ```

                    https://www.proshop.dk/SSD/Verbatim-Vi550-S3-SSD-512GB-SATA-600-25/3071602

                    ```'
                return_page_source:
                  type: boolean
                  description: 'When true, return the raw HTML as {"result": "..."}.'
              required:
              - query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  ean:
                    type: string
                  mpn:
                    type: string
                  sku:
                    type: string
                  url:
                    type: string
                  name:
                    type: string
                  brand:
                    type: string
                  price:
                    type: integer
                  images:
                    type: array
                    items:
                      type: string
                  summary:
                    type: string
                  currency:
                    type: string
                  in_stock:
                    type: boolean
                  image_url:
                    type: string
                  breadcrumbs:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: string
                        name:
                          type: string
                  availability:
                    type: string
                  price_ex_vat:
                    type: integer
                  price_display:
                    type: string
                  specifications:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        value:
                          type: string
                  price_ex_vat_display:
                    type: string
              examples:
                Verbatim Vi550 512GB on proshop.dk:
                  value:
                    id: '3071602'
                    ean: 0023942493525
                    mpn: '49352'
                    sku: '3071602'
                    url: https://www.proshop.dk/3071602
                    name: Verbatim Vi550 S3 SSD - 512GB - SATA-600 - 2.5"
                    brand: Verbatim
                    price: 580
                    images:
                    - https://www.proshop.dk/Images/915x900/3071602_95234c5c86d9.jpg
                    - https://www.proshop.dk/Images/915x900/3071602_349c4c4c7a0f.jpg
                    - https://www.proshop.dk/Images/915x900/3071602_14c535b3fa39.jpg
                    - https://www.proshop.dk/Images/915x900/3071602_ca0e5223d5b8.jpg
                    summary: 'SSD (Solid State Drive), 512 GB, intern, overførselshastighed: 520 MB/s (læs) / 500 MB/s (skriv), IOPS: 75413 IOPS (læs) / 86756 IOPS (skriv), størrelse: 2.5", SATA-600 tilslutning, farve: sort'
                    currency: DKK
                    in_stock: true
                    image_url: https://www.proshop.dk/Images/915x900/3071602_95234c5c86d9.jpg
                    breadcrumbs:
                    - url: https://www.proshop.dk/
                      name: Forside
                    - url: https://www.proshop.dk/Hardware
                      name: Hardware
                    - url: https://www.proshop.dk/SSD
                      name: SSD
                    - url: https://www.proshop.dk/SSD/Verbatim
                      name: Verbatim SSD
                    availability: 15+ stk. på lager – Levering i morgen (bestil inden kl. 22)
                    price_ex_vat: 464
                    price_display: 580,00 kr.
                    specifications:
                    - name: Producent
                      value: Verbatim
                    - name: Varenummer
                      value: '3071602'
                    - name: Model
                      value: '49352'
                    - name: Ean
                      value: 0023942493525
                    - name: Til producentens hjemmeside
                      value: www.verbatim-europe.co.uk/en/prod/vi550-...
                    - name: Produktbeskrivelse
                      value: Verbatim Vi550 - SSD - 512 GB - SATA 6Gb/s
                    - name: Type
                      value: Solid state-drev - intern
                    - name: Kapacitet
                      value: 512 GB
                    - name: Model
                      value: 2.5"
                    - name: Grænseflade
                      value: SATA 6Gb/s
                    - name: Dataoverførselshastighed
                      value: 600 MBps
                    - name: Egenskaber
                      value: 3D NAND Technology, Phison PS3111 controller, S.M.A.R.T.
                    - name: Dimensioner (B x D x H)
                      value: 71 mm x 100 mm x 7 mm
                    - name: Enhedstype
                      value: Solid state-drev - intern
                    - name: Bredde
                      value: 71 mm
                    - name: Dybde
                      value: 100 mm
                    - name: Højde
                      value: 7 mm
                    - name: SSD-udholdenhed
                      value: 360 TB
                    - name: Overføringshastighed, drev
                      value: 600 MBps (ekstern)
                    - name: Intern datahastighed
                      value: 560 MBps (læs) / 535 MBps (skriv)
                    - name: 4KB Random Read
                      value: 75413 IOPS
                    - name: 4KB Random Write
                      value: 86756 IOPS
                    - name: MTBF (forventet tid mellem fejl)
                      value: 2,000,000 timer
                    - name: Interface
                      value: 1 x SATA 6 Gb/s
                    - name: Kompatibel bås
                      value: 2.5"
                    - name: Strømforbrug
                      value: 1430 mW (læs) 1670 mW (skriv) 320 mW (ledig)
                    - name: Overensstemmelsesstandarder
                      value: RoHS
                    - name: Min. driftstemperatur
                      value: 0 °C
                    - name: Maks. driftstemperatur
                      value: 70 °C
                    - name: Min. lagertemperatur
                      value: -40 °C
                    - name: Maks. Opbevaringstemperatur
                      value: 85 °C
                    - name: Modstandsdygtighed over for stød (operativ)
                      value: 1500 g @ 0,5 ms halvsinuskurve
                    price_ex_vat_display: 464,00 kr.
        '400':
          description: Bad Request — missing or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
        '401':
          description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidKey:
                  value:
                    error: Invalid API Key
                planRateLimit:
                  value:
                    error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
                keyQuota:
                  value:
                    error: 'Rate limit exceeded for the API key: quota monthly'
        '402':
          description: Payment Required — your subscription or credit balance is insufficient.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Payment required
        '500':
          description: Internal Server Error — something went wrong on our side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Error
      tags:
      - Proshop
components:
  parameters:
    fields:
      name: fields
      in: query
      required: false
      description: Comma-separated list of response fields to return, with dot notation for nested fields (e.g. `name,location.city`).
      schema:
        type: string
    is_async:
      name: is_async
      in: query
      required: false
      description: 'Run the request as a background job: the API answers `202` with a `job_id` to poll on `GET /v1/jobs/{id}`.'
      schema:
        type: boolean
        default: false
    soft_fail:
      name: soft_fail
      in: query
      required: false
      description: Return HTTP 200 even when the request fails; the error is in the `error` field of the body.
      schema:
        type: boolean
        default: false
  schemas:
    ErrorResponse:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          description: Human-readable error message.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Your API key. Include it in the x-api-key header for every request.