robosystems-ai Search API

openapi: 3.2.0
info:
  title: RoboSystems Search 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: Search
  description: 🔎 Search - Full-text and semantic search on documents, narratives and disclosures
paths:
  /v1/graphs/{graph_id}/search:
    post:
      tags:
      - Search
      summary: Search Graph Documents
      description: Shared repositories require a subscription; subscription plan determines search rate limits.
      operationId: searchDocuments
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: graph_id
        in: path
        required: true
        schema:
          type: string
          title: Graph Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
        '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'
        '503':
          description: Text search not available
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/graphs/{graph_id}/search/{document_id}:
    get:
      tags:
      - Search
      summary: Get Document Section
      operationId: getDocumentSection
      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/DocumentSection'
        '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'
        '503':
          description: Text search not available
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    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
    SearchRequest:
      properties:
        query:
          type: string
          maxLength: 500
          minLength: 1
          title: Query
          description: Search query
        entity:
          anyOf:
          - type: string
          - type: 'null'
          title: Entity
          description: Filter by CIK (exactly one filer), ticker, or entity name. A name, or a ticker that is also a word, is a loose word match that can include other filers
        form_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Form Type
          description: Filter by SEC form type (10-K, 10-Q)
        section:
          anyOf:
          - type: string
          - type: 'null'
          title: Section
          description: 'Filter by section ID: an Item (item_1, item_1a, item_7, ...) or, for iXBRL disclosures, the element qname (us-gaap:GoodwillDisclosureTextBlock)'
        element:
          anyOf:
          - type: string
          - type: 'null'
          title: Element
          description: Filter by XBRL element qname (e.g., us-gaap:Goodwill)
        source_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Type
          description: Filter by source type (xbrl_textblock, narrative_section, ixbrl_disclosure, uploaded_doc, connection_doc)
        fiscal_year:
          anyOf:
          - type: integer
          - type: 'null'
          title: Fiscal Year
          description: Filter by fiscal year
        date_from:
          anyOf:
          - type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
          - type: 'null'
          title: Date From
          description: Filter filings on or after date (YYYY-MM-DD)
        date_to:
          anyOf:
          - type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
          - type: 'null'
          title: Date To
          description: Filter filings on or before date (YYYY-MM-DD)
        semantic:
          type: boolean
          title: Semantic
          description: Enable hybrid semantic search (BM25 + KNN). Default is BM25-only for speed.
          default: false
        group:
          type: boolean
          title: Group
          description: Fold hits from successive filings of the same filer and section into the best-ranked one; also_in_filings counts the others. Ignored when entity is set, where a filer's filing history is the point. A grouped page is drawn from the first 100 hits.
          default: false
        size:
          type: integer
          maximum: 50.0
          minimum: 1.0
          title: Size
          description: Max results to return
          default: 10
        offset:
          type: integer
          minimum: 0.0
          title: Offset
          description: Pagination offset
          default: 0
        snippet_chars:
          anyOf:
          - type: integer
            maximum: 1500.0
            minimum: 80.0
          - type: 'null'
          title: Snippet Chars
          description: Approximate snippet budget per hit in characters; the default is three highlight fragments of about 200
      type: object
      required:
      - query
      title: SearchRequest
      description: Request model for document search.
    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'
    DocumentSection:
      properties:
        document_id:
          type: string
          title: Document Id
        graph_id:
          type: string
          title: Graph Id
        source_type:
          type: string
          title: Source Type
        parent_document_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Parent Document Id
        part:
          type: integer
          title: Part
          default: 1
        part_count:
          type: integer
          title: Part Count
          default: 1
        next_document_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Document Id
        entity_ticker:
          anyOf:
          - type: string
          - type: 'null'
          title: Entity Ticker
        entity_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Entity Name
        entity_cik:
          anyOf:
          - type: string
          - type: 'null'
          title: Entity Cik
        section_label:
          anyOf:
          - type: string
          - type: 'null'
          title: Section Label
        section_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Section Id
        element_qname:
          anyOf:
          - type: string
          - type: 'null'
          title: Element Qname
        filing_date:
          anyOf:
          - type: string
          - type: 'null'
          title: Filing Date
        fiscal_year:
          anyOf:
          - type: integer
          - type: 'null'
          title: Fiscal Year
        fiscal_period:
          anyOf:
          - type: string
          - type: 'null'
          title: Fiscal Period
        form_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Form Type
        accession_number:
          anyOf:
          - type: string
          - type: 'null'
          title: Accession Number
        xbrl_elements:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Xbrl Elements
        content:
          type: string
          title: Content
        content_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Content Url
        content_length:
          type: integer
          title: Content Length
          default: 0
        document_title:
          anyOf:
          - type: string
          - type: 'null'
          title: Document Title
        tags:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tags
        folder:
          anyOf:
          - type: string
          - type: 'null'
          title: Folder
      type: object
      required:
      - document_id
      - graph_id
      - source_type
      - content
      title: DocumentSection
      description: 'Full document section retrieved by ID — one part of it when the section

        is long; `next_document_id` continues it.'
    SearchHit:
      properties:
        document_id:
          type: string
          title: Document Id
        score:
          type: number
          title: Score
        source_type:
          type: string
          title: Source Type
        parent_document_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Parent Document Id
        part:
          type: integer
          title: Part
          default: 1
        part_count:
          type: integer
          title: Part Count
          default: 1
        next_document_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Document Id
        entity_ticker:
          anyOf:
          - type: string
          - type: 'null'
          title: Entity Ticker
        entity_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Entity Name
        section_label:
          anyOf:
          - type: string
          - type: 'null'
          title: Section Label
        section_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Section Id
        element_qname:
          anyOf:
          - type: string
          - type: 'null'
          title: Element Qname
        filing_date:
          anyOf:
          - type: string
          - type: 'null'
          title: Filing Date
        fiscal_year:
          anyOf:
          - type: integer
          - type: 'null'
          title: Fiscal Year
        form_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Form Type
        accession_number:
          anyOf:
          - type: string
          - type: 'null'
          title: Accession Number
        xbrl_elements:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Xbrl Elements
        snippet:
          type: string
          title: Snippet
        content_length:
          type: integer
          title: Content Length
          default: 0
        content_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Content Url
        document_title:
          anyOf:
          - type: string
          - type: 'null'
          title: Document Title
        tags:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tags
        folder:
          anyOf:
          - type: string
          - type: 'null'
          title: Folder
        also_in_filings:
          anyOf:
          - type: integer
          - type: 'null'
          title: Also In Filings
      type: object
      required:
      - document_id
      - score
      - source_type
      - snippet
      title: SearchHit
      description: 'A single search result with snippet.


        A long SEC section (an MD&A, a commitments note) is indexed in parts, each

        a document of its own: `part` of `part_count`, `parent_document_id`

        shared by the section''s parts, `next_document_id` to read on.


        On a grouped search, `also_in_filings` counts the other filings of the

        same filer whose same section (and part) matched and were folded into

        this hit.'
    SearchResponse:
      properties:
        total:
          type: integer
          title: Total
          description: Matching documents before any grouping, as OpenSearch counts them (it stops counting at 10,000). Not the number of distinct results a grouped search can page through.
        hits:
          items:
            $ref: '#/components/schemas/SearchHit'
          type: array
          title: Hits
        query:
          type: string
          title: Query
        graph_id:
          type: string
          title: Graph Id
      type: object
      required:
      - total
      - hits
      - query
      - graph_id
      title: SearchResponse
      description: Response model for document search.
  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