API

Hey, it's me again, with some good news this time. That api I mentioned before is live!

How can I use this api?

Send your request to  https://api.kheina.com/v1/search encoded via Multipart/formdata. Just like the search page, the accepted fields are `file` and `url`. raw image data passed via the `file` field is prioritized over the `url` field. the results are returned JSON encoded

What's included in the response?

`stats` contains some current information about the database (newest/oldest indexed images from each website, image count, source count, artist count, last database update in unix time)

`elapsedtime` how long it took to search the database

`error` if the query passed, this will be null. if any problems occurred during the search, this will contain the name of the error, with other information likely in the response. it's highly recommended to check this field before doing any processing on the rest of the response!

`results` contains a sorted list of the results from most similar at `0` and least similar at the end. each result object contains a `similarity` field and a `sources` field which is an array of the sources for a single image.

Where are the thumbnails?

The server does no processing on the results returned from the query, so there is some trickery involved in getting the thumbnails from the results. a sample result might look something like this:

{
"similarity": 96.998355,
"sources": [
        {
"sha1": "aac29e7ac84932a22306534ca5461d3b5c39cec2",
"title": "Gift for Twiren",
"source": "https:\/\/www.furaffinity.net\/view\/33759411",
"artist": "Guppic",
"rating": 1,
"websiteid": 0
        },
        {
"sha1": "aac29e7ac84932a22306534ca5461d3b5c39cec2",
"title": "Gift for Twiren",
"source": "https:\/\/www.furaffinity.net\/view\/33757135",
"artist": "Guppic",
"rating": 1,
"websiteid": 0
        }
    ]
}

The `sha1` field in this each of these sources contains the thumbnail for that particular source, and can be loaded from a url like so: `https://cdn.kheina.com/file/kheinacom/{sha1}.jpg`

What if this changes?

(good) APIs are built on a version control system built into the url. the url for ` https://api.kheina.com/v1/search` will always return results in this fashion for as long as the endpoint is active. you can safely process the response under the assumption that the format of the response will never change.

How do I filter out the porn if I just want SFW results?

The `rating` in each source field represents the rating that uploader gave to the image on the source website. 0 should be safe for all audiences, 1 is mature, 2 is explicit. I highly recommend iterating over all sources for each result and taking the max, as different uploaders may believe the image deserves a different rating.

What the hell is this "websiteid" field?

As one might imagine, it identifies the website the source is for. currently, 1 = https://www.furaffinity.net and 3 = https://furrynetwork.com.

I'm still confused.

Here's a cURL example you can run in your terminal:

`curl -X POST -F "url=https://static1.e621.net/data/preview/53/6d/536d6919b0b83e743dc378610f66f06a.jpg" https://api.kheina.com/v1/search`

