Piloterr Ikea API

The Ikea API from Piloterr — 2 operation(s) for ikea.

GitHub OpenAPI

Operations 4

POST /v2/ikea/search IKEA Search #
GET /v2/ikea/product IKEA Product #
POST /v2/ikea/product IKEA 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-ikea-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-ikea-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Piloterr API Reference Ikea API
  description: Complete API reference documentation.
  version: 1.0.0
servers:
- url: https://api.piloterr.com
  description: API Server
tags:
- name: Ikea
paths:
  /v2/ikea/search:
    get:
      summary: IKEA Search
      description: 'Search IKEA products from a search URL and retrieve prices, ratings, dimensions, images, and pagination.


        **Credit cost:** 1 credit per call'
      operationId: get-ikea-search
      security:
      - ApiKeyAuth: []
      parameters:
      - name: query
        in: query
        required: true
        description: "Full IKEA search URL.\n\n**Example 1 (French search):**\n\n    https://www.ikea.com/fr/fr/search/?q=meuble\n\n**Example 2 (page 2):**\n\n    https://www.ikea.com/fr/fr/search/?q=meuble&page=2\n\n**Example 3 (UK search):**\n\n    https://www.ikea.com/gb/en/search/?q=desk\n\n**Notes:**\n- Only `ikea.com` `/search/` URLs with a `q` parameter are accepted.\n- Copy the full URL from ikea.com, including country and language segments (`/fr/fr/`, `/gb/en/`, etc.).\n- Pagination via `?page=2` in the URL.\n- Use each result's `url` with the IKEA Product endpoint for full product data."
        schema:
          type: string
          description: "Full IKEA search URL.\n\n**Example 1 (French search):**\n\n    https://www.ikea.com/fr/fr/search/?q=meuble\n\n**Example 2 (page 2):**\n\n    https://www.ikea.com/fr/fr/search/?q=meuble&page=2\n\n**Example 3 (UK search):**\n\n    https://www.ikea.com/gb/en/search/?q=desk\n\n**Notes:**\n- Only `ikea.com` `/search/` URLs with a `q` parameter are accepted.\n- Copy the full URL from ikea.com, including country and language segments (`/fr/fr/`, `/gb/en/`, etc.).\n- Pagination via `?page=2` in the URL.\n- Use each result's `url` with the IKEA Product endpoint for full product data."
      - $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
                        image:
                          type: string
                        price:
                          type: string
                        title:
                          type: string
                        rating:
                          type: number
                        measure:
                          type: string
                        currency:
                          type: string
                        subtitle:
                          type: string
                        price_amount:
                          type: number
                        reviews_count:
                          type: integer
                        online_sellable:
                          type: boolean
                  pagination:
                    type: object
                    properties:
                      next:
                        type: integer
                      current:
                        type: integer
                      next_url:
                        type: string
                      per_page:
                        type: integer
                      total_count:
                        type: integer
                      total_pages:
                        type: integer
                      has_next_page:
                        type: boolean
              examples:
                Search meubles on IKEA France:
                  value:
                    results:
                    - id: '60282186'
                      url: https://www.ikea.com/fr/fr/p/lack-etagere-blanc-60282186/
                      image: https://www.ikea.com/fr/fr/images/products/lack-etagere-blanc__0246565_pe385541_s5.jpg
                      price: 69,99€
                      title: LACK
                      rating: 4.8
                      measure: 30x190 cm
                      currency: EUR
                      subtitle: Étagère
                      price_amount: 69.99
                      reviews_count: 327
                      online_sellable: true
                    - id: '20574587'
                      url: https://www.ikea.com/fr/fr/p/eket-element-2-portes-et-1-tablette-brun-motif-noyer-20574587/
                      image: https://www.ikea.com/fr/fr/images/products/eket-element-2-portes-et-1-tablette-brun-motif-noyer__1373669_pe960035_s5.jpg
                      price: 105€
                      title: EKET
                      rating: 3.3
                      measure: 70x35x70 cm
                      currency: EUR
                      subtitle: Élément 2 portes et 1 tablette
                      price_amount: 105
                      reviews_count: 184
                      online_sellable: true
                    - id: '80275887'
                      url: https://www.ikea.com/fr/fr/p/kallax-etagere-blanc-80275887/
                      image: https://www.ikea.com/fr/fr/images/products/kallax-etagere-blanc__0644757_pe702939_s5.jpg
                      price: 74,99€
                      title: KALLAX
                      rating: 4.7
                      measure: 77x147 cm
                      currency: EUR
                      subtitle: Étagère
                      price_amount: 74.99
                      reviews_count: 2742
                      online_sellable: true
                    pagination:
                      next: 2
                      current: 1
                      next_url: https://www.ikea.com/fr/fr/search/?q=meuble&page=2
                      per_page: 24
                      total_count: 766
                      total_pages: 32
                      has_next_page: true
        '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:
      - Ikea
    post:
      summary: IKEA Search
      description: 'Search IKEA products from a search URL and retrieve prices, ratings, dimensions, images, and pagination.


        **Credit cost:** 1 credit per call'
      operationId: post-ikea-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: "Full IKEA search URL.\n\n**Example 1 (French search):**\n\n    https://www.ikea.com/fr/fr/search/?q=meuble\n\n**Example 2 (page 2):**\n\n    https://www.ikea.com/fr/fr/search/?q=meuble&page=2\n\n**Example 3 (UK search):**\n\n    https://www.ikea.com/gb/en/search/?q=desk\n\n**Notes:**\n- Only `ikea.com` `/search/` URLs with a `q` parameter are accepted.\n- Copy the full URL from ikea.com, including country and language segments (`/fr/fr/`, `/gb/en/`, etc.).\n- Pagination via `?page=2` in the URL.\n- Use each result's `url` with the IKEA Product endpoint for full product data."
              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
                        image:
                          type: string
                        price:
                          type: string
                        title:
                          type: string
                        rating:
                          type: number
                        measure:
                          type: string
                        currency:
                          type: string
                        subtitle:
                          type: string
                        price_amount:
                          type: number
                        reviews_count:
                          type: integer
                        online_sellable:
                          type: boolean
                  pagination:
                    type: object
                    properties:
                      next:
                        type: integer
                      current:
                        type: integer
                      next_url:
                        type: string
                      per_page:
                        type: integer
                      total_count:
                        type: integer
                      total_pages:
                        type: integer
                      has_next_page:
                        type: boolean
              examples:
                Search meubles on IKEA France:
                  value:
                    results:
                    - id: '60282186'
                      url: https://www.ikea.com/fr/fr/p/lack-etagere-blanc-60282186/
                      image: https://www.ikea.com/fr/fr/images/products/lack-etagere-blanc__0246565_pe385541_s5.jpg
                      price: 69,99€
                      title: LACK
                      rating: 4.8
                      measure: 30x190 cm
                      currency: EUR
                      subtitle: Étagère
                      price_amount: 69.99
                      reviews_count: 327
                      online_sellable: true
                    - id: '20574587'
                      url: https://www.ikea.com/fr/fr/p/eket-element-2-portes-et-1-tablette-brun-motif-noyer-20574587/
                      image: https://www.ikea.com/fr/fr/images/products/eket-element-2-portes-et-1-tablette-brun-motif-noyer__1373669_pe960035_s5.jpg
                      price: 105€
                      title: EKET
                      rating: 3.3
                      measure: 70x35x70 cm
                      currency: EUR
                      subtitle: Élément 2 portes et 1 tablette
                      price_amount: 105
                      reviews_count: 184
                      online_sellable: true
                    - id: '80275887'
                      url: https://www.ikea.com/fr/fr/p/kallax-etagere-blanc-80275887/
                      image: https://www.ikea.com/fr/fr/images/products/kallax-etagere-blanc__0644757_pe702939_s5.jpg
                      price: 74,99€
                      title: KALLAX
                      rating: 4.7
                      measure: 77x147 cm
                      currency: EUR
                      subtitle: Étagère
                      price_amount: 74.99
                      reviews_count: 2742
                      online_sellable: true
                    pagination:
                      next: 2
                      current: 1
                      next_url: https://www.ikea.com/fr/fr/search/?q=meuble&page=2
                      per_page: 24
                      total_count: 766
                      total_pages: 32
                      has_next_page: true
        '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:
      - Ikea
  /v2/ikea/product:
    get:
      summary: IKEA Product
      description: 'Extract full IKEA product details from a product URL, including price, gallery, variants, dimensions, and breadcrumb.


        **Credit cost:** 1 credit per call'
      operationId: get-ikea-product
      security:
      - ApiKeyAuth: []
      parameters:
      - name: query
        in: query
        required: true
        description: "Full IKEA product page URL.\n\n**Example:**\n\n    https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-blanc-30493939/\n\n**Notes:**\n- Only `/p/` product URLs on ikea.com are accepted.\n- Copy the listing URL from search results or from ikea.com.\n- Variant URLs with `-s` suffix IDs are also supported."
        schema:
          type: string
          description: "Full IKEA product page URL.\n\n**Example:**\n\n    https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-blanc-30493939/\n\n**Notes:**\n- Only `/p/` product URLs on ikea.com are accepted.\n- Copy the listing URL from search results or from ikea.com.\n- Variant URLs with `-s` suffix IDs are also supported."
      - $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
                  url:
                    type: string
                  image:
                    type: string
                  price:
                    type: string
                  title:
                    type: string
                  images:
                    type: array
                    items:
                      type: string
                  rating:
                    type: number
                  measure:
                    type: string
                  category:
                    type: string
                  currency:
                    type: string
                  variants:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        url:
                          type: string
                        name:
                          type: string
                        image:
                          type: string
                  breadcrumb:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: string
                        name:
                          type: string
                  dimensions:
                    type: object
                    properties:
                      depth:
                        type: string
                      width:
                        type: string
                      height:
                        type: string
                  description:
                    type: string
                  price_amount:
                    type: integer
                  reviews_count:
                    type: integer
              examples:
                Lookup GLADHÖJDEN sit/stand desk on IKEA France:
                  value:
                    id: '30493939'
                    url: https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-blanc-30493939/
                    image: https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1159429_pe888476_s5.jpg
                    price: 149 €
                    title: GLADHÖJDEN Bureau assis/debout, blanc, 100x60 cm
                    images:
                    - https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1159429_pe888476_s5.jpg
                    - https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1159428_pe888477_s5.jpg
                    - https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1167477_pe891584_s5.jpg
                    - https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1470516_pe996887_s5.jpg
                    rating: 4.1
                    measure: 100x60cm
                    category: Bureaux pour la maison
                    currency: €
                    variants:
                    - id: '30493939'
                      url: https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-blanc-30493939/
                      name: Blanc
                      image: https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1159429_pe888476_s5.jpg
                    - id: '20541610'
                      url: https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-gris-clair-anthracite-20541610/
                      name: Gris clair/anthracite
                      image: https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-gris-clair-anthracite__1159426_pe888475_s5.jpg
                    breadcrumb:
                    - url: https://www.ikea.com/fr/fr/cat/produits-products/
                      name: Produits
                    - url: https://www.ikea.com/fr/fr/cat/bureaux-chaises-de-bureau-fu004/
                      name: Bureaux & chaises de bureau
                    - url: https://www.ikea.com/fr/fr/cat/bureaux-et-support-pc-tablettes-20649/
                      name: Bureaux et support PC/tablettes
                    - url: https://www.ikea.com/fr/fr/cat/bureaux-pour-la-maison-20651/
                      name: Bureaux pour la maison
                    - url: null
                      name: GLADHÖJDENBureau assis/debout
                    dimensions:
                      depth: 100 cm
                      width: 10 kg
                      height: 60 cm
                    description: Vous travaillez depuis la maison ? Ce bureau assis/debout permet de passer la journée bien installé. Grâce un vérin à gaz, le bureau monte et descend facilement et en silence. Vous êtes ainsi toujours dans une bonne position de travail.
                    price_amount: 149
                    reviews_count: 9
        '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:
      - Ikea
    post:
      summary: IKEA Product
      description: 'Extract full IKEA product details from a product URL, including price, gallery, variants, dimensions, and breadcrumb.


        **Credit cost:** 1 credit per call'
      operationId: post-ikea-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: "Full IKEA product page URL.\n\n**Example:**\n\n    https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-blanc-30493939/\n\n**Notes:**\n- Only `/p/` product URLs on ikea.com are accepted.\n- Copy the listing URL from search results or from ikea.com.\n- Variant URLs with `-s` suffix IDs are also supported."
              required:
              - query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  url:
                    type: string
                  image:
                    type: string
                  price:
                    type: string
                  title:
                    type: string
                  images:
                    type: array
                    items:
                      type: string
                  rating:
                    type: number
                  measure:
                    type: string
                  category:
                    type: string
                  currency:
                    type: string
                  variants:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        url:
                          type: string
                        name:
                          type: string
                        image:
                          type: string
                  breadcrumb:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: string
                        name:
                          type: string
                  dimensions:
                    type: object
                    properties:
                      depth:
                        type: string
                      width:
                        type: string
                      height:
                        type: string
                  description:
                    type: string
                  price_amount:
                    type: integer
                  reviews_count:
                    type: integer
              examples:
                Lookup GLADHÖJDEN sit/stand desk on IKEA France:
                  value:
                    id: '30493939'
                    url: https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-blanc-30493939/
                    image: https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1159429_pe888476_s5.jpg
                    price: 149 €
                    title: GLADHÖJDEN Bureau assis/debout, blanc, 100x60 cm
                    images:
                    - https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1159429_pe888476_s5.jpg
                    - https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1159428_pe888477_s5.jpg
                    - https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1167477_pe891584_s5.jpg
                    - https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1470516_pe996887_s5.jpg
                    rating: 4.1
                    measure: 100x60cm
                    category: Bureaux pour la maison
                    currency: €
                    variants:
                    - id: '30493939'
                      url: https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-blanc-30493939/
                      name: Blanc
                      image: https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1159429_pe888476_s5.jpg
                    - id: '20541610'
                      url: https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-gris-clair-anthracite-20541610/
                      name: Gris clair/anthracite
                      image: https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-gris-clair-anthracite__1159426_pe888475_s5.jpg
                    breadcrumb:
                    - url: https://www.ikea.com/fr/fr/cat/produits-products/
                      name: Produits
                    - url: https://www.ikea.com/fr/fr/cat/bureaux-chaises-de-bureau-fu004/
                      name: Bureaux & chaises de bureau
                    - url: https://www.ikea.com/fr/fr/cat/bureaux-et-support-pc-tablettes-20649/
                      name: Bureaux et support PC/tablettes
                    - url: https://www.ikea.com/fr/fr/cat/bureaux-pour-la-maison-20651/
                      name: Bureaux pour la maison
                    - url: null
                      name: GLADHÖJDENBureau assis/debout
                    dimensions:
                      depth: 100 cm
                      width: 10 kg
                      height: 60 cm
                    description: Vous travaillez depuis la maison ? Ce bureau assis/debout permet de passer la journée bien installé. Grâce un vérin à gaz, le bureau monte et descend facilement et en silence. Vous êtes ainsi toujours dans une bonne position de travail.
                    price_amount: 149
                    reviews_count: 9
        '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:
      - Ikea
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.