### Install MkDocs Dependencies

Source: https://docs.purrbot.site/contribute/translate/translate-docs

Use this command to install and upgrade MkDocs and its dependencies from the requirements file.

```bash
pip install -U -r requirements.txt
```

--------------------------------

### GET Request Parameters for OWOify

Source: https://docs.purrbot.site/de_CH/api

These query parameters can be used with a GET request to OWOify text. The 'text' parameter is mandatory.

```http
GET /owoify?text=Hello%20World!&stutter=true&emoticons=true HTTP/1.1
Host: api.purrbot.site
Accept: application/json
```

--------------------------------

### GET /img/nsfw/threesome_ffm/gif

Source: https://docs.purrbot.site/api

Get a random threesome (2 Females, 1 Male) gif. Returns a randomly selected threesome (2 Females, 1 Male) gif.

```APIDOC
## GET /img/nsfw/threesome_ffm/gif

### Description
Get a random threesome (2 Females, 1 Male) gif. Returns a randomly selected threesome (2 Females, 1 Male) gif.

### Method
GET

### Endpoint
/img/nsfw/threesome_ffm/gif

### Responses
#### Success Response (200)
- **link** (string) - URL of the randomly selected image file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "link": "https://cdn.purrbot.site/nsfw/threesome_fff/gif/threesome_001.gif",
    "error": false,
    "time": 0
}
```

#### Error Response (403)
- **details** (object) - Details about the error.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/nsfw/threesome_fff/invalid",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path is not valid.",
    "time": 0
}
```

#### Error Response (404)
- **details** (object) - Details about the error.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/nsfw/threesome_fff",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path does not contain any images.",
    "time": 0
}
```
```

--------------------------------

### Pymdown MagicLink URL Formatting

Source: https://docs.purrbot.site/contribute/formatting-help

Example of a simple URL that will be automatically made clickable by the `MagicLink` extension.

```markdown
https://purrbot.site
```

--------------------------------

### GET Request Parameters for OWOify

Source: https://docs.purrbot.site/api

Use these query parameters with a GET request to the OWOify endpoint. The 'text' parameter is mandatory. Other boolean parameters like 'emoticons', 'replace-words', and 'stutter' can be added to customize the OWOification.

```http
GET /owoify?text=Hello%20World!&emoticons=true&replace-words=true&stutter=true HTTP/1.1
```

--------------------------------

### GET /img/nsfw/solo_male/gif

Source: https://docs.purrbot.site/api

Retrieves a random solo masturbation GIF of a man.

```APIDOC
## GET /img/nsfw/solo_male/gif

### Description
Get a random solo masturbation gif of a man. Returns a randomly selected solo masturbation gif of a man.

### Method
GET

### Endpoint
/img/nsfw/solo_male/gif

### Responses
#### Success Response (200)
- **link** (string) - URL of the randomly selected image file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "link": "https://cdn.purrbot.site/nsfw/solo/gif/solo_001.gif",
    "error": false,
    "time": 0
}
```

#### Error Response (403)
- **details** (object) - Details about the error.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/nsfw/solo/invalid",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path is not valid.",
    "time": 0
}
```

#### Error Response (404)
- **details** (object) - Details about the error.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/nsfw/solo",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path does not contain any images.",
    "time": 0
}
```
```

--------------------------------

### GET /img/nsfw/threesome_mmf/gif

Source: https://docs.purrbot.site/de_CH/api

Get a random threesome (2 Males, 1 Female) gif. Returns a randomly selected threesome (2 Males, 1 Female) gif.

```APIDOC
## GET /img/nsfw/threesome_mmf/gif

### Description
Get a random threesome (2 Males, 1 Female) gif. Returns a randomly selected threesome (2 Males, 1 Female) gif.

### Method
GET

### Endpoint
/img/nsfw/threesome_mmf/gif

### Responses
#### Success Response (200)
- **link** (string) - URL of the randomly selected image file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Error Response (403)
- **details** (object) - Contains details about the invalid path provided.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Error Response (404)
- **details** (object) - Contains details about the provided path.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

### Response Example (200)
{
  "link": "https://cdn.purrbot.site/nsfw/threesome_ffm/gif/threesome_001.gif",
  "error": false,
  "time": 0
}
```

