Unofficial API Docs for Gaius Discord Bots (1.1)

Download OpenAPI specification:

License: MIT

About

Unofficial Gaius API docs Built by Flammableassassin

If you wish to contribute feel free to here https://github.com/flamableassassin/openapi-docs/

Each group has a link to the discord messages from the original API docs. Join the discord server with this invite: https://discord.gg/C7SxkVh

apiKey

Use the createapikey scope scope command in your server to get the api key for your server.

Available scopes:

warnings
caselogs
wordlists
notes
info
modlogs
leveling

Security Scheme Type: API Key

Header parameter name: api-key

Wordlist Endpoints

Endpoints for wordlists

https://discord.com/channels/270438133584232449/914296262520627290/914296431156805633

Get a list of all wordlists

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

[{"listname": "string",
"private": true,
"locked": true
}
]

Get all words in a list

Authorizations:

apiKey

path Parameters

ListName

string

Responses

Response samples

200

Content type

application/json

[{"word": "string",
"flags": ["string"
]
}
]

Creates new list with given name optional array of words can be put in the body.

Authorizations:

apiKey

path Parameters

ListName

string

Request Body schema: application/json
optional

List of words to add to the list.

Array of objects (wordlist)

Responses

Request samples

Payload

Content type

application/json

{"words": [{"word": "string",
"flags": ["string"
]
}
]
}

Response samples

200

Content type

application/json

{"added": [{"word": "string",
"flags": ["string"
]
}
],
"invalid": ["you pass 'invalid word' instead of {word, flags} and you get 'invalid word'"
]
}

Update a created list with the words

Authorizations:

apiKey

path Parameters

ListName

string

Request Body schema: application/json
required

List of words to add to the list.

Array of objects (wordlist)

Responses

Request samples

Payload

Content type

application/json

{"words": [{"word": "string",
"flags": ["string"
]
}
]
}

Response samples

200

Content type

application/json

{"added": [{"word": "string",
"flags": ["string"
]
}
],
"invalid": ["you pass 'invalid word' instead of {word, flags} and you get 'invalid word'"
]
}

Delete words from a list

Authorizations:

apiKey

path Parameters

ListName

string

Request Body schema: application/json
optional

List of words to delete from the list

words

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"words": ["string"
]
}

Response samples

200

Content type

application/json

Example

wordlist

[ ]

Endpoint for case logs

https://discord.com/channels/270438133584232449/914296262520627290/914299007977795584

Get all caselogs

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{"property1": {"casenum": 0,
"type": "ban",
"time": 0,
"userid": "string",
"modid": "string",
"reason": "string",
"date": 0
},
"property2": {"casenum": 0,
"type": "ban",
"time": 0,
"userid": "string",
"modid": "string",
"reason": "string",
"date": 0
},
"totalCases": "string"
}

Fetch caselogs for user with their ID

Fetch all caselogs for a user ID

Authorizations:

apiKey

path Parameters

UserID

string <Snowflake>

Either a User ID

Responses

Response samples

200
418

Content type

application/json

{"property1": {"casenum": 0,
"type": "ban",
"time": 0,
"userid": "string",
"modid": "string",
"reason": "string",
"date": 0
},
"property2": {"casenum": 0,
"type": "ban",
"time": 0,
"userid": "string",
"modid": "string",
"reason": "string",
"date": 0
}
}

Get all caselogs that occurred after the given date.

Get all caselogs that occurred after the given timestamp or ISO date. Invalid dates are: before 2016, and 1 minute after the current time

Authorizations:

apiKey

path Parameters

string or string

Examples: 2022-09-27 18:00:00.000

Responses

Response samples

200

Content type

application/json

[{"property1": {"casenum": 0,
"type": "ban",
"time": 0,
"userid": "string",
"modid": "string",
"reason": "string",
"date": 0
},
"property2": {"casenum": 0,
"type": "ban",
"time": 0,
"userid": "string",
"modid": "string",
"reason": "string",
"date": 0
}
}
]

