A client that knows only an instance's origin starts with get instance discovery, which returns the API, Gateway and media URLs, the enabled features and the limits. Every route on this page works without a token.
The images the instance shows in place of the built-in guild badges
hidden_built_in_guild_badges?2
array[string]
The built-in guild badges the instance doesn't show: any of verified, partnered and discoverable
voice_origins?
array[string]
The origin of every voice server endpoint, such as wss://voice.example.com, for content security policies. Voice servers that share a domain are listed once as a wildcard, such as wss://*.example.com (at most 1000)
1 An instance can have any number of guild badges. Discovery lists the first 100 in display order, and List guild badges serves every one. A client that knows only guild_badges can't show a badge past the first 100
2 Guilds keep the feature behind a hidden badge, so a discoverable guild is still listed in discovery. When a guild has more than one of these badges, clients show the next one that isn't hidden
A custom badge that instance admins give to guilds. A guild lists the badges it has in badge_ids. Clients look up the IDs they don't know with List guild badges, skip the IDs it leaves out, and show the badges in ascending position order.
Instance admins can replace the artwork of the built-in guild badges. When a field has a URL, draw that image wherever the badge appears and keep the badge's usual tooltip. When it's null, draw the built-in artwork.
Base URL of the client API, the same as api_client
api_client
string
Base URL of the client API, used by the Resenha apps
api_public
string
Base URL of the public API, used by bots and other clients
api_transport?
string
Base URL the official desktop app sends API requests to instead of api_client. Only Resenha.app lists it, and the app ignores any address other than the matching joinresenha.com.br one
gateway
string
The Gateway WebSocket URL, with a ws or wss scheme
People register and sign in with a username, and the instance collects no email address
On a username instance, email routes return 400 EMAIL_UNAVAILABLE_ON_INSTANCE. On an email instance, username-only routes such as recover an account return 400 USERNAME_SIGN_IN_ONLY.
A hash of the release's default limit values, which changes when a release changes them
Each rule lists the keys that differ from the release defaults, plus max_guild_emojis, max_guild_stickers and their aliases whenever the rule sets them. The document doesn't include the defaults, and your client needs its own copy of them. To resolve limits, follow these steps.
A feature_ key is 1 when the feature is available and 0 when it isn't. The scope of each key is in parentheses.
Value
Description
avatar_max_size
Maximum avatar upload size in bytes, up to 104857600 (user)
emoji_max_size
Maximum emoji upload size in bytes, up to 104857600 (guild)
feature_animated_avatar
Animated avatar uploads (user)
feature_animated_banner
Animated banner uploads (user)
feature_custom_discriminator
Choosing a custom discriminator, ignored with the none tag style (user)
feature_custom_notification_sounds
Custom notification sounds (user)
feature_early_access
Beta features (user)
feature_global_expressions
Using expressions in every guild (user)
feature_guild_create
Creating communities while the instance restricts it (user)
feature_higher_video_quality
Higher video streaming quality: screen shares up to 2160p at 120 FPS and cameras up to 1080p, whatever the max_screen_share_resolution, max_screen_share_frame_rate and max_camera_resolution limits say (user)
feature_per_guild_profiles
A different profile in each guild (user)
feature_voice_entrance_sounds
A sound when joining voice (user)
guild_visit_history_days_unverified
Days of history an unverified account sees while visiting a guild (user)
max_attachment_file_size
Maximum size of each attachment in bytes (user and guild)
max_attachments_per_message
Maximum attachments per message (user and guild)
max_bio_length
Maximum characters in a bio, 320 by default and at most 1000 (user)
max_bookmarks
Maximum bookmarked messages (user)
max_bot_attachment_file_size
Maximum size of each attachment a bot uploads in bytes, 52428800 by default. A bot gets the lower of this and max_attachment_file_size (user and guild)
max_camera_resolution
Tallest camera video in pixels, 720 or 1080 (user)
max_channels_per_category
Maximum channels per category (guild)
max_custom_backgrounds
Maximum custom profile backgrounds (user)
max_embeds_per_message
Maximum embeds per message (user and guild)
max_favorite_meme_tags
Maximum meme tags to track (user)
max_favorite_memes
Maximum favorite memes (user)
max_group_dm_recipients
Maximum members per group DM (user)
max_group_dms_per_user
Maximum group DMs a user can own (user)
max_guild_channels
Maximum channels per guild, counting forum and media channels but not threads (guild)
max_guild_emojis
Maximum emojis per guild (guild)
max_guild_emojis_animated
Alias of max_guild_emojis for older clients (guild)
max_guild_emojis_animated_more
Alias of max_guild_emojis for older clients (guild)
max_guild_emojis_static
Alias of max_guild_emojis for older clients (guild)
max_guild_emojis_static_more
Alias of max_guild_emojis for older clients (guild)
max_guild_invites
Maximum active invites per guild (guild)
max_guild_members
Maximum members per guild (guild)
max_guild_roles
Maximum roles per guild (guild)
max_guild_stickers
Maximum stickers per guild (guild)
max_guild_stickers_more
Alias of max_guild_stickers for older clients (guild)
max_guild_visits
Maximum guilds a user can visit at once, halved for unverified accounts (user)
max_guilds
Maximum guilds a user can join (user)
max_message_length
Maximum characters per message (user and guild)
max_private_channels_per_user
Maximum DM channels per user (user)
max_reactions_per_message
Maximum distinct reactions per message (guild)
max_relationships
Maximum friends and blocked users (user)
max_screen_share_bitrate
Highest screen share bitrate in bits per second, 1000000 to 50000000 (user)
max_screen_share_frame_rate
Highest screen share frame rate, 30 to 120, rounded down to 30, 60 or 120 (user)
max_screen_share_resolution
Tallest screen share in pixels, 720 to 2160, rounded down to 720, 1080, 1440 or 2160, where 2160 also allows the source resolution (user)
max_users_per_message_reaction
Maximum users per reaction on a message (guild)
max_voice_message_duration
Maximum voice message length in seconds (user and guild)
max_webhooks_per_channel
Maximum webhooks per channel (guild)
max_webhooks_per_guild
Maximum webhooks per guild (guild)
sticker_max_size
Maximum sticker upload size in bytes, up to 104857600 (guild)
The approximate location of the request, the places where a date of birth typed in is not enough for mature content, and the places where mature content isn't available.
Returns the instance discovery object. The response has ETag and Last-Modified headers, and a request with a matching If-None-Match or If-Modified-Since gets 304 with no body.
Returns custom guild badges in display order. Send ids to look up the badges of some guilds, or page through every badge with after and limit. User badges aren't listed here. They come back in each profile instead.
The response has an ETag header, and a request with a matching If-None-Match gets 304 with no body. A response read while the catalog changes gets the short lifetime and no ETag. The version also changes when the instance moves to a new media URL, because every asset_url changes with it.
INVALID_FORM_BODY for a bad parameter, a cursor from another list, or ids sent with after
The rate limit is 60 requests per minute, on the instance:badges bucket. A request with a valid token counts against the account, and a request without one counts against the IP address.
Sets how people sign in on a new self-hosted instance and, for email, whether usernames have tags. Returns an account identity object. It works until one of the account identity lock reasons applies, such as setup being finished or the first account existing. Send setup_token while setup_token_required is true in the public setup state.