--------------------------------

### GET /img/sfw/icon/img

Source: https://docs.purrbot.site/api

Retrieves a random icon image used in the bot's welcome feature.

```APIDOC
## GET /img/sfw/icon/img

### Description
Get a random icon image. Returns a randomly selected icon image used in the bots welcome feature.

### Method
GET

### Endpoint
/img/sfw/icon/img

### Responses
#### Success Response (200)
- **link** (string) - URL of the randomly selected image file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "link": "https://cdn.purrbot.site/sfw/hug/gif/hug_001.gif",
    "error": false,
    "time": 0
}
```

#### Error Response (403)
- **details** (object) - Details about the error.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/sfw/hug/invalid",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path is not valid.",
    "time": 0
}
```

#### Error Response (404)
- **details** (object) - Details about the error.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/sfw/hug",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path does not contain any images.",
    "time": 0
}
```
```

--------------------------------

### GET /img/sfw/icon/img

Source: https://docs.purrbot.site/de_CH/api

Retrieves a random icon image used in the bot's welcome feature.

```APIDOC
## GET /img/sfw/icon/img

### Description
Get a random icon image. Returns a randomly selected icon image used in the bots welcome feature.

### Method
GET

### Endpoint
/img/sfw/icon/img

### Response
#### Success Response (200)
- **link** (string) - URL of the randomly selected image file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "link": "https://cdn.purrbot.site/sfw/hug/gif/hug_001.gif",
    "error": false,
    "time": 0
}
```

#### Error Response (403)
- **details** (object) - Contains details about the invalid path provided.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/sfw/hug/invalid",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path is not valid.",
    "time": 0
}
```

#### Error Response (404)
- **details** (object) - Contains details about the invalid path provided.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/sfw/hug",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path does not contain any images.",
    "time": 0
}
```
```

--------------------------------

### GET /img/sfw/background/img

Source: https://docs.purrbot.site/de_CH/api

Retrieves a random background image. This endpoint is used for the bots welcome feature.

```APIDOC
## GET /img/sfw/background/img

### Description
Get a random background image. Returns a randomly selected background image used in the bots welcome feature.

### Method
GET

### Endpoint
/img/sfw/background/img

### Response
#### Success Response (200)
- **link** (string) - URL of the randomly selected image file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "link": "https://cdn.purrbot.site/sfw/angry/gif/angry_001.gif",
    "error": false,
    "time": 0
}
```

#### Error Response (403)
- **details** (object) - Contains details about the invalid path provided.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message indicating an invalid path.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/sfw/angry/invalid",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path is not valid.",
    "time": 0
}
```

#### Error Response (404)
- **details** (object) - Contains details about the request.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message indicating that the path does not contain any images.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/sfw/angry",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path does not contain any images.",
    "time": 0
}
```
```

--------------------------------

### Get List of SFW Images

Source: https://docs.purrbot.site/de_CH/api

Retrieves a list of all available SFW (Safe For Work) image URLs for a specified path.

```APIDOC
## GET /list/sfw/{path}

### Description
Get all available images of the path.
Returns a list of all available images (as URLs) from the provided `{path}`.

### Method
GET

### Endpoint
/list/sfw/{path}

### Parameters
#### Path Parameters
- **path** (string) - Required - The path to list all available images in. Allowed are all available `/api/img/sfw/` paths.
```

--------------------------------

### OWOify Text (GET)

Source: https://docs.purrbot.site/api

OWOifies text using query parameters for configuration. Supports options for word replacement, stuttering, and emoticons.

```APIDOC
## GET /owoify

### Description
OWOifies text, meaning it replaces characters and words with others, depending on the provided configuration. Multiple configurations can be set via additional query parameters.

### Method
GET

### Endpoint
/owoify

