app/static/docs/data.json

[
    {
        "color":"#df7fff",
        "route_name":"get_crops",
        "route":"/api/get_crops",
        "method":"POST",
        "summary":"This route is used to get face crops from any image",
        "request_params":[
            {"name":"image","summary":"Image to get face crops from.","type":"File","required":"*"},
            {"name":"access_key","summary":"access key related with your account.","type":"json","required":"*"},
            {"name":"settings-parameter","summary":"pass any settings for example \"d_thres\":0.3 .","type":"json","required":""}
        ],
        "response_params":[
            {"name":"message","summary":"\"success\" if everything is fine.","type":"Text"},
            {"name":"crops","summary":"return list of crop images.","type":"list of base64 values"}
        ]
    },
    
    {
        "color":"#acff7f",
        "route_name":"face_recognize",
        "route":"/api/face_recognize",
        "method":"POST",
        "summary":"This route is used to do face recognition based on the images in the db.",
        "request_params":[
            {"name":"image","summary":"Image to do face recognition on.","type":"File","required":"*"},
            {"name":"access_key","summary":"access key related with your account.","type":"json","required":"*"},
            {"name":"settings-parameter","summary":"pass any settings for example \"d_thres\":0.3 .","type":"json","required":""}
        ],
        "response_params":[
            {"name":"message","summary":"\"success\" if everything is fine.","type":"Text"},
            {"name":"pred_image","summary":"image with prediction boxes","type":"base64"},
            {"name":"person_ids","summary":"list of person_id(\"face\" if face is not found)","type":"list of string"},
            {"name":"crops","summary":"return list of cropped images.","type":"list of base64 values"},
            {"name":"objs_found","summary":"dictionary of faces found with coordinates and names .","type":"dictionary"}
        ]
    }
]