# StyleApi.PlaygroundApi

All URIs are relative to *http://api-prod.stylelens.io*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getImagesByKeyword**](PlaygroundApi.md#getImagesByKeyword) | **GET** /playgrounds/images | Query to search multiple objects
[**getImagesDatasetByCategory**](PlaygroundApi.md#getImagesDatasetByCategory) | **GET** /playgrounds/images/datasets/{source}/categories | Query to search multiple objects
[**getImagesDatasetCategoriesCountsByCategory**](PlaygroundApi.md#getImagesDatasetCategoriesCountsByCategory) | **GET** /playgrounds/images/datasets/{source}/categories/counts | Query to search category counts
[**getPlaygroundObjectsByUserImageFile**](PlaygroundApi.md#getPlaygroundObjectsByUserImageFile) | **POST** /playgrounds/objects | 
[**updateImagesDatasetByIds**](PlaygroundApi.md#updateImagesDatasetByIds) | **POST** /playgrounds/images/datasets/{source} | Update image


<a name="getImagesByKeyword"></a>
# **getImagesByKeyword**
> GetImagesByKeywordResponse getImagesByKeyword(opts)

Query to search multiple objects



### Example
```javascript
var StyleApi = require('style_api');

var apiInstance = new StyleApi.PlaygroundApi();

var opts = { 
  'keyword': "keyword_example", // String | 
  'categoryName': "categoryName_example", // String | 
  'offset': 56, // Number | 
  'limit': 56 // Number | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getImagesByKeyword(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **keyword** | **String**|  | [optional] 
 **categoryName** | **String**|  | [optional] 
 **offset** | **Number**|  | [optional] 
 **limit** | **Number**|  | [optional] 

### Return type

[**GetImagesByKeywordResponse**](GetImagesByKeywordResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getImagesDatasetByCategory"></a>
# **getImagesDatasetByCategory**
> GetImagesByCategoryResponse getImagesDatasetByCategory(source, opts)

Query to search multiple objects



### Example
```javascript
var StyleApi = require('style_api');

var apiInstance = new StyleApi.PlaygroundApi();

var source = "source_example"; // String | 

var opts = { 
  'category': "category_example", // String | 
  'offset': 56, // Number | 
  'limit': 56 // Number | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getImagesDatasetByCategory(source, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **source** | **String**|  | 
 **category** | **String**|  | [optional] 
 **offset** | **Number**|  | [optional] 
 **limit** | **Number**|  | [optional] 

### Return type

[**GetImagesByCategoryResponse**](GetImagesByCategoryResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getImagesDatasetCategoriesCountsByCategory"></a>
# **getImagesDatasetCategoriesCountsByCategory**
> GetImagesCategoriesCountsByCategoryResponse getImagesDatasetCategoriesCountsByCategory(source, opts)

Query to search category counts



### Example
```javascript
var StyleApi = require('style_api');

var apiInstance = new StyleApi.PlaygroundApi();

var source = "source_example"; // String | 

var opts = { 
  'category': "category_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getImagesDatasetCategoriesCountsByCategory(source, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **source** | **String**|  | 
 **category** | **String**|  | [optional] 

### Return type

[**GetImagesCategoriesCountsByCategoryResponse**](GetImagesCategoriesCountsByCategoryResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getPlaygroundObjectsByUserImageFile"></a>
# **getPlaygroundObjectsByUserImageFile**
> GetObjectsResponse getPlaygroundObjectsByUserImageFile(file)





### Example
```javascript
var StyleApi = require('style_api');

var apiInstance = new StyleApi.PlaygroundApi();

var file = "/path/to/file.txt"; // File | User's Image file to upload (only support jpg format yet)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getPlaygroundObjectsByUserImageFile(file, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **file** | **File**| User&#39;s Image file to upload (only support jpg format yet) | 

### Return type

[**GetObjectsResponse**](GetObjectsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: multipart/form-data
 - **Accept**: application/json

<a name="updateImagesDatasetByIds"></a>
# **updateImagesDatasetByIds**
> UpdateImageDatasetResponse updateImagesDatasetByIds(source, ids, valid)

Update image



### Example
```javascript
var StyleApi = require('style_api');

var apiInstance = new StyleApi.PlaygroundApi();

var source = "source_example"; // String | 

var ids = ["ids_example"]; // [String] | 

var valid = true; // Boolean | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateImagesDatasetByIds(source, ids, valid, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **source** | **String**|  | 
 **ids** | [**[String]**](String.md)|  | 
 **valid** | **Boolean**|  | 

### Return type

[**UpdateImageDatasetResponse**](UpdateImageDatasetResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json