Browse the api reference

Recall Semantic Memory

post/v1/graphs/{graph_id}/memory/recall

Part of Memory.

Ranked semantic recall over the graph's per-graph memory store. Returns scored hits in the same shape as document search.

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
graph_idrequiredstringGraph Id

Request body

Required, application/json.

FieldTypeDescription
queryrequiredstring

Recall query

Constraints: 1–500 characters

koptionalinteger

Max results to return

Default: 10

Constraints: 1–50

memory_typeoptionalstring

Filter by memory type

sourceoptionalstring

Filter by source

Example request

curl
curl -X POST "https://api.robosystems.ai/v1/graphs/{graph_id}/memory/recall" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "string"
}'

Responses

200 Successful Response

FieldTypeDescription
totalrequiredinteger

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.

hitsrequiredSearchHit[]

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.

SearchHit fields
FieldTypeDescription
document_idrequiredstring
scorerequirednumber
source_typerequiredstring
parent_document_idoptionalstring
partoptionalinteger

Default: 1

part_countoptionalinteger

Default: 1

next_document_idoptionalstring
entity_tickeroptionalstring
entity_nameoptionalstring
section_labeloptionalstring
section_idoptionalstring
element_qnameoptionalstring
filing_dateoptionalstring
fiscal_yearoptionalinteger
form_typeoptionalstring
accession_numberoptionalstring
xbrl_elementsoptionalstring[]
snippetrequiredstring
content_lengthoptionalinteger

Default: 0

content_urloptionalstring
document_titleoptionalstring
tagsoptionalstring[]
folderoptionalstring
also_in_filingsoptionalinteger
queryrequiredstring
graph_idrequiredstring
StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
422Validation Error
429Rate limit exceeded
500Internal server error
503Semantic memory not available