Get all caselogs that occurred before the given date.

Get all caselogs that occurred before the given timestamp or ISO date. Invalid dates are: before 2016, and 1 minute after the current time

Authorizations:

apiKey

path Parameters

string or string

Examples: 2022-09-27 18:00:00.000

Responses

Response samples

200

Content type

application/json

[{"property1": {"casenum": 0,
"type": "ban",
"time": 0,
"userid": "string",
"modid": "string",
"reason": "string",
"date": 0
},
"property2": {"casenum": 0,
"type": "ban",
"time": 0,
"userid": "string",
"modid": "string",
"reason": "string",
"date": 0
}
}
]

Warnings Endpoints

Endpoints for fetching warnings

https://discord.com/channels/270438133584232449/914296262520627290/951126712152903771

Get all warnings for the given server.

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

[{"guildid": "string",
"warnid": 0,
"userid": "string",
"reason": "string",
"warndate": 0,
"pardonerid": "string",
"pardondate": 0,
"modid": "string"
}
]

Fetch warning with ID

Fetch all warnings for a user ID or the warning with the corresponding ID

Authorizations:

apiKey

path Parameters

string or integer

Either a User ID or note ID

Responses

Response samples

200

Content type

application/json

[{"guildid": "string",
"warnid": 0,
"userid": "string",
"reason": "string",
"warndate": 0,
"pardonerid": "string",
"pardondate": 0,
"modid": "string"
}
]

Get all warnings that occurred after date.

Get all warnings that occurred after the given timestamp or ISO date. Invalid dates are: before 2016, and 1 minute after the current time

Authorizations:

apiKey

path Parameters

string or string

Examples: 2022-09-27 18:00:00.000

Responses

Response samples

200

Content type

application/json

[[{"guildid": "string",
"warnid": 0,
"userid": "string",
"reason": "string",
"warndate": 0,
"pardonerid": "string",
"pardondate": 0,
"modid": "string"
}
]
]

Get all warnings that occurred before date.

Get all warnings that occurred before the given timestamp or ISO date. Invalid dates are: before 2016, and 1 minute after the current time

Authorizations:

apiKey

path Parameters

string or string

Examples: 2022-09-27 18:00:00.000

Responses

Response samples

200

Content type

application/json

[[{"guildid": "string",
"warnid": 0,
"userid": "string",
"reason": "string",
"warndate": 0,
"pardonerid": "string",
"pardondate": 0,
"modid": "string"
}
]
]

Modlogs

Endpoints for modlogs

https://canary.discord.com/channels/270438133584232449/914296262520627290/1229913800094777384

Fetch all modlogs

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{"property1": {"bans": 0,
"kicks": 0,
"softbans": 0,
"mutes": 0,
"warns": 0,
"vcmutes": 0,
"vcbans": 0,
"unmutes": 0,
"purgewarns": 0,
"pardons": 0,
"unbans": 0
},
"property2": {"bans": 0,
"kicks": 0,
"softbans": 0,
"mutes": 0,
"warns": 0,
"vcmutes": 0,
"vcbans": 0,
"unmutes": 0,
"purgewarns": 0,
"pardons": 0,
"unbans": 0
}
}

Fetch modlogs for user with their ID

Fetch all modlogs for a user ID

Authorizations:

apiKey

path Parameters

UserID

string <Snowflake>

Either a User ID

Responses

Response samples

200
418

Content type

application/json

{"property1": {"bans": 0,
"kicks": 0,
"softbans": 0,
"mutes": 0,
"warns": 0,
"vcmutes": 0,
"vcbans": 0,
"unmutes": 0,
"purgewarns": 0,
"pardons": 0,
"unbans": 0
},
"property2": {"bans": 0,
"kicks": 0,
"softbans": 0,
"mutes": 0,
"warns": 0,
"vcmutes": 0,
"vcbans": 0,
"unmutes": 0,
"purgewarns": 0,
"pardons": 0,
"unbans": 0
}
}

