Zrzur Developers

Status and coverage

How these docs are made

  1. A script reads the server's route code, its permission checks, its error and rate-limit tables, its gateway events, both SDKs and the API's OpenAPI document, and writes the inventory these pages are built from. Nothing here is typed in by hand that the code can say.
  2. The doc-accuracy tests create a server, bots and test members on a local Zrzur server, call documented endpoints with a bot token, compare the answers with the documented schemas, and run every tutorial as a real bot.
  3. Automated checks fail the build when an endpoint has no documentation, a page links nowhere, an example calls a route that does not exist, or the inventory is out of date.

Every endpoint shows how it was checked:

LevelMeaning
Verified liveCalled with a bot token on a running server; response matched the schema
Local integrationTested against services started for the test
Type-checkedCompiles against the SDK types; not run
MockedRun against a fake server
UntestedKnown from the source code only

Status

StatusEndpoints
supported101
partial4
unverified52
unsupported33

What bots cannot do

Endpoint
DELETE /bots/{bot_id}Only the bot's owner, with an MFA ticket, can delete it; a bot token gets NotFound.
PATCH /bots/{bot_id}Only the bot's owner (user session) can edit it; a bot token gets NotFound.
DELETE /bots/{target}/interactions/endpointOnly the bot's owner (user session) can call it; a bot token gets IsBot.
PUT /bots/{target}/interactions/endpointOnly the bot's owner (user session) can call it; a bot token gets IsBot.
POST /bots/{target}/interactions/secretOnly the bot's owner, with an MFA ticket, can make a signing secret; a bot token gets IsBot.
POST /bots/{target}/inviteIsBot
POST /bots/{target}/verificationIsBot
GET /bots/@meLists the bots a user owns; a bot token gets an empty list. Use the Developer Portal.
POST /bots/createBots cannot create bots: the owner's user session creates them in the Developer Portal (IsBot).
DELETE /channels/{group_id}/recipients/{member_id}IsBot
PUT /channels/{group_id}/recipients/{member_id}IsBot
POST /channels/createIsBot
POST /interactionsIsBot
POST /interactions/autocompleteIsBot
PUT /channels/{target}/ack/{message}IsBot
DELETE /channels/{target}/messages/{msg}/polls/answers/{answer}/votes/@meBots cannot vote in a poll: a bot token gets IsBot.
PUT /channels/{target}/messages/{msg}/polls/answers/{answer}/votes/@meBots cannot vote in a poll: a bot token gets IsBot.
POST /channels/{target}/messages/forwardForwarding is switched on per instance: `GET /` shows `features.forwarding`. Where it is off the answer is FeatureDisabled.
GET /oauth2/authorizeIsBot
POST /oauth2/authorizeIsBot
GET /oauth2/authorizedIsBot
DELETE /oauth2/authorized/{application_id}IsBot
POST /invites/{target}IsBot
PUT /servers/{target}/ackIsBot
POST /servers/createIsBot
DELETE /users/{target}/blockIsBot
PUT /users/{target}/blockIsBot
DELETE /users/{target}/friendIsBot
PUT /users/{target}/friendIsBot
GET /users/@me/mentionsIsBot
GET /users/@me/privacyIsBot
PATCH /users/@me/privacyIsBot
POST /users/friendIsBot

Account settings, sessions, multi-factor authentication, billing, Discover listings, plugins, the community gallery and staff tools are not part of the Bot API and are not listed here.