agents

Recall

Find the agent's memories for a question. Candidates are opened and ranked by the words of query, how recent and how important they are (rerank re-reads the best by meaning), anything under threshold goes, then limit. This is a search, so a key with only the read scope may use it (it is a POST because it carries a body). Without a user_id or a subject it reads what the agent knows and what it knows of its owner, and NOT its users: name a user_id to read one user's. include_person adds the person's own facts, only as deep as the agent's person.read allows (and each self or private fact that leaves is logged against the key for the person to see). A paused agent answers 423.

post/v1/agents/{agent}/recall

Request

  • Base URL: https://innernet.live/api
  • URL: https://innernet.live/api/v1/agents/{agent}/recall
  • Auth: HTTP bearer

Path parameters

agentstring required

The agent's slug, its id, or me (the agent a key made for one agent is bound to). Another agent, by any name, is a 404 to an agent key.

Request body

querystring
filtersobject

The filter language: and / or / not over kind, subject, user_id, run_id, tags, importance, confidence, immutable, source, created_at, updated_at, event_at, expires_at, about_you and metadata.<key>, with eq ne in nin gt gte lt lte contains exists. A bare value means eq. Example: { "and": [ { "kind": { "in": ["fact", "preference"] } }, { "metadata.plan": "pro" } ] }.

user_idstring

One of the agent's users: reads that user's memories.

run_idstring
subject'agent' | 'owner' | 'user'
kindsstring[]
limitinteger

Default: the agent's recall.limit.

thresholdnumber
rerankboolean
include_personboolean
include_expiredboolean
sincestring date-time

Kept at or after this.

untilstring date-time

Kept before or at this.

Response

OK

Changes

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