memory.get_unread_count
Overview
- Returns the number of unread memories for the target character.
Metadata
| Field | Value |
|---|---|
| Display | Get Unread Memory Count |
| Category | memory |
| Access | Public |
| Scope | B2Authority |
| Tags | — |
| Aliases | — |
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| entity_id | entityId | no | — | Target entity ID (default: possessed) |
Returns
Returns a JSON object with the following fields:
| Field | Type | Required | Description |
|---|---|---|---|
entity_id | entityId | yes | Owner entity id |
unread_count | int | yes | Number of unread memories |
Usage
await inzoi.cli.execute('memory.get_unread_count', {
entity_id: 0, // optional
});