API docs by Redocly

Byte Bot (0.2.0)

Download OpenAPI specification:Download

Admin: hello@byte-bot.app

The Byte Bot API supports the Byte Discord bot. You can find out more about this project in the docs.

Byte Bot API Docs

Guilds

Create a new guild.

Create a guild.

Args: guilds_service (GuildsService): Guilds service guild_id (int): Guild ID guild_name (str): Guild name

Returns: Guild: Created guild object

query Parameters
guild_id
required
integer (Guild ID)

The guild ID.

guild_name
required
string (Guild Name)

The guild name.

Responses

Response samples

Content type
application/json
{
  • "status_code": 400,
  • "detail": "Bad Request",
  • "extra": { }
}

List Guilds

List guilds.

Args: guilds_service (GuildsService): Guilds service filters (list[FilterTypes]): Filters

Returns: list[Guild]: List of guilds

query Parameters
null or string
null or string
null or string
null or string
null or Array of strings
currentPage
integer >= 1
Default: 1
pageSize
integer >= 1
Default: 20
Field to search (null) or Field to search (string) (Field to search)
Field to search (null) or Field to search (string) (Field to search)
Search should be case sensitive (null) or Search should be case sensitive (boolean) (Search should be case sensitive)
Order by field (null) or Order by field (string) (Order by field)
sortOrder
null or string (Field to search)
Default: "desc"
Enum: "asc" "desc" null

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "limit": 0,
  • "offset": 0,
  • "total": 0
}