Platform
ScaiWave ScaiGrid ScaiCore ScaiBot ScaiDrive ScaiKey Models Tools & Services
Solutions
Organisations Developers Internet Service Providers Managed Service Providers AI-in-a-Box
Resources
Support Documentation Blog Downloads
Company
About Research Careers Investment Opportunities Contact
Log in

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
{
  "data": [
    {
      "participant_id": "5e4d…",
      "membership": "join",
      "power_level": 0,
      "joined_at": "2026-05-10T09:00:00Z",
      "notification_mode": "mentions",
      "muted_until": null,
      "response_mode": null,
      "participant": {
        "id": "5e4d…",
        "local_id": "alice",
        "server_name": "scaiwave.example.com",
        "display_name": "Alice",
        "participant_type": "human",
        "avatar_url": "..."
      }
    }
  ]
}

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 (matches local_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
curl "$BASE/v1/directory/alias/Meeting%20Notes%202026-05-12" \
  -H "Authorization: Bearer $TOKEN"

Returns either a note reference or an error.

Updated 2026-05-17 13:10:03 View source (.md) rev 3