### Parameters
#### Query Parameters
- **text** (string) - Required - The text to OwOify.
- **replace-words** (boolean) - Optional - Whether to replace specific key-words with others.
- **stutter** (boolean) - Optional - Whether stuttering should be added.
- **emoticons** (boolean) - Optional - Whether to replace punctuation characters (`.!?`) with random emoticons.
```

--------------------------------

### Get Random Solo Masturbation GIF

Source: https://docs.purrbot.site/de_CH/api

This endpoint returns a randomly selected solo masturbation GIF. It is part of the NSFW image endpoints.

```http
GET /img/nsfw/solo/gif
```

--------------------------------

### Build Shaded Jar with Gradle

Source: https://docs.purrbot.site/bot/selfhosting

Execute this command to build a shaded JAR file that includes all necessary dependencies for the bot.

```bash
gradlew clean shadowJar
```

--------------------------------

### Set Welcome Background

Source: https://docs.purrbot.site/bot/welcome-channel

Choose a background image for the welcome message. Replace `<background>` with one of the available options.

```discord commands
p.welcome bg set <background>
```

--------------------------------

### Test Welcome Message

Source: https://docs.purrbot.site/bot/welcome-channel

Preview the current welcome message and image configuration without a new member joining.

```discord commands
p.welcome test
```

--------------------------------

### Set Welcome Message

Source: https://docs.purrbot.site/bot/welcome-channel

Define a custom welcome message. Use placeholders like `{count}`, `{guild}`, or `{mention}` for dynamic content. Replace `<message>` with your desired text.

```discord commands
p.welcome msg set <message>
```

--------------------------------

### Emoji and Icon Usage

Source: https://docs.purrbot.site/contribute/formatting-help

Demonstrates the syntax for using standard emojis and various icon sets via the Emojis and MkDocs-Material extensions. Note that custom icons require a site prefix and Octicons may need size suffixes.

```markdown
Normal Emojis:

- :smile:
- :heart:

FontAwesome Icons (Brands):  

- :fontawesome-brands-github:
- :fontawesome-brands-discord:

FontAwesome Icons (Regular):

- :fontawesome-regular-bell:
- :fontawesome-regular-bell-slash:

FontAwesome Icons (Solid):

- :fontawesome-solid-bell:
- :fontawesome-solid-bell-slash:

Material Design:

- :material-sync:
- :material-alert:

Octicons:

- :octicons-repo-24:
- :octicons-git-pull-request-24:

Simple-Icons:

- :simple-mastodon:
- :simple-simpleicons:

```

--------------------------------

### GET /img/sfw/shiro/img

Source: https://docs.purrbot.site/api

Retrieves a random image from the shiro category.

```APIDOC
## GET /img/sfw/shiro/img

### Description
Get a random shiro image. Returns a randomly selected shiro image.

### Method
GET

### Endpoint
/img/sfw/shiro/img

### Responses
#### Success Response (200)
- **link** (string) - URL of the randomly selected image file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
{
  "link": "https://cdn.purrbot.site/sfw/senko/img/senko_001.jpg",
  "error": false,
  "time": 0
}

#### Error Response (403)
- **details** (object) - Contains details about the invalid path provided.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
{
  "details": {
    "path": "/api/img/sfw/senko/invalid",
    "content-type": "application/json",
    "user-agent": "Some_User-Agent/1.0"
  },
  "error": true,
  "message": "The provided path is not valid.",
  "time": 0
}

#### Error Response (404)
- **details** (object) - Contains details about the path that doesn't contain images.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
{
  "details": {
    "path": "/api/img/sfw/senko",
    "content-type": "application/json",
    "user-agent": "Some_User-Agent/1.0"
  },
  "error": true,
  "message": "The provided path does not contain any images.",
  "time": 0
}
```

--------------------------------

### Set Welcome Channel

Source: https://docs.purrbot.site/bot/welcome-channel

Specify the Discord channel where welcome messages will be sent. Use `#channel` to denote the target channel.

```discord commands
p.welcome channel set #channel
```

--------------------------------

### GET /img/nsfw/pussylick/gif

Source: https://docs.purrbot.site/api

Retrieves a random pussylick GIF from the Purrbot API.

