Roboto Search API

openapi: 3.2.0
info:
  description: 'Read-only JSON API over the Roboto Docs documentation: Documentation for the Roboto platform.


    Every operation is public and needs no authentication. Errors are RFC 9457 problem details (`application/problem+json`) with a stable `code`, a `detail`, and a `resolution` hint.'
  title: Roboto Docs Search API
  version: 2.2.4
  x-generator: blume@2.2.4
servers:
- description: Roboto Docs
  url: https://www.roboto.ai/docs
security: []
tags:
- description: Full-text search over the docs.
  name: Search
paths:
  /api/docs/search:
    get:
      description: Full-text search across the documentation. Returns matching pages with their title, route, content type, and a short excerpt; narrow by content type, locale, version, or facet. Use it first to discover relevant pages, then `getPage` to read one in full.
      operationId: searchDocs
      parameters:
      - description: The search query.
        in: query
        name: q
        required: true
        schema:
          minLength: 1
          type: string
      - description: Maximum hits to return (default 8, at most 20).
        in: query
        name: limit
        required: false
        schema:
          default: 8
          maximum: 20
          minimum: 1
          type: integer
      - description: Only include pages of these content types (frontmatter `type`, e.g. `doc`, `rfc`). Comma-separated or repeated. Omit for every type.
        explode: false
        in: query
        name: contentTypes
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Only include pages in this locale (e.g. `fr`). Omit for every language.
        in: query
        name: locale
        required: false
        schema:
          type: string
      - description: 'Docs version to scope to on a versioned site: `latest` (the default — current docs only), `all`, or an archived version id. Ignored when the site is unversioned.'
        in: query
        name: version
        required: false
        schema:
          type: string
      - description: Only include pages matching every facet, as `filters[key]=value` pairs (e.g. `filters[status]=enforced`). Facets are metadata the site declares per content type; the page index shows each page's values.
        explode: true
        in: query
        name: filters
        required: false
        schema:
          additionalProperties:
            type: string
          type: object
        style: deepObject
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
          description: The matching pages, best first.
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: The query was missing or blank.
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: An error, as problem details.
      summary: Search the docs
      tags:
      - Search
components:
  schemas:
    Problem:
      description: RFC 9457 problem details, with a stable code and a resolution hint.
      properties:
        code:
          description: Stable error code (e.g. `PAGE_NOT_FOUND`).
          type: string
        detail:
          description: Human-readable explanation of this occurrence.
          type: string
        instance:
          description: The request path the problem occurred on.
          type: string
        links:
          description: Recovery links, when there is somewhere useful to go.
          items:
            properties:
              href:
                type: string
              label:
                type: string
            required:
            - href
            - label
            type: object
          type: array
        resolution:
          description: What to do next.
          type: string
        status:
          type: integer
        title:
          type: string
        type:
          description: Problem type URI; `about:blank` by default.
          type: string
      required:
      - code
      - detail
      - resolution
      - status
      - title
      - type
      type: object
    SearchResponse:
      properties:
        count:
          type: integer
        query:
          type: string
        results:
          items:
            $ref: '#/components/schemas/SearchHit'
          type: array
      required:
      - count
      - query
      - results
      type: object
    SearchHit:
      properties:
        contentType:
          type: string
        excerpt:
          description: The page description, else the start of its content.
          type: string
        facets:
          additionalProperties:
            type: string
          description: Facet values the site declares for the page's content type (`content.types.<type>.facets`), key → value.
          type: object
        route:
          description: The page's route; pass it to `getPage`.
          type: string
        title:
          type: string
        url:
          format: uri-reference
          type: string
        version:
          description: 'Docs version the page belongs to on a versioned site: `""` for the current docs, else an archived version id. Absent on unversioned sites.'
          type: string
      required:
      - excerpt
      - route
      - title
      - url
      type: object
externalDocs:
  description: Roboto Docs documentation
  url: https://www.roboto.ai/docs