GET
/
search
curl --request GET \
  --url https://nekosauce.com/api/search \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: image/*'
{
  "data": [
    {
      "id": 123,
      "similarity": 123,
      "hash": "<string>",
      "sha512": "<string>",
      "urls": {
        "site": [
          "<string>"
        ],
        "file": [
          "<string>"
        ],
        "api": [
          "<string>"
        ]
      },
      "source": 123,
      "source_site_id": "<string>",
      "tags": [
        "<string>"
      ],
      "sauce_type": "illustration",
      "is_nsfw": true,
      "file_meta": {
        "width": 123,
        "height": 123,
        "mimetype": "image/webp"
      },
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}
This endpoint has a higher rate limit than other endpoints. By default, the rate limit is 1r/10s.

Authorizations

​
Authorization
string
header
required

Format: ApiKey <api-key>

Headers

​
Content-Disposition
string

The name of the image file together with some other metadata. Format: attachment; filename={filename}

​
Content-Type
string

The type of the image file (if uploaded)

Query Parameters

​
url
string

An URL pointing to the image's source file

​
limit
integer
default:10

The maximum number of results to return

Required range: 1 <= x <= 50
​
threshold
number
default:90

The lowest similarity (percentage) that can be returned. The lower this value, the more the time the request will take to complete.

Required range: 1 <= x <= 100
​
sources
integer[]

The ID of the sources from where results can be

​
nsfw
boolean | null

Filter the results by their NSFW status. Don't specify to return all results.

Body

image/* · file
A raw image file. The size must not exceed 1MB. Any format supported by [Pillow](https://pillow.readthedocs.io/en/stable/handbook/image-file-formats.html) is supported.

The body is of type file.

Response

200
application/json
The query was completed successfully
​
data
object[]