Recall
const url = 'https://api.metaphoric.io/v1/spaces/personal/recall';const options = { method: 'POST', headers: { 'metaphor-user': 'customer-4821', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"question":"example","budget":2000}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.metaphoric.io/v1/spaces/personal/recall \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'metaphor-user: customer-4821' \ --data '{ "question": "example", "budget": 2000 }'Needs memories:read. The context for a question from one space. Recall never returns a memory the user cannot see, or anything made from one. The body may be up to 65,536 bytes.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”personal for the acting user’s own space, or a shared space’s ID: 1 to 63 lowercase letters, digits and hyphens, starting with a letter or digit. personal always answers: before the user’s first write it holds nothing.
Example
personalpersonal for the acting user’s own space, or a shared space’s ID: 1 to 63 lowercase letters, digits and hyphens, starting with a letter or digit. personal always answers: before the user’s first write it holds nothing.
Header Parameters
Section titled “Header Parameters”A member’s ID, which Metaphor issued and which starts with metaphor:, or your own ID for an end user: 1 to 256 visible ASCII characters but " and \, not starting with metaphor:. Metaphor keeps an end user’s ID as you send it only on a key held to that user. A service user’s ID is issued by Metaphor, so it starts with metaphor: too.
Example
customer-4821The user this request acts for. Required for a key of your own server; a key held to a user may leave it out, or send that user’s ID. A server key acts for a member only where the owner turned that on for the project, and each such request is recorded.
Request Bodyrequired
Section titled “Request Bodyrequired”object
The question, in the user’s words. It is never written to a log.
The most tokens the answer’s lines may take together.
Responses
Section titled “Responses”The lines, in the order they are best read. None when nothing in the space answers the question.
object
object
When it happened, if known.
Up to 20 of the memories this line was made from, each one a memory the user can see. The newest come first, by the minute each was written. Memories written in the same minute come in order of ID, not the order they were written.
Example
{ "items": [ { "occurred_at": "2027-01-31T09:30:00Z", "memory_ids": [ "4f1c9a7e2b8d06c3a5e9f17b20d4c8e6" ] } ]}The request is not valid, or names no user to act for.
object
object
One of ErrorCode, or a code added since. Treat a code you do not know by its status.
Example generated
{ "error": { "code": "example", "message": "example" }}No valid API key was sent.
object
object
One of ErrorCode, or a code added since. Treat a code you do not know by its status.
Example generated
{ "error": { "code": "example", "message": "example" }}The API key does not allow this, or not for this user.
object
object
One of ErrorCode, or a code added since. Treat a code you do not know by its status.
Example generated
{ "error": { "code": "example", "message": "example" }}No such shared space.
object
object
One of ErrorCode, or a code added since. Treat a code you do not know by its status.
Example generated
{ "error": { "code": "example", "message": "example" }}user-erased: the acting user was erased after the request was let in. Nothing was done.
object
object
One of ErrorCode, or a code added since. Treat a code you do not know by its status.
Example generated
{ "error": { "code": "example", "message": "example" }}The request body is longer than 65,536 bytes.
object
object
One of ErrorCode, or a code added since. Treat a code you do not know by its status.
Example generated
{ "error": { "code": "example", "message": "example" }}The body was not sent as application/json.
object
object
One of ErrorCode, or a code added since. Treat a code you do not know by its status.
Example generated
{ "error": { "code": "example", "message": "example" }}The API key sent more than 600 requests in a minute, the user’s keys together more than 2000, or the tenant’s keys together more than 6000. Wait the seconds Retry-After gives.
object
object
One of ErrorCode, or a code added since. Treat a code you do not know by its status.
Example generated
{ "error": { "code": "example", "message": "example" }}Something went wrong. Try again.
object
object
One of ErrorCode, or a code added since. Treat a code you do not know by its status.
Example generated
{ "error": { "code": "example", "message": "example" }}The request could not be checked, or the tenant is not set up to recall yet. Try again later.
object
object
One of ErrorCode, or a code added since. Treat a code you do not know by its status.
Example generated
{ "error": { "code": "example", "message": "example" }}