API Documentation

Revised on Friday, February 1st, 2019

Have any issues, concerns or needing help with anything regarding sheri, join our support server for assistance.

To use/obtain a API key for the donor endpoints, Donate to our patreon!

Home Official Support Server Sheri's Commands Patreon Add Me!

NodeJS API Wrapper:

The base url for the REST API is https://sheri.bot/api/v2/

Authorization

You are required to be a donor to use the locked endpoints.

Headers

{"Authorization": "YOUR_KEY_HERE"}

Misc/Utility Endpoints

Endpoint Returns Authorization required Complete Url
GET
/usage/global
{
"apiRequests": 210254,
"cdnRequestsTotal": {bandwidth: "123 GB", requests: 98},
"cdnRequests": [ { "BAN": { "requests": 565,
"bandwidth": "755.82 MB" } },
{ "BANG": { "requests": 85969, "bandwidth": "17.3 GB" } } ] }
No https://sheri.bot/api/v2/usage/global
GET
/usage/me
{ "apiRequests": { "allTime": 1, "usingCurrentToken": 1 } } Yes https://sheri.bot/api/v2/usage/me
GET
/authcheck
{ error: false, valid: true, info: `This auth token is valid!` } Yes https://sheri.bot/api/v2/authcheck

Endpoints

Note: Returns null for author, source, and link if there is no data for the image.

Endpoint Returns Authorization required Complete Url
GET /mur {
"url": "https://cdn.sheri.bot/mur/a0284.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
No https://sheri.bot/api/v2/mur
GET /hug {
"url": "https://cdn.sheri.bot/hug/A000A.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/hug
GET /kiss {
"url": "https://cdn.sheri.bot/kiss/A0037.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/kiss
GET /hold {
"url": "https://cdn.sheri.bot/hold/A000B.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/hold
GET /cuddle {
"url": "https://cdn.sheri.bot/cuddles/A00D6.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/cuddle
GET /lick {
"url": "https://cdn.sheri.bot/lick/005D6.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/lick
GET /boop {
"url": "https://cdn.sheri.bot/boop/00224.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/boop
GET /wolves {
"url": "https://cdn.sheri.bot/wolves/0012F7.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/wolves
GET /nature {
"url": "https://cdn.sheri.bot/wolves/0012F7.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/nature
GET /fox {
"url": "https://cdn.sheri.bot/fox/13a.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/fox
GET /pig {
"url": "https://cdn.sheri.bot/pig/6AA4.gif",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/pig

NSFW Endpoints

Note: Returns null for author, source, and link if there is no data for the image.

Endpoint Returns Authorization required Complete Url
GET /yiff {
"url": "https://cdn.sheri.life/yiff/ASBC.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
No https://sheri.bot/api/v2/yiff
GET /nhug {
"url": "https://cdn.sheri.bot/nhug/2bcdb7abe9632f30a76e2283950ad011.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/nhug
GET /nkiss {
"url": "https://cdn.sheri.bot/nkiss/1B38O.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/nkiss
GET /nhold {
"url": "https://cdn.sheri.bot/nhold/1F76O.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/nhold
GET /ncuddle {
"url": "https://cdn.sheri.bot/ncuddle/A018.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/ncuddle
GET /nlick {
"url": "https://cdn.sheri.bot/nlick/8FCO.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/nlick
GET /finger {
"url": "https://cdn.sheri.bot/finger/1O.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/finger
GET /suck {
"url": "https://cdn.sheri.bot/finger/1O.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/suck
GET /bang {
"url": "https://cdn.sheri.bot/bang/1D0FO.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/bang
GET /gif {
"url": "https://cdn.sheri.bot/gif/Gif14.gif",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/gif
GET /lesbian {
"url": "https://cdn.sheri.bot/lesbian/ZI7gpafqBjUSQMEpYTzSnw2Nb.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://sheri.bot/api/v2/lesbian
GET /gay {
"url": "https://cdn.sheri.bot/lesbian/ZI7gpafqBjUSQMEpYTzSnw2Nb.jpg",
"author": { "name": "John Doe",
"link": "https://example.com" },
"source": "https://example.com",
"tags": [ ]
}
Yes https://cdn.sheri.bot/gay/B010E.jpg