Recall
context for your prompt, ask for an answer in words, search for ranked memories. This page is generated from the API's own spec, so it says exactly what the API does.
The memories that bear on a question, written out for your prompt
Put context straight into your prompt. It is the same ten lines of formatting every
integration writes after calling search, so we write them once. When nothing is held it says so
in words rather than coming back empty, because an empty block reads to a model as permission.
| Parameter | In | Type | Description |
|---|---|---|---|
X-Geniffy-Space |
header | string | One of your own users, for every call this client makes. Leave it out for your own memory; a blank one is refused. (up to 128 characters) |
Body (application/json)
| Field | Type | Description | |
|---|---|---|---|
question |
string | required | What your model is about to answer (at least 1 character; up to 2,000 characters) |
limit |
integer | optional | (at least 1; at most 50; default 12) |
kind |
all, people, plan, pref, detail |
optional | |
with_sources |
boolean | optional | Put where each memory came from beside it (default true) |
labels |
object | optional | Only what sources carrying these labels said: every name must match, and a list of values is any one of them, such as {"channel": ["email", "chat"]} |
space |
string | optional | One of your own users. Leave it out for your own memory; a blank one is refused. (up to 128 characters) |
Returns 200
| Field | Type | Description | |
|---|---|---|---|
question |
string | required | |
context |
string | required | Put this straight into your prompt: the memories that bear on the question, each with where it came from, then what happened, the rules that apply and where things stand as they bear on it. Never empty: when nothing is held it says so, so your model does not fill the silence. |
memories |
array of Memory | required | |
used |
integer | required | |
empty |
boolean | required | true when nothing stored bears on the question |
Answer from the memory only, or say nothing supports it
| Parameter | In | Type | Description |
|---|---|---|---|
X-Geniffy-Space |
header | string | One of your own users, for every call this client makes. Leave it out for your own memory; a blank one is refused. (up to 128 characters) |
Body (application/json)
| Field | Type | Description | |
|---|---|---|---|
question |
string | required | (at least 1 character; up to 2,000 characters) |
labels |
object | optional | Only what sources carrying these labels said: every name must match, and a list of values is any one of them, such as {"channel": ["email", "chat"]} |
space |
string | optional | One of your own users. Leave it out for your own memory; a blank one is refused. (up to 128 characters) |
Returns 200
| Field | Type | Description | |
|---|---|---|---|
question |
string | required | |
answer |
string | optional | None when nothing in the memory supports an answer |
message |
string | optional | |
memories |
array of Memory | required | |
clash |
boolean | optional | (default false) |
The memories that best match a query, with the lessons, stories and promises that bear on it
Facts first (memories, best match first), then everything else the memory learned that bears on the
query: rules and how-tos (lessons), what happened (episodes) and open promises (intentions). Matched by
meaning and by the words themselves, so "port 6543" finds the how-to that holds it. With a label filter, or a
kind other than all, only memories come back.
| Parameter | In | Type | Description |
|---|---|---|---|
X-Geniffy-Space |
header | string | One of your own users, for every call this client makes. Leave it out for your own memory; a blank one is refused. (up to 128 characters) |
Body (application/json)
| Field | Type | Description | |
|---|---|---|---|
q |
string | required | (at least 1 character; up to 2,000 characters) |
limit |
integer | optional | (at least 1; at most 50; default 10) |
kind |
all, people, plan, pref, detail |
optional | |
labels |
object | optional | Only what sources carrying these labels said: every name must match, and a list of values is any one of them, such as {"channel": ["email", "chat"]} |
space |
string | optional | One of your own users. Leave it out for your own memory; a blank one is refused. (up to 128 characters) |
Returns 200
| Field | Type | Description | |
|---|---|---|---|
memories |
array of Memory | required | |
counts |
object | required | |
total |
integer | required | |
next |
integer | optional | |
lessons |
array of LessonOut | optional | Rules, how-tos and lessons that bear on the query, best first (empty when none do) |
episodes |
array of EpisodeOut | optional | What happened, as stories, that bears on the query, best first |
intentions |
array of IntentionOut | optional | Open promises and plans that bear on the query |