Welcome

PimeyesBot supply the API methods to search images.

License

### Source Channel

Database Source Credit amount Number of faces Status
PimEyesBot 10 27398054823 Already supported
PimEyesBotFree 5 27398054823 Already supported
VK 9 1109563766 Already supported
VkOk2020 9 1109563766 Already supported
VkOk2022 9 126280848 Already supported
TikTok 9 125443334 Already supported
ClubHouse 9 13071041 Already supported
PublicPerson 9 355741249 Already supported
FaceBook 10 335590951 Already supported
Onlyfans 9 206092651 Not supported

Use this method to search image.

API

POST https://api.pimeyesbot.com/api/v1/external/search

Request Header

Parameter Optional Type Description Example
X-API-KEY yes string License Key 8b5cba9e9292840fb2d81188a36f5a3b

Request Parameter

Parameter Optional Type Description Example
image_base64 yes string image transform to base64 data data:image/jpeg;base64,/9j/xxx
source_channel yes string source channel for search PimEyesBot
callback_url yes string callback URL will be invoked by the API method you're calling after it's done. https://{your domain}/api/v1/search_callback

Response Parameter

Parameter Type Description
code number 200: success, 400: bad request, 403: forbidden, 500: server error
msg string message
success bool true/false
data object result body
├── id string Search Result ID

Response Sample

{
    "code": 200,
    "msg": "success",
    "data": {
        "id": "635e3727b898be96c66eb5a8"
    },
    "success": true
}

Search Result Callback

API

POST {your callback url}

Request Parameter

Parameter Optional Type Description Example
id yes string Search Result ID 635e3727b898be96c66eb5a8
source_channel yes string source channel for search pimeyesbot
start_at yes utc start to search 2022-10-30T11:14:27.667000
end_at yes utc end to search 2022-10-30T11:15:18.032000
search_result yes object result of search images
├── items array

Request items Description

Parameter Type Description
avatar string address of the search image
source_url string address of the source website
created_at dateTime the date to crawl
quality float degree of similarity

Response

  • Each image search result will notify once when the status code of your response is 200.
  • And each image search result will retry three times when the status code of your response is not 200.

License Key Status

Use this method to get credit amount of license key.

API

GET https://api.pimeyesbot.com/api/v1/external/status

Request Header

Parameter Optional Type Description Example
X-API-KEY yes string License Key 8b5cba9e9292840fb2d81188a36f5a3b

Response Parameter**

Parameter Type Description
code number 200: success, 400: bad request, 403: forbidden, 500: server error
msg string message
success bool true/false
data object result body
├── key string License Key
├── credit_amount number credit amount of purchased plan
├── used_credit_amount number creadit amount have been consumed

Response Sample

{
    "code": 200,
    "msg": "success",
    "data": {
        "key": "8b5cba9e9292840fb2d81188a36f5a3b",
        "credit_amount": 1000,
        "used_credit_amount": 10
    },
    "success": true
}

Search Result Detail

Use this method to get search result detail.

API

GET https://api.pimeyesbot.com/api/v1/external/:id

Request Header

Parameter Optional Type Description Example
X-API-KEY yes string License Key 8b5cba9e9292840fb2d81188a36f5a3b

Response Parameter**

Parameter Type Description
code number 200: success, 400: bad request, 403: forbidden, 500: server error
msg string message
success bool true/false
data object result body
├── id string Search Result ID
├── source_channel string source channel for search
├──start_at utc start to search
├──end_at utc end to search
├──callback_url string callback URL
├──status string pending/failed/success
├── search_result object result of search images
├── items array

Response items Description

Parameter Type Description
avatar string address of the search image
source_url string address of the source website
created_at dateTime the date to crawl
quality float degree of similarity

Response Sample

{
  "code": 200,
  "msg": "success",
  "data": {
    "id": "6418776ef8c4027b04c18262",
    "start_at": "2023-03-20T15:10:38.922000",
    "end_at": "2023-03-20T15:11:02.364000",
    "status": "success",
    "source_channel": "PimEyesBot",
    "callback_url": "https://{your domain}/api/v1/search_callback",
    "search_result": {
      "items": [
        {
          "avatar": "https://telegra.ph/file/c29625d2314ce88f497ae.jpg",
          "source_url": "https://www.n81.com/d4e7427709674f538eb3132c5ee94ebc",
          "created_at": "2015-02-15T18:47:03",
          "quality": 99.99
        }
      ]
    }
  },
  "success": true
}