robosystems-ai Files API

openapi: 3.2.0
info:
  title: RoboSystems Files 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: Files
  description: 📄 File management - List stored data files for generic graphs
paths:
  /v1/graphs/{graph_id}/files:
    get:
      tags:
      - Files
      summary: List Files in Graph
      description: Filter by `table_name` or upload `status`. Files are graph-scoped resources with S3 → DuckDB → Graph lifecycle tracking.
      operationId: listFiles
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: graph_id
        in: path
        required: true
        schema:
          type: string
          title: Graph Id
      - name: table_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by table name (optional)
          title: Table Name
        description: Filter by table name (optional)
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by upload status (optional)
          title: Status
        description: Filter by upload status (optional)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTableFilesResponse'
        '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'
  /v1/graphs/{graph_id}/files/{file_id}:
    get:
      tags:
      - Files
      summary: Get File Information
      description: Returns per-layer status (`layers.s3`, `layers.duckdb`, `layers.graph`) for pipeline debugging.
      operationId: getFile
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: graph_id
        in: path
        required: true
        schema:
          type: string
          title: Graph Id
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          description: File ID
          title: File Id
        description: File ID
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFileInfoResponse'
        '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:
    FileInfo:
      properties:
        file_id:
          type: string
          title: File Id
          description: Unique file identifier
        file_name:
          type: string
          title: File Name
          description: Original file name
        file_format:
          type: string
          title: File Format
          description: File format (parquet, csv, etc.)
        size_bytes:
          type: integer
          title: Size Bytes
          description: File size in bytes
        row_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Row Count
          description: Estimated row count
        upload_status:
          type: string
          title: Upload Status
          description: Current upload status
        upload_method:
          type: string
          title: Upload Method
          description: Upload method used
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
          description: File creation timestamp
        uploaded_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Uploaded At
          description: File upload completion timestamp
        s3_key:
          type: string
          title: S3 Key
          description: S3 object key
      type: object
      required:
      - file_id
      - file_name
      - file_format
      - size_bytes
      - upload_status
      - upload_method
      - s3_key
      title: FileInfo
    GetFileInfoResponse:
      properties:
        file_id:
          type: string
          title: File Id
          description: Unique file identifier
        graph_id:
          type: string
          title: Graph Id
          description: Graph database identifier
        table_id:
          type: string
          title: Table Id
          description: Table identifier
        table_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Table Name
          description: Table name
        file_name:
          type: string
          title: File Name
          description: Original file name
        file_format:
          type: string
          title: File Format
          description: File format (parquet, csv, etc.)
        size_bytes:
          type: integer
          title: Size Bytes
          description: File size in bytes
        row_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Row Count
          description: Estimated row count
        upload_status:
          type: string
          title: Upload Status
          description: Current upload status
        upload_method:
          type: string
          title: Upload Method
          description: Upload method used
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
          description: File creation timestamp
        uploaded_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Uploaded At
          description: File upload completion timestamp
        s3_key:
          type: string
          title: S3 Key
          description: S3 object key
        layers:
          anyOf:
          - $ref: '#/components/schemas/EnhancedFileStatusLayers'
          - type: 'null'
          description: Multi-layer pipeline status (S3 → DuckDB → Graph). Shows status, timestamps, and row counts for each layer independently.
      type: object
      required:
      - file_id
      - graph_id
      - table_id
      - file_name
      - file_format
      - size_bytes
      - upload_status
      - upload_method
      - s3_key
      title: GetFileInfoResponse
    ListTableFilesResponse:
      properties:
        graph_id:
          type: string
          title: Graph Id
          description: Graph database identifier
        table_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Table Name
          description: Table name (null if listing all files in graph)
        files:
          items:
            $ref: '#/components/schemas/FileInfo'
          type: array
          title: Files
          description: List of files in the table
        total_files:
          type: integer
          title: Total Files
          description: Total number of files
        total_size_bytes:
          type: integer
          title: Total Size Bytes
          description: Total size of all files in bytes
      type: object
      required:
      - graph_id
      - files
      - total_files
      - total_size_bytes
      title: ListTableFilesResponse
    FileLayerStatus:
      properties:
        status:
          type: string
          title: Status
          description: Layer status
        timestamp:
          anyOf:
          - type: string
          - type: 'null'
          title: Timestamp
          description: Status timestamp
        row_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Row Count
          description: Row count (if available)
        size_bytes:
          anyOf:
          - type: integer
          - type: 'null'
          title: Size Bytes
          description: Size in bytes (S3 layer only)
      type: object
      required:
      - status
      title: FileLayerStatus
    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
    EnhancedFileStatusLayers:
      properties:
        s3:
          $ref: '#/components/schemas/FileLayerStatus'
          description: S3 layer status (immutable source)
        duckdb:
          $ref: '#/components/schemas/FileLayerStatus'
          description: DuckDB layer status (mutable staging)
        graph:
          $ref: '#/components/schemas/FileLayerStatus'
          description: Graph layer status (immutable materialized view)
      type: object
      required:
      - s3
      - duckdb
      - graph
      title: EnhancedFileStatusLayers
    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