robosystems-ai Org Usage API

openapi: 3.2.0
info:
  title: RoboSystems Org Usage 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: Org Usage
  description: 📈 Organization usage - Track organization-wide usage, limits, and analytics
paths:
  /v1/orgs/{org_id}/limits:
    get:
      tags:
      - Org Usage
      summary: Get Organization Limits
      operationId: getOrgLimits
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: org_id
        in: path
        required: true
        schema:
          type: string
          title: Org Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgLimitsResponse'
        '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/orgs/{org_id}/usage:
    get:
      tags:
      - Org Usage
      summary: Get Organization Usage
      description: Aggregated across all graphs in the org. Use the `days` query param to control the lookback window (default 30).
      operationId: getOrgUsage
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: org_id
        in: path
        required: true
        schema:
          type: string
          title: Org Id
      - name: days
        in: query
        required: false
        schema:
          type: integer
          default: 30
          title: Days
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgUsageResponse'
        '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:
    OrgUsageSummary:
      properties:
        total_credits_used:
          type: number
          title: Total Credits Used
        total_ai_operations:
          type: integer
          title: Total Ai Operations
        total_storage_gb:
          type: number
          title: Total Storage Gb
        daily_avg_credits:
          type: number
          title: Daily Avg Credits
        projected_monthly_credits:
          type: number
          title: Projected Monthly Credits
        credits_limit:
          anyOf:
          - type: integer
          - type: 'null'
          title: Credits Limit
        storage_limit_gb:
          anyOf:
          - type: integer
          - type: 'null'
          title: Storage Limit Gb
      type: object
      required:
      - total_credits_used
      - total_ai_operations
      - total_storage_gb
      - daily_avg_credits
      - projected_monthly_credits
      - credits_limit
      - storage_limit_gb
      title: OrgUsageSummary
      description: Organization usage summary.
    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
    OrgLimitsResponse:
      properties:
        org_id:
          type: string
          title: Org Id
        max_graphs:
          type: integer
          title: Max Graphs
        current_usage:
          additionalProperties: true
          type: object
          title: Current Usage
        warnings:
          items:
            type: string
          type: array
          title: Warnings
        can_create_graph:
          type: boolean
          title: Can Create Graph
      type: object
      required:
      - org_id
      - max_graphs
      - current_usage
      - warnings
      - can_create_graph
      title: OrgLimitsResponse
      description: Organization limits response.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OrgUsageResponse:
      properties:
        org_id:
          type: string
          title: Org Id
        period_days:
          type: integer
          title: Period Days
        start_date:
          type: string
          format: date-time
          title: Start Date
        end_date:
          type: string
          format: date-time
          title: End Date
        summary:
          $ref: '#/components/schemas/OrgUsageSummary'
        graph_details:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Graph Details
        daily_trend:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Daily Trend
      type: object
      required:
      - org_id
      - period_days
      - start_date
      - end_date
      - summary
      - graph_details
      - daily_trend
      title: OrgUsageResponse
      description: Organization usage response.
    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