robosystems-ai Graph Info API

openapi: 3.2.0
info:
  title: RoboSystems Graph Info 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 Info
  description: ℹ️ Graph info - Database metadata and statistics
paths:
  /v1/graphs/{graph_id}/info:
    get:
      tags:
      - Graph Info
      summary: Database Information
      operationId: getDatabaseInfo
      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/DatabaseInfoResponse'
        '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:
    DatabaseInfoResponse:
      properties:
        graph_id:
          type: string
          title: Graph Id
          description: Graph database identifier
          examples:
          - kg1a2b3c4d5
        database_name:
          type: string
          title: Database Name
          description: Database name
          examples:
          - kg1a2b3c4d5
        database_size_bytes:
          type: integer
          title: Database Size Bytes
          description: Database size in bytes
          examples:
          - 1048576
        database_size_mb:
          type: number
          title: Database Size Mb
          description: Database size in MB
          examples:
          - 1.0
        node_count:
          type: integer
          title: Node Count
          description: Total number of nodes
          examples:
          - 1250
        relationship_count:
          type: integer
          title: Relationship Count
          description: Total number of relationships
          examples:
          - 2340
        node_labels:
          items:
            type: string
          type: array
          title: Node Labels
          description: List of node labels
          examples:
          - - Entity
            - Report
            - Fact
        relationship_types:
          items:
            type: string
          type: array
          title: Relationship Types
          description: List of relationship types
          examples:
          - - HAS_REPORT
            - REPORTED_IN
            - HAS_ELEMENT
        created_at:
          type: string
          title: Created At
          description: Database creation timestamp
          examples:
          - '2024-01-15T10:00:00Z'
        last_modified:
          type: string
          title: Last Modified
          description: Last modification timestamp
          examples:
          - '2024-01-15T10:30:00Z'
        schema_version:
          anyOf:
          - type: string
          - type: 'null'
          title: Schema Version
          description: Schema version
          examples:
          - 1.0.0
        read_only:
          type: boolean
          title: Read Only
          description: Whether database is read-only
          examples:
          - false
        backup_count:
          type: integer
          title: Backup Count
          description: Number of available backups
          examples:
          - 5
        last_backup_date:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Backup Date
          description: Date of last backup
          examples:
          - '2024-01-15T09:00:00Z'
      type: object
      required:
      - graph_id
      - database_name
      - database_size_bytes
      - database_size_mb
      - node_count
      - relationship_count
      - node_labels
      - relationship_types
      - created_at
      - last_modified
      - read_only
      - backup_count
      title: DatabaseInfoResponse
      description: Response model for database information and statistics.
    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