Sourcebot System API

openapi: 3.0.3
info:
  title: Sourcebot Public Enterprise (EE) Enterprise (EE) System API
  version: v5.1.3
  description: 'OpenAPI description for the public Sourcebot REST endpoints used for search, repository listing, and file browsing. Authentication is instance-dependent: API keys are the standard integration mechanism, OAuth bearer tokens are EE-only, and some instances may allow anonymous access.'
security:
- bearerToken: []
- apiKeyHeader: []
- {}
tags:
- name: System
  description: System health and version endpoints.
paths:
  /api/version:
    get:
      operationId: getVersion
      tags:
      - System
      summary: Get Sourcebot version
      description: Returns the currently running Sourcebot version string.
      responses:
        '200':
          description: Current Sourcebot version.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicVersionResponse'
  /api/health:
    get:
      operationId: getHealth
      tags:
      - System
      summary: Health check
      responses:
        '200':
          description: Service is healthy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicHealthResponse'
components:
  schemas:
    PublicVersionResponse:
      type: object
      properties:
        version:
          type: string
      required:
      - version
    PublicHealthResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - ok
      required:
      - status
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      description: Bearer authentication header of the form `Bearer <token>`, where `<token>` is your API key.
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-Sourcebot-Api-Key
      description: 'Header of the form `X-Sourcebot-Api-Key: <token>`, where `<token>` is your API key.'