{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a5015144-bafc-41d5-aa1d-d8dda811428d","name":"Insect.id","description":"[Insect.id](https://insect.kindwise.com) is a machine learning-based service to identify beetles, spiders, centipedes, butterflies, ants, bees and other insect-like animals from images. To use the API you need to [get an API key](https://admin.kindwise.com).\n\nTo use API from python, use SDK: [kindwise API client](https://github.com/flowerchecker/plant-id-examples).\n\n### How to use this documentation\n\nThis is a description of an important part of the API. The specification of the endpoints is given below. In the right column, you can find example calls of these endpoints (on the right you can toggle between different examples).\n\nYou can also open this [documentation directly on postman](https://www.postman.com/winter-shadow-932363/workspace/kindwise/collection/3802128-a5015144-bafc-41d5-aa1d-d8dda811428d), where you can see endpoints and examples, and you can also try it out (after providing your API key).\n\nMore implementation examples can be found [here](https://github.com/flowerchecker/insect-id-examples).\n\n[Here](https://insect.kindwise.com/api/v1/openapi.yaml) is openAPI definition of this api.\n\n# Authentication\n\nYou should provide the `Api-Key` header with your API key. You can request it [here](https://admin.kindwise.com).\n\n# Identification request\n\nThere are two methods to create a new identification:\n\n1. using `application/json` request - all attributes including images are encoded in json body - see [the example](https://www.postman.com/winter-shadow-932363/workspace/kindwise/example/3802128-83204c5f-85c3-4970-bd71-4fc0ef17f29e)\n    \n2. using `multipart/form-data` request - attributes are sent in text fields; images are sent as files - see [the example](https://www.postman.com/winter-shadow-932363/workspace/kindwise/example/3802128-c088728b-8c98-4c1f-86f3-c5032fd53981)\n    \n\nAttributes:\n\n- **`images`**\n    \n    - `application/json`: a list of strings (required) with one or more images of the insect you want to identify of either:\n        \n        - image(s) encoded as strings in [Base64,](https://base64.guru/converter/encode/image)\n            \n        - public URL(s) of images\n            \n    - `multipart/form-data` - all images in file fields (names of file fields are not important)\n        \n- `latitude` - float (optional) - geographic coordinate, increases the identification accuracy\n    \n- `longitude` - float (optional) - geographic coordinate, increases the identification accuracy\n    \n- `similar_images` - boolean (optional) - if `true`, the model also selects images similar to the provided images for each suggestion\n    \n- `custom_id` - int (optional) - unique identifier, can be used to access the identification results\n    \n- `datetime` - str (optional) - to improve results, e.g. for images taken at different seasons, specify the date when the images were taken in ISO format with variable precision (e.g. `2023-06-22` for days or `2023-06-22T11:28` for minutes)\n    \n- `suggestion_filter` - dict (optional) in format `{\"classification\": \"FILTER_NAME (filter examples below)\"}` - restricts the output of the model to specified list of classes (based on taxonomy) and adjusts the probabilities. The lists can be combined with logical operators and parentheses. The lists are available [here](https://insect.kindwise.com/suggestion_filters). Examples:\n    \n    - Butterflies and moths - `{\"classification\": \"lepidoptera\"}`\n        \n    - Arachnids and beetles - `{\"classification\": \"arachnida OR coleoptera\"}`\n        \n\n# Identification result\n\nHere we comment on important parts of the result. For a complete example of the results see the response examples below.\n\n- `access_token` - a unique identifier of the identification, can be used to access the identification results\n    \n- `result`\\->`classification`\\->`suggestions` - predictions of the model containing [taxa](https://en.wikipedia.org/wiki/Taxon) (order, family, genus or species) suggestions and additional information; each `suggestion` consists of:\n    \n    - `id` - the id of the suggested taxon, which doesn't change over time\n        \n    - `name` - the name of the [taxon](https://en.wikipedia.org/wiki/Taxon) in our database (this name can change over time)\n        \n    - `probability` - the level of certainty that suggested taxon is the one in the image\n        \n    - `similar_images` - if `similar_images=true` is in request - list of representative images of the identified taxon carefully selected by the model to resemble the input image; the images may also contain license data that should be cited when using the image\n        \n    - `details` - additional info you requested, see below\n        \n- `result`\\->`is_insect` - prediction of the model about presence of an insect in the input images\n    \n    - `binary` - if `false` images probably do not contain an insect\n        \n    - `treshold` - treshold used for the `binary` result\n        \n    - `probability` - probability that images contain an insect - you can apply your own threshold\n        \n\n# Details\n\nThere is a list of additional information about insect that you can get in identification result. To get specific information, include the detail's name in the GET parameters.\n\nThe default language is English; to get details in a different language include the language parameter in the GET parameters. ISO 639 two-letter language codes are used, except for Chinese where `zh` is Simplified Chinese and `zh-hant` is Traditional Chinese.\n\nSome details are **licensed**. If you want to use this detail, you should also cite the source.\n\nSome details are not available for all entities, if unavailable, `null` is returned.\n\n⚠️ We are not liable for damages or injury caused by actions based on inaccurate, misleading, incomplete or wrong information provided.\n\nThis is a basic description of the available details. To see examples of return values and their exact format, see [this example](https://www.postman.com/winter-shadow-932363/workspace/kindwise/example/3802128-0dc8645a-53e4-40e5-8045-1e6eeb93e004) with all details for a single language or [this example](https://www.postman.com/winter-shadow-932363/workspace/kindwise/example/3802128-44a304e1-486b-4a11-a00c-41bda596ac62) with multiple languages.\n\n- **`common_names`** - list of strings - _localized_ - local, non-scientific name\n    \n- **`url`** - string - _localized_ - link to insect profile page (usually Wikipedia); if localized page not available, an English one is provided\n    \n- **`description`** - string - _localized, with license_ - short description from Wikipedia\n    \n- **`description_gpt`**\\- string - _localized_ - short description from GPT\n    \n- **`description_all`**\\- string - _localized, some with license_ - short description, combined Wikipedia and GPT. [Read more](https://kindwise.com/handbook#plant_descriptions).\n    \n- **`taxonomy`** - dict - scientific taxonomy\n    \n- **`rank`** - string - taxonomic rank\n    \n- **`gbif_id`** - int - id in [GBIF database](https://www.gbif.org)\n    \n- **`inaturalist_id`** - int - id in [iNaturalist database](https://www.inaturalist.org)\n    \n- **`image`** - string - _with licence_ - url of representative image\n    \n- **`images`** - list - _with licences_ - list of more urls of representative images\n    \n- **`red_list`** - string - conservation status and extinction risk from [IUCN Red List of Threatened Species](https://www.iucnredlist.org/)\n    \n- **`synonyms`** - list of strings - other names of the insect\n    \n- **`danger`** - list of strings - tags suggesting the danger of the insect, possible values:\n    \n    - `harmless to human health`\n        \n    - `bites or stings`\n        \n    - `bites pets`\n        \n    - `disease transmission`\n        \n    - `rash or skin irritation`\n        \n    - `allergenic`\n        \n    - `non-venomous`\n        \n    - `mildly venomous`\n        \n    - `highly venomous`\n        \n- **`danger_description`** - string - short description of the danger of the insect\n    \n- **`role`** - list of strings - tags suggesting the role of the insect in the environment and its interaction with humans, possible values:\n    \n    - `beneficial`\n        \n    - `pollinator`\n        \n    - `agriculture or garden pest`\n        \n    - `household pest`\n        \n    - `wood destroying`\n        \n\n# Endpoints","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"3802128","team":5102404,"collectionId":"a5015144-bafc-41d5-aa1d-d8dda811428d","publishedId":"2s93sZ5YeU","public":true,"publicUrl":"https://documenter-api.postman.tech/view/3802128/2s93sZ5YeU","privateUrl":"https://go.postman.co/documentation/3802128-a5015144-bafc-41d5-aa1d-d8dda811428d","customColor":{"top-bar":"ffb946","right-sidebar":"444444","highlight":"a26c00"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Documentation for API of machine learning identification of insect, spiders, butterflies, ant and other bugs from images."},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/9a28820e-fea1-4fff-bb96-e7b8a0ebe84f/bG9nby5saWdodC5wbmc=","colors":{"top-bar":"00150a","right-sidebar":"444444","highlight":"ffb946"}},{"name":"light","logo":"https://content.pstmn.io/2268571e-3d3a-4b36-baad-66c131bf9b31/bG9nby5kYXJrLnBuZw==","colors":{"top-bar":"ffb946","right-sidebar":"444444","highlight":"a26c00"}}]}},"version":"8.10.1","publishDate":"2023-06-06T13:50:46.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"Documentation for API of machine learning identification of insect, spiders, butterflies, ant and other bugs from images."},"logos":{"logoLight":"https://content.pstmn.io/2268571e-3d3a-4b36-baad-66c131bf9b31/bG9nby5kYXJrLnBuZw==","logoDark":"https://content.pstmn.io/9a28820e-fea1-4fff-bb96-e7b8a0ebe84f/bG9nby5saWdodC5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/26f40c6e93a44c2dff2f36796f6c1fac72dfad0aae17cb25b5b7b4bff0441f95","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s93sZ5YeU"}