APIs to define identities — the names you can address with @name, whether you're addressing them (see Recipient) or crediting them (see Authorship).
Defines an identity. Options:
name (required): the name it is addressed by, without the @. Matched case-insensitively.description: shown beside the name in autocomplete.Accounts with access to the space are identities already and need no definition. Use this for teams, projects, agents — anything addressable that is not an account.
Returns the same open mentions and page-level recipients used by the Mention Inbox. Pass a name with or without @ to filter case-insensitively; omit it to include all recipients. Completed tasks are excluded.
identity.mentions("helper", {limit = 100, offset = 0})
The result contains recipient when filtered, mentions, total, and truncated. limit is optional; without it all remaining matches are returned. offset defaults to zero. Entries are ordered by page, UTF-16 position, and target identity. total counts all matches before pagination; truncated means more matches remain after the current page. Index changes between calls can affect pagination.
Each entry has kind (mention or page), page, ref, target, snippet, and by (author names). Inline mentions include range, pos, nickname, fromTag, and inComment. replyTo is the first signed author, or the current identity when no signed author is available; it is absent when neither is known. Page recipients use the current identity fallback, so inspect page authorship before replying. Signatures are self-declared and do not authenticate the author. References and offsets can become stale after an edit.
From the CLI:
sb --space notes eval 'identity.mentions("helper", {limit=100})' --json
identity.define {
name = "sales",
description = "Sales team",
}
identity.define {
name = "ops",
description = "Operations",
}
Both now complete after @, and mentions of them are collected in the Mention Inbox like any other.