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-documents-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

openapi: 3.2.0
info:
  title: RoboSystems Documents 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: Documents
  description: 📑 Documents - List documents for search and analysis
paths:
  /v1/graphs/{graph_id}/documents:
    get:
      tags:
      - Documents
      summary: List Documents
      operationId: listDocuments
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: graph_id
        in: path
        required: true
        schema:
          type: string
          title: Graph Id
      - name: source_type
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Type
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentListResponse'
        '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}/documents/{document_id}:
    get:
      tags:
      - Documents
      summary: Get Document
      operationId: getDocument
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: graph_id
        in: path
        required: true
        schema:
          type: string
          title: Graph Id
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentDetailResponse'
        '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}/documents/{document_id}/file:
    get:
      tags:
      - Documents
      summary: Download Document File
      description: A short-lived link to a document's stored file, such as the statement PDF behind a recorded balance.
      operationId: getDocumentFile
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: graph_id
        in: path
        required: true
        schema:
          type: string
          title: Graph Id
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentFileDownloadResponse'
        '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:
    DocumentFileInfo:
      properties:
        file_name:
          type: string
          title: File Name
          description: The file's name as uploaded.
        content_type:
          type: string
          title: Content Type
          description: The file's media type.
        size_bytes:
          type: integer
          title: Size Bytes
          description: The stored file's size.
        sha256:
          type: string
          title: Sha256
          description: Hex SHA-256 of the stored bytes, taken when the upload completed. A stored file never changes, so this identifies it.
      type: object
      required:
      - file_name
      - content_type
      - size_bytes
      - sha256
      title: DocumentFileInfo
      description: The stored file behind a document, when it is one.
    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
    DocumentListItem:
      properties:
        id:
          type: string
          title: Id
        document_title:
          type: string
          title: Document Title
        section_count:
          type: integer
          title: Section Count
        source_type:
          type: string
          title: Source Type
        folder:
          anyOf:
          - type: string
          - type: 'null'
          title: Folder
        tags:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tags
        file:
          anyOf:
          - $ref: '#/components/schemas/DocumentFileInfo'
          - type: 'null'
          description: The stored file, for a document that is one.
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      type: object
      required:
      - id
      - document_title
      - section_count
      - source_type
      - created_at
      - updated_at
      title: DocumentListItem
      description: A document in the document list.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DocumentFileDownloadResponse:
      properties:
        document_id:
          type: string
          title: Document Id
        download_url:
          type: string
          title: Download Url
          description: Presigned URL to GET the file.
        expires_in:
          type: integer
          title: Expires In
          description: Seconds until the URL expires.
        file:
          $ref: '#/components/schemas/DocumentFileInfo'
      type: object
      required:
      - document_id
      - download_url
      - expires_in
      - file
      title: DocumentFileDownloadResponse
      description: A short-lived link to a stored document file.
    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'
    DocumentDetailResponse:
      properties:
        id:
          type: string
          title: Id
        graph_id:
          type: string
          title: Graph Id
        user_id:
          type: string
          title: User Id
        title:
          type: string
          title: Title
        content:
          type: string
          title: Content
        tags:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tags
        folder:
          anyOf:
          - type: string
          - type: 'null'
          title: Folder
        external_id:
          anyOf:
          - type: string
          - type: 'null'
          title: External Id
        source_type:
          type: string
          title: Source Type
        source_provider:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Provider
        sections_indexed:
          type: integer
          title: Sections Indexed
        file:
          anyOf:
          - $ref: '#/components/schemas/DocumentFileInfo'
          - type: 'null'
          description: The stored file, for a document that is one; its `content` is empty. Download it from `GET /documents/{document_id}/file`.
        evidence_for:
          items:
            $ref: '#/components/schemas/DocumentEvidence'
          type: array
          title: Evidence For
          description: The live events that name this document as their evidence (an invoice, a bill, a statement balance), newest first, at most 50. While any are listed, the document cannot be deleted.
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      type: object
      required:
      - id
      - graph_id
      - user_id
      - title
      - content
      - source_type
      - sections_indexed
      - created_at
      - updated_at
      title: DocumentDetailResponse
      description: Full document detail with raw content.
    DocumentEvidence:
      properties:
        event_id:
          type: string
          title: Event Id
        event_type:
          type: string
          title: Event Type
        status:
          type: string
          title: Status
        occurred_at:
          type: string
          title: Occurred At
      type: object
      required:
      - event_id
      - event_type
      - status
      - occurred_at
      title: DocumentEvidence
      description: A live event on the books that names the document as its evidence.
    DocumentListResponse:
      properties:
        total:
          type: integer
          title: Total
        documents:
          items:
            $ref: '#/components/schemas/DocumentListItem'
          type: array
          title: Documents
        graph_id:
          type: string
          title: Graph Id
      type: object
      required:
      - total
      - documents
      - graph_id
      title: DocumentListResponse
      description: Response from listing indexed documents.
  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