```APIDOC
## GET /img/nsfw/pussylick/gif

### Description
Get a random pussylick gif. Returns a randomly selected pussylick gif.

### Method
GET

### Endpoint
/img/nsfw/pussylick/gif

### Responses
#### Success Response (200)
- **link** (string) - URL of the randomly selected image file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Error Response (403)
- **details** (object) - Contains details about the invalid path provided.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Error Response (404)
- **details** (object) - Contains details about the path that doesn't contain images.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

### Response Example (200)
```json
{
    "link": "https://cdn.purrbot.site/nsfw/neko/gif/neko_001.gif",
    "error": false,
    "time": 0
}
```
```

--------------------------------

### Set Welcome Icon

Source: https://docs.purrbot.site/bot/welcome-channel

Set a custom icon that appears on the right side of the welcome image. Replace `<icon>` with the desired icon.

```discord commands
p.welcome icon set <icon>
```

--------------------------------

### GET /img/nsfw/blowjob/gif

Source: https://docs.purrbot.site/api

Retrieves a random blowjob GIF from the Purrbot API.

```APIDOC
## GET /img/nsfw/blowjob/gif

### Description
Get a random blowjob gif. Returns a randomly selected blowjob gif.

### Method
GET

### Endpoint
/img/nsfw/blowjob/gif

### Response
#### Success Response (200)
- **link** (string) - URL of the randomly selected image file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "link": "https://cdn.purrbot.site/nsfw/blowjob/gif/blowjob_001.gif",
    "error": false,
    "time": 0
}
```

#### Error Response (403)
- **details** (object) - Contains details about the invalid path provided.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/nsfw/blowjob/invalid",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path is not valid.",
    "time": 0
}
```

#### Error Response (404)
- **details** (object) - Contains details about the path that doesn't contain images.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/nsfw/blowjob",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path does not contain any images.",
    "time": 0
}
```
```

--------------------------------

### Get Random Senko Image

Source: https://docs.purrbot.site/api

Retrieves a random image from the Senko category.

```APIDOC
## GET /img/sfw/senko/img

### Description
Get a random senko image. Returns a randomly selected senko image.

### Method
GET

### Endpoint
/img/sfw/senko/img

### Responses
#### Success Response (200)
- **link** (string) - URL of the randomly selected image file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "link": "https://cdn.purrbot.site/sfw/pout/gif/pout_001.gif",
    "error": false,
    "time": 0
}
```

#### Error Response (403)
- **details** (object) - Contains details about the invalid path provided.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message: "The provided path is not valid."
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Error Response (404)
- **details** (object) - Contains details about the invalid path provided.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message: "The provided path does not contain any images."
- **time** (integer) - How long the request took to be processed (in milliseconds).
```

--------------------------------

### Set Welcome Text Color

Source: https://docs.purrbot.site/bot/welcome-channel

Customize the text color for the welcome message. Supports hex, RGB, or 'random' values. Replace `<color>` with your chosen format.

```discord commands
.welcome color set <color>
```

--------------------------------

### Pymdown Collapsable Box Syntax

Source: https://docs.purrbot.site/contribute/formatting-help

Demonstrates creating collapsable boxes using the `blocks.details` extension. Boxes can be set to open by default using `open: true`.

```markdown
/// details | Title
    type: info

This box is closed by default
///

----

/// details | Title
    type: info
    open: true

Adding `open: true` opens it by default
///
```

--------------------------------

### Get Random Kiss GIF

Source: https://docs.purrbot.site/de_CH/api

Retrieves a random kiss GIF from the API.

```APIDOC
## GET /img/sfw/kiss/gif

### Description
Get a random kiss gif. Returns a randomly selected kiss gif.

### Method
GET

### Endpoint
/img/sfw/kiss/gif

### Response
#### Success Response (200)
- **link** (string) - URL of the randomly selected image file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "link": "https://cdn.purrbot.site/sfw/icon/img/icon_001.jpg",
    "error": false,
    "time": 0
}
```

