Skip to content

Major changes of API v3 vs API v2

OndrejVild edited this page Sep 7, 2023 · 3 revisions

For detailed description see documentation for API V3:

  • URL for identification changed from https://api.plant.id/api/v2/identify to https://plant.id/api/v3/identification
  • Changes in modifiers: crops modifiers are deprecated, similar_images are not provided as "modifiers": ["similar_images"] but as "similar_images": true
  • Ask for details not in POST parameters, but in GET parameters, so instead of "plant_details": ["common_names", "taxonomy", "url"] use https://plant.id/api/v3/identification?common_names,taxonomy,url
  • Additional details are now provided for plant identification - inaturalist_idrank
  • Plant details wiki_image and wiki_images renamed to image and images
  • Get identification with access_token (not numerical ID) on different URL using GET method, so instead of https://api.plant.id/v2/get_identification_result/ID, use https://plant.id/api/v3/identification/access_token
  • Delete identification now uses DELETE method (not POST) and URL is changed, instead of https://api.plant.id/v2/delete_identification/ID use https://plant.id/api/v3/identification/access_token
  • Health assessment URL changed from https://api.plant.id/v2/health_assessment to https://plant.id/api/v3/health_assessment
  • Access both identification of plant & health assessment with modifier "health": "all"
  • For Health Assessment, the default is the pruned disease list with 70 classes, instead of 90 classes. All classes can be obtained with the full_disease_list parameter
  • New structure of response, introduce input and result. Plant suggestions are now in result > classification > suggestions and disease suggestions in result > disease > suggestions

Documentation for API v2 can be found here.