Members and directory API
6 endpoints.
Members#
| Method | Path | Purpose |
|---|---|---|
GET |
/v1/rooms/{room_id}/members |
Members of a room with their power, mute, snooze, mode. |
Members come back as:
json
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
For invites, kicks, bans, see Rooms API.
Directory#
Tenant-scoped browse + search.
| Method | Path | Purpose |
|---|---|---|
GET |
/v1/directory/participants |
Search participants by name / local_id. |
GET |
/v1/directory/groups |
List groups (synced from ScaiKey). |
GET |
/v1/directory/groups/{group_id}/members |
Members of a group. |
GET |
/v1/directory/rooms |
Discoverable rooms in your tenant. |
GET |
/v1/directory/alias/{alias:path} |
Resolve a wiki-link alias to its target (note id or fqid). |
Query parameters#
/v1/directory/participants:
q— search string (matcheslocal_id,display_name, email).type— filter by participant type (human,model,helper, …).limit,offset.include_federated=true— search the federation directory too.
/v1/directory/rooms:
q— search room name / topic.room_type— filter.limit,offset.
Aliases#
ScaiWave resolves wiki-link [[Alias]] to either a note or a
participant. The directory's alias endpoint is what powers that
resolution at the API level — used by the AI's find_note plugin
and by the client when rendering a wiki-link click.
bash
1 2 | |
Returns either a note reference or an error.