bots.botMemory

GET

/v1/bots/{botId}/memory

const url = 'https://example.com/v1/bots/example/memory';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/bots/example/memory \
  --header 'Authorization: Bearer <token>'

Reads the entries of the Bot memory that the caller may see: entries for the caller, for a Channel group that the caller is in, or for everyone who uses the Bot, in the organization of the caller. Nobody can read the memory about another person.

Authorizations

token
session

Parameters

Path Parameters

botId

required

string

>= 1 characters <= 128 characters

Query Parameters

tags

string

>= 1 characters

Responses

200

Success

application/json

object

entries

required

Array<object>

object

required

string

layer

required

string

Allowed values: fact observation pinned

content

required

string

>= 1 characters

tags

required

Array<string>

sources

required

Array

Any of:

object
object

object

chat

required

string

item

required

string

confidence

number

status

required

string

Allowed values: active retracted

createdAt

required

number

updatedAt

required

number

invalidatedAt

number

version

required

integer

<= 9007199254740991

Example

{
  "entries": [
    {
      "layer": "fact",
      "status": "active"
    }
  ]
}

400

BotInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: BotInvalid

message

required

string

Example

{
  "_tag": "BotInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

BotNotFound

application/json

object

_tag

required

string

Allowed values: BotNotFound

bot

required

string

Example

{
  "_tag": "BotNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending | BotConflict

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

BotStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PolicyUnavailable

Example

{
  "_tag": "PolicyUnavailable"
}