API OVERVIEW

Slackzilla's API allows you to interact with the bot programmatically. You can retrieve information, send commands, and manage users through the available endpoints.

To access the API, which will normally need a bearer/authentication-token, but for testing purposes, i wont require it once the pai has been implemented, the API will be rate limited to 20 reqs per ip per minute.

NOTE: THERE IS NO AUTHENTICATION AND THIS IS THE PLAN

The Slackzilla API Bearer Token will use Slack OAuth 2.0 in order to verify your identity and will recieve the token, (this is to stop these hackers from spamming the api and to keep it secure) the token generated will will expire after 2 weeks (you have to referesh the token via api or manually) Each API credential will consist of a Key ID and a Secret API Key. The Key ID identifies the credential, while the Secret API Key is used to authenticate requests. Secret keys are generated using a cryptographically secure random number generator and only a SHA-256 hash of the key is stored on the server. If a secret key is lost, it cannot be recovered and must be regenerated.

API STATUS

Error Codes

ENDPOINTS

once the api has been implemented,

All endpoints are experimental and WILL not work as of rn but you might just stumble across them when i have just implemented it. The proposed endpoints are as follows: any ideas or suggestions for api are welcome.

Base URL: https://rylvion.hackclub.app/api

                            
curl \
https://rylvion.hackclub.app/api/commands

curl \
"https://rylvion.hackclub.app/api/commands?categories=core,utility"

curl \
"https://rylvion.hackclub.app/api/commands?search=ping"

{
    "success": true,
    "version": "v0.7.1-beta",
    "generatedAt": "2026-07-29T13:10:42.123Z",
    "count": 22,
    "commands": [
        {
            "name": "ping",
            "cmd": "/sz-ping",
            "description": "idk js pongs ig",
            "category": "core",
            "usage_hint": ""
        },
        {
            "name": "hash",
            "cmd": "/sz-hash",
            "description": "generates a hash of a string, default: sha256",
            "category": "utility",
            "usage_hint": "<algorithm> <text>"
        },
    ]
}

{
    "success": true,
    "count": 1,
    "commands": [
        {
            "name": "ping",
            "cmd": "/sz-ping",
            "description": "idk js pongs ig",
            "category": "core"
        }
    ]
}

                                
{
    "success": true,
    "command": {
        "name": "ping",
        "cmd": "/sz-ping",
        "description": "idk js pongs ig",
        "category": "core",
        "usage_hint": ""
    }
}

{
    "success": false,
    "error": {
        "code": 404,
        "code_name": "COMMAND_NOT_FOUND",
        "message": "Command 'foo' does not exist."
    }
}