Cykably.at API Documentation

Usage

Our JSON-API is entirely based on GET-Requests

Calling a Endpoint on our API will just return a JSON-Object with exactly one file entry, which contains the URL to a random file of that endpoint.

Prerequisites

In order to be able to use our API, you need a personal token.

If you wish to request a personal token, please register on our website and confirm your E-Mail Address

After you've confirmed your E-Mail address, you can log into your dashboard and request a API token.


All API tokens have a set amount of credits they can use per day. Per default you're limited to 1000 credits a day.

Every request to our API will reduce your credits by 1

All Credits will be restored at 12:00 AM CEST.

Sending a request

Method Endpoint
GET https://cykably.at/api/{endpoint}

Our API expects your token to be supplied in the X-API-KEY header:

X-API-KEY: YourAPIKeyGoesHere

We don't, however, use sessions on our API.


Upon every request, the server will let you know if your request was successful, your remaining credits and a data object containing only the file url.

{
    "success": true,
    "message": "",
    "credits": 999,
    "data": {
        "file": "FILE-URL"
    }
}

If the request hasn't been successful, you'll find the reason in the message member.

{
    "success": false,
    "message": "Invalid Token",
    "credits": 0,
    "data": []
}

Endpoints

Endpoint Files Description
angry 19
baka 26
blush 26
bored 34
calm-down 3
claps 21
confused 13
cry 71
cuddle 47
dance 9
feed 17
fox_girl 204
happy 13
highfive 2
holo 183
hug 151
kemonomimi 362
kill 11
kiss 202 Kissing images
kitsune 79
laugh 9
lick 4
neko 663
ngif 110
no 19 Disagreement images
pat 129
poke 23
punch 14
sad 22
scared 14
slap 36
smug 99
surprised 24
thinking 13
tickle 37
vomit 8
wave 50
yes 14 Agreement images

Error types

Status Code Possible reasons
401 Unauthorized No X-API-KEY header has been supplied or the header contained a invalid token.
403 Forbidden The token has been banned from API usage.
423 Locked The token ran out of credits.

Usage examples

  • Python
    import aiohttp
async def get_image(self, reaction: str):
    url = f"https://cykably.at/api/{reaction}"
    token = "YourAPIKeyGoesHere"
    file = None
    async with aiohttp.ClientSession() as session:
        async with session.get(url, headers={'X-API-KEY': token}) as r:
            r = await r.json()
            return r["data"]["file"]
print(await get_image('angry'))
  • Node.js
    const fetch = require('node-fetch');

const getImage = async (reaction) => {
    const token = 'YourAPIKeyGoesHere'
    const response = await fetch('https://cykably.at/api/'+reaction,
                            { method: 'GET', headers: {'X-API-KEY': token}});
    const r = await response.json();
    return r['data']['file'];
}
getImage('angry').then((image) => {
    console.log(image);
})

Cykably.at is not responsible for any content provided by the api.

The content is provided by our users and checked before making available to public. However, we cannot guarantee that something slips through.


If you found any illegal or disturbing content (Lolicon, Rape, Gore e.t.c), please contact us immediately.

We will check and delete the files as soon as possible.