# 🛠 Endpoints | METHOD | URL | DESCRIPTION | | ------ | ------------------------------------------------------------- | ----------------------------------------- | | GET | `https://alcohol-label-recognition.p.rapidapi.com/v1/version` | Get a service version. | | POST | `https://alcohol-label-recognition.p.rapidapi.com/v1/results` | Perform image analysis and get results. | ## 👉 Get version Retrieve the current version of the service, formatted as `vX.Y.Z`, where X indicates the API version. | PROPERTY | DESCRIPTION | | ---------------- | ---------------------------------------------------------------| | Endpoint | `https://alcohol-label-recognition.p.rapidapi.com/v1/version` | | Method | `GET` | | Query parameters | – | | POST parameters | – | **Example** ```bash curl -X 'GET' 'https://alcohol-label-recognition.p.rapidapi.com/v1/version' \ -H 'X-RapidAPI-Key: ...' ```

Click here to view the response

``` v1.3.0 ```

## 👉 Analyze image and return results Initiate an image analysis and receive the results. | PROPERTY | DESCRIPTION | | ---------------- | -------------------------------------------------------------- | | Endpoint | `https://alcohol-label-recognition.p.rapidapi.com/v1/results` | | Method | `POST` | | POST parameters | `image`, `url` | **Passing image** Image can be passed by posting regular "multipart/form-data" in two alternative ways: * as binary file in `image` field * as URL to some public resource in `url` field Image must be a regular JPEG or PNG image (with or without transparency). Usually such images have extensions: `.jpg`, `.jpeg`, `.png`. The service accepts the following MIME types: * `image/jpeg` * `image/png` The size of the image file must be less than `16Mb`. The maximum allowed resolution is `4096x4096`. **Response schema** For responses with `200` HTTP code the type of response is JSON object with the following schema: ```json { "results": [ { "status": { "code": ..., "message": ... }, "name": ..., "md5": ..., "page": ..., "width": ..., "height": ..., "entities": [ { "kind": "array", "name": "alcohol-labels", "array": { ... } } ] } ] } ``` Primary fields: | Name | Type | Description | | --------------------------------------------------- | -------- | ------------------------------------------------------------- | | `results[].status.code` | `string` | Status code of image processing: `ok` or `failure`. | | `results[].status.message` | `string` | Human readable explanation for status of image processing. | | `results[].name` | `string` | Original image name passed in request (e.g. `bottle.jpg`). | | `results[].md5` | `string` | MD5 sum of original image passed in request. | | `results[].page` | `int` | Optinal page number (presented for multipage inputs only). | | `results[].width` | `int` | Optinal image width (presented for valid inputs only). | | `results[].height` | `int` | Optinal image height (presented for valid inputs only). | | `results[].entities[].array` | `array` | Recognized labels. | * The most important part of an output is `results[].entities[].array` – array of objects which encodes recognized labels. * Each label always has propery `drink` which defines the kind of the drink. Possible values: - beer - wine - vodka - whiskey - bourbon - brandy - cognac - rum - tekila - liqueur * The other properties of a label object depends on kind of the drink. - For example a `wine` label will contain the following properties (besides `drink`): + country + variety + vintage + region + abv - While a `beer` label will contain the following properties (besides `drink`, again): + brewery + country + abv + type * `N/A` – is special value for properties which is used in cases when the API can not identify proper value.

# 📌 Examples ## 👉 Recognize the whole text as single block ```bash curl -X 'POST' 'https://alcohol-label-recognition.p.rapidapi.com/v1/results' \ -H 'X-RapidAPI-Key: ...' \ -F 'image=@bottle.jpg' ```

Click here to view the response

