Skip to main content

How to identify any aquatic animal

This guide explains how to use the Aquaware API to identify aquatic animal species based on uploaded images. The API is available only to users with the Premium Subscription Tier (Tier 2).

API Endpoint​

To identify an aquatic animal species, use the following API endpoint:

POST /api/animal/identify/

Parameters:​

  • image: A form-data field that must contain the image file of the aquatic animal. The image should be in a supported format (JPEG, PNG, etc.).

Example Request (using cURL):​

curl -X POST https://dev.aquaware.cloud/api/animal/identify/ \
  -H 'X-API-KEY: your-api-key' \
  -F 'image=@/path-to-your-image/animal_image.jpg'

Subscription Tier Requirement:​

This endpoint is restricted to users with a Premium Subscription (Tier 2). If a user with a lower-tier subscription attempts to access this endpoint, the API will return a 403 status code with a message:

{
  "detail": "This feature is only available for Premium subscribers."
}

Example Response​

If the animal is detected and analyzed successfully, the API will return a 200 status code with a JSON response similar to the following:

{
  "animal_detected": true,
  "species": "betta",
  "habitat": "Freshwater ponds and slow-moving streams",
  "diet": "Carnivorous, feeds on insects and larvae",
  "average_size": "5-7 cm",
  "behavior": "Aggressive towards other males, prefers isolation",
  "lifespan": "2-5 years",
  "visual_characteristics": "Colorful body with large fins and vibrant patterns"
}

Status Codes:​

  • 200 OK: The animal was successfully detected and identified.
  • 400 Bad Request: If no image was uploaded or if the image format is invalid, the API will return a 400 status code.
  • 403 Forbidden: If the user is not subscribed to Tier 3 (Premium), the API will return this status code.
  • 500 Internal Server Error: If something goes wrong on the server or during the processing of the image, a 500 status code is returned.

Limitations and Caution:​

Keep in Mind

Please note that this API uses machine learning models to analyze the animal species. While it is generally accurate, there may be edge cases where:

  • Species identification may not be perfect, especially if the image quality is low.
  • Visual characteristics of certain aquatic animals may overlap, leading to misidentification.

The species identification provided should be taken as a recommendation, not a definitive conclusion. No liability will be accepted for any incorrect identification or subsequent actions taken based on the API response.

It is always recommended to consult an aquatic animal expert or professional if you require absolute certainty regarding the species.