Skip to content
Navigation

Retrieve what a mind knows about a query

Everything this mind holds that bears on the query: matched skills, remembered facts, and document excerpts.

This endpoint does not generate text. All three arms are existing non-generative retrievers, scoped to the mind. The caller does the reasoning — which is the point, since a model is usually already sitting on the other side of this call.

Arms fail independently: a dead embedder costs you skills and excerpts, not the memories you could still have had.

POST
https://truememory-api.mvstg.com/minds/{mind_id}/consult
View as Markdown

Authorization

  • HTTPBearerHTTPrequired

Path parameters

  • mind_idstringrequired
    format: uuid

Header parameters

  • X-App-Idoptional

    One of the following:

    • string
    • null
  • X-On-Behalf-Ofoptional

    One of the following:

    • string
    • null
  • X-External-User-Idoptional

    One of the following:

    • string
    • null

Request bodyJSONrequired

  • querystringrequired

    What to retrieve. Skills are matched against this by embedding similarity, so keep the asker's own wording.

    maxLength: 5000 · minLength: 1
  • agent_idoptionalstring

    Memory scope for the caller's own facts, blended alongside the mind's.

    default: "chatbot"

Returns

200

Successful Response

JSON
  • mind_idstringrequired
  • mindstringrequired
  • querystringrequired
  • skillsoptionalarray ofobject
    • keystringrequired
    • namestringrequired
    • instructionsstringrequired
    • similaritynumberrequired
    • filesoptionalarray ofobject

      The skill's other files. Read one with GET /minds/{mind_id}/skills/{key}/files/{path} when the instructions point to it.

      • pathstringrequired
      • sizeintegerrequired
  • memoriesoptionalarray ofobject
    • factstringrequired
    • whenoptional

      One of the following:

      • string
      • null
    • sourceoptional

      One of the following:

      • string
      • null
    • scopeoptional

      One of the following:

      • string
      • null
  • excerptsoptionalarray ofobject
    • filenamestringrequired
    • contentstringrequired

422

Validation Error
JSON
  • detailoptionalarray ofobject
    • locarray ofrequired

      One of the following:

      • string
      • integer
    • msgstringrequired
    • typestringrequired
    • inputoptionalunknown
    • ctxoptionalobject

Type to search…

↑↓ navigate↵ selectEsc close