Voznest Forge

Workspace

WorkspaceProjects

Development

DocsAPI ReferenceSDKsEmbed StudioChangelog
  1. Forge
  2. /Docs

Start here

Getting StartedQuickstartPlatform ConceptsEnvironments

Build

ProjectsIdentityAgentsGatewayCapabilitiesPermissions ReferenceInstallationsLive activity

Commands & interactions

CommandsContext-menu CommandsInteractionsComponentsModals (Forms)Activities (Embedded Apps)

Acting in hubs

MessagesEmbedsEmbeds v2 (Blocks)Embeds v3Incoming WebhooksHub Management APIEvent StreamDelivery

Sign in with Voznest

AccessOpenID Connect

API

APIAuthenticationErrorsRate LimitsSecurity

Publish & operate

App Market & ListingTemplates & SandboxObservability & Team Tools

Tools

SDKsExamplesFAQ & TroubleshootingReference

Acting in hubs

Hub Management API

Everything an agent can do in a hub with the capabilities it was granted.

With an agent token (Authorization: Bot …), these endpoints act in hubs where the agent is installed. Each one checks the agent's permissions in that hub — and, for members and roles, the role hierarchy — exactly like for a person. Anything else answers 404 (not found or not visible) or 403.

Hubs

GET/servers/:idThe hub
GET/servers/:id/snapshotChannels, roles and members visible to the agent, in one call
PATCH/servers/:idSettings (manageServer)
GET/servers/:id/insights7-day activity (viewInsights)
GET/servers/:id/voice-statesWho is in which voice channel
DELETE/servers/:id/members/@meLeave the hub

Starter layouts and the hub's look

People create hubs from the app with a starter layout — the same structure as the official Voznest hub, or one for gaming, study, creators, developers, music or friends — in icon, emoji or plain style, with roles, rules and welcome posts in Embeds v3. GET /api/v1/servers/layouts?lang=es|en lists them (no authentication): categories, channels with their icon, emoji and topic, roles and rules.

  • Channels take an icon (one of the Embeds v3 icon names; null for the type's icon) on create and edit, in any hub.
  • Names may include emoji and the ・ separator: text channels keep them, lowercased with dashes (🔥 Hot Takes → 🔥-hot-takes).
  • Roles take an icon too, shown next to names in chat and in the member list.
  • Blueprints (hub templates) keep channel icons, descriptions and role icons — never messages.

Channels

POST/servers/:id/channelsCreate a channel or category (manageChannels)
PATCH/servers/:id/channelsReorder / move (transactional)
GET / PATCH / DELETE/channels/:idRead / edit / delete
PUT/channels/:id/overwrites/:targetIdPermission overwrite for a role or member (manageRoles)
POST/channels/:id/syncSync permissions with the category
POST/channels/:id/invitesCreate an invite (createInvite)

Roles & members

GET / POST / PATCH/servers/:id/rolesList, create, reorder (manageRoles, below the agent's highest role)
PATCH / DELETE/servers/:id/roles/:roleIdEdit / delete
GET/servers/:id/membersCursor pagination (after, limit ≤ 100, q, roleId)
GET / PATCH/servers/:id/members/:userIdRead / nickname, hub mute & deafen
PUT / DELETE/servers/:id/members/:userId/roles/:roleIdGive / remove a role
POST/servers/:id/members/:userId/voiceMove to another voice channel or disconnect (moveMembers)

Moderation

DELETE/servers/:id/members/:userIdKick (kickMembers)
PUT / DELETE/servers/:id/bans/:userIdBan (optional message deletion) / unban (banMembers)
GET/servers/:id/bansBans
POST/servers/:id/members/:userId/timeoutSuspend up to 28 days, 0 lifts it (timeoutMembers)
POST/servers/:id/members/:userId/warnWarn (opens a case, notifies the member)
POST/servers/:id/members/:userId/notesModerator note
GET/servers/:id/casesModeration cases
GET / PATCH/servers/:id/reports(/:reportId)Reports and their review
POST/servers/:id/lockdownPause joins and invites (manageServer)
GET / POST / PATCH / DELETE/servers/:id/automod(/:ruleId)Guardian rules
GET/servers/:id/audit-logAudit log (viewAuditLog)

Events, expressions, onboarding

GET / POST/servers/:id/eventsScheduled events (createEvents)
PATCH / DELETE/events/:idUpdate, start, end, cancel / delete
GET/servers/:id/expressionsEmoji and stickers
POST / PATCH / DELETE/servers/:id/emoji(/:emojiId)From an upload (manageEmoji)
POST / DELETE/servers/:id/stickers(/:stickerId)Stickers
GET / PUT/servers/:id/onboardingOnboarding questions and default channels
GET/servers/:id/invites · /servers/:id/webhooks · /servers/:id/integrationsInvites, webhooks, installed apps
Destructive bursts (many bans, channel deletions, role edits in a row) trip raid protection (anti-nuke): the agent's admin actions pause for a while (429 RAID_PROTECTION with retryAfter) and the hub owner is alerted. Design bulk jobs to go slowly. Each hub owner controls it in Settings → Safety Checklist: turn it off, pick a sensitivity (relaxed = 3× the budget), trust specific members or bots, or trust every app in the hub. Sandbox hubs created from the portal trust apps by default.

The complete, always-current list — including request bodies — is in the API Reference.

PreviousIncoming WebhooksNext Event Stream