robosystems-ai Graph Health API

openapi: 3.2.0
info:
  title: RoboSystems Graph Health API
  description: 'The REST and GraphQL API for RoboSystems — an open-source, AI-native platform for accounting, financial reporting and investment management. It powers RoboLedger and RoboInvestor.


    ## Two surfaces


    **Platform** — `/v1/…` — graphs, queries, schema, documents, search, memory, connections, billing and access. Reads are REST `GET`s; every write is a named operation at `/operations/{name}` returning an `OperationEnvelope`, accepting an `Idempotency-Key`, and streaming progress at `/v1/operations/{id}/stream`.

    → API reference


    **Extensions** — `/extensions/…` — RoboLedger and RoboInvestor, scoped by `graph_id` in the URL. Reads are GraphQL at `POST /extensions/{graph_id}/graphql` and change nothing; writes are named operations at `/extensions/{domain}/{graph_id}/operations/{name}`; analytical views read the materialized graph.

    → Extensions reference · every GraphQL query


    ## Authenticating


    `X-API-Key: rfs…` on REST, GraphQL and per-graph MCP. Browser sessions use JWTs from `POST /v1/auth/login`. The graph-agnostic MCP endpoint `/v1/mcp` takes OAuth 2.1 bearer tokens only.


    ## Connecting an AI client


    Every graph is an MCP server at `POST /v1/graphs/{graph_id}/mcp`, and `POST /v1/mcp` serves OAuth clients that pick their graph at consent.

    → MCP guide


    ## Clients


    `robosystems-client` for Python, `@robosystems/client` for TypeScript.

    → Guides · Technical docs'
  version: 1.20.6
tags:
- name: Graph Health
  description: 🩺 Graph health - Database health and performance metrics
paths:
  /v1/graphs/{graph_id}/health:
    get:
      tags:
      - Graph Health
      summary: Database Health Check
      operationId: getDatabaseHealth
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: graph_id
        in: path
        required: true
        schema:
          type: string
          title: Graph Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseHealthResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DatabaseHealthResponse:
      properties:
        graph_id:
          type: string
          title: Graph Id
          description: Graph database identifier
          examples:
          - kg1a2b3c4d5
        status:
          type: string
          title: Status
          description: Overall health status
          examples:
          - healthy
        connection_status:
          type: string
          title: Connection Status
          description: Database connection status
          examples:
          - connected
        uptime_seconds:
          type: number
          title: Uptime Seconds
          description: Database uptime in seconds
          examples:
          - 3600.5
        last_query_time:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Query Time
          description: Timestamp of last query execution
          examples:
          - '2024-01-15T10:30:00Z'
        query_count_24h:
          type: integer
          title: Query Count 24H
          description: Number of queries executed in last 24 hours
          examples:
          - 150
        avg_query_time_ms:
          type: number
          title: Avg Query Time Ms
          description: Average query execution time in milliseconds
          examples:
          - 45.2
        error_rate_24h:
          type: number
          title: Error Rate 24H
          description: Error rate in last 24 hours (percentage)
          examples:
          - 0.5
        memory_usage_mb:
          anyOf:
          - type: number
          - type: 'null'
          title: Memory Usage Mb
          description: Instance memory in use, MB. Only populated for dedicated single-tenant instances; null on shared repositories and packed tiers.
          examples:
          - 512.3
        memory_usage_percent:
          anyOf:
          - type: number
          - type: 'null'
          title: Memory Usage Percent
          description: Instance memory in use, percent. Expect high values during materialization — the engine deliberately boosts to near the whole instance while rebuilding. Read `resource_status` rather than this number alone. Dedicated instances only.
          examples:
          - 41.8
        cpu_usage_percent:
          anyOf:
          - type: number
          - type: 'null'
          title: Cpu Usage Percent
          description: Instance CPU in use, percent. Dedicated single-tenant instances only.
          examples:
          - 12.4
        resource_status:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource Status
          description: 'Interpreted instance load: ''idle'' (headroom), ''busy'' (working normally — typical while materializing), ''constrained'' (sustained pressure worth acting on). Null when resource metrics are not exposed.'
          examples:
          - idle
        storage_usage_mb:
          anyOf:
          - type: number
          - type: 'null'
          title: Storage Usage Mb
          description: Storage usage in MB
          examples:
          - 1024.7
        alerts:
          items:
            type: string
          type: array
          title: Alerts
          description: Active alerts or warnings
          examples:
          - - High memory usage detected
        is_stale:
          type: boolean
          title: Is Stale
          description: Whether the graph has staged changes not yet materialized
          default: false
        stale_reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Stale Reason
          description: 'Reason the graph was marked stale (e.g. ''file_deleted: data.parquet'')'
        stale_since:
          anyOf:
          - type: string
          - type: 'null'
          title: Stale Since
          description: ISO timestamp when the graph became stale
        last_materialized_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Materialized At
          description: ISO timestamp of the last successful materialization
        hours_since_materialization:
          anyOf:
          - type: number
          - type: 'null'
          title: Hours Since Materialization
          description: Hours elapsed since last materialization
      type: object
      required:
      - graph_id
      - status
      - connection_status
      - uptime_seconds
      - query_count_24h
      - avg_query_time_ms
      - error_rate_24h
      title: DatabaseHealthResponse
      description: Response model for database health check.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
          description: Human-readable error message explaining what went wrong
          examples:
          - Insufficient credits for operation
        code:
          anyOf:
          - type: string
          - type: 'null'
          title: Code
          description: Machine-readable error code for programmatic handling
          examples:
          - INSUFFICIENT_CREDITS
        request_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Request Id
          description: Unique request ID for tracking and debugging
          examples:
          - req_1234567890abcdef
        timestamp:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Timestamp
          description: Timestamp when the error occurred
          examples:
          - '2024-01-01T00:00:00Z'
      type: object
      required:
      - detail
      title: ErrorResponse
      description: Error body returned by every endpoint.
      example:
        code: RESOURCE_NOT_FOUND
        detail: Resource not found
        request_id: req_1234567890abcdef
        timestamp: '2024-01-01T00:00:00Z'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT bearer token