robosystems-ai

robosystems-ai Operations API

⏱️ Operation monitoring - Track SSE stream status and progress

GitHub OpenAPI

Operations 4

GET /v1/operations/{operation_id}/stream Stream Operation Events #
GET /v1/operations/{operation_id}/status Get Operation Status #
DELETE /v1/operations/{operation_id} Cancel Operation #
POST /v1/operations/{operation_id}/resume Resume Operation #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/robosystems-ai/openapi/robosystems-ai-operations-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/robosystems-ai/json-schema/robosystems-ai-create-event-block-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/robosystems-ai/json-schema/robosystems-ai-create-entity-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/robosystems-ai/json-schema/robosystems-ai-update-entity-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/robosystems-ai/json-schema/robosystems-ai-update-event-block-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/robosystems-ai/json-schema/robosystems-ai-create-graph-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/robosystems-ai/json-schema/robosystems-ai-create-event-handler-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/robosystems-ai:robosystems-ai-operations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

robosystems-ai-operations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: RoboSystems Operations 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: Operations
  description: ⏱️ Operation monitoring - Track SSE stream status and progress
paths:
  /v1/operations/{operation_id}/stream:
    get:
      tags:
      - Operations
      summary: Stream Operation Events
      description: Server-Sent Events stream for real-time operation progress. Use `from_sequence` to replay missed events on reconnect. Max 5 concurrent SSE connections per user. Consumes no credits.
      operationId: streamOperationEvents
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: operation_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(op_[0-9A-Z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
          description: Operation identifier from initial submission
          title: Operation Id
        description: Operation identifier from initial submission
      - name: from_sequence
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Replay stored events from this sequence number, then stream live ones. A running operation replays nothing at 0 (live events only); a settled one replays its history from here (0 = all) and closes.
          default: 0
          title: From Sequence
        description: Replay stored events from this sequence number, then stream live ones. A running operation replays nothing at 0 (live events only); a settled one replays its history from here (0 = all) and closes.
      - name: token
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: JWT token for SSE authentication
          title: Token
        description: JWT token for SSE authentication
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: 'SSE stream — Content-Type: text/event-stream'
          content:
            application/json:
              schema: {}
        '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/operations/{operation_id}/status:
    get:
      tags:
      - Operations
      summary: Get Operation Status
      description: Point-in-time status check. Use `/stream` for real-time updates. Consumes no credits.
      operationId: getOperationStatus
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: operation_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(op_[0-9A-Z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
          description: Operation identifier
          title: Operation Id
        description: Operation identifier
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Getoperationstatus
        '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/operations/{operation_id}:
    delete:
      tags:
      - Operations
      summary: Cancel Operation
      description: Cancels a pending or running operation. Emits a cancellation event to any active SSE connections. Cannot cancel completed or failed operations, or a running operation that cannot be stopped (graph creation, tier changes, materialization, period close), which returns 409.
      operationId: cancelOperation
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: operation_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(op_[0-9A-Z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
          description: Operation identifier
          title: Operation Id
        description: Operation identifier
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Canceloperation
        '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'
        '409':
          description: Operation already completed or failed — cannot cancel
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/operations/{operation_id}/resume:
    post:
      tags:
      - Operations
      summary: Resume Operation
      description: Answers an operation that paused at a checkpoint (status `awaiting_input`) and puts it back on the worker queue with the answer. The operation keeps its id, so the stream, status and cancel links stay valid; reconnect to `/stream` to follow the resumed run. Consumes no credits.
      operationId: resumeOperation
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: operation_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(op_[0-9A-Z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
          description: Operation identifier
          title: Operation Id
        description: Operation identifier
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperationResumeRequest'
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Resumeoperation
        '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'
        '409':
          description: Operation is not waiting for input
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    OperationResumeRequest:
      properties:
        input:
          additionalProperties: true
          type: object
          title: Input
          description: The decision the paused run asked for, in whatever shape its prompt described. Delivered to the task as `params['resume']['input']`.
      additionalProperties: false
      type: object
      title: OperationResumeRequest
      description: Answer for an operation paused at a checkpoint (`awaiting_input`).
      examples:
      - input:
          approved: true
    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