Granite Search API

openapi: 3.2.0
info:
  title: Granite Search API
  version: 1.0.0
  summary: REST API for Granite clients, bots, and integrations.
  description: 'Conventions (apply to every operation; see PLAN.md 3.2 and 3.6):


    - **Base URL** `https://api.granite.md`. All public operations live under `/v1`.

    After Phase 6 ships, `/v1` changes are additive only.

    - **Errors** use RFC 9457 problem details (`application/problem+json`, schema `Problem`).

    The `type` URI is `https://granite.md/problems/`; `code` refines it for programmatic handling.

    Every response carries `X-Request-ID`, also echoed as `request_id` in problems.

    - **Pagination** is cursor based. List operations accept `cursor` and `limit` and return

    `{ "items": [...], "next_cursor": "..." }`. `next_cursor` is absent on the last page.

    Cursors are opaque; clients must not parse or build them.

    - **Idempotency**: non-idempotent `POST` operations accept an `Idempotency-Key` header

    (1-255 printable ASCII). Repeating a request with the same key and body within 24 hours

    returns the original response; the same key with a different body returns `409` with

    code `idempotency_key_reused`.

    - **IDs** are UUIDv7 strings. **Timestamps** are RFC 3339 in UTC.

    - **Authentication**: `Authorization: Bearer ` with a session access token,

    a personal API token (`gr_pat_...`), or an OAuth access token. Scopes are listed per operation.

    - **Rate limits**: each personal API token may make 600 requests a minute. Over the limit

    the API answers `429` with code `token_rate_limited` and a `Retry-After` header (seconds).'
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
- url: https://api.granite.md
  description: Production
- url: http://localhost:8080
  description: Local development
security:
- bearerAuth: []
tags:
- name: Search
  description: Full-text search over notes.
paths:
  /v1/search:
    get:
      operationId: searchNotes
      tags:
      - Search
      summary: Full-text search in a vault
      description: 'Searches the notes of one vault the caller may read. Query syntax: words match by

        prefix and all must match; `"a phrase"`; `-word` excludes; `tag:x` (also finds `#x/y`),

        `path:x`, and `file:x` filter. Matching ignores case and accents. Notes are indexed a few

        seconds after each commit; `pending` counts notes not indexed yet.'
      parameters:
      - name: vault_id
        in: query
        required: true
        schema:
          type: string
          format: uuid
      - name: q
        in: query
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 500
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 50
          default: 20
      responses:
        '200':
          description: Matching notes, best first.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResults'
        default:
          $ref: '#/components/responses/Error'
components:
  headers:
    RequestID:
      description: Identifier of this request, for support and log correlation.
      schema:
        type: string
  schemas:
    Problem:
      type: object
      description: RFC 9457 problem details.
      required:
      - type
      - title
      - status
      properties:
        type:
          type: string
          format: uri
          examples:
          - https://granite.md/problems/conflict
        title:
          type: string
        status:
          type: integer
          format: int32
        detail:
          type: string
        instance:
          type: string
        code:
          type: string
          description: Machine-readable refinement of `type`, for example `version_conflict`.
        request_id:
          type: string
        errors:
          type: array
          description: Per-field validation errors.
          items:
            $ref: '#/components/schemas/FieldError'
    SearchHit:
      type: object
      required:
      - file_id
      - path
      - title
      - snippet
      - line
      - score
      properties:
        file_id:
          type: string
          format: uuid
        path:
          type: string
        title:
          type: string
          description: The file name without ".md".
        snippet:
          type: string
          description: The line of the first match, shortened.
        line:
          type: integer
          description: 1-based line of the snippet.
        score:
          type: number
          format: float
    SearchResults:
      type: object
      required:
      - results
      - pending
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/SearchHit'
        pending:
          type: integer
          format: int64
          description: Notes changed so recently that they are not searchable yet.
    FieldError:
      type: object
      required:
      - field
      - detail
      properties:
        field:
          type: string
          description: JSON path of the invalid field, for example `ops[2].path`.
        detail:
          type: string
  responses:
    Error:
      description: Error response.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestID'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Session access token, personal API token, or OAuth access token.