{"results":[{"similarity":96.998355,"sources":[{"sha1":"aac29e7ac84932a22306534ca5461d3b5c39cec2","title":"Gift for Twiren","source":"https:\/\/www.furaffinity.net\/view\/33759411","artist":"Guppic","rating":1,"websiteid":0},{"sha1":"aac29e7ac84932a22306534ca5461d3b5c39cec2","title":"Gift for Twiren","source":"https:\/\/www.furaffinity.net\/view\/33757135","artist":"Guppic","rating":1,"websiteid":0}]},{"similarity":76.057364,"sources":[{"sha1":"6a73db44771e7abad5d8e7f18e6548ec6f23a42a","title":"WIP Gift for Twiren","source":"https:\/\/www.furaffinity.net\/view\/33742565","artist":"Guppic","rating":2,"websiteid":0}]},{"similarity":50.606225,"sources":[{"sha1":"14e4bafb07a79a16bfa137043e82c3f46236466c","title":"Inktober | 16","source":"https:\/\/www.furaffinity.net\/view\/33998258","artist":"Frenetic_Sir","rating":1,"websiteid":0}]},{"similarity":49.427296,"sources":[{"sha1":"6b7c6b701507283d46dcd7a29e584ca24c2b40d2","title":"Adelle DeWitt","source":"https:\/\/www.furaffinity.net\/view\/30527333","artist":"czgoldedition","rating":0,"websiteid":0}]},{"similarity":48.849178,"sources":[{"sha1":"8b48da68a961a1a7b9b0bffa44ca2f6c10b39361","title":"Got some tongue action?","source":"https:\/\/furrynetwork.com\/artwork\/1093412","artist":"Destova","rating":0,"websiteid":3}]},{"similarity":47.842742,"sources":[{"sha1":"7d2217cd9a718e7c43e34fb487fd2b155088dde8","title":"Ssss","source":"https:\/\/www.furaffinity.net\/view\/30764806","artist":"Anneartcommissions","rating":0,"websiteid":0}]},{"similarity":47.738536,"sources":[{"sha1":"6802a1f3b94f1e119b07c4b88a698f66e1b9ccf4","title":"Equinox","source":"https:\/\/www.furaffinity.net\/view\/28147613","artist":"Dakarai","rating":0,"websiteid":0}]},{"similarity":46.603377,"sources":[{"sha1":"2a7c69fad6adeb6ecacd21cf75157092dae63468","title":"(c) shall we be on our way?","source":"https:\/\/www.furaffinity.net\/view\/29774287","artist":"satanickpaws","rating":0,"websiteid":0}]},{"similarity":46.581563,"sources":[{"sha1":"f8929772d4cb17d7f842682b92357c205e7710ef","title":"You Can Sip on Me","source":"https:\/\/furrynetwork.com\/artwork\/505642","artist":"little-munster","rating":2,"websiteid":3}]},{"similarity":46.558188,"sources":[{"sha1":"b0f4def3e554c6fd04d59e1dc3de4f21799ffea1","title":"Character Sale: Fennec Fox","source":"https:\/\/www.furaffinity.net\/view\/31495447","artist":"MakotoMew","rating":2,"websiteid":0},{"sha1":"b0f4def3e554c6fd04d59e1dc3de4f21799ffea1","title":"Character Sale: Fennec Fox","source":"https:\/\/www.furaffinity.net\/view\/32187400","artist":"MakotoMew","rating":2,"websiteid":0}]},{"similarity":46.426395,"sources":[{"sha1":"0b331bc1d362888480ec1ee9cf08b9ef96ab4c46","title":"Amy Rose wait sonic back","source":"https:\/\/www.furaffinity.net\/view\/27779468","artist":"HyperSupremoSayajinGod","rating":1,"websiteid":0}]},{"similarity":46.372964,"sources":[{"sha1":"974fcc4eae0825d5b9002a1c600080cf41a8bd59","title":"chibi pink","source":"https:\/\/www.furaffinity.net\/view\/31298862","artist":"Pinkzilla","rating":0,"websiteid":0}]},{"similarity":46.261173,"sources":[{"sha1":"f0ab9d0d9737e1987a26aff1382f972d6b067d32","title":"sitting v2","source":"https:\/\/www.furaffinity.net\/view\/31017279","artist":"MisterLuK","rating":1,"websiteid":0}]},{"similarity":46.043425,"sources":[{"sha1":"3ea056514fc0b097c4eb05c70b8fef18fb4ca9f5","title":"grrrls meme","source":"https:\/\/www.furaffinity.net\/view\/30030372","artist":"kyrisuz","rating":0,"websiteid":0}]},{"similarity":45.827538,"sources":[{"sha1":"39d0319ccf8b58e096925dbb9c6719372a97a2c1","title":"Third Wish","source":"https:\/\/furrynetwork.com\/artwork\/328483","artist":"owlizard","rating":1,"websiteid":3}]},{"similarity":45.64199,"sources":[{"sha1":"caa882e743a107904e3937e50136a95e1a393ba4","title":"Schools Out","source":"https:\/\/www.furaffinity.net\/view\/32894774","artist":"silverfoxchild12","rating":1,"websiteid":0}]},{"similarity":45.523848,"sources":[{"sha1":"9ecc2babefd74b154bac644d9070159fe28f49d5","title":"Adopt [open]","source":"https:\/\/www.furaffinity.net\/view\/31707795","artist":"BreamAdopts","rating":0,"websiteid":0}]},{"similarity":44.976464,"sources":[{"sha1":"1d6b3c8e7a96bb9b3cc12c1ca7ac0b44a0f378ee","title":"Fursuit Friday #8","source":"https:\/\/www.furaffinity.net\/view\/29739424","artist":"Darashi_Kuso","rating":0,"websiteid":0}]},{"similarity":44.805969,"sources":[{"sha1":"d765a546299d0ccc1e875c7ea6f66e284480cae6","title":"if her boobs were big.","source":"https:\/\/www.furaffinity.net\/view\/27672103","artist":"HyperionTrash","rating":1,"websiteid":0},{"sha1":"d765a546299d0ccc1e875c7ea6f66e284480cae6","title":"if her boobs were big.","source":"https:\/\/www.furaffinity.net\/view\/31823458","artist":"HyperionTrash","rating":1,"websiteid":0}]},{"similarity":44.759398,"sources":[{"sha1":"9695ef0f3b0b7fb0c768ed4e8eda27d134f78bfc","title":"Abizu ♥ [P]","source":"https:\/\/www.furaffinity.net\/view\/30284804","artist":"Lunarii","rating":1,"websiteid":0}]},{"similarity":44.758023,"sources":[{"sha1":"b2c3e3e077e6d9b9d3220a728e3d908ad8a709dc","title":"Foxy Hike","source":"https:\/\/www.furaffinity.net\/view\/31097690","artist":"Shadow91smith","rating":0,"websiteid":0}]},{"similarity":44.689611,"sources":[{"sha1":"1b699b41e7d5fa40ed50313961455f43489fdf99","title":"Snuggle Eva the Pink Snow","source":"https:\/\/www.furaffinity.net\/view\/28934567","artist":"RawrHeartC4ZZ","rating":0,"websiteid":0}]},{"similarity":44.684828,"sources":[{"sha1":"070669291dff56c107d29252248b8a964d772b1a","title":"PPP30th Day 25: Appelknekten","source":"https:\/\/www.furaffinity.net\/view\/33965136","artist":"Super_Retrotredo","rating":1,"websiteid":0}]},{"similarity":44.648283,"sources":[{"sha1":"9e069b916076e4d490a5de76c8d67dff53361b50","title":"The best boy in the world! (nude ver)","source":"https:\/\/www.furaffinity.net\/view\/32898742","artist":"ShudaYuda","rating":2,"websiteid":0}]},{"similarity":44.616321,"sources":[{"sha1":"46c73427c6478dff7e3f97e20dc2098c78cf4c44","title":"1","source":"https:\/\/furrynetwork.com\/artwork\/1348993","artist":"oriont","rating":2,"websiteid":3}]}],"elapsedtime":1.6370177269,"stats":{},"error":null}