Skip to main content
POST
Get one record

Description

Returns a single memory record for a user by its key, identified by userReferenceId and botId.

Endpoint

Body parameters

userReferenceId
string
required
The user’s external reference identifier.
botId
string
required
Identifier of the bot associated with the memory.
key
string
required
Key of the record to retrieve.

Authentication

Every request must include the x-api-key header with an API key that has the memory:read scope.

Request example

cURL

Responses

Response example

Authorizations

x-api-key
string
header
required

API key del proyecto de Jelou

Body

application/json
userReferenceId
string
required

External reference identifier of the user.

botId
string
required

Identifier of the bot associated with the memory.

key
string
required

Key of the record to retrieve.

Response

Record retrieved successfully.

status
string
Example:

"success"

message
string
Example:

"Record retrieved successfully"

data
any

The stored value for the requested key. Any JSON type.