Fish-AIR_API

Fish-AIR API is a RESTful API built with FastAPI for managing and querying information about fish images and metadata.

Table of Contents

• Using the API
  • API Documentation
  • API Key
• License

Using the API

API Documentation

The API documentation generated by FastAPI can be accessed through the following links:

• Swagger UI: https://fishair.org/api/docs

These interactive documentation pages allow you to explore the available API endpoints and test them directly from your browser.

API Key

Some API endpoints might require an API key for authentication. To obtain an API key, please contact Xiaojun Wang at xwang48@tulane.edu for an API key. Please don't share your api key with others. To authenticate a request, include the access token in the x-api-key header of the request. For example, using Python's requests library:

import requests

url = "http://fishair.org/api/docs/{protected-endpoint}"
headers = {"x-api-key": f"{your_api_key}"}
response = requests.get(url, headers=headers)

License

This project is licensed under the MIT License.