API resources

A flat index of every resource exposed by the REST + Gateway APIs. Most resources have a list endpoint, a get-by-id endpoint, and a small set of mutations gated by permission.

Core resources

Name
Users
Type
/v1/users
Description
Account identity, presence, equipment, inventory, relationships, and sessions. The /@me literal segment is the caller's own row; everything else is a :userId lookup. See Users.
Name
Channels
Type
/v1/channels
Description
DMs, group DMs, HUBs, and HOMEs. All four channel types share the same endpoint surface; type-specific fields (scene, owner) sit alongside the common ones. See Channels.
Name
Messages
Type
/v1/channels/:channelId/messages
Description
Text + attachment posts within a channel. Inline tokens (<@USER_ID>, <#CHANNEL_ID>, <t:UNIX:STYLE>) are stored as plain text and resolved client-side at render time. See Messages.
Name
Items
Type
/v1/items
Description
Catalog of every grantable / equippable / fishable thing. Item instances (the rows users actually own) live under /v1/users/@me/inventory. See Items.
Name
Permissions
Type
permission model
Description
Every authz decision in the app flows through one can(actor, action) function on the server. The requirePermission middleware is a thin shim. See Permissions.

Real-time

Name
Gateway
Type
wss://gateway.localuniverse.io/v1
Description
WebSocket connection for push events — typing indicators, message creates / updates / deletes, presence changes, equipment changes, channel updates. Identify with the same bearer token used on REST. See Gateway.
Name
Gateway events
Type
dispatch payloads
Description
Every t: payload the Gateway can emit, with shapes and triggers. See Gateway events.

Errors + auth

Name
Authentication
Type
bearer / bot / OAuth
Description
Email-OTP login, bearer-token storage, and the three Authorization header shapes (user, Bot, Bearer). See Authentication.
Name
Errors
Type
status codes + codes
Description
Wire shape for errors ({ error: { code: string } }), what each HTTP class means, and the recovery guidance per code. See Errors.