Skip to content

Read a forget

GET
/v1/spaces/{space_id}/forgets/{forget_id}
curl --request GET \
--url https://api.metaphoric.io/v1/spaces/personal/forgets/b7e04c2a9d3f18e6c5a0f29d4b81e7c3 \
--header 'Authorization: Bearer <token>' \
--header 'metaphor-user: customer-4821'

Needs memories:forget. Only the user who asked for a forget can read it.

space_id
required

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.

string
/^[a-z0-9][a-z0-9-]{0,62}$/

Example

personal

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.

forget_id
required
string
/^[0-9a-f]{32}$/

Example

b7e04c2a9d3f18e6c5a0f29d4b81e7c3
metaphor-user

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.

string
>= 1 characters <= 256 characters /^[!#-[\]-~]+$/

Example

customer-4821

The 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.

Where the forget stands.

Media typeapplication/json
object
id
required
string
/^[0-9a-f]{32}$/
state
required

Where what this forget took stands. open: gone from recall, and can be undone until undo_until. undone: brought back. closed: the undo window has closed and nothing of it can be read. erased: every key that could open a copy of it is destroyed too.

string
undo_until
required
string | null format: date-time
erased_at
required

When every key that could open a copy is, or will be, destroyed.

string | null format: date-time

Example

{
"id": "b7e04c2a9d3f18e6c5a0f29d4b81e7c3",
"undo_until": "2027-01-31T09:30:00Z",
"erased_at": "2027-01-31T09:30:00Z"
}

The request is not valid, or names no user to act for.

Media typeapplication/json
object
error
required
object
code
required

One of ErrorCode, or a code added since. Treat a code you do not know by its status.

string
message
required
string

Example generated

{
"error": {
"code": "example",
"message": "example"
}
}

No valid API key was sent.

Media typeapplication/json
object
error
required
object
code
required

One of ErrorCode, or a code added since. Treat a code you do not know by its status.

string
message
required
string

Example generated

{
"error": {
"code": "example",
"message": "example"
}
}

The API key does not allow this, or not for this user.

Media typeapplication/json
object
error
required
object
code
required

One of ErrorCode, or a code added since. Treat a code you do not know by its status.

string
message
required
string

Example generated

{
"error": {
"code": "example",
"message": "example"
}
}

No such forget, or no such shared space.

Media typeapplication/json
object
error
required
object
code
required

One of ErrorCode, or a code added since. Treat a code you do not know by its status.

string
message
required
string

Example generated

{
"error": {
"code": "example",
"message": "example"
}
}

user-erased: the acting user was erased after the request was let in. Nothing was done.

Media typeapplication/json
object
error
required
object
code
required

One of ErrorCode, or a code added since. Treat a code you do not know by its status.

string
message
required
string

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.

Media typeapplication/json
object
error
required
object
code
required

One of ErrorCode, or a code added since. Treat a code you do not know by its status.

string
message
required
string

Example generated

{
"error": {
"code": "example",
"message": "example"
}
}

Something went wrong. Try again.

Media typeapplication/json
object
error
required
object
code
required

One of ErrorCode, or a code added since. Treat a code you do not know by its status.

string
message
required
string

Example generated

{
"error": {
"code": "example",
"message": "example"
}
}

The request could not be checked. Try again later.

Media typeapplication/json
object
error
required
object
code
required

One of ErrorCode, or a code added since. Treat a code you do not know by its status.

string
message
required
string

Example generated

{
"error": {
"code": "example",
"message": "example"
}
}