robosystems-ai Subgraphs API

openapi: 3.2.0
info:
  title: RoboSystems Subgraphs 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: Subgraphs
  description: 🌳 Subgraphs - List and inspect subgraph databases
paths:
  /v1/graphs/{graph_id}/subgraphs:
    get:
      tags:
      - Subgraphs
      summary: List Subgraphs
      operationId: listSubgraphs
      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/ListSubgraphsResponse'
        '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'
  /v1/graphs/{graph_id}/subgraphs/{subgraph_name}:
    get:
      tags:
      - Subgraphs
      summary: Get Subgraph Details
      description: Pass the subgraph name (e.g., `dev`) not the full subgraph ID (e.g., `kg0123_dev`).
      operationId: getSubgraphInfo
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: graph_id
        in: path
        required: true
        schema:
          type: string
          title: Graph Id
      - name: subgraph_name
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9]{1,20}$
          description: Subgraph name (e.g., 'dev', 'staging')
          title: Subgraph Name
        description: Subgraph name (e.g., 'dev', 'staging')
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubgraphResponse'
        '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'
        '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'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SubgraphResponse:
      properties:
        graph_id:
          type: string
          title: Graph Id
          description: Full subgraph identifier (e.g., kg123_dev)
          examples:
          - kg5f2e5e0da65d45d69645_dev
        parent_graph_id:
          type: string
          title: Parent Graph Id
          description: Parent graph identifier
          examples:
          - kg5f2e5e0da65d45d69645
        subgraph_index:
          type: integer
          title: Subgraph Index
          description: Numeric index of the subgraph
          examples:
          - 1
          - 2
          - 3
        subgraph_name:
          type: string
          title: Subgraph Name
          description: Alphanumeric name of the subgraph
          examples:
          - dev
          - staging
          - prod
        display_name:
          type: string
          title: Display Name
          description: Human-readable display name
          examples:
          - Development Environment
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Description of the subgraph's purpose
        subgraph_type:
          $ref: '#/components/schemas/SubgraphType'
          description: Type of subgraph
        status:
          type: string
          title: Status
          description: Current status of the subgraph
          examples:
          - active
          - creating
          - deleting
          - failed
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When the subgraph was created
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: When the subgraph was last updated
        size_bytes:
          anyOf:
          - type: integer
          - type: 'null'
          title: Size Bytes
          description: On-disk footprint in bytes — the database, its write-ahead log, and its vector index. Prefer this over size_mb at subgraph scale.
        size_mb:
          anyOf:
          - type: number
          - type: 'null'
          title: Size Mb
          description: Size of the subgraph database in megabytes
        node_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Node Count
          description: Number of nodes in the subgraph
        edge_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Edge Count
          description: Number of edges in the subgraph
        last_accessed:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Accessed
          description: When the subgraph was last accessed
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Metadata
          description: Additional metadata for the subgraph
      type: object
      required:
      - graph_id
      - parent_graph_id
      - subgraph_index
      - subgraph_name
      - display_name
      - subgraph_type
      - status
      - created_at
      - updated_at
      title: SubgraphResponse
      description: Response model for a subgraph.
    SubgraphSummary:
      properties:
        graph_id:
          type: string
          title: Graph Id
          description: Full subgraph identifier
          examples:
          - kg5f2e5e0da65d45d69645_dev
        subgraph_name:
          type: string
          title: Subgraph Name
          description: Alphanumeric name
          examples:
          - dev
        display_name:
          type: string
          title: Display Name
          description: Human-readable name
          examples:
          - Development Environment
        subgraph_type:
          $ref: '#/components/schemas/SubgraphType'
          description: Type of subgraph
        status:
          type: string
          title: Status
          description: Current status
          examples:
          - active
        size_bytes:
          anyOf:
          - type: integer
          - type: 'null'
          title: Size Bytes
          description: On-disk footprint in bytes — the database, its write-ahead log, and its vector index. Prefer this over size_mb at subgraph scale.
        size_mb:
          anyOf:
          - type: number
          - type: 'null'
          title: Size Mb
          description: Same footprint in megabytes. Derived from size_bytes; kept for callers that render MB directly.
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Creation timestamp
        last_accessed:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Accessed
          description: Last access timestamp
      type: object
      required:
      - graph_id
      - subgraph_name
      - display_name
      - subgraph_type
      - status
      - created_at
      title: SubgraphSummary
      description: Summary model for listing subgraphs.
    ListSubgraphsResponse:
      properties:
        parent_graph_id:
          type: string
          title: Parent Graph Id
          description: Parent graph identifier
          examples:
          - kg5f2e5e0da65d45d69645
        parent_graph_name:
          type: string
          title: Parent Graph Name
          description: Parent graph name
          examples:
          - My Company Graph
        parent_graph_tier:
          type: string
          title: Parent Graph Tier
          description: Parent graph tier
          examples:
          - ladybug-large
          - ladybug-xlarge
        subgraphs_enabled:
          type: boolean
          title: Subgraphs Enabled
          description: Whether subgraphs are enabled for this tier
        subgraph_count:
          type: integer
          minimum: 0.0
          title: Subgraph Count
          description: Total number of subgraphs
        max_subgraphs:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Subgraphs
          description: Maximum allowed subgraphs for this tier (None = unlimited)
        total_size_bytes:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total Size Bytes
          description: Combined on-disk footprint of all subgraphs in bytes
        total_size_mb:
          anyOf:
          - type: number
          - type: 'null'
          title: Total Size Mb
          description: Combined size of all subgraphs in megabytes
        subgraphs:
          items:
            $ref: '#/components/schemas/SubgraphSummary'
          type: array
          title: Subgraphs
          description: List of subgraphs
      type: object
      required:
      - parent_graph_id
      - parent_graph_name
      - parent_graph_tier
      - subgraphs_enabled
      - subgraph_count
      - subgraphs
      title: ListSubgraphsResponse
      description: Response model for listing subgraphs.
    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
    SubgraphType:
      type: string
      enum:
      - static
      - knowledge
      - empty
      title: SubgraphType
      description: Types of subgraphs.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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'
  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