openapi.json

{"openapi":"3.0.2","info":{"title":"Cell Analyzer","version":"0.1.0"},"paths":{"/api/models":{"get":{"tags":["api"],"summary":"Retrieve Models","description":"Retrieve the name of all available models","operationId":"retrieve_models_api_models_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/batch":{"get":{"tags":["api"],"summary":"Api List Batches","description":"List submitted batches\n\nThe batches are listed with the newest first and\nlimited to the given limit.\n\n- **limit**: the amount of batches to return","operationId":"api_list_batches_api_batch_get","parameters":[{"description":"limit the amount of batches to list","required":false,"schema":{"title":"Limit","type":"integer","description":"limit the amount of batches to list","default":15},"name":"limit","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["api"],"summary":"Submit Batch","description":"Submit a new batch for analysis\n\nThe batch is started in the background and its\nbatch id is returned for furhter reference.\n\n- **model**: the name of the model to use for the analysis. It must match a model from `/models` endpoint.\n- **prediction_threshold**: a floating point number between 0 and 1 to use as minimum prediction probability\n- **tags**: a list of tags to describe this batch\n- **image_files**: a list of images to analysis","operationId":"submit_batch_api_batch_post","parameters":[{"description":"the name of the model to use for the analysis. It must match a model from `/models` endpoint","required":true,"schema":{"title":"Model","type":"string","description":"the name of the model to use for the analysis. It must match a model from `/models` endpoint"},"name":"model","in":"query"},{"description":"a floating point number between 0 and 1 to use as minimum prediction probability","required":true,"schema":{"title":"Prediction Threshold","type":"number","description":"a floating point number between 0 and 1 to use as minimum prediction probability"},"name":"prediction_threshold","in":"query"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_submit_batch_api_batch_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/batch/tags":{"get":{"tags":["api"],"summary":"Get Batch Tags","description":"List the tags of the last 50 batches","operationId":"get_batch_tags_api_batch_tags_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/batch/{batch_id}":{"get":{"tags":["api"],"summary":"Get Batch Details","description":"Retrieve the details for a single batch\n\n- **batch_id**: the batch id as returned by `POST /batch`","operationId":"get_batch_details_api_batch__batch_id__get","parameters":[{"description":"the batch id as returned by `POST /batch`","required":true,"schema":{"title":"Batch Id","type":"string","description":"the batch id as returned by `POST /batch`"},"name":"batch_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/batch/{batch_id}/export":{"get":{"tags":["api"],"summary":"Export Batch","description":"Export all information about a single batch\n\nThis endpoint returns a ZIP file.\n\n- **batch_id**: the batch id as returned by `POST /batch`\n- **include_originals**: flag to indicate if the original images should be included in the export\n- **include_result_images**: flag to indicate if the result images should be included in the export","operationId":"export_batch_api_batch__batch_id__export_get","parameters":[{"description":"the batch id as returned by `POST /batch`","required":true,"schema":{"title":"Batch Id","type":"string","description":"the batch id as returned by `POST /batch`"},"name":"batch_id","in":"path"},{"description":"flag to indicate if the original images should be included in the export","required":true,"schema":{"title":"Include Originals","type":"boolean","description":"flag to indicate if the original images should be included in the export"},"name":"include_originals","in":"query"},{"description":"flag to indicate if the result images should be included in the export","required":true,"schema":{"title":"Include Result Images","type":"boolean","description":"flag to indicate if the result images should be included in the export"},"name":"include_result_images","in":"query"}],"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/batch/{batch_id}/{image_name}":{"get":{"tags":["api"],"summary":"Get Image Details","description":"Retrieve detail information for a single image\n\n- **batch_id**: the batch id as returned by `POST /batch`\n- **image_name**: the image name as returned by `GET /batch/<batch_id>`","operationId":"get_image_details_api_batch__batch_id___image_name__get","parameters":[{"required":true,"schema":{"title":"Batch Id","type":"string"},"name":"batch_id","in":"path"},{"required":true,"schema":{"title":"Image Name","type":"string"},"name":"image_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/batch/{batch_id}/{image_name}/export":{"get":{"tags":["api"],"summary":"Export Image","description":"Export all information about a single image\n\nThis endpoint returns a ZIP file.\n\n- **batch_id**: the batch id as returned by `POST /batch`\n- **image_name**: the image name as returned by `GET /batch/<batch_id>`\n- **include_originals**: flag to indicate if the original images should be included in the export\n- **include_result_images**: flag to indicate if the result images should be included in the export","operationId":"export_image_api_batch__batch_id___image_name__export_get","parameters":[{"required":true,"schema":{"title":"Batch Id","type":"string"},"name":"batch_id","in":"path"},{"required":true,"schema":{"title":"Image Name","type":"string"},"name":"image_name","in":"path"},{"description":"flag to indicate if the original images should be included in the export","required":true,"schema":{"title":"Include Originals","type":"boolean","description":"flag to indicate if the original images should be included in the export"},"name":"include_originals","in":"query"},{"description":"flag to indicate if the result images should be included in the export","required":true,"schema":{"title":"Include Result Images","type":"boolean","description":"flag to indicate if the result images should be included in the export"},"name":"include_result_images","in":"query"}],"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_submit_batch_api_batch_post":{"title":"Body_submit_batch_api_batch_post","required":["image_files"],"type":"object","properties":{"tags":{"title":"Tags","type":"array","items":{"type":"string"},"default":[]},"image_files":{"title":"Image Files","type":"array","items":{"type":"string","format":"binary"},"description":"a list of images to analysis"}}},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"type":"string"}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}}}}}