API Documentation¶
The ImageAPI was created as a replacement for your common Image APIs such as nekos.life.
Endpoints are available to use without any authentication required.
The Source code is publicly available and contributions are always welcome.
Base URL
Categories¶
Safe for Work (SFW) Endpoints¶
/quote Generates an image that mimics a Discord message.
Request
Type
application/json
Note
You must provide an empty JSON body ({}) if you want to use the default values.
Body
| Name | Type | Default | Notes |
|---|---|---|---|
| avatar | String (URL) | https://purrbot.site/assets/img/api/unknown.png | |
| dateFormat | String | dd. MMM yyyy |
Uses SimpleDateFormat |
| message | String | This is an example message. |
|
| nameColor | String | hex:ffffff |
Supported: rgb:r,g,b, hex:rrggbb |
| timestamp | Integer | Current time |
|
| username | String | Someone |
Example
{
"avatar": "https://cdn.discordapp.com/avatars/204232208049766400/dfaaefa54a2804addb1f494da7aa904d.png",
"dateFormat": "dd. MMM yyyy",
"message": "This is an example message.",
"nameColor": "hex:ffffff",
"timestamp": 1583708400,
"username": "Andre_601"
}
Response
200
Type
image/png
400
Type
application/json
Body
Example
{
"details": {
"path": "/api/quote",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "Received invalid or empty JSON Body."
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
500
Type
application/json
Body
Example
{
"details": {
"path": "/api/quote",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "Couldn't generate Image. Make sure the values are valid!"
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/status Generates an image that displays an avatar with a Status icon.
Request
Type: application/json
Body
| Name | Type | Default | Notes |
|---|---|---|---|
| avatar | String (URL) | https://purrbot.site/assets/img/api/unknown.png | |
| mobile | Boolean | false |
Changes the icon to a phone. Not used with status offline. |
| status | String | offline |
Supported: online, idle, do_not_disturb/dnd or offline |
Example
{
"avatar": "https://cdn.discordapp.com/avatars/204232208049766400/dfaaefa54a2804addb1f494da7aa904d.png",
"mobile": false,
"status": "online"
}
Response
200
Type
image/png
400
Type
application/json
Body
Example
{
"details": {
"path": "/api/status",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "Received invalid or empty JSON Body."
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
500
Type
application/json
Body
Example
{
"details": {
"path": "/api/status",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "Couldn't generate Image. Make sure the values are valid!"
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/background/img Returns a randomly selected Welcome Background Image.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/background/img/color_black.png",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/bite/gif Returns a randomly selected Bite Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/bite/gif/bite_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/blush/gif Returns a randomly selected Blush Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/blush/gif/blush_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/comfy/gif Returns a randomly selected Comfy Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/comfy/gif/comfy_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/cry/gif Returns a randomly selected Cry Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/cry/gif/cry_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/cuddle/gif Returns a randomly selected Cuddle Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/cuddle/gif/cuddle_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/dance/gif Returns a randomly selected Dance Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/dance/gif/dance_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/eevee/{type} Returns a randomly selected Eevee Image/Gif.
Parameters
| Name | Description |
|---|---|
| type | The Image type to return. Supported: gif or img. |
Response
200
Type
application/json
Body
Example Gif
{
"error": false,
"link": "https://purrbot.site/img/sfw/eevee/gif/eevee_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
Example Image
{
"error": false,
"link": "https://purrbot.site/img/sfw/eevee/img/eevee_001.jpg",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/feed/gif Returns a randomly selected Feeding Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/feed/gif/feed_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/fluff/gif Returns a randomly selected Blush Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/fluff/gif/fluff_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/holo/img Returns a randomly selected Image of Holo from 'Spice and Wolf'
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/holo/img/holo_001.jpg",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/hug/gif Returns a randomly selected hugging Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/hug/gif/hug_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/icon/img Returns a randomly selected Welcome Icon.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/icon/img/holo.jpg",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/kiss/gif Returns a randomly selected kissing Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/kiss/gif/kiss_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/kitsune/img Returns a randomly selected Kitsune (Fox Girl) Image.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/kitsune/img/kitsune_001.jpg",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/lick/gif Returns a randomly selected licking Gif
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/lick/gif/lick_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/neko/{type} Returns a randomly selected Neko (Cat Girl) Gif or Image.
Parameters
| Name | Description |
|---|---|
| type | The Image type to return. Supported: gif or img. |
Response
200
Type
application/json
Body
Example Gif
{
"error": false,
"link": "https://purrbot.site/img/sfw/neko/gif/neko_001.gif",
"time": 0
}
Example Image
{
"error": false,
"link": "https://purrbot.site/img/sfw/neko/img/neko_001.jpg",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/okami/img Returns a randomly selected Okami (Wolf Girl) Image.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/okami/img/okami_001.jpg",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/pat/gif Returns a randomly selected patting Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/pat/gif/pat_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/poke/gif Returns a randomly selected poking Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/poke/gif/poke_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/senko/img Returns a randomly selected Image of Senko-San.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/senko/img/senko_001.jpg",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/slap/gif Returns a randomly selected slapping Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/slap/gif/slap_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/smile/gif Returns a randomly selected smiling Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/smile/gif/smile_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/tail/gif Returns a randomly selected tail wagging Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/tail/gif/tail_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/sfw/tickle/gif Returns a randomly selected tickling Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/sfw/tickle/gif/tickle_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/list/sfw/{path} Lists all found images of the specified {path}
Parameters
| Name | Description |
|---|---|
| path | The path to the image folder. Available paths are the same as with all the /api/img/ endpoints. |
Response
200
Type
application/json
Body
Example
{
"error": false,
"links": [
"https://purrbot.site/img/sfw/background/img/color_black.png",
"https://purrbot.site/img/sfw/background/img/color_blue.png",
"https://purrbot.site/img/sfw/background/img/color_blurple.png",
"https://purrbot.site/img/sfw/background/img/color_green.png",
"https://purrbot.site/img/sfw/background/img/color_grey.png",
"https://purrbot.site/img/sfw/background/img/color_red.png",
"https://purrbot.site/img/sfw/background/img/color_white.png",
"https://purrbot.site/img/sfw/background/img/gradient.png",
"https://purrbot.site/img/sfw/background/img/gradient_blue.png",
"https://purrbot.site/img/sfw/background/img/gradient_dark_red.png",
"https://purrbot.site/img/sfw/background/img/gradient_green.png",
"https://purrbot.site/img/sfw/background/img/gradient_orange.png",
"https://purrbot.site/img/sfw/background/img/gradient_red.png",
"https://purrbot.site/img/sfw/background/img/rainbow.png"
],
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.links: Array
Array of Strings representing URLs to the Images/Gifs found in the directory.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
Not Safe for Work (NSFW) Endpoints¶
/img/nsfw/anal/gif Returns a randomly selected Anal-Sex Gif
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/nsfw/anal/gif/anal_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/nsfw/blowjob/gif Returns a randomly selected blowjob Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/nsfw/blowjob/gif/blowjob_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/nsfw/cum/gif Returns a randomly selected cumming Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/nsfw/cum/gif/cum_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/nsfw/fuck/gif Returns a randomly selected Sex Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/nsfw/fuck/gif/fuck_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/nsfw/neko/{type} Returns a randomly selected NSFW Neko (Cat Girl) Gif or Image.
Parameters
| Name | Description |
|---|---|
| type | The Image type to return. Supported: gif or img |
Response
200
Type
application/json
Body
Example Gif
{
"error": false,
"link": "https://purrbot.site/img/nsfw/neko/gif/neko_001.gif",
"time": 0
}
Example Image
{
"error": false,
"link": "https://purrbot.site/img/nsfw/neko/img/neko_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/nsfw/pussylick/gif Returns a randomly selected pussy licking Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/nsfw/pussylick/gif/pussylick_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/nsfw/solo/gif Returns a randomly selected Gif of a female masturbating.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/nsfw/solo/gif/solo_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/nsfw/threesome_fff/gif Returns a randomly selected Threesome Gif (Females only).
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/nsfw/threesome_fff/gif/threesome_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/nsfw/threesome_ffm/gif Returns a randomly selected Threesome Gif (2 Females, 1 Male).
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/nsfw/threesome_ffm/gif/threesome_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/nsfw/threesome_mmf/gif Returns a randomly selected Threesome Gif (1 Female, 2 Males).
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/nsfw/threesome_mmf/gif/threesome_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/nsfw/yaoi/gif Returns a randomly selected Yaoi (Gay Hentai) Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/nsfw/yaoi/gif/yaoi_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/img/nsfw/yuri/gif Returns a randomly selected Yuri (Lesbian Hentai) Gif.
Response
200
Type
application/json
Body
Example
{
"error": false,
"link": "https://purrbot.site/img/nsfw/yuri/gif/yuri_001.gif",
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.link: String (URL)
URL to the randomly selected Image/Gif.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
/list/nsfw/{path} Lists all found images of the specified {path}
Parameters
| Name | Description |
|---|---|
| path | The path to the image folder. Available paths are the same as with all the /api/img/ endpoints. |
Response
200
Type
application/json
Body
Example
{
"error": false,
"links": [
"https://purrbot.site/img/nsfw/anal/gif/anal_001.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_002.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_003.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_004.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_005.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_006.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_007.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_008.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_009.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_010.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_011.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_012.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_013.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_014.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_015.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_016.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_017.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_018.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_019.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_020.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_021.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_022.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_023.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_024.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_025.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_026.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_027.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_028.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_029.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_030.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_031.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_032.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_033.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_034.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_035.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_036.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_037.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_038.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_039.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_040.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_041.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_042.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_043.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_044.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_045.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_046.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_047.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_048.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_049.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_050.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_051.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_052.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_053.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_054.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_055.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_056.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_057.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_058.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_059.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_060.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_061.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_062.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_063.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_064.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_065.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_066.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_067.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_068.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_069.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_070.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_071.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_072.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_073.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_074.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_075.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_076.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_077.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_078.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_079.gif",
"https://purrbot.site/img/nsfw/anal/gif/anal_080.gif"
"time": 0
}
Scheme
error: Boolean
Always returns false for successful requests.links: Array
Array of Strings representing URLs to the Images/Gifs found in the directory.time: Integer
Time in milliseconds it took for the API to process the request.
403
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path is not valid.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.
404
Type
application/json
Body
Example
{
"details": {
"path": "/api/img/:path",
"content-type": ":your-content-type",
"user-agent": ":your-user-agent"
},
"error": true,
"message": "The provided path does not contain any images.",
"time": 0
}
Schema
details: JSON Object
Contains details about your request.path: String
The path you accessed.content-type: String
The content-type you provided in your request.user-agent: String
The User-Agent you used in your request.
error: Boolean
Always returns true for errors.message: String
The reason why the request failed.time: Integer
Time in milliseconds it took for the API to process the request.