{ "openapi": "3.1.0", "info": { "title": "Yapper Bot API", "version": "1.0.0", "description": "Drive a Yapper bot account over HTTPS. Send `Authorization: Bot ` (Settings → Developer). Docs: https://www.yapper.website/developers", "termsOfService": "https://www.yapper.website/terms" }, "servers": [ { "url": "https://www.yapper.website/api/bot/v1" } ], "security": [ { "bot": [] } ], "tags": [ { "name": "Bot" }, { "name": "Events" }, { "name": "Servers" }, { "name": "Channels" }, { "name": "Messages" }, { "name": "Moderation" }, { "name": "Voice" }, { "name": "Users" } ], "paths": { "/me": { "get": { "tags": [ "Bot" ], "summary": "The bot itself", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "username": { "type": "string" }, "display_name": { "type": [ "string", "null" ] }, "bio": { "type": "string" }, "avatar_url": { "type": [ "string", "null" ] }, "banner_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "bot": { "type": "object", "properties": { "name": { "type": "string" }, "public": { "type": "boolean" }, "owner_id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Bot" ], "summary": "Change display name or bio", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotProfile" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "display_name": { "type": "string", "maxLength": 32 }, "bio": { "type": "string", "maxLength": 190 } } } } } } } }, "/me/avatar": { "put": { "tags": [ "Bot" ], "summary": "Set the profile picture (image body or multipart \"file\", PNG/JPG/GIF/WebP, 8 MB)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Image" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "description": "The image itself (PNG, JPG, GIF or WebP, up to 8 MB), or multipart/form-data with it in \"file\"", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "image/gif": { "schema": { "type": "string", "format": "binary" } }, "image/webp": { "schema": { "type": "string", "format": "binary" } }, "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "required": [ "file" ] } } } } }, "delete": { "tags": [ "Bot" ], "summary": "Remove the profile picture", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/me/banner": { "put": { "tags": [ "Bot" ], "summary": "Set the banner (10 MB)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Image" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "description": "The image itself (PNG, JPG, GIF or WebP, up to 10 MB), or multipart/form-data with it in \"file\"", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "image/gif": { "schema": { "type": "string", "format": "binary" } }, "image/webp": { "schema": { "type": "string", "format": "binary" } }, "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "required": [ "file" ] } } } } }, "delete": { "tags": [ "Bot" ], "summary": "Remove the banner", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/me/status": { "put": { "tags": [ "Bot" ], "summary": "Status and activity", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Ok" }, { "type": "object", "properties": { "status": { "enum": [ "online", "idle", "dnd" ] }, "activity": { "type": [ "string", "null" ] } } } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "enum": [ "online", "idle", "dnd" ] }, "activity": { "type": "string", "maxLength": 60 } } } } } } } }, "/events": { "get": { "tags": [ "Events" ], "summary": "Long-poll for events (keeps the bot online)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "last": { "type": "integer" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Last event id you saw. 0 returns no events and the newest id as last (start from now)" }, { "name": "wait", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 25 }, "description": "Seconds to wait for something" } ] } }, "/commands": { "get": { "tags": [ "Bot" ], "summary": "The bot's slash commands", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "commands": { "type": "array", "items": { "$ref": "#/components/schemas/Command" } } }, "required": [ "commands" ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "tags": [ "Bot" ], "summary": "Replace the slash commands (up to 50)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Ok" }, { "type": "object", "properties": { "commands": { "type": "array", "items": { "$ref": "#/components/schemas/Command" } } } } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "commands": { "type": "array", "items": { "$ref": "#/components/schemas/Command" } } } } } } } } }, "/servers": { "get": { "tags": [ "Servers" ], "summary": "Servers the bot is in", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "servers": { "type": "array", "items": { "$ref": "#/components/schemas/Server" } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/servers/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Servers" ], "summary": "One server", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "server": { "$ref": "#/components/schemas/Server" } }, "required": [ "server" ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/servers/{id}/channels": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Channels" ], "summary": "Channels the bot can see, in sidebar order (private ones only if it was let in)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "channels": { "type": "array", "items": { "$ref": "#/components/schemas/Channel" } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "enum": [ "text", "voice" ] } } ] }, "post": { "tags": [ "Channels" ], "summary": "Create a channel (Manage channels)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "$ref": "#/components/schemas/Channel" } }, "required": [ "channel" ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "kind": { "enum": [ "text", "voice" ] }, "category_id": { "type": "string", "format": "uuid" } }, "required": [ "name" ] } } } } } }, "/channels": { "get": { "tags": [ "Channels" ], "summary": "Every channel the bot can see, in all its servers", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "channels": { "type": "array", "items": { "$ref": "#/components/schemas/Channel" } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "enum": [ "text", "voice" ] } } ] } }, "/servers/{id}/categories": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "post": { "tags": [ "Channels" ], "summary": "Create a category", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } } }, "required": [ "category" ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } } } } }, "/servers/{id}/categories/{cid}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "patch": { "tags": [ "Channels" ], "summary": "Rename a category", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } } } } } } }, "delete": { "tags": [ "Channels" ], "summary": "Delete a category", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/servers/{id}/roles": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Servers" ], "summary": "Roles", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/servers/{id}/members": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Servers" ], "summary": "Members, sorted by user id: 200 a page by default, up to 500 with limit", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "members": { "type": "array", "items": { "$ref": "#/components/schemas/Member" } } }, "required": [ "members" ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 200 } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Last user id of the previous page" } ] } }, "/servers/{id}/members/{uid}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "uid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Servers" ], "summary": "One member with roles", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "member": { "$ref": "#/components/schemas/MemberDetail" } }, "required": [ "member" ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Moderation" ], "summary": "Set a nickname (Manage nicknames)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nickname": { "type": [ "string", "null" ] } } } } } } } }, "/servers/{id}/members/{uid}/roles/{rid}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "uid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "rid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "put": { "tags": [ "Moderation" ], "summary": "Give a role (Manage roles)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Moderation" ], "summary": "Take a role away", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/servers/{id}/kick": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "post": { "tags": [ "Moderation" ], "summary": "Kick someone (Kick members)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uuid" } }, "required": [ "user_id" ] } } } } } }, "/servers/{id}/bans": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Moderation" ], "summary": "Bans", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "bans": { "type": "array", "items": { "$ref": "#/components/schemas/Ban" } } }, "required": [ "bans" ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Moderation" ], "summary": "Ban someone (Ban members)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uuid" }, "reason": { "type": "string" } }, "required": [ "user_id" ] } } } } } }, "/servers/{id}/bans/{uid}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "uid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "delete": { "tags": [ "Moderation" ], "summary": "Unban", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/servers/{id}/timeouts": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "post": { "tags": [ "Moderation" ], "summary": "Time someone out (Timeout members); minutes 0 clears", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Ok" }, { "type": "object", "properties": { "minutes": { "type": "integer" } } } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uuid" }, "minutes": { "type": "integer", "maximum": 40320 }, "reason": { "type": "string" } }, "required": [ "user_id", "minutes" ] } } } } } }, "/servers/{id}/voice": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Voice" ], "summary": "Who is in voice, for every voice channel the bot can see (in testing: flag bot_voice; 60 a minute)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "voice": { "type": "array", "items": { "$ref": "#/components/schemas/VoiceChannel" } } }, "required": [ "voice" ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/servers/{id}/voice/move": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "post": { "tags": [ "Voice" ], "summary": "Move someone who is in voice to another voice channel (Move Members, 30 a minute)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Ok" }, { "type": "object", "properties": { "from": { "type": "string", "format": "uuid" }, "channel_id": { "type": "string", "format": "uuid" } } } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uuid" }, "channel_id": { "type": "string", "format": "uuid" } }, "required": [ "user_id", "channel_id" ] } } } } } }, "/servers/{id}/voice/disconnect": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "post": { "tags": [ "Voice" ], "summary": "Drop someone from voice (Move Members, 30 a minute)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Ok" }, { "type": "object", "properties": { "channel_id": { "type": "string", "format": "uuid", "description": "The voice channel they were in" } } } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uuid" } }, "required": [ "user_id" ] } } } } } }, "/channels/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Channels" ], "summary": "One channel", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "$ref": "#/components/schemas/Channel" } }, "required": [ "channel" ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Channels" ], "summary": "Edit a channel (Manage channels)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "$ref": "#/components/schemas/Channel" } }, "required": [ "channel" ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "category_id": { "type": [ "string", "null" ] }, "private": { "type": "boolean" }, "role_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "read_only": { "type": "boolean" }, "post_role_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "slowmode": { "type": "integer", "maximum": 21600 } } } } } } }, "delete": { "tags": [ "Channels" ], "summary": "Delete a channel", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/channels/{id}/messages": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Messages" ], "summary": "Messages, oldest first (50, up to 100)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } }, "authors": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100 } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ] }, "post": { "tags": [ "Messages" ], "summary": "Send a message (30 a minute)", "responses": { "201": { "description": "Sent", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/Message" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "maxLength": 2000 }, "reply_to": { "type": "string", "format": "uuid" }, "embeds": { "type": "array", "maxItems": 5, "items": { "$ref": "#/components/schemas/Embed" } }, "components": { "type": "array", "maxItems": 5, "items": { "$ref": "#/components/schemas/ActionRow" } } } } } } } } }, "/channels/{id}/messages/bulk-delete": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "post": { "tags": [ "Messages" ], "summary": "Delete up to 100 messages", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "skipped": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "deleted", "skipped" ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "maxItems": 100, "items": { "type": "string", "format": "uuid" } } }, "required": [ "ids" ] } } } } } }, "/channels/{id}/messages/{mid}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Messages" ], "summary": "One message", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/Message" }, "author": { "oneOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] } }, "required": [ "message" ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Messages" ], "summary": "Edit the bot's own message (embeds / components: null removes them)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/Message" } }, "required": [ "message" ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "maxLength": 2000 }, "embeds": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/Embed" } }, "components": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/ActionRow" } } } } } } } }, "delete": { "tags": [ "Messages" ], "summary": "Delete a message (own, or others with Manage messages)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/channels/{id}/messages/{mid}/pin": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "put": { "tags": [ "Messages" ], "summary": "Pin", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Ok" }, { "type": "object", "properties": { "pinned": { "type": "boolean" } } } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Messages" ], "summary": "Unpin", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Ok" }, { "type": "object", "properties": { "pinned": { "type": "boolean" } } } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/channels/{id}/messages/{mid}/reactions": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Messages" ], "summary": "Reactions on a message", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "reactions": { "type": "array", "items": { "$ref": "#/components/schemas/Reaction" } } }, "required": [ "reactions" ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/channels/{id}/messages/{mid}/reactions/{emoji}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "emoji", "in": "path", "required": true, "schema": { "type": "string" }, "description": "URL-encoded unicode emoji" } ], "put": { "tags": [ "Messages" ], "summary": "React", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Messages" ], "summary": "Remove the bot's reaction", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/interactions/{id}/{token}/callback": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The token from the interaction event" } ], "post": { "tags": [ "Messages" ], "summary": "Answer a button click (within 15 minutes, up to 10 answers)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "What happened, e.g. the new or edited message for reply and update", "additionalProperties": true } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "reply", "ephemeral", "update", "ack" ], "description": "reply: new message in the channel. ephemeral: only the clicker sees it. update: edit the clicked message. ack: just \"got it\"" }, "content": { "type": [ "string", "null" ], "maxLength": 2000 }, "embeds": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/Embed" } }, "components": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/ActionRow" }, "description": "reply and update only" } }, "required": [ "type" ] } } } } } }, "/users/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Users" ], "summary": "A user's public profile", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "allOf": [ { "$ref": "#/components/schemas/User" }, { "type": "object", "properties": { "banner_path": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" }, "bio": { "type": [ "string", "null" ] }, "pronouns": { "type": [ "string", "null" ] } } } ] } }, "required": [ "user" ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/users/{id}/dm": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "post": { "tags": [ "Users" ], "summary": "Open (or find) a DM; their DM setting applies", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel_id": { "type": "string", "format": "uuid" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or wrong token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not allowed (the bot is not in that server, or its roles do not allow it)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such thing, or the bot cannot see it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Slow down. When waiting helps, the Retry-After header says how many seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "securitySchemes": { "bot": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Bot " } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] }, "User": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "username": { "type": "string" }, "display_name": { "type": [ "string", "null" ] }, "avatar_path": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } } } }, "Server": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "icon_path": { "type": [ "string", "null" ] }, "owner_id": { "type": "string", "format": "uuid" }, "member_count": { "type": "integer" } } }, "Category": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "position": { "type": "integer" } } }, "Channel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "type": { "enum": [ "text", "voice" ] }, "kind": { "enum": [ "text", "voice" ], "description": "Same as type" }, "server_id": { "type": "string", "format": "uuid" }, "position": { "type": "integer" }, "category": { "oneOf": [ { "$ref": "#/components/schemas/Category" }, { "type": "null" } ] }, "category_id": { "type": [ "string", "null" ] }, "private": { "type": "boolean" }, "read_only": { "type": "boolean" }, "slowmode": { "type": "integer", "description": "Seconds" } } }, "EmbedField": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "value": { "type": "string", "maxLength": 1024 }, "inline": { "type": "boolean" } }, "required": [ "name", "value" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 256 }, "description": { "type": "string", "maxLength": 4096, "description": "Markdown; [masked](links) work" }, "url": { "type": "string", "format": "uri" }, "color": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 16777215 }, { "type": "string", "pattern": "^#?[0-9a-fA-F]{6}$" } ] }, "fields": { "type": "array", "maxItems": 10, "items": { "$ref": "#/components/schemas/EmbedField" } }, "author": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "url": { "type": "string" }, "icon_url": { "type": "string" } }, "required": [ "name" ] }, "footer": { "type": "object", "properties": { "text": { "type": "string", "maxLength": 2048 }, "icon_url": { "type": "string" } }, "required": [ "text" ] }, "thumbnail": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] }, "image": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] }, "timestamp": { "type": "string", "format": "date-time" } } }, "Button": { "type": "object", "properties": { "type": { "enum": [ "button" ] }, "style": { "enum": [ "primary", "secondary", "success", "danger", "link" ] }, "label": { "type": "string", "maxLength": 80 }, "emoji": { "type": "string", "description": "One emoji: \"🔥\" or a server emoji \"<:name:id>\"" }, "custom_id": { "type": "string", "maxLength": 100, "description": "Sent back to the bot on a click. Required unless style is link; unique per message" }, "url": { "type": "string", "format": "uri", "description": "Link buttons only, https" }, "disabled": { "type": "boolean" } }, "required": [ "style" ] }, "ActionRow": { "type": "object", "properties": { "type": { "enum": [ "row" ] }, "components": { "type": "array", "minItems": 1, "maxItems": 5, "items": { "$ref": "#/components/schemas/Button" } } }, "required": [ "components" ] }, "Message": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "channel_id": { "type": "string", "format": "uuid" }, "author_id": { "type": "string", "format": "uuid" }, "content": { "type": "string" }, "embeds": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/Embed" } }, "components": { "type": [ "array", "null" ], "maxItems": 5, "items": { "$ref": "#/components/schemas/ActionRow" } }, "created_at": { "type": "string", "format": "date-time" }, "edited_at": { "type": [ "string", "null" ] }, "attachment_path": { "type": [ "string", "null" ] }, "reply_to_id": { "type": [ "string", "null" ] }, "pinned_at": { "type": [ "string", "null" ] } } }, "Event": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "enum": [ "message", "member_join", "member_leave", "reaction_add", "reaction_remove", "voice_join", "voice_leave", "interaction", "test" ] }, "data": { "type": "object", "properties": { "channel_id": { "type": [ "string", "null" ] }, "server_id": { "type": [ "string", "null" ] } } }, "created_at": { "type": "string", "format": "date-time" } } }, "Command": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z0-9_-]{1,32}$" }, "description": { "type": "string", "maxLength": 100 } }, "required": [ "name" ] }, "Role": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": [ "string", "null" ] }, "position": { "type": "integer" } } }, "Ok": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true } }, "required": [ "ok" ] }, "VoiceChannel": { "type": "object", "properties": { "channel_id": { "type": "string", "format": "uuid" }, "user_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "channel_id", "user_ids" ] }, "Member": { "allOf": [ { "$ref": "#/components/schemas/User" }, { "type": "object", "properties": { "nickname": { "type": [ "string", "null" ] }, "joined_at": { "type": "string", "format": "date-time" }, "roles": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } ] }, "MemberDetail": { "allOf": [ { "$ref": "#/components/schemas/Member" }, { "type": "object", "properties": { "timeout": { "type": [ "object", "null" ], "description": "Active timeout, if any" } } } ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uuid" }, "banned_by": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" }, "user": { "oneOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] } } }, "Reaction": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user_id": { "type": "string", "format": "uuid" }, "emoji": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } }, "Image": { "type": "object", "properties": { "path": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "path", "url" ] }, "BotProfile": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "username": { "type": "string" }, "display_name": { "type": [ "string", "null" ] }, "avatar_path": { "type": [ "string", "null" ] }, "banner_path": { "type": [ "string", "null" ] }, "bio": { "type": [ "string", "null" ] } } } } } }