{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b067e857-2490-4875-8b38-1b6bba5d3a92","name":"Crop.health","description":"_This is a beta version of the service and it may undergo changes that may not be compatible with the current version._\n\n[Crop.health](https://crop.kindwise.com) is a machine learning-based service to identify crop diseases and pests 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/kindwise-api-client).\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 in Postman](https://www.postman.com/winter-shadow-932363/workspace/kindwise/documentation/3802128-a5015144-bafc-41d5-aa1d-d8dda811428d), where you can see endpoints and examples and try it out (after providing your API key).\n\nMore implementation examples can be found [here](https://github.com/flowerchecker/crop-health-examples).\n\n[Here](https://crop.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 call. You can request the API key [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-acfaa065-fd12-4742-854c-baed5d058d33)\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-7f1471e0-9ea4-4067-b918-595e084a1a27)\n    \n\nAttributes:\n\n- `images`\n    \n    - `application/json`: a list of strings (required) - one or more images (encoded as strings in [Base64](https://base64.guru/converter/encode/image)) of the crop you want to identify\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) - a 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\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`\\->`crop`\\->`suggestions` - predictions of the model containing plant [taxa](https://en.wikipedia.org/wiki/Taxon) 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` - English name of the taxon (e.g. potato) - this name can change over time\n        \n    - `scientific_name` - Latin name of the [taxon](https://en.wikipedia.org/wiki/Taxon) (e.g. Solanum tuberosum) - 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`\\->`disease`\\->`suggestions` - predictions of the model containing suggestions including diseases, pests and healthy categories. Additional information is similar to crop suggestions and consists of`id`, `name`, `scientific_name`, `probability`, `similar_images`, `details`.\n    \n\n# Details\n\nThere is a list of additional information about crops and diseases that you can get in the 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.\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\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-575854ce-827b-40e1-b89a-e5fab46cf784) with all details for a single language or [this example](https://www.postman.com/winter-shadow-932363/workspace/kindwise/example/3802128-6f53942b-04fd-435f-8392-54dbe2c1adaf) with multiple languages.\n\n**Crop details**\n\n- `gbif_id` - int - id in [GBIF database](https://www.gbif.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\n**Diseases details**\n\n- `type` - string - high-level taxonomical category (e.g. Fungi)\n    \n- `common_names` - list of strings - _localized_ - local, non-scientific names\n    \n- `taxonomy` - dict - scientific taxonomy\n    \n- `eppo_code` - str - id in the [EPPO database](https://www.eppo.int/)\n    \n- `eppo_regulation_status` - dict - quarantine status from [EPPO database](https://www.eppo.int/)\n    \n- `gbif_id` - int - id in the [GBIF database](https://www.gbif.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- `wiki_url` - string - _localized_ - link to disease profile page; if localized page not available, English one is provided\n    \n- `wiki_description` - string - _localized, licensed_ - short description from Wikipedia\n    \n- `description` - string - short description, by kindwise\n    \n- `treatment` - dict - treatment instructions in biological, chemical and prevention categories, by kindwise\n    \n- `symptoms` - dict - description of symptoms, by kindwise\n    \n- `severity` - string - static description of seriousness of the disease, by kindwise\n    \n- `spreading` - string - description of how the disease spreads, by kindwise\n    \n\n# Endpoints","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"3802128","team":5102404,"collectionId":"b067e857-2490-4875-8b38-1b6bba5d3a92","publishedId":"2sA2xh1CXy","public":true,"publicUrl":"https://documenter-api.postman.tech/view/3802128/2sA2xh1CXy","privateUrl":"https://go.postman.co/documentation/3802128-b067e857-2490-4875-8b38-1b6bba5d3a92","customColor":{"top-bar":"b0d26d","right-sidebar":"444444","highlight":"B0D26D"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Documentation for API of machine learning identification of crop diseases and pests."},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/7fc87ece-efa0-47d3-94b1-fb174ad8da29/bG9nby5saWdodC5wbmc=","colors":{"top-bar":"000f33","right-sidebar":"444444","highlight":"B0D26D"}},{"name":"light","logo":"https://content.pstmn.io/eac2ac3e-73ea-407e-a4ef-212c508bbdea/bG9nby5kYXJrLnBuZw==","colors":{"top-bar":"b0d26d","right-sidebar":"444444","highlight":"B0D26D"}}]}},"version":"8.10.1","publishDate":"2024-03-08T10:54:01.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"Documentation for API of machine learning identification of crop diseases and pests."},"logos":{"logoLight":"https://content.pstmn.io/eac2ac3e-73ea-407e-a4ef-212c508bbdea/bG9nby5kYXJrLnBuZw==","logoDark":"https://content.pstmn.io/7fc87ece-efa0-47d3-94b1-fb174ad8da29/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/2sA2xh1CXy"}