👋Getting Started

The API can be used with any programming language, some examples can be found here: https://github.com/Kawaii-API/Examples

API Token

To get a token you must first login to your dashboard where you will find your personal api token.

If you don't want to log in or you think the stat functions are necessary you can use the token anonymous instead of your token so you can still use the api but you will miss some functions.

If you want to know more about the token (how, why and where) you can check here:

🔑pageToken

API Request

For testing you can make the api requests also via the browser.

Basic Request

GET https://kawaii.red/api/MAIN/SUB?token=TOKEN&type=TYPE&filter=FILTER

The structure of the request system.

Path Parameters

NameTypeDescription

MAIN*

Endpoint

Here you make the rough choice which main endpoint you want to target.

SUB*

Endpoint

Here you make the selection of which endpoint you want to go to in the previously selected category.

TOKEN*

String

Here comes your api token or anonymous in (note the token information).

FILTER

List

With the filter you can filter possible unwanted responses so that the api does not return them.

TYPE

String

You can specify the type of response depending on what is easier for you to implement.

{
   "response": "Requested content"
}

Example Request

GET https://kawaii.red/api/gif/hug?token=anonymous

You can open this link in your browser.

Path Parameters

NameTypeDescription

gif*

MAIN

The category Gif Endpoints.

hug*

SUB

The hug endpoint.

anonymous*

TOKEN

The token in this case is the anonymous one which has no stats function.

{
   "response":"https://api.kawaii.red/gif/hug/hug1.gif"
}

NEW! API Request

The new way is completely header-based, so please use an extra tool for testing.

Basic Request

GET https://kawaii.red/api/main/sub

Path Parameters

NameTypeDescription

main*

Endpoint

Here you make the rough choice which main endpoint you want to target.

sub*

Endpoint

Here you make the selection of which endpoint you want to go to in the previously selected category.

Headers

NameTypeDescription

token*

String

Here comes your api token or anonymous in (note the token information).

type

String

You can specify the type of response depending on what is easier for you to implement.

filter

List

With the filter you can filter possible unwanted responses so that the api does not return them.

{
   "response": "Requested content"
}

Example Request

GET https://kawaii.red/api/gif/hug

Path Parameters

NameTypeDescription

gif*

main

The category Gif Endpoints.

hug*

sub

The hug endpoint

Headers

NameTypeDescription

anonymous*

token

The token in this case is the anonymous one which has no stats function.

{
   "response":"https://api.kawaii.red/gif/hug/hug1.gif"
}

The api always returns a 200: OK message even for wrong requests, however it gives an error message out with the exact reason should something be wrong.

Error layout:

{
   "error": f"Error reason! For more information go to https://kawaii.red/docs/"
}

Here you will find a detailed explanation for all cases and with more detailed explanations of how it works:

🏠pageRequest Structure

API Endpoints

📝pageText

Currently not yet ready. I'm sorry.

🌅pageImage

Currently not yet ready. I'm sorry.

🎬pageGIF

Through this endpoint you can query many different anime GIFs.

📊pageStats

Here you can query your stats or your complete database entry.

Last updated