Skip to content
Ask LucyAsk LucyAsk Lucy Docs

My memory at a glance

GET
/memory
curl --request GET \
  --url https://api.asklucy.eu/v1/memory \
  --header 'Authorization: Bearer <token>'

Whether memory is on for you (and which switch turned it off if not), and what it holds.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
entitled
required

The contract includes Lucy Memory (entitlements.memory).

boolean
org_enabled
required

The organization hasn’t turned memory off (settings memory_enabled isn’t false).

boolean
personal_enabled
required

You haven’t turned memory off (preference memory isn’t false).

boolean
enabled
required

All three hold, so Lucy reads and writes memory in your conversations.

boolean
counts
required
object
facts
required

Live facts in your own scope.

integer
entities
required

Entities in your own scope.

integer
own_processes
required

Active processes in your own scope.

integer
org_processes
required

Active processes shared with you (the organization’s and your groups’).

integer
pending_proposals
required

For admins, the proposals waiting for review; null for others.

integer | null

Example generated

{
  "entitled": true,
  "org_enabled": true,
  "personal_enabled": true,
  "enabled": true,
  "counts": {
    "facts": 1,
    "entities": 1,
    "own_processes": 1,
    "org_processes": 1,
    "pending_proposals": 1
  }
}

401

Section titled “401”

Missing, expired or invalid token.

Media typeapplication/problem+json

RFC 9457 problem details.

object
type
required
string format: uri-reference
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
quota

For quota-exceeded, the window that is used up.

object
window
required
string
Allowed values: five_hours week month
percent_used
required
number
<= 100
resets_at
required

Null for a rolling window that hasn’t started.

string | null format: date-time
limited_by
required

organization when the organization’s budget is closer to running out than the member’s own limit.

string
Allowed values: personal organization
request
One of:

A request as its member sees it, where they asked.

object
id
required
string
status
required
string
Allowed values: pending approved declined withdrawn
created_at
required
string format: date-time
decided_at
required
string | null format: date-time
note
required

What the admin who decided wrote back.

string | null
errors

Field-level problems (400 only).

Array<object>
object
field
required

JSON pointer into the request body.

string
message
required
string

Example 

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

Unique per request; quote it to support.

403

Section titled “403”

The token is valid but lacks the role this needs.

Media typeapplication/problem+json

RFC 9457 problem details.

object
type
required
string format: uri-reference
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
quota

For quota-exceeded, the window that is used up.

object
window
required
string
Allowed values: five_hours week month
percent_used
required
number
<= 100
resets_at
required

Null for a rolling window that hasn’t started.

string | null format: date-time
limited_by
required

organization when the organization’s budget is closer to running out than the member’s own limit.

string
Allowed values: personal organization
request
One of:

A request as its member sees it, where they asked.

object
id
required
string
status
required
string
Allowed values: pending approved declined withdrawn
created_at
required
string format: date-time
decided_at
required
string | null format: date-time
note
required

What the admin who decided wrote back.

string | null
errors

Field-level problems (400 only).

Array<object>
object
field
required

JSON pointer into the request body.

string
message
required
string

Example 

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

Unique per request; quote it to support.