```json { "results": [ { "status": { "code": "ok", "message": "Success" }, "name": "bottle.jpg", "md5": "a447c0aa2b2b89aa6ffb488317c0ab1e", "entities": [ { "kind": "array", "name": "alcohol-labels", "array": [ { "drink": "wine", "winery": "Tierra de Almas", "country": "Spain", "variety": "Tempranillo", "vintage": "2020", "region": "Rioja", "abv": "13%" }, { "drink": "beer", "brewery": "Löwenbräu", "country": "Germany", "abv": "0.0", "type": "Wheat Beer" } ] } ] } ] } ```

# ❗️ Possible errors ## 👉 The service can not process an image When a client sends an image that can not be processed for some reason(s), the service responds with `200` code and returns a JSON object in the same format as the format for successful analysis. In this case, the `results[].status.code` will have `failure` value and `results[].status.message` will contain relevant explanation. Example of possible reasons for the issue: * Unsupported MIME type * Image resolution exceeds limits * Corrupted image **Example response for image with unsupported MIME type:** ```json { "results": [ { "status": { "code": "failure", "message": "Can not load image." }, "name": "file.txt", "md5": "d41d8cd98f00b204e9800998ecf8427e", "entities": [] } ] } ``` ## 👉 Request size is too big Request size is limited by approximately `32Mb`. When a client sends a request that exceeds this limit, the service responds with `413` code. The typical reason for exceeding this limit is an overly large image. Taking into account additional HTTP overhead, we strongly recommend not passing image files of size more than `16Mb`. **Example response for overly big image:** ``` Error: Request Entity Too Large Your client issued a request that was too large. ``` ## 👉 Missing image When a client sends a request without an image, the service responds with `422` code and returns a JSON object. **Example response for request with missing image:** ```json {"detail":"Missing image or url field."} ```

# ❓ F.A.Q. ## 👉 Is this yet another wine recognition API? No. Alcohol Label Recognition API supports many kinds of drinks (including wine, of course): * **beer** * **wine** * **vodka** * **whiskey** * **bourbon** * **brandy** * **cognac** * **rum** * **tekila** * **liqueur** ## 👉 Which properties does it support for a label? It depends on the drink: * __beer__: brewery, country, abv, type * __wine__: winery, country, variety, vintage, region, abv * __vodka__: brand, country, abv * __whiskey__: brand, country, malt, (e.g. single, double, blended), abv * __bourbon__: brand, country, abv * __brandy__: brand, country, aging (e.g. VS, VSOP, XO)), abv * __cognac__: brand, country, aging (e.g. VS, VSOP, XO)), abv * __rum__: brand, country, color, abv * __tekila__: brand, country, abv, color * __liqueur__: brand, country, abv, color, base ## 👉 What will happen if the image contains multiple drinks of different kinds? This is not a problem! The API will recognize all labels and return information about all of them. ## 👉 How to pass an image as binary file? Post a file content as a "multipart/form-data" field named `image`. ```bash curl -X 'POST' 'https://alcohol-label-recognition.p.rapidapi.com/v1/results' \ -H 'X-RapidAPI-Key: ...' \ -F 'image=@bottle.jpg' ``` ## 👉 How to pass an image as URL? Post a URL to file as a "multipart/form-data" field named `url`. ```bash curl -X 'POST' 'https://alcohol-label-recognition.p.rapidapi.com/v1/results' \ -H 'X-RapidAPI-Key: ...' \ -F 'url=https://static.api4.ai/samples/alco-rec-1.jpg' ``` ## 👉 Where to find code examples? Code examples in Python, C#, JavaScript, Swift and other popular programming languages: https://gitlab.com/api4ai/examples/alco-rec ## 👉 Where to try live demo? * 🤖 Telegram demo bot: https://t.me/a4a_alco_rec_bot * 🔗 Web demo: [https://api4.ai/apis/alco-rec](https://api4.ai/apis/alco-rec?utm_source=rapidapi&utm_medium=referral&utm_campaign=alco-rec) ## 👉 I need support Feel free to contact API4AI team if you have any questions. * 📩 Email: hello@api4.ai * 💬 Telegram: https://t.me/a4a_support_bot