#### Error Response (403)
- **details** (object) - Details about the error, including path, content-type, and user-agent.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message, e.g., "The provided path is not valid.".
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Error Response (404)
- **details** (object) - Details about the error, including path, content-type, and user-agent.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message, e.g., "The provided path does not contain any images.".
- **time** (integer) - How long the request took to be processed (in milliseconds).
```

--------------------------------

### Reset Welcome Background

Source: https://docs.purrbot.site/bot/welcome-channel

Reverts the welcome background to its default setting.

```discord commands
p.welcome bg reset
```

--------------------------------

### Get a random fluff gif

Source: https://docs.purrbot.site/api

Returns a randomly selected fluff gif.

```APIDOC
## GET /img/sfw/fluff/gif

### Description
Get a random fluff gif
Returns a randomly selected fluff gif.

### Method
GET

### Endpoint
/img/sfw/fluff/gif

### Responses
#### Success Response (200)
- **link** (string) - URL of the randomly selected image file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "link": "https://cdn.purrbot.site/sfw/eevee/gif/eevee_001.gif",
    "error": false,
    "time": 0
}
```

#### Error Response (403)
- **details** (object) - Details about the error.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/sfw/eevee/invalid",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path is not valid.",
    "time": 0
}
```

#### Error Response (404)
- **details** (object) - Details about the error.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/sfw/eevee",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path does not contain any images.",
    "time": 0
}
```
```

--------------------------------

### Get Random Yaoi GIF

Source: https://docs.purrbot.site/de_CH/api

Retrieves a random yaoi (gay) GIF from the API.

```http
GET /img/nsfw/yaoi/gif
```

--------------------------------

### Pymdown Tab Syntax

Source: https://docs.purrbot.site/contribute/formatting-help

Shows how to create tabs using the `blocks.tab` extension. New sets of tabs can be created with `new: true`.

```markdown
/// tab | Tab 1
You can add more tabs...
///

/// tab | Tab 2
...by just adding additional `/// tab | title ... ///` content.
///

/// tab | Tab A
    new: true

Adding `new: true`...
///

/// tab | Tab B
...creates a new set of tabs.
///
```

--------------------------------

### Default config.json Structure

Source: https://docs.purrbot.site/bot/selfhosting

This is the default structure of the `config.json` file. You only need to set specific options if you followed the preparation steps.

```json
{
  "bot-token": "TOKEN",

  "beta": false,
  "debug": false,

  "webhooks": {
    "guild": "guild-webhook-url",
    "log": "log-webhook-url"
  },

  "tokens": {
    "fluxpoint-dev": "fluxpoint-dev-token",

    "discord-bots-gg": "dbgg-token",
    "botlist-space": "botlist-token",
    "discordextremelist-xyz": "debl-token",
    "discordservices-net": "discordservices-net-token"
  },

  "database": {
    "ip": "127.0.0.1",
    "name": "DatabaseName",
    "guildTable": "GuildTable"
  }
}
```

--------------------------------

### Get Random Yuri GIF

Source: https://docs.purrbot.site/api

Retrieves a random yuri (lesbian) GIF from the API.

```APIDOC
## GET /img/nsfw/yuri/gif

### Description
Get a random yuri (lesbian) gif. Returns a randomly selected yuri (lesbian) gif.

### Method
GET

### Endpoint
/img/nsfw/yuri/gif

### Responses
#### Success Response (200)
- **link** (string) - URL of the randomly selected image file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "link": "https://cdn.purrbot.site/nsfw/yaoi/gif/yaoi_001.gif",
    "error": false,
    "time": 0
}
```

#### Error Response (403)
- **details** (object) - Contains details about the invalid path provided.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message indicating the provided path is not valid.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/nsfw/yaoi/invalid",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path is not valid.",
    "time": 0
}
```

#### Error Response (404)
- **details** (object) - Contains details about the request path.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message indicating the provided path does not contain any images.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/nsfw/yaoi",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path does not contain any images.",
    "time": 0
}
```
```

--------------------------------

### Reset Welcome Text Color

Source: https://docs.purrbot.site/bot/welcome-channel

