# BULK API

{% hint style="info" %}
**SINGLE API vs BULK API**

**SINGLE API** sends **one image per request.**

Tagging results are received immediately on the response (**SYNCHRONOUS** Method)

**BULK API** sends **multiple images per request**.

Once the tagging tasks are complete within the request, the tagging results can be received through a separate API request (**ASYNCHRONOUS** Method)
{% endhint %}

## BULK API Flow

* **POST endpoint: POST /bulk**
* **Append endpoint: PUT /bulk/{status id}**
* **Status endpoint: GET /bulk/{task id}/status**
* **Result endpoint: GET /bulk/{task id}?offset=0\&size=100**

1. The client sends multiple images (max 1,000 per request) in a request and receives 202(Accepted) status code and TASK ID from the server.
2. If the client wants to add additional images to the TASK ID, they can make a request to the **Append endpoint**.
3. The client can make a GET request to the **Status endpoint** to retrieve the status of the TASKS. Once the "TASK\_DONE" value is received, it means tagging results are available through the **Result endpoint**.
4. The client makes a GET request to the **Result Endpoint** to receive the tagging results (max 100 per request).

{% hint style="info" %}
**What is a TASK ID?**

***

**BULK API is managed through TASKs**

TASK ID is given through the response from the POST endpoint.

This ID can be used to check the TASK's status and its tagging results.\
\
**Append endpoint can be used to make additional tagging requests to an existing TASK.**

For example, to tag 3,000 images the client must make three POST requests with 1,000 images each. This means 3 batches are managed separately.

Instead, they can use the TASK ID from the first POST request as an input to the append endpoint to manage all 3,000 images from on TASK.

(There is no limit to the total number of images for a TASK)\\

**GET /bulk API can be used to see statuses for all TASK IDs.**
{% endhint %}

{% hint style="info" %}
**What is an IMAGE ID?**

All images are managed through a TASK.

**Each image has a unique Image ID within a TASK.**
{% endhint %}

## POST /bulk

### Basic Information <a href="#post-bulk-common" id="post-bulk-common"></a>

The Header information required to make a request to the TAGGER BULK API URI is as follows.

***

