Batch API

Request Frenzy tags for a batch of products.

Prediction Request

POST https://api.frenzy.ai/imageUrlTextProcess

Submit request for one product.

Headers

Name	Type	Description
Content-Type	string	application/json
X-Frenzy-Authorization	string	API key provided at the time of account
X-Frenzy-Single-Object-Images	string	true - If your images consist of only single objects. false - If your images consist of multiple objects. Default value- false
X-Frenzy-Webhook-Endpoint	string	URL of the listening server where the results will be redirected. If left blank, the responses will be delivered to the system which made the request.

Request Body

Name	Type	Description
id	string	It is used to uniquely identify the request and will be included in the response.
imageurl	string	Image URLs for the product.
text	string	It contains the textual product description.

200 Prediction request successful.

{
  "1": {
    "Products": [
      {
        "bounding_box": [76.27632141113281,152.2967987060547,859.9697875976562,1097.4202880859375],
        "category": {"description": ["dresses"],"prob": "0.67"},
        "style": {"description": ["slip dress"],"prob": "0.87"},
        "color": {"description": ["brown"],"prob": "0.25"},
        ...
      },
      {
        "bounding_box": [[124.05464935302734,585.519775390625,376.329345703125,824.7747802734375]],
        "category": {"description": ["bags"],"prob": "0.95"},
        "style": {"description": ["clutches"],"prob": "0.87"},
        "color": {"description": ["black"],"prob": "0.25"},
        ...
      }
    ]
  },
  "2": {
    "Products": [
      {
        "bounding_box": [76.27632141113281,152.2967987060547,859.9697875976562,1097.4202880859375],
        "category": {"description": ["dresses"],"prob": "0.67"},
        "style": {"description": ["slip dress"],"prob": "0.87"},
        "color": {"description": ["brown"],"prob": "0.25"},
        ...
      },
      {
        "bounding_box": [[124.05464935302734,585.519775390625,376.329345703125,824.7747802734375]],
        "category": {"description": ["bags"],"prob": "0.95"},
        "style": {"description": ["clutches"],"prob": "0.87"},
        "color": {"description": ["black"],"prob": "0.25"},
        ...
      }
    ]
  }
}

202 Request has been accepted and the response would be forwarded to the webhook address.

400 No data was found in the request body.

403 API key is missing/incorrect.

500 Prediction request unsuccessful.

For more details on the request body parameters, see the request format page

NOTE: It is advised to use a Webhook listener for Batch Requests, as they take more time to process.