API Docs

An Open-Source Deep Learning Project to Identify Trout Species

Aqua Vision Deep Learning Research Parent Template

API Endpoints

GET: /api/classes

Species Identification that the Deep Learning Model Currently Supports

To test this endpoint using cURL:

curl -X GET "https://aqua-vision.herokuapp.com/api/classes"

You'll get a return like this: ["brown_trout", "bull_trout", "rainbow_trout"]

POST: /api/predict

Send an image file to this endpoint to get a predicted Trout Species

To test this endpoint using cURL:

curl -X POST -F image=@file_name.png "https://aqua-vision.herokuapp.com/api/predict"

You'll get a return like this: {"class":"rainbow_trout","success":true}

Accessing the API Programmatically via Python

This is a simple Python script to submit data to the API and then consume the returned predictions.

If you run into issues feel free to check out the GitHub repo and open an issue