Quick Start

This small tutorial will only provide you with minimal knowledge of the API, if you wish to learn more just continue reading the docs step by step

Alternatively you can also use one of the packages mentioned in Packages

Get a random image

The easiest and most common way to use the API is to get a random waifu images.

Here is an example to get a random image with the raiden-shogun and maid tags with an height superior or equal to 2000 pixels:

curl -X GET \
  'https://api.waifu.im/search?included_tags=raiden-shogun&included_tags=maid&height=>=2000' \
  -H 'Content-Type: application/json'

It is recommended to checkout the API Reference.

You can find a more detailed guide for this route here : #search-images.

Last updated