| **Method** |                                      **Request URI**                                     |                                 **Required Header**                                 |
| :--------: | :--------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------: |
|  **POST**  | [https://api.omnious.com/tagger/v2.12/bulk](https://api.omnious.com/tagger/v2/tags/bulk) | <ul><li>x-api-key : API key For Authorization</li><li>API Key \[Required]</li></ul> |

### Request <a href="#post-bulk-request" id="post-bulk-request"></a>

**\[HTTP Request Header]**

POST /tagger/v2.12/bulk HTTP/1.1\
Host : api.omnious.com\
Content-Type: application/json\
x-api-key : {API Key provided by Omnious}

**\[HTTP Request Body]**

| **Field Name**                               | **Data Type**  | **Description**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | **Required** |
| -------------------------------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| albumName                                    | string         | <p>Album Name where requested images will be stored<br></p><p>Automatically Created if not defined</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | X            |
| option                                       | array          | <p>Options currently supported: "STRICT"</p><ul><li>STRICT: The whole request fails if at least one taggingRequest fails on request validation stage.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | X            |
| defaultDetection                             | array          | <p>Default value is used if no value is provided to the defaultDetection field.<br></p><p>default: \["TOP", "BOTTOM", "WHOLEBODY", "SWIMWEAR"]<br><br>Available Values: <strong>TOP, BOTTOM, WHOLEBODY, SWIMWEAR, SHOES, BAG, HAT, JEWELRY, ACCESSORY</strong></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | X            |
| description                                  | string         | <p>Description of the task</p><p>(MAX 1,024 characters)</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | X            |
| taggingRequest                               | string         | Product ID on the client's database.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | O            |
| taggingRequest\[].image                      | object         | Object containing the type of image to be requested and description of the given type.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | O            |
| taggingRequest\[].image.type                 | string         | Type of the requested image. currently only **url type** is supported                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | O            |
| taggingRequest\[].image.content              | string         | <p>Information of the image with regards to its type.</p><p><strong>url type</strong>: URL information of the requested image.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | O            |
| taggingRequest\[].context                    | object         | Object containing additional information.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | O            |
| taggingRequest\[].context.id                 | string         | <p>ID of the requested image.</p><p>It must be given a unique Id within a task.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | O            |
| taggingRequest\[].context.detection          | Array\[string] | <ul><li>value : <strong>TOP, BOTTOM, WHOLEBODY, SWIMWEAR, SHOES, BAG, HAT, JEWELRY, ACCESSORY</strong></li><li>When not defined: defaultDetection value is applied.</li><li>To tag clothing only.</li><li>detection: \["TOP", "BOTTOM", "WHOLEBODY", "SWIMWEAR"]</li><li><p>To tag Accessories only</p><ul><li>detection :\["ACCESSORY"]</li><li>Accessories are provided as Beta service until further notice.</li></ul></li><li><p>To tag Jewelry only</p><ul><li>detection: \[“JEWELRY”]</li><li>Jewelry is provided as Beta service until further notice.</li></ul></li><li><p>To tag Hats only</p><ul><li>detection :\["HAT"]</li><li>Hats is provided as Beta service until further notice.</li></ul></li><li><p>To tag Bags only</p><ul><li>detection:\["BAG"]</li></ul></li><li><p>To tag Shoes only</p><ul><li>detection:\["SHOES"]</li></ul></li><li><p>To tag Skirts and Pants from clothing only</p><ul><li>detection: \["BOTTOM"]</li></ul></li><li><p>To tag all Clothing Types and Shoes</p><ul><li>detection: \["TOP", "BOTTOM", "WHOLEBODY", "SWIMWEAR", "SHOES"]<br></li></ul></li><li><p>To tag Tops from Clothing and Shoes</p><ul><li>detection: \["TOP", "SHOES"]</li></ul></li><li><p>To tag all supported types (Clothing, Hats, Bags, Shoes)</p><ul><li>detection: \["TOP", "BOTTOM", "WHOLEBODY", "SWIMWEAR", "SHOES", "HAT", "BAG", "JEWELRY", "ACCESSORY"</li></ul></li></ul> | X            |
| taggingRequest\[].context.gender             | string         | <p>Gender information of the product</p><p>ex) male, female, unisex</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | X            |
| taggingRequest\[].context.brand              | string         | Brand name of product                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | X            |
| taggingRequest\[].context.currency           | string         | <p>Currency (KRW)</p><p>EX) KRW or USD</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | X            |
| taggingRequest\[].context.price              | string         | Product price                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | X            |
| taggingRequest\[].context.age                | Array\[string] | <p>The target age group of the product</p><p>Example) <code>10s</code>, <code>early20s</code>, <code>mid-late20s</code>, <code>early30s</code>, <code>mid-late30s</code>, <code>40s</code>, <code>over50s</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | X            |
| taggingRequest\[].context.keywords           | string         | <p>Product keywords</p><p>Example) <code>summer onepiece</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | X            |
| taggingRequest\[].context.productContentName | string         | Product name of the requested image                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | X            |
| taggingRequest\[].context.season             | string         | <p>Season information about the product</p><p>Example) <code>19SS</code>, <code>19FW</code>, <code>20SS</code>, <code>20FW</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | X            |

#### **Example Request**

```javascript
{
    "albumName": "Album name of your choice",
    "option": ["STRICT"],
    "defaultDetection": ["TOP"],
    "description": "Description",
    "taggingRequest": [
        {
            "image": {
                "type": "url",
                "content": "URL of the image to be analyzed"
            },
            "context": {
                "id": "imageID1",
                "detection": ["TOP"],
                "gender": "male",
                "brand": "NIKE",
                "currency": "USD",
                "price": 299.99,
                "age": ["early20s"],
                "keywords": "bling bling, test",
                "productContentName": "dress",
                "season": "19SS"
            }
        },
        {
            "image": {
                "type": "url",
                "content": "URL of the image to be analyzed"},
                "context": {
                    "id": "ImageID2",
                    "brand": "NIKE"
                }
        }
    ]
}
```

### Response <a href="#post-bulk-response" id="post-bulk-response"></a>

