Images

get
Get An image (JSON)
https://yiff.rest/v2/:cat
Get an image from the specified category
Request
Response
Request
Path Parameters
cat
required
string
The category name.
Query Parameters
limit
optional
number
Number between 1-5 for the number of images to return
Response
200: OK
Image fetched successfully
{
    "images": [
        {
            "artists": [],
            "sources": [],
            "width": 1280,
            "height": 987,
            "url": "https://yiff.media/V2/furry/hug/8f145feb984f0b9a7f2bb2ad9a25682c.jpg",
            "type": "image/jpeg",
            "name": "8f145feb984f0b9a7f2bb2ad9a25682c.jpg",
            "id": "8f145feb984f0b9a7f2bb2ad9a25682c",
            "shortURL": "https://yiff.rocks/8f145feb984f0b9a7f2bb2ad9a25682c",
            "ext": "jpg",
            "reportURL": "https://report.yiff.media/8f145feb984f0b9a7f2bb2ad9a25682c"
        }
    ],
    "$schema": "https://yiff.rest/V2/schema.json",
    "success": true
}
404: Not Found
No images were found in the specified category (may be invalid or empty).
{
    "success": false,
    "error": {
        "message": "No images were found in that category. (category may not exist)",
        "type": "filesystem",
        "category": {
            "db": "furry.invalid",
            "dir": {
                "location": "/var/www/sites/yiff.media/V2/furry/invalid",
                "exists": false,
                "files": null
            }
        }
    }
}
get
Get an image (Image)
https://yiff.rest/v2/:cat/image
Get an image from the specified category
Request
Response
Request
Path Parameters
cat
required
string
The category name.
Response
200: OK
Image fetched successfully
The body itself will be an image, all image info will be in the headers, as listed below.
​
Headers:
* - there can be multiple of these per response
​
X-Yiffy-Artist*: the artist(s) of the image
X-Yiffy-Image-Extension: image extension
X-Yiffy-Image-Height: the height of the image
X-Yiffy-Image-Width: the width of the image
X-Yiffy-Image-Type: the mime type of the image
X-Yiffy-URL: the cdn url of the image
X-Yiffy-Source*: the source(s) of the image
X-Yiffy-Short-URL: the shorturl link of the image
X-Yiffy-Version: the version of the api (2)
X-Yiffy-Schema: the json schema (https://yiff.rest/V2/schema.json)
404: Not Found
No images were found in the specified category (may be invalid or empty).
{
    "success": false,
    "error": {
        "message": "No images were found in that category. (category may not exist)",
        "type": "filesystem",
        "category": {
            "db": "furry.invalid",
            "dir": {
                "location": "/var/www/sites/yiff.media/V2/furry/invalid",
                "exists": false,
                "files": null
            }
        }
    }
}
​
Images

getGet An image (JSON)

getGet an image (Image)

get
Get An image (JSON)

get
Get an image (Image)
