Search documentation

openapi: 3.0.1
info:
  title: Mintlify Assistant API
  description: An API to integrate Mintlify discovery features into your product.
  version: 1.0.0
servers:
  - url: https://api.mintlify.com/discovery
security:
  - bearerAuth: []
paths:
  /v1/search/{domain}:
    post:
      summary: Search documentation
      description: >-
        Perform semantic and keyword searches across your documentation with
        configurable filtering and pagination.


        Authenticate with an assistant API key. Search requests do not consume
        credits.
      parameters:
        - name: domain
          in: path
          required: true
          schema:
            type: string
          description: >-
            The domain identifier from your `domain.mintlify.site` URL. Can be
            found at the end of your dashboard URL. For example,
            `app.mintlify.com/organization/domain` has a domain identifier of
            `domain`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - query
              properties:
                query:
                  type: string
                  description: >-
                    The search query to execute against your documentation
                    content.
                pageSize:
                  type: integer
                  default: 10
                  minimum: 1
                  maximum: 50
                  description: >-
                    Number of search results to return. Must be between 1 and
                    50. Defaults to 10 if not specified.
                scoreThreshold:
                  type: number
                  minimum: 0
                  maximum: 1
                  description: >-
                    Minimum relevance score for results. Only results with a
                    score at or above this threshold are returned. Must be
                    between 0 and 1.
                filter:
                  type: object
                  description: Optional filtering parameters to narrow search results.
                  properties:
                    version:
                      type: string
                      description: Filter results by documentation version.
                    language:
                      type: string
                      description: Filter results by content language.
                    tag:
                      type: string
                      description: Filter results by tag.
                    groups:
                      type: array
                      items:
                        type: string
                      description: >-
                        Optional documentation groups the caller is authorized
                        to access. When the deployment uses `auth` or
                        `userAuth`, results are limited to pages the specified
                        groups can view. If omitted or empty on a protected
                        deployment, results are limited to public pages.
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    content:
                      type: string
                      description: The matching content from your documentation.
                    path:
                      type: string
                      description: The path or URL to the source document.
                    metadata:
                      type: object
                      description: Additional metadata about the search result.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        The Authorization header expects a Bearer token. Use an assistant API
        key. Generate one on the [API keys
        page](https://app.mintlify.com/settings/organization/api-keys) in your
        dashboard. In production, proxy requests through your backend rather
        than embedding the key in client-side code.