Reverts the welcome text color to its default setting.

```discord commands
p.welcome color reset
```

--------------------------------

### GET /img/nsfw/cum/gif

Source: https://docs.purrbot.site/api

Retrieves a random GIF from the 'cum' category within the NSFW section.

```APIDOC
## GET /img/nsfw/cum/gif

### Description
Get a random cum gif. Returns a randomly selected cum gif.

### Method
GET

### Endpoint
/img/nsfw/cum/gif

### Responses
#### Success Response (200)
- **link** (string) - URL of the randomly selected image file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "link": "https://cdn.purrbot.site/nsfw/blowjob/gif/blowjob_001.gif",
    "error": false,
    "time": 0
}
```

#### Error Response (403)
- **details** (object) - Contains details about the invalid path provided.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/nsfw/blowjob/invalid",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path is not valid.",
    "time": 0
}
```

#### Error Response (404)
- **details** (object) - Contains details about the request.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/nsfw/blowjob",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path does not contain any images.",
    "time": 0
}
```
```

--------------------------------

### GET /img/sfw/slap/gif

Source: https://docs.purrbot.site/api

Retrieves a random slap GIF from the SFW (Safe For Work) category.

```APIDOC
## GET /img/sfw/slap/gif

### Description
Get a random slap gif. Returns a randomly selected slap gif.

### Method
GET

### Endpoint
/img/sfw/slap/gif

### Responses
#### Success Response (200)
- **link** (string) - URL of the randomly selected GIF file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Error Response (403)
- **details** (object) - Contains details about the invalid path provided.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message: "The provided path is not valid."
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Error Response (404)
- **details** (object) - Contains details about the path that doesn't contain images.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message: "The provided path does not contain any images."
- **time** (integer) - How long the request took to be processed (in milliseconds).
```

--------------------------------

### Get Random Pat GIF

Source: https://docs.purrbot.site/api

Retrieves a randomly selected pat GIF from the API.

```APIDOC
## GET /img/sfw/pat/gif

### Description
Get a random pat gif. Returns a randomly selected pat gif.

### Method
GET

### Endpoint
/img/sfw/pat/gif

### Responses
#### Success Response (200)
- **link** (string) - URL of the randomly selected GIF file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "link": "https://cdn.purrbot.site/sfw/pat/gif/pat_001.gif",
    "error": false,
    "time": 0
}
```

#### Error Response (403)
- **details** (object) - Contains details about the invalid path provided.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/sfw/pat/invalid",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path is not valid.",
    "time": 0
}
```

#### Error Response (404)
- **details** (object) - Contains details about the path that doesn't contain images.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/sfw/pat",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path does not contain any images.",
    "time": 0
}
```
```

--------------------------------

### Get Random Laying GIF

Source: https://docs.purrbot.site/api

Retrieves a random GIF of someone laying down or resting.

```APIDOC
## GET /img/sfw/lay/gif

### Description
Get a random gif of someone laying down
Returns a randomly selected gif of someone laying down/resting.

### Method
GET

### Endpoint
/img/sfw/lay/gif

### Responses
#### Success Response (200)
- **link** (string) - URL of the randomly selected GIF file.
- **error** (boolean) - Whether the response is an error response. Always `false` for this response type.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "link": "https://cdn.purrbot.site/sfw/lay/gif/lay_001.gif",
    "error": false,
    "time": 0
}
```

#### Error Response (403)
- **details** (object) - Contains details about the invalid path provided.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/sfw/lay/invalid",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path is not valid.",
    "time": 0
}
```

#### Error Response (404)
- **details** (object) - Contains details about the path not containing images.
- **error** (boolean) - Whether the response is an error response. Always `true` for this response type.
- **message** (string) - The error message.
- **time** (integer) - How long the request took to be processed (in milliseconds).

#### Response Example
```json
{
    "details": {
        "path": "/api/img/sfw/lay",
        "content-type": "application/json",
        "user-agent": "Some_User-Agent/1.0"
    },
    "error": true,
    "message": "The provided path does not contain any images.",
    "time": 0
}
```
```