Search

Search Graph Documents

Shared repositories require a subscription; subscription plan determines search rate limits.

post/v1/graphs/{graph_id}/search

Request

  • Base URL: https://api.robosystems.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.robosystems.ai/v1/graphs/{graph_id}/search
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required

Request body

querystring required

Search query

entitystring nullable

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_typestring nullable

Filter by SEC form type (10-K, 10-Q)

sectionstring nullable

Filter by section ID: an Item (item_1, item_1a, item_7, ...) or, for iXBRL disclosures, the element qname (us-gaap:GoodwillDisclosureTextBlock)

elementstring nullable

Filter by XBRL element qname (e.g., us-gaap:Goodwill)

source_typestring nullable

Filter by source type (xbrl_textblock, narrative_section, ixbrl_disclosure, uploaded_doc, connection_doc)

fiscal_yearinteger nullable

Filter by fiscal year

date_fromstring nullable

Filter filings on or after date (YYYY-MM-DD)

date_tostring nullable

Filter filings on or before date (YYYY-MM-DD)

semanticboolean

Enable hybrid semantic search (BM25 + KNN). Default is BM25-only for speed.

groupboolean

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.

sizeinteger

Max results to return

offsetinteger

Pagination offset

snippet_charsinteger nullable

Approximate snippet budget per hit in characters; the default is three highlight fragments of about 200

Response

Successful Response

totalinteger required

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.

querystring required
graph_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.