Request Object

The product information is sent as JSON

Request Object Format

The request data sent to the API is a JSON array:

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

1. A request without any 'imageurl' and 'text' will not be processed. The API requires at least one of them.

2. In case there is no 'imageurl' or 'text' for a product, then do not include that key in the request.

Example Request

CASE 1: Multiple-Object Image without Webhook endpoint

curl --location --request POST 'https://api.frenzy.ai/imageUrlTextProcess' \
--header 'Content-Type: application/json' \
--header 'X-Frenzy-Authorization: API_KEY' \
--data-raw '[
    {
        "id": "123",
        "imageurl": "http://image_url",
        "text": "product description of the image"
    }
]'

CASE 2: Multiple-Object Image with Webhook endpoint

curl --location --request POST 'https://api.frenzy.ai/imageUrlTextProcess' \
--header 'Content-Type: application/json' \
--header 'X-Frenzy-Authorization: API_KEY' \
--header 'X-Frenzy-Webhook-Endpoint: https://webhook_endpoint' \
--data-raw '[
    {
        "id": "123",
        "imageurl": "http://image_url",
        "text": "product description of the image"
    }
]'

CASE 3: Single-Object Image without Webhook endpoint

curl --location --request POST 'https://api.frenzy.ai/imageUrlTextProcess' \
--header 'Content-Type: application/json' \
--header 'X-Frenzy-Authorization: API_KEY' \
--header 'X-Frenzy-Single-Object-Images: true' \
--data-raw '[
    {
        "id": "123",
        "imageurl": "http://image_url",
        "text": "product description of the image"
    }
]'

CASE 4: Single-Object Image with Webhook endpoint

curl --location --request POST 'https://api.frenzy.ai/imageUrlTextProcess' \
--header 'Content-Type: application/json' \
--header 'X-Frenzy-Authorization: API_KEY' \
--header 'X-Frenzy-Single-Object-Images: true' \
--header 'X-Frenzy-Webhook-Endpoint: https://webhook_endpoint' \
--data-raw '[
    {
        "id": "123",
        "imageurl": "http://image_url",
        "text": "product description of the image"
    }
]'

For more details about how to submit individual requests, see the single request page.