{ "openapi": "3.0.1", "info": { "title": "Discord Server Toolkit Bot", "description": "Runs a fully configurable Discord bot on your own server: welcome/leave messages, auto-moderation, an XP leveling leaderboard, custom text commands, and reaction roles.", "version": "1.0", "x-build-id": "myj9dgo2dWSAwpgol" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hebaabdalaziz~discord-server-toolkit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hebaabdalaziz-discord-server-toolkit", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/hebaabdalaziz~discord-server-toolkit/runs": { "post": { "operationId": "runs-sync-hebaabdalaziz-discord-server-toolkit", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/hebaabdalaziz~discord-server-toolkit/run-sync": { "post": { "operationId": "run-sync-hebaabdalaziz-discord-server-toolkit", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "botToken" ], "properties": { "botToken": { "title": "Discord Bot Token", "type": "string", "description": "Your bot's token from the Discord Developer Portal (Applications > your app > Bot > Reset Token). This is a bot token, not your personal Discord password. Kept secret." }, "enableWelcome": { "title": "Enable welcome/leave messages", "type": "boolean", "description": "Post a message when a member joins or leaves the server.", "default": true }, "welcomeChannelName": { "title": "Welcome channel name", "type": "string", "description": "Channel name (without #) to post welcome/leave messages in, e.g. \"welcome\".", "default": "welcome" }, "welcomeMessage": { "title": "Welcome message", "type": "string", "description": "Use {user} for a mention and {server} for the server name.", "default": "Welcome to {server}, {user}! 🎉 Glad to have you here." }, "leaveMessage": { "title": "Leave message", "type": "string", "description": "Use {user} for the member's name.", "default": "{user} has left the server." }, "enableModeration": { "title": "Enable auto-moderation", "type": "boolean", "description": "Automatically delete messages containing banned words and warn/kick/ban repeat offenders.", "default": true }, "bannedWords": { "title": "Banned words/phrases", "type": "array", "description": "Messages containing any of these (case-insensitive, whole word) are deleted automatically.", "default": [], "items": { "type": "string" } }, "moderationAction": { "title": "Action after repeated violations", "enum": [ "warn_only", "kick", "ban" ], "type": "string", "description": "What happens once a member hits the warning limit below.", "default": "warn_only" }, "maxWarningsBeforeAction": { "title": "Warnings before action", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many banned-word violations before the action above triggers.", "default": 3 }, "enableLeveling": { "title": "Enable XP leveling & leaderboard", "type": "boolean", "description": "Members earn XP for chatting and can level up, check !rank and !leaderboard.", "default": true }, "xpPerMessage": { "title": "XP per message", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How much XP a member earns per message (subject to a 10s cooldown per member).", "default": 10 }, "levelUpMessage": { "title": "Level-up message", "type": "string", "description": "Use {user} for a mention and {level} for the new level.", "default": "🎉 {user} just reached level {level}!" }, "enableCustomCommands": { "title": "Enable custom text commands", "type": "boolean", "description": "Let the bot reply to your own custom !command triggers below.", "default": true }, "commandPrefix": { "title": "Command prefix", "type": "string", "description": "The character(s) that start a command, e.g. \"!\" for !rules.", "default": "!" }, "customCommands": { "title": "Custom commands", "type": "array", "description": "List of {\"trigger\": \"rules\", \"response\": \"Read #rules please!\"} objects. The bot replies with \"response\" when someone types prefix+trigger, e.g. !rules.", "default": [ { "trigger": "rules", "response": "Please check #rules for our server guidelines!" } ] }, "enableReactionRoles": { "title": "Enable reaction roles", "type": "boolean", "description": "Let members react to a message to self-assign a role (and remove it by un-reacting).", "default": false }, "reactionRoleSetups": { "title": "Reaction role setups", "type": "array", "description": "List of {\"channelName\": \"roles\", \"introText\": \"React to get a role!\", \"roles\": [{\"emoji\": \"🎮\", \"roleName\": \"Gamer\"}]} objects. The bot posts one message per entry and assigns/removes the role when members react/unreact.", "default": [] } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }