robosystems-ai Schema API

openapi: 3.2.0
info:
  title: RoboSystems Schema 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: Schema
  description: 📐 Schema - Inspect and export a graph's deployed schema
paths:
  /v1/graphs/{graph_id}/schema:
    get:
      tags:
      - Schema
      summary: Get Runtime Graph Schema
      description: Runtime schema from actual graph data — node labels, relationship types, and up to 10 sample properties per node type. For the original schema definition or structured export formats, use `/schema/export`.
      operationId: getGraphSchema
      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/SchemaInfoResponse'
        '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'
        '504':
          description: Schema operation timed out
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/graphs/{graph_id}/schema/export:
    get:
      tags:
      - Schema
      summary: Export Declared Graph Schema
      description: Returns the original schema definition from graph creation, not the runtime state. Set `include_data_stats=true` to add live node/relationship counts. Use `/schema` to inspect what's actually in the database.
      operationId: exportGraphSchema
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: graph_id
        in: path
        required: true
        schema:
          type: string
          title: Graph Id
      - name: format
        in: query
        required: false
        schema:
          type: string
          pattern: ^(json|yaml|cypher)$
          description: 'Export format: json, yaml, or cypher'
          default: json
          title: Format
        description: 'Export format: json, yaml, or cypher'
        examples:
          json:
            summary: JSON Format
            description: Structured JSON format for programmatic access
            value: json
          yaml:
            summary: YAML Format
            description: Human-readable YAML format for documentation
            value: yaml
          cypher:
            summary: Cypher DDL
            description: Cypher CREATE statements for database migration
            value: cypher
      - name: include_data_stats
        in: query
        required: false
        schema:
          type: boolean
          description: Include statistics about actual data in the graph (node counts, relationship counts)
          default: false
          title: Include Data Stats
        description: Include statistics about actual data in the graph (node counts, relationship counts)
        examples:
          without_stats:
            summary: Schema Only
            description: Export schema definition without data statistics
            value: false
          with_stats:
            summary: Schema + Statistics
            description: Export schema with node and relationship counts
            value: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaExportResponse'
        '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:
    SchemaExportResponse:
      properties:
        graph_id:
          type: string
          title: Graph Id
          description: Graph ID
          examples:
          - sec
          - kg1a2b3c4d5
        schema_definition:
          anyOf:
          - additionalProperties: true
            type: object
          - type: string
          title: Schema Definition
          description: Exported schema definition (format depends on 'format' parameter)
          examples:
          - description: Schema for SEC financial data analysis
            name: financial_analysis_schema
            nodes:
            - name: Company
              properties:
              - name: cik
                type: STRING
                is_primary_key: true
              - name: name
                type: STRING
                nullable: false
              - name: ticker
                type: STRING
              - name: market_cap
                type: INT64
              - name: sector
                type: STRING
            - name: Filing
              properties:
              - name: accession_number
                type: STRING
                is_primary_key: true
              - name: form_type
                type: STRING
                nullable: false
              - name: filing_date
                type: DATE
              - name: fiscal_year
                type: INT32
            relationships:
            - from_node: Company
              name: FILED
              properties:
              - name: filing_count
                type: INT32
              to_node: Filing
            type: custom
            version: 1.0.0
          - "name: financial_analysis_schema\nversion: '1.0.0'\ntype: custom\ndescription: Schema for SEC financial data analysis\nnodes:\n  - name: Company\n    properties:\n      - name: cik\n        type: STRING\n        is_primary_key: true\n      - name: name\n        type: STRING\n        nullable: false\n      - name: ticker\n        type: STRING\n      - name: market_cap\n        type: INT64\nrelationships:\n  - name: FILED\n    from_node: Company\n    to_node: Filing"
          - "CREATE NODE TABLE Company (\n  cik STRING PRIMARY KEY,\n  name STRING NOT NULL,\n  ticker STRING,\n  market_cap INT64,\n  sector STRING\n);\n\nCREATE NODE TABLE Filing (\n  accession_number STRING PRIMARY KEY,\n  form_type STRING NOT NULL,\n  filing_date DATE,\n  fiscal_year INT32\n);\n\nCREATE REL TABLE FILED (\n  FROM Company TO Filing,\n  filing_count INT32\n);"
        format:
          type: string
          title: Format
          description: Export format used
          examples:
          - json
          - yaml
          - cypher
        exported_at:
          type: string
          title: Exported At
          description: Export timestamp
          examples:
          - '2025-10-29T10:30:00Z'
        data_stats:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Data Stats
          description: Data statistics if requested (only when include_data_stats=true)
          examples:
          - node_counts:
              Company: 8500
              Filing: 125000
              Industry: 1200
            node_labels_count: 4
            node_properties_count: 12
            relationship_types_count: 3
            total_nodes: 134700
      type: object
      required:
      - graph_id
      - schema_definition
      - format
      - exported_at
      title: SchemaExportResponse
      description: Response model for schema export.
    SchemaInfoResponse:
      properties:
        graph_id:
          type: string
          title: Graph Id
          description: Graph database identifier
        schema:
          additionalProperties: true
          type: object
          title: Schema
          description: Runtime schema information showing actual database structure
      type: object
      required:
      - graph_id
      - schema
      title: SchemaInfoResponse
      description: 'Response model for runtime schema introspection.


        This model represents the actual current state of the graph database,

        showing what node labels, relationship types, and properties exist right now.'
      examples:
      - graph_id: sec
        schema:
          node_labels:
          - Entity
          - Report
          - Fact
          - Element
          - Period
          - Unit
          - Dimension
          - Taxonomy
          - Structure
          - Association
          node_properties:
            Entity:
              cik: STRING
              entity_type: STRING
              fiscal_year_end: STRING
              industry: STRING
              name: STRING
              state_of_incorporation: STRING
              ticker: STRING
            Fact:
              decimals: INT64
              fact_type: STRING
              numeric_value: DOUBLE
            Report:
              accession_number: STRING
              filing_date: STRING
              form: STRING
              name: STRING
              report_date: STRING
          relationship_types:
          - ENTITY_HAS_REPORT
          - REPORT_HAS_FACT
          - FACT_HAS_ELEMENT
          - FACT_HAS_PERIOD
          - FACT_HAS_UNIT
          - FACT_HAS_DIMENSION
          - REPORT_USES_TAXONOMY
          - STRUCTURE_HAS_TAXONOMY
          - STRUCTURE_HAS_ASSOCIATION
          - ASSOCIATION_HAS_FROM_ELEMENT
          - ASSOCIATION_HAS_TO_ELEMENT
      - graph_id: kg1a2b3c4d5
        schema:
          node_labels:
          - Transaction
          - LineItem
          - Element
          - Report
          - Entity
          - Fact
          - Period
          - Unit
          node_properties:
            Element:
              balance: STRING
              classification: STRING
              name: STRING
            LineItem:
              credit_amount: DOUBLE
              debit_amount: DOUBLE
            Transaction:
              date: STRING
              description: STRING
              type: STRING
          relationship_types:
          - TRANSACTION_HAS_ENTRY
          - ENTRY_HAS_LINE_ITEM
          - LINE_ITEM_RELATES_TO_ELEMENT
          - ENTITY_HAS_REPORT
          - REPORT_HAS_FACT
          - FACT_HAS_ELEMENT
          - FACT_HAS_PERIOD
          - FACT_HAS_UNIT
      - graph_id: kg9f8e7d6c5
        schema:
          node_labels:
          - Person
          - Company
          - Project
          node_properties:
            Company:
              identifier: STRING
              industry: STRING
              location: STRING
              name: STRING
            Person:
              identifier: STRING
              interests: STRING
              name: STRING
              title: STRING
            Project:
              budget: DOUBLE
              name: STRING
              status: STRING
          relationship_types:
          - PERSON_WORKS_FOR_COMPANY
          - PERSON_WORKS_ON_PROJECT
          - COMPANY_SPONSORS_PROJECT
      - graph_id: kg2x3y4z5a6
        schema:
          node_labels: []
          node_properties: {}
          relationship_types: []
    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
    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