Note Endpoints

Endpoints for fetching user notes

https://discord.com/channels/270438133584232449/914296262520627290/994386530179239937

Get all notes for a given server.

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

[{"guildid": "string",
"id": 0,
"userid": "string",
"msg": "string",
"modid": "string",
"time": 0
}
]

Fetch note with ID

Fetch all notes for a user ID or the note with the corresponding ID

Authorizations:

apiKey

path Parameters

string or integer

Either a User ID or warning ID

Responses

Response samples

200

Content type

application/json

[{"guildid": "string",
"id": 0,
"userid": "string",
"msg": "string",
"modid": "string",
"time": 0
}
]

Leveling System Endpoints

Endpoints for the Leveling system

https://discord.com/channels/270438133584232449/914296262520627290/1370477784933072927

Get a users xp

Authorizations:

apiKey

path Parameters

userid

string <Snowflake>

Responses

Response samples

200
418

Content type

application/json

{"text": 0,
"voice": 0
}

Update a users xp

Authorizations:

apiKey

path Parameters

userid

string <Snowflake>

Request Body schema: application/json
required

The XP amount of a user to update. Set either property to 0 to not modify it

	string or number The amount to add to a users text level
	string or number The amount to add to a users voice level

Responses

Request samples

Payload

Content type

application/json

{"textamount": "string",
"voiceamount": "string"
}

Response samples

200
418

Content type

application/json

{"text": 0,
"voice": 0
}

Other Endpoints

Other endpoints

https://discord.com/channels/270438133584232449/914296262520627290/994393407755653210

Get user information

Authorizations:

apiKey

path Parameters

User	string <Snowflake>

header Parameters

string or null

Which bot to use if not supplied the server will try to guess.

Responses

Response samples

200
418

Content type

application/json

{"member": {"avatar": "string",
"avatar_decoration_data": { },
"communication_disabled_until": "2019-08-24T14:15:22Z",
"flags": 0,
"joined_at": "2019-08-24T14:15:22Z",
"nick": "string",
"pending": true,
"premium_since": "2019-08-24T14:15:22Z",
"roles": ["string"
],
"user": {"id": "string",
"username": "string",
"avatar": "string",
"discriminator": "string",
"public_flags": 0,
"flags": -9007199254740991,
"bot": true,
"system": true,
"banner": "string",
"accent_color": 0,
"global_name": "string"
},
"mute": true,
"deaf": true
},
"infractions": {"noteCount": 0,
"warnCount": 0,
"caseCount": 0
}
}

Unofficial API Docs for Gaius Discord Bots (1.1)

About

apiKey

Wordlist Endpoints

Get a list of all wordlists

Authorizations:

Responses

Response samples

Get all words in a list

Authorizations:

path Parameters

Responses

Response samples

Creates new list with given name optional array of words can be put in the body.

Authorizations:

path Parameters

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Update a created list with the words

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete words from a list

Authorizations:

path Parameters

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Image Endpoints

Get a random picture of a snake

Authorizations:

Responses

Get a random picture of a bunny

Authorizations:

Responses

Get a random picture of Guts from 'Berserk'

Authorizations:

Responses

Get a random picture of Holo from 'Spice and Wolf'

Authorizations:

Responses

Get a random picture of Frieza from 'Dragon Ball'

Authorizations:

Responses

Get a random picture of a Sea slug

Authorizations:

Responses

Cage logs Endpoints

Get all caselogs

Authorizations:

Responses

Response samples

Fetch caselogs for user with their ID

Authorizations:

path Parameters

Responses

Response samples

Get all caselogs that occurred after the given date.

Authorizations:

path Parameters

Responses

Response samples

Get all caselogs that occurred before the given date.

Authorizations:

path Parameters

Responses

Response samples

Warnings Endpoints

Get all warnings for the given server.

Authorizations:

Responses

Response samples

Fetch warning with ID

Authorizations:

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
required