Skip to main content Link Menu Expand (external link) Document Search Copy Copied

BQAT API

Table of contents

Setup

This project is run as a server which provides BQAT functionalities as RESTful API. To begin, simply pull the Docker image and start it with the Docker compose file provided.

Download the Docker Compose file

Download

Usage

  • Download the docker compose file into your working directory.
  • Create a data folder within your working directory and put your input images in this folder.
  • Start the BQAT API service:
# Start container stack
docker compose up -d

# Stop the service
docker compose down

Note: The tool is designed to be executed with a /data folder in your working directory. The /data folder (where all the images are stored) will be mounted to the container. “Read and write” permission is required for this folder. It should work as long as the folder was created before spinning up the server. Otherwise, the ownership of the folder will need to be changed.

API

The documentation of the API endpoints lives in:

  • localhost:8848/docs

Further Details