CompatAir Search API

The Search API from CompatAir — 4 operation(s) for search.

GitHub OpenAPI

Operations 4

0 of 4 operations are conformant: apis.io called them with no credentials and the responses matched this contract; 1 more answered but could not be checked against a schema. Checked 2026-11-11. how this works · status file

GET /api/v1/search Search the published full-text agent corpus #
GET /api/v1/search/catalog Search compact products or the site index observed #
GET /api/v1/search/products Read at most 50 exact original source records #
GET /api/v1/search/identify Identify exact references without resolving collisions silently #

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/compatair-fr:compatair-fr-search-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

compatair-fr-search-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Compatair Fr Search API
  version: '2026-07-15'
  description: 'Operations tagged Search across 2 of this provider''s published API definitions: compatair-2026-07-15.json, compatair-fr-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://compatair.fr
tags:
- name: Search
paths:
  /api/v1/search:
    get:
      operationId: searchKnowledge
      summary: Search the published full-text agent corpus
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 256
      - name: type
        in: query
        schema:
          enum:
          - Guide
          - Glossaire
          - Compresseur
          - Outil
      - name: locale
        in: query
        schema:
          enum:
          - fr
          - en
      - name: cursor
        in: query
        schema:
          type: string
          maxLength: 256
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 20
          default: 10
      responses:
        '200':
          description: Rank-neutral matching published records
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResult'
        '400':
          $ref: '#/components/responses/BadRequest'
        '429':
          $ref: '#/components/responses/RateLimited'
      security: []
      tags:
      - Search
    servers:
    - url: https://compatair.fr
  /api/v1/search/catalog:
    get:
      operationId: searchCatalogProducts
      summary: Search compact products or the site index
      parameters:
      - name: q
        in: query
        schema:
          type: string
          maxLength: 256
        required: false
      - name: kind
        in: query
        schema:
          enum:
          - product
          - site
          default: product
        required: false
      - name: type
        in: query
        schema:
          enum:
          - compressor
          - tool
          - compresseur
          - outil
          - guide
          - glossaire
        required: false
        description: 'For kind=product: compressor or tool. For kind=site: compresseur, outil, guide or glossaire. Omit to search all types.'
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 50
          default: 10
        required: false
      - name: cursor
        in: query
        schema:
          type: string
          maxLength: 1024
        required: false
      responses:
        '200':
          description: Compact matches with bounded pagination. Cursors bind the query and product catalog version, or the site index fingerprint for kind=site. Restart at the first page after either changes.
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: Requested catalogVersion differs from the active release. Reload rather than silently mixing source versions.
        '429':
          $ref: '#/components/responses/RateLimited'
      security: []
      tags:
      - Search
    servers:
    - url: https://compatair.fr
  /api/v1/search/products:
    get:
      operationId: readCatalogProducts
      summary: Read at most 50 exact original source records
      parameters:
      - name: ids
        in: query
        schema:
          type: string
          pattern: ^[a-z0-9-]+(,[a-z0-9-]+){0,49}$
        required: true
      - name: catalogVersion
        in: query
        schema:
          type: string
          pattern: ^[a-f0-9]{64}$
        required: false
      responses:
        '200':
          description: Bounded original compressor/tool records with schemaVersion, catalogVersion, catalogVerifiedAt and calculationVersion. Unknown identities are never substituted.
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: Requested catalogVersion differs from the active release. Reload rather than silently mixing source versions.
        '429':
          $ref: '#/components/responses/RateLimited'
      security: []
      tags:
      - Search
    servers:
    - url: https://compatair.fr
  /api/v1/search/identify:
    get:
      operationId: identifyCatalogProduct
      summary: Identify exact references without resolving collisions silently
      parameters:
      - name: q
        in: query
        schema:
          type: string
          minLength: 1
          maxLength: 160
        required: true
      responses:
        '200':
          description: Exact matches, version metadata and ambiguous boolean. A collision never becomes a unique identification; the user must select the reference.
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: Requested catalogVersion differs from the active release. Reload rather than silently mixing source versions.
        '429':
          $ref: '#/components/responses/RateLimited'
      security: []
      tags:
      - Search
    servers:
    - url: https://compatair.fr
components:
  schemas:
    KnowledgeRecord:
      type: object
      required:
      - id
      - type
      - locale
      - title
      - url
      - content_sha256
      properties:
        id:
          type: string
        type:
          enum:
          - Guide
          - Glossaire
          - Compresseur
          - Outil
        locale:
          enum:
          - fr
          - en
        title:
          type: string
        description:
          type: string
        url:
          type: string
          format: uri
        excerpt:
          type: string
          maxLength: 1200
        content_sha256:
          type: string
          pattern: ^[a-f0-9]{64}$
      additionalProperties: true
    PublicEnvelope:
      type: object
      required:
      - verdict
      - verdict_scope
      - verdict_schema_version
      - canonical_url
      - product_urls
      - source_urls
      - method_version
      - catalog_version
      - observed_at
      - limitations
      - next_actions
      properties:
        verdict:
          enum:
          - information
          - compatible
          - compatible_with_limits
          - incompatible
          - insufficient_data
        verdict_scope:
          enum:
          - information
          - request
          - air_supply
          - complete_air_system
          - commercial_constraints
        verdict_schema_version:
          const: 2.0.0
        canonical_url:
          type: string
          format: uri
          pattern: ^https://compatair\.fr/
        product_urls:
          type: array
          items:
            type: string
            format: uri
            pattern: ^https://compatair\.fr/
          uniqueItems: true
        source_urls:
          type: array
          items:
            type: string
            format: uri
            pattern: ^https://
          uniqueItems: true
        method_version:
          type: string
          pattern: ^2026\.[0-9]{2}$
        catalog_version:
          type: string
          minLength: 1
        observed_at:
          type: string
          format: date
        limitations:
          type: array
          items:
            type: string
        next_actions:
          type: array
          items:
            type: string
    SearchResult:
      allOf:
      - $ref: '#/components/schemas/PublicEnvelope'
      - type: object
        required:
        - items
        properties:
          items:
            type: array
            items:
              $ref: '#/components/schemas/KnowledgeRecord'
          nextCursor:
            type: string
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          minLength: 1
      additionalProperties: false
  responses:
    NotFound:
      description: Unknown product
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid or duplicate query parameter
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Per-address rate limit exceeded
      headers:
        Retry-After:
          schema:
            type: integer
            const: 60
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-refined-from:
- compatair-2026-07-15.json
- compatair-fr-openapi.yml