# Portal API

## Docs

- [Get Audit Logs](https://docs.7331.org/api-reference/admin/audit/get-logs.md): Retrieve audit logs with optional filters (moderator+).
- [Delete Bot](https://docs.7331.org/api-reference/admin/bots/delete-bot.md): Hard delete a bot (admin only).
- [List Bots](https://docs.7331.org/api-reference/admin/bots/list-bots.md): List all bots with admin details (admin only).
- [Regenerate Bot API Key](https://docs.7331.org/api-reference/admin/bots/regenerate-key.md): Regenerate a bot's API key. The old key is immediately invalidated (admin only).
- [Register Bot](https://docs.7331.org/api-reference/admin/bots/register-bot.md): Register a new bot instance (admin only).
- [Reset Bot Stats](https://docs.7331.org/api-reference/admin/bots/reset-stats.md): Reset a bot's cached statistics (groups, users, latency) to zero (admin only).
- [Update Bot](https://docs.7331.org/api-reference/admin/bots/update-bot.md): Update bot fields including name, owner, rate limit, and bot type (admin only).
- [Create Official Chat](https://docs.7331.org/api-reference/admin/chats/create-chat.md): Create an OFFICIAL chat. OFFICIAL chats are public and pinned in the lobby.
- [Delete Chat](https://docs.7331.org/api-reference/admin/chats/delete-chat.md): Hard-delete a chat. Removes DB record, Redis state, and stops neko container.
- [Get Chat Detail](https://docs.7331.org/api-reference/admin/chats/get-chat.md): Get full chat detail including members and browser config.
- [Kick User from Chat](https://docs.7331.org/api-reference/admin/chats/kick-user.md): Kick a user from a chat. Works even when the VM is stopped.
- [List All Chats](https://docs.7331.org/api-reference/admin/chats/list-chats.md): Get all chats (admin overview). Includes both public and private chats.
- [Start Browser VM](https://docs.7331.org/api-reference/admin/chats/start-browser.md): Start the virtual browser VM for a chat.
- [Stop Browser VM](https://docs.7331.org/api-reference/admin/chats/stop-browser.md): Stop the virtual browser VM for a chat without destroying it.
- [Transfer Chat Ownership](https://docs.7331.org/api-reference/admin/chats/transfer-chat.md): Transfer chat ownership to another user. Owner-only action.
- [Update Chat](https://docs.7331.org/api-reference/admin/chats/update-chat.md): Update chat fields (name, visibility, slug, browser config).
- [Grant Subscription](https://docs.7331.org/api-reference/admin/subscriptions/grant.md): Grant a subscription to a user (admin only).
- [Grant Trial](https://docs.7331.org/api-reference/admin/subscriptions/grant-trial.md): Grant a one-time 7-day trial to a user (admin only).
- [List Active Subscriptions](https://docs.7331.org/api-reference/admin/subscriptions/list-active.md): List all active (non-BASIC) user subscriptions (admin only).
- [Revoke Subscription](https://docs.7331.org/api-reference/admin/subscriptions/revoke.md): Revoke a subscription, reverting the user to Basic tier (admin only).
- [Delete User](https://docs.7331.org/api-reference/admin/users/delete-user.md): Delete a user and all associated data (admin only).
- [Update User](https://docs.7331.org/api-reference/admin/users/update-user.md): Update a user's details (admin only).
- [Fetch Pending Code](https://docs.7331.org/api-reference/authentication/bot-login-code.md): Fetch a pending web-initiated login code for bot delivery.
- [Quick Login](https://docs.7331.org/api-reference/authentication/bot-send-code.md): Quick login — bot generates a code for an existing user and returns it for DM delivery.
- [Logout](https://docs.7331.org/api-reference/authentication/logout.md): Invalidate the current user session and clear authentication cookies.
- [Lookup User](https://docs.7331.org/api-reference/authentication/lookup-user.md): Look up a user by username. Used by the login page to identify returning users.
- [Request Web Code](https://docs.7331.org/api-reference/authentication/request-login-code.md): Request a login code via the web-initiated flow.
- [Verify Authentication Code](https://docs.7331.org/api-reference/authentication/verify-code.md): Verify an authentication code and establish a user session.
- [Batch Update Commands](https://docs.7331.org/api-reference/bots-management/batch-update-commands.md): Efficiently report multiple command executions at once.
- [Get Bot Profile](https://docs.7331.org/api-reference/bots-management/get-bot-profile.md): Retrieve the authenticated bot's complete profile information.
- [Look Up User](https://docs.7331.org/api-reference/bots-management/lookup-user.md): Bot-authenticated lookup of a user's profile by ID.
- [Update Bot](https://docs.7331.org/api-reference/bots-management/update-bot.md): Unified bot self-update — info (name, avatar) and/or stats (group_ids, users, latency).
- [Update User Info](https://docs.7331.org/api-reference/bots-management/update-user-info.md): Bot-authenticated update of a user's information. User must already exist.
- [Get Bot by ID](https://docs.7331.org/api-reference/bots/get-bot-by-id.md): Get a bot's profile by ID. Response detail varies by caller's permission level.
- [List All Bots](https://docs.7331.org/api-reference/bots/list-all-bots.md): Get a paginated list of all active bots with their public information.
- [Search Bots](https://docs.7331.org/api-reference/bots/search-bots.md): Search bots with filters. Response detail varies by permission level.
- [Dequeue from Match](https://docs.7331.org/api-reference/match/dequeue.md): Cancel an in-flight match search.
- [Enqueue for Match](https://docs.7331.org/api-reference/match/enqueue.md): Join the 1-on-1 matchmaking queue on one or more interest tags.
- [Leave Direct Chat](https://docs.7331.org/api-reference/match/leave.md): Explicitly end the current 1-on-1 chat.
- [Match Statistics](https://docs.7331.org/api-reference/match/statistics.md): Current online count and top interest tags by queue depth.
- [Match Status](https://docs.7331.org/api-reference/match/status.md): Fetch the caller's current matchmaking state.
- [Admin Health Check](https://docs.7331.org/api-reference/monitoring/admin-health.md): Full health diagnostics including pool stats, cache metrics, and source hash. Admin+ only.
- [Health Check](https://docs.7331.org/api-reference/monitoring/health-check.md): Get the health status of the API and its dependencies.
- [Root Endpoint](https://docs.7331.org/api-reference/monitoring/root.md): Get basic application information.
- [Mark All Read](https://docs.7331.org/api-reference/notifications/mark-all-read.md): Mark all unread notifications as read for the caller.
- [Mark Notification Read](https://docs.7331.org/api-reference/notifications/mark-read.md): Mark a single notification as read. Enforces ownership.
- [Unread Count](https://docs.7331.org/api-reference/notifications/unread-count.md): Quick unread notification count for badge display.
- [API Reference](https://docs.7331.org/api-reference/overview.md): Every Portal endpoint, grouped by surface.
- [Ban User from Chat](https://docs.7331.org/api-reference/portal/ban-user.md): Ban a user from a specific chat, preventing them from rejoining.
- [Clear Chat Messages](https://docs.7331.org/api-reference/portal/clear-messages.md): Wipe all messages from a chat. Chat owner or Admin+ only.
- [Create Chat](https://docs.7331.org/api-reference/portal/create-chat.md): Create a new private group chat.
- [Create Chat Invite](https://docs.7331.org/api-reference/portal/create-invite.md): Create an invite code for a chat, persisted in the database.
- [Delete Last N Messages](https://docs.7331.org/api-reference/portal/delete-last-messages.md): Delete the last N messages in a chat (mod+ only).
- [Delete Portal Message](https://docs.7331.org/api-reference/portal/delete-message.md): Delete a message from a chat.
- [Delete My Messages](https://docs.7331.org/api-reference/portal/delete-my-messages.md): Delete all messages sent by you in a chat.
- [Destroy Chat](https://docs.7331.org/api-reference/portal/destroy-chat.md): Permanently destroy a chat and all its state.
- [Get Chat Activity](https://docs.7331.org/api-reference/portal/get-chat-activity.md): Get paginated membership activity log for a chat.
- [Get Clipboard](https://docs.7331.org/api-reference/portal/get-clipboard.md): Read the running browser VM clipboard. Requires chat access.
- [Get Chat Message History](https://docs.7331.org/api-reference/portal/get-history.md): Get message history for a chat.
- [Get Portal Status](https://docs.7331.org/api-reference/portal/get-status.md): Get portal online count, user list, and mute status.
- [Kick User from Chat](https://docs.7331.org/api-reference/portal/kick-user.md): Remove a user from a chat's viewer list.
- [List Chats](https://docs.7331.org/api-reference/portal/list-chats.md): List all chats visible to the authenticated user, including active and archived direct chats.
- [List Chat Invites](https://docs.7331.org/api-reference/portal/list-invites.md): List all active invites for a chat.
- [List Notifications](https://docs.7331.org/api-reference/portal/list-notifications.md): Get paginated notifications for the current user.
- [Mute User in Chat](https://docs.7331.org/api-reference/portal/mute-user.md): Mute a user in a specific chat.
- [Register E2EE Public Key](https://docs.7331.org/api-reference/portal/register-key.md): Register the authenticated session's X25519 public key for end-to-end encryption.
- [Revoke Chat Invite](https://docs.7331.org/api-reference/portal/revoke-invite.md): Revoke an invite code, removing it from the database.
- [Get Chat Screenshot](https://docs.7331.org/api-reference/portal/screenshot.md): Capture a live JPEG screenshot of a running browser VM screen.
- [Send Message](https://docs.7331.org/api-reference/portal/send-message.md): Send an encrypted chat message to a chat.
- [Set Clipboard](https://docs.7331.org/api-reference/portal/set-clipboard.md): Set the running browser VM clipboard. Chat owner or Admin+ only.
- [Start Browser VM](https://docs.7331.org/api-reference/portal/start-browser.md): Start the virtual browser VM for a chat.
- [Stop Browser VM](https://docs.7331.org/api-reference/portal/stop-browser.md): Stop the virtual browser VM for a chat without removing chat viewers.
- [Timeout User in Chat](https://docs.7331.org/api-reference/portal/timeout-user.md): Apply a temporary timeout to a user in the context of a chat.
- [Unban User from Chat](https://docs.7331.org/api-reference/portal/unban-user.md): Lift a chat ban, allowing the user to rejoin.
- [Unmute User in Chat](https://docs.7331.org/api-reference/portal/unmute-user.md): Unmute a user in a specific chat.
- [Update Chat Config](https://docs.7331.org/api-reference/portal/update-chat-config.md): Update chat behavior config. Auth: chat owner, or outranks chat owner on non-private chats.
- [Warn User in Chat](https://docs.7331.org/api-reference/portal/warn-user.md): Issue a formal warning to a user in the context of a chat.
- [Roles & Access](https://docs.7331.org/api-reference/roles-and-access.md): Permission levels, subscription tiers, and what each role can do.
- [Get Application Statistics](https://docs.7331.org/api-reference/statistics/application-statistics.md): Get overall application statistics.
- [Get Bot Statistics](https://docs.7331.org/api-reference/statistics/bot-statistics.md): Get bot count statistics by verification status.
- [Get Browser Statistics](https://docs.7331.org/api-reference/statistics/browser-statistics.md): Get chat count statistics.
- [Get User Statistics](https://docs.7331.org/api-reference/statistics/user-statistics.md): Get user count statistics by subscription tier.
- [Destroy Other Sessions](https://docs.7331.org/api-reference/users/destroy-sessions.md): Destroy all sessions except the current one.
- [Destroy Single Session](https://docs.7331.org/api-reference/users/destroy-single-session.md): Destroy a specific session by its 6-character token suffix.
- [Get Current User](https://docs.7331.org/api-reference/users/get-current-user.md): Retrieve the authenticated user's complete profile including subscription status and permissions.
- [Get My Chats](https://docs.7331.org/api-reference/users/get-my-chats.md): Get chats owned by the authenticated user.
- [Get User Profile](https://docs.7331.org/api-reference/users/get-profile.md): Get a user's profile by username. Privileged viewers see extended data.
- [Get My Moderation History](https://docs.7331.org/api-reference/users/get-punishments.md): Get the authenticated user's moderation action history.
- [Get My Sessions](https://docs.7331.org/api-reference/users/get-sessions.md): List all active and past sessions for the authenticated user with geo data.
- [Get My Subscription](https://docs.7331.org/api-reference/users/get-subscription.md): Get current subscription information for the authenticated user.
- [Get User by ID](https://docs.7331.org/api-reference/users/get-user-by-id.md): Retrieve a user's profile by ID. Response detail varies by caller's permission level.
- [Search Users](https://docs.7331.org/api-reference/users/search-users.md): Search and browse users. Response detail varies by permission level.
- [Update Current User](https://docs.7331.org/api-reference/users/update-me.md): Update the authenticated user's profile settings (username, avatar source).
- [Authentication](https://docs.7331.org/authentication.md): How to authenticate with the Portal API
- [Changelog](https://docs.7331.org/changelog.md): What's new in the Portal API.
- [Chat Types](https://docs.7331.org/concepts/chats.md): OFFICIAL, PUBLIC, PRIVATE, DIRECT — four flavors with different visibility and moderation rules.
- [End-to-End Encryption](https://docs.7331.org/concepts/e2ee.md): How Portal encrypts chat so the server only ever sees opaque bytes.
- [Matchmaking](https://docs.7331.org/concepts/matchmaking.md): How 1-on-1 direct chats get created, survived, archived, and torn down.
- [Errors](https://docs.7331.org/errors.md): Error handling in the Portal API
- [Introduction](https://docs.7331.org/introduction.md): Portal — shared virtual browsers and end-to-end encrypted chat
- [Quickstart](https://docs.7331.org/quickstart.md): Log in to Portal and open your first chat.

## OpenAPI Specs

- [openapi](https://docs.7331.org/api-reference/openapi.json)

## Optional

- [GitHub](https://github.com/7331)