| Field ID                                          | Data Type                 | **Description**                                                                                                                                                                                        |
| ------------------------------------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| taskId                                            | string                    | Created Task ID                                                                                                                                                                                        |
| albumName                                         | string                    | Album name where requested images will be stored.                                                                                                                                                      |
| taskExpiredAt                                     | string                    | <p>Task expiry time.</p><p>You cannot request additional PUT requests after the task has expired.</p>                                                                                                  |
| validation                                        | object                    | <p>Validation results.</p><p>Only the images that have passed validation will be tagged.</p><p>ex)</p><p>Out of total 10 images, if 2 images failed validation, the result is - accept:8 failure:2</p> |
| validation.accept                                 | int                       | The number of requests that passed validation                                                                                                                                                          |
| validation.failure                                | int                       | The number of requests that failed validation                                                                                                                                                          |
| failureList                                       | <p>object</p><p>array</p> | <p>Failed request information.</p><p>Contains data from the request and its respective error message</p>                                                                                               |
| failureList\[].request                            | object                    | Failed request information                                                                                                                                                                             |
| failureList\[].request.image                      | object                    | Failed request information (image)                                                                                                                                                                     |
| failureList\[].request.image.type                 | string                    | Failed request information. (Fail type)                                                                                                                                                                |
| failureList\[].request.image.content              | string                    | <p>Description of the failed image.</p><p>base64 type: string of the requested image encoded in base64</p>                                                                                             |
| failureList\[].request.context                    | object                    | Additional information of the failed request                                                                                                                                                           |
| failureList\[].request.context.id                 | string                    | Image Id of the image from the failed request                                                                                                                                                          |
| failureList\[].request.context.detection          | array                     | Detection information of the image from the failed request                                                                                                                                             |
| failureList\[].request.context.gender             | string                    | Gender information of the image from the failed request                                                                                                                                                |
| failureList\[].request.context.brand              | string                    | Brand information of the image from the failed request                                                                                                                                                 |
| failureList\[].request.context.currency           | string                    | Currency of the image from the failed request                                                                                                                                                          |
| failureList\[].request.context.price              | string                    | Price of the image from the failed request                                                                                                                                                             |
| failureList\[].request.context.age                | Array\[string]            | Target age group information of the image from the failed request                                                                                                                                      |
| failureList\[].request.context.keywords           | string                    | Keyword information of the image from the failed request                                                                                                                                               |
| failureList\[].request.context.productContentName | string                    | Product name of the image from the failed request                                                                                                                                                      |
| failureList\[].request.context.season             | string                    | Season information of the image from the failed request                                                                                                                                                |
| failureList\[].errorMessage                       | string                    | Error message of the image from the failed request                                                                                                                                                     |

#### Example Response

```javascript
{
    "taskId": "f48ff440-488c-4df4-8f70-0a0320283dca",
    "albumName": "Album Name",
    "taskExpiredAt": "2021-08-24T05:50:38",
    "validation": {
        "accept": 4,
        "failure": 2
    },
    "failureList": [
        {
            "request": {
                "image": {
                    "type": "url",
                    "content": "https://wrong_image_url_nononoasdf1.jpg"
                },
                "context": {
                    "id": "wrong_id_1",
                    "detection": ["n"],
                    "gender": "male",
                    "brand": "NIKE",
                    "currency": "USD",
                    "price": 299.99,
                    "age": ["early20s"],
                    "keywords": "bling bling, test",
                    "productContentName": "dress",
                    "season": "19SS"
                }
            },
            "errorMessage": "The 'NoneType' field value 'TOP,BOTTOM,WHOLEBODY,SWIMWEAR,SHOES,BAG,HAT,JEWELRY,ACCESSORY' does not match any of the allowed values!"
        },
        {
            "request": {
                "image": {
                    "type": "url",
                    "content": "https://wrong_image_url_nononoasdf2.jpg"
                },
                "context": {
                    "id": "wrong_id_2",
                    "detection": ["n"]
                }
            },
            "errorMessage": "The 'NoneType' field value 'TOP,BOTTOM,WHOLEBODY,SWIMWEAR,SHOES,BAG,HAT,JEWELRY,ACCESSORY' does not match any of the allowed values!"
        },
    ]
}
```

## PUT /bulk/{task id}

### Basic Information <a href="#put-bulk-common" id="put-bulk-common"></a>

Add additional tagging requests to a given TASK.

No more requests can be added after the expiry time (taskExpireAt).

The expiry time is a minimum 10 minutes after the TASK created time. 10 minutes is extended after every successful PUT request.

***This API is the same as POST /bulk API, but \`description\` and \`albumName\` options will remain the same in the result even if a new value was provided.***

Header information required for TAGGER BULK PUT API is as follows

***

| **Method** |                                                   **Request URI**                                                   |                                                                         **Required Header**                                                                        |
| :--------: | :-----------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|   **PUT**  | [https://api.omnious.com/tagger/v2.12/bulk/{task-id}](https://api.omnious.com/tagger/v2.12/tags/bulk/%7Btask-id%7D) | <ul><li>x-api-key : API Key for authentication \[Required]</li><li><p>task id: TASK ID generated from the initial POST API request</p><p>\[Required]</p></li></ul> |

### Request <a href="#put-bulk-request" id="put-bulk-request"></a>

**\[HTTP Request Header]**

PUT /tagger/v2.12/bulk/{task id} HTTP/1.1\
Host : api.omnious.com\
Content-Type: application/json\
x-api-key : {API Key retrieved from Omnious}\
task id: TASK ID generated from the initial POST API request.

**\[HTTP Request Body]**

* **Same as POST /bulk API**

### Response <a href="#put-bulk-response" id="put-bulk-response"></a>

* **Same as POST /bulk API**

## GET /bulk

### Basic Information <a href="#get-tasks-common" id="get-tasks-common"></a>

Header information required for TAGGER BULK GET API request is as follows.

***

| **Method** |                                       **Request URI**                                       |                          **Required Header**                         |
| :--------: | :-----------------------------------------------------------------------------------------: | :------------------------------------------------------------------: |
|   **GET**  | [https://api.omnious.com/tagger/v2.12/bulk](https://api.omnious.com/tagger/v2.12/tags/bulk) | <ul><li>x-api-key : API Key for authentication \[Required]</li></ul> |

### Request <a href="#get-tasks-request" id="get-tasks-request"></a>

**\[HTTP Request Header]**

GET /tagger/v2.12/bulk HTTP/1.1\
Host : api.omnious.com\
Content-Type: application/json\
x-api-key : {API Key provided by Omnious}

### Response <a href="#get-tasks-response" id="get-tasks-response"></a>

| **Field Name**                 | **Data Type** | **Description**                                                                  |
| ------------------------------ | ------------- | -------------------------------------------------------------------------------- |
| data                           | object        | Object containing task information                                               |
| data.tasks                     | array         | Array containing task information                                                |
| data.tasks\[].taskId           | string        | Task identifier                                                                  |
| data.tasks\[].count            | int           | Object containing various count information for the requests in a task           |
| data.tasks\[].count.total      | int           | Number of requests in a task                                                     |
| data.tasks\[].count.done       | int           | Number of successful requests in a task                                          |
| data.tasks\[].count.processing | int           | Number of requests being processed in a task                                     |
| data.tasks\[].count.failure    | int           | Number of failed requests in a task                                              |
| data.tasks\[].description      | string        | <p>Task description</p><p>(Information provided on request)</p>                  |
| data.tasks\[].taskStatus       | string        | <p>Current status of task</p><p>value: TASK\_PROCESSING<em>, TASK\_DONE</em></p> |
| data.tasks\[].taskExpireAt     | string        | After task expires, futher PUT request is not possible                           |
| data.tasks\[].resultExpiredAt  | string        | Task result expiry time. After expiry, task results will no longer be available  |
| data.tasks\[].createDate       | string        | Task created time                                                                |
| error                          | string        | Error information of the request                                                 |
| status                         | string        | Sucess/fail status of the request                                                |

#### Example Response

```javascript
{
    "data": {
        "tasks": [
            {
                "taskId": "00000000-0000-0000-0002-000000000200",
                "count": {
                    "total": 4,
                    "done": 3,
                    "processing": 1,
                    "failure": 0
                }, 
                "description": "test", 
                "taskStatus": "TASK_PROCCESSING", 
                "taskExpiredAt": "2021-08-18T01:50:02", 
                "resultExpiredAt": "2022-08-18T01:40:02", 
                "createDate": "2021-08-18T01:37:43"
            }, 
            {
                "taskId": "00000000-0000-0000-0002-000000000201", 
                "count": {
                    "total": 2, 
                    "done": 2, 
                    "processing": 0, 
                    "failure": 0
                }, 
                "description": "test", 
                "taskStatus": "TASK_DONE", 
                "taskExpiredAt": "2021-08-19T00:21:16", 
                "resultExpiredAt": "2022-08-19T00:11:16", 
                "createDate": "2021-08-19T00:11:16"
            }
        ]
    }, 
    "error": None, 
    "status": "ok"
}
```

�

## GET /bulk/{task id}/status

### Basic Information <a href="#get-status-common" id="get-status-common"></a>

Header information required for TAGGER BULK TASK STATUS GET API request is as follows.

***

|  Method |                             **Request URI**                             |                                                                      **Required Header**                                                                      |
| :-----: | :---------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------: |
| **GET** | <p><https://api.omnious.com/tagger/v2.12/bulk/><br>{task id}/status</p> | <ul><li>x-api-key : API Key for authentication \[Required]</li><li><p>task id: TASK ID retrieved from the inital POST request</p><p>\[Required]</p></li></ul> |

### Request <a href="#get-status-request" id="get-status-request"></a>

**\[HTTP Request Header]**

GET /tagger/v2.12/bulk/{task id}/status HTTP/1.1\
Host : api.omnious.com\
Content-Type: application/json\
x-api-key : {API Key provided by Omnious}\
task id: TASK ID retrieved from the initial POST request

### Response <a href="#get-status-response" id="get-status-response"></a>

| **Field Name**        | **Data Type** | **Description**                                                                  |
| --------------------- | ------------- | -------------------------------------------------------------------------------- |
| data                  | object        | Object containing task information                                               |
| data.taskId           | string        | Task identifier                                                                  |
| data.count            | int           | Object containing various count information for the requests in a task           |
| data.count.total      | int           | Number of requests in a task                                                     |
| data.count.done       | int           | Number of successful requests in a task                                          |
| data.count.processing | int           | Number of requests being processed in a task                                     |
| data.count.failure    | int           | Number of failed requests in a task                                              |
| data.description      | string        | <p>Task description</p><p>(Information provided on request)</p>                  |
| data.taskStatus       | string        | <p>Current status of task</p><p>value: TASK\_PROCESSING<em>, TASK\_DONE</em></p> |
| data.taskExpireAt     | string        | After task expires, futher PUT request is not possible                           |
| data.resultExpiredAt  | string        | Task result expiry time. After expiry, task results will no longer be available  |
| data.createDate       | string        | Task created time                                                                |
| error                 | string        | Error information of the request                                                 |
| status                | string        | Success/fail status of the request                                               |

#### Example Response

```javascript
{
    "data": {
        "taskId": "24ad5226-7c94-48df-bdb1-24480015369e",
        "count": {
            "total": 8,
            "done": 8,
            "processing": 0,
            "failure": 0
        },
        "description": null,
        "taskStatus": "TASK_DONE",
        "taskExpiredAt": "2021-08-24T07:09:08",
        "resultExpiredAt": "2022-08-24T06:59:08",
        "createDate": "2021-08-24T06:59:08"
    },
    "error": null,
    "status": "ok"
}
```

## GET /bulk/{task id}?offset=0\&size=100

### Basic Information <a href="#get-result-common" id="get-result-common"></a>

Header information required for TAGGER BULK TASK RESULT GET API request is as follows.

|  Method |                                   **Request URI**                                   |                                                                                                                                                                                                                                                   **Required Header**                                                                                                                                                                                                                                                   |
| :-----: | :---------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| **GET** | <p><https://api.omnious.com/tagger/v2.12/bulk/><br>{task id}?offset=0\&size=100</p> | <ul><li>x-api-key : API Key for authentication \[Required]</li><li><p>task id: TASK ID retrieved from the initial POST request</p><p>\[Required]</p></li><li>accept-language : Language to receive tagging results</li></ul><p>en: English (default)</p><p>ko: Korean</p><p>zh: Chinese</p><p>ja: Japanese</p><ul><li>offset: location from where task results will be retrieved from (Results are saved in the order requests were made).</li><li>size: how many items to retreive from the offset location.</li></ul> |

### Request <a href="#get-result-request" id="get-result-request"></a>

**\[HTTP Request Header]**

GET /tagger/v2.12/bulk/{task id}?offset=0\&size=100 HTTP/1.1\
Host : api.omnious.com\
Content-Type: application/json\
x-api-key : {API Key provided by Omnious}\
accept-language : {Select language}\
task id: post TASK ID retrieved from the initial POST request.

### Response <a href="#get-result-response" id="get-result-response"></a>

* **Results will only be available after all images within a task have been tagged.**

| **Field Name**                | **Data Type**             | **Description**                             |
| ----------------------------- | ------------------------- | ------------------------------------------- |
| data                          | object                    | Object containing task results information  |
| data.taskInfo                 | object                    | Object containing basic task information    |
| data.taskInfo.totalCount      | int                       | Total number of images in a task            |
| data.taskInfo.offset          | int                       | Offset information of the result data       |
| data.taskInfo.size            | int                       | Size information of the result data         |
| data.results                  | <p>array</p><p>object</p> | Object containing image tagging information |
| data.results\[].id            | string                    | Image identifier                            |
| data.results\[].taggingResult | object                    | Tagging result (Same as SINGLE API results) |

#### Example Response

```javascript
{
    "data": {
        "taskInfo": {
            "totalCount": 3,
            "offset": 0,
            "size": 100
        },
        "results": [
            {
                "id": "top_2.jpeg",
                "taggingResult": {
                    "imageInfo": [],
                    "genderInfo": {
                        "id": "T0574",
                        "name": "female"
                    },
                    "objects": [
                        {
                            "type": "CLOTHING",
                            "tags": [
                                {
                                    "category": {
                                        "id": "T0357",
                                        "name": "tops",
                                        "confidence": 1.0
                                    },
                                    "position": {
                                        "x": 0.5183625,
                                        "y": 0.45390624
                                    },
                                    "item": {
                                        "id": "T0008",
                                        "name": "tank-top",
                                        "confidence": 0.51910496
                                    },
                                    "colors": [
                                        {
                                            "id": "T0324",
                                            "name": "black",
                                            "confidence": 0.9998622
                                        }
                                    ],
                                    "length": {
                                        "id": "T0467",
                                        "name": "cropped",
                                        "confidence": 0.99343336
                                    },
                                    "sleeveLength": {
                                        "id": "T0079",
                                        "name": "sleeveless",
                                        "confidence": 0.9990767
                                    },
                                    "neckLine": {
                                        "id": "T0294",
                                        "name": "u-neck",
                                        "confidence": 0.843747
                                    },
                                    "prints": [
                                        {
                                            "id": "T0822",
                                            "name": "lettering",
                                            "confidence": 0.89514226
                                        }
                                    ],
                                    "textures": [
                                        {
                                            "id": "T1176",
                                            "name": "synthetic/polyester",
                                            "confidence": 0.4131982
                                        }
                                    ],
                                    "details": [
                                        {
                                            "id": "T0833",
                                            "name": "strap",
                                            "confidence": 0.30810547
                                        }
                                    ],
                                    "looks": [
                                        {
                                            "id": "T0141",
                                            "name": "casual",
                                            "confidence": 0.98714685
                                        }
                                    ],
                                    "fit": {
                                        "id": "T0477",
                                        "name": "normal",
                                        "confidence": 0.6773367
                                    },
                                    "colorDetail": [
                                        {
                                            "id": "#2b272b",
                                            "name": "black-onyx",
                                            "confidence": 0.87550867
                                        },
                                        {
                                            "id": "#f0f0f0",
                                            "name": "real-white5",
                                            "confidence": 0.049204588
                                        },
                                        {
                                            "id": "#b5acab",
                                            "name": "ashes-of-roses",
                                            "confidence": 0.020347761
                                        },
                                        {
                                            "id": "#5a4743",
                                            "name": "shopping-bag",
                                            "confidence": 0.017018128
                                        },
                                        {
                                            "id": "#e2bea2",
                                            "name": "amberlight",
                                            "confidence": 0.014798372
                                        },
                                        {
                                            "id": "#918c8f",
                                            "name": "gull",
                                            "confidence": 0.012023677
                                        },
                                        {
                                            "id": "#56352d",
                                            "name": "chocolate-fondant",
                                            "confidence": 0.011098779
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "notMatchedObject": []
                }
            },
            {
                "id": "top_1.jpeg",
                "taggingResult": {
                    "imageInfo": [],
                    "genderInfo": {
                        "id": "T0575",
                        "name": "unknown"
                    },
                    "objects": [
                        {
                            "type": "CLOTHING",
                            "tags": [
                                {
                                    "category": {
                                        "id": "T0365",
                                        "name": "casual-tops",
                                        "confidence": 1.0
                                    },
                                    "position": {
                                        "x": 0.49500003,
                                        "y": 0.5509766
                                    },
                                    "item": {
                                        "id": "T0003",
                                        "name": "t-shirts",
                                        "confidence": 0.7397298
                                    },
                                    "colors": [
                                        {
                                            "id": "T0325",
                                            "name": "white",
                                            "confidence": 0.9995327
                                        }
                                    ],
                                    "length": {
                                        "id": "T0945",
                                        "name": "long",
                                        "confidence": 0.6230829
                                    },
                                    "sleeveLength": {
                                        "id": "T0079",
                                        "name": "sleeveless",
                                        "confidence": 0.99896467
                                    },
                                    "neckLine": {
                                        "id": "T0293",
                                        "name": "round-neck",
                                        "confidence": 0.98163325
                                    },
                                    "prints": [
                                        {
                                            "id": "T0824",
                                            "name": "solid",
                                            "confidence": 0.99883574
                                        }
                                    ],
                                    "textures": [
                                        {
                                            "id": "T0807",
                                            "name": "cotton",
                                            "confidence": 0.67741483
                                        }
                                    ],
                                    "details": [
                                        {
                                            "id": "T0670",
                                            "name": "line",
                                            "confidence": 0.24584961
                                        }
                                    ],
                                    "looks": [
                                        {
                                            "id": "T0141",
                                            "name": "casual",
                                            "confidence": 0.98154646
                                        }
                                    ],
                                    "fit": {
                                        "id": "T0477",
                                        "name": "normal",
                                        "confidence": 0.8062806
                                    },
                                    "colorDetail": [
                                        {
                                            "id": "#edf1fe",
                                            "name": "brilliant-white",
                                            "confidence": 0.989307
                                        },
                                        {
                                            "id": "#dbbeb7",
                                            "name": "peach-whip",
                                            "confidence": 0.0106930155
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "notMatchedObject": []
                }
            },
            {
                "id": "pants_2.jpeg",
                "taggingResult": {
                    "imageInfo": [],
                    "genderInfo": {
                        "id": "T0575",
                        "name": "unknown"
                    },
                    "objects": [
                        {
                            "type": "CLOTHING",
                            "tags": [
                                {
                                    "category": {
                                        "id": "T0369",
                                        "name": "pants",
                                        "confidence": 1.0
                                    },
                                    "position": {
                                        "x": 0.4978125,
                                        "y": 0.23466797
                                    },
                                    "item": {
                                        "id": "T0051",
                                        "name": "chino-pants",
                                        "confidence": 0.49502462
                                    },
                                    "colors": [
                                        {
                                            "id": "T0324",
                                            "name": "black",
                                            "confidence": 0.98704755
                                        }
                                    ],
                                    "length": {
                                        "id": "T0475",
                                        "name": "short",
                                        "confidence": 0.8220196
                                    },
                                    "prints": [
                                        {
                                            "id": "T0824",
                                            "name": "solid",
                                            "confidence": 0.99687505
                                        }
                                    ],
                                    "textures": [
                                        {
                                            "id": "T0807",
                                            "name": "cotton",
                                            "confidence": 0.5936825
                                        }
                                    ],
                                    "details": [
                                        {
                                            "id": "T1040",
                                            "name": "pockets",
                                            "confidence": 0.23388672
                                        }
                                    ],
                                    "looks": [
                                        {
                                            "id": "T0141",
                                            "name": "casual",
                                            "confidence": 0.96245253
                                        }
                                    ],
                                    "fit": {
                                        "id": "T0477",
                                        "name": "normal",
                                        "confidence": 0.9640701
                                    },
                                    "shape": {
                                        "id": "T0494",
                                        "name": "straight",
                                        "confidence": 0.9999956
                                    },
                                    "colorDetail": [
                                        {
                                            "id": "#323137",
                                            "name": "blue-graphite",
                                            "confidence": 0.9291391
                                        },
                                        {
                                            "id": "#f0f0f0",
                                            "name": "real-white5",
                                            "confidence": 0.049668875
                                        },
                                        {
                                            "id": "#593c39",
                                            "name": "brown-stone",
                                            "confidence": 0.010860927
                                        },
                                        {
                                            "id": "#7f7c81",
                                            "name": "silver-filigree",
                                            "confidence": 0.010331126
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "notMatchedObject": []
                }
            },
        ]
    },
    "error": null,
    "status": "ok"
}
```
