# UiApi

All URIs are relative to *http://localhost*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**cleanupUIStorage**](#cleanupuistorage) | **POST** /api/ui/storage/cleanup | Cleanup Old Storage Files|
|[**getResultConfig**](#getresultconfig) | **GET** /api/ui/result/config | Get Result Configuration|
|[**getUIResult**](#getuiresult) | **GET** /api/ui/result | Get Stored UI Result|
|[**getUIResultStatus**](#getuiresultstatus) | **GET** /api/ui/result/status | Check UI Result Status|
|[**getUIStorageInfo**](#getuistorageinfo) | **GET** /api/ui/storage/info | Get UI Storage Information|
|[**listUIResults**](#listuiresults) | **GET** /api/ui/results/list | List All Stored Results|

# **cleanupUIStorage**
> any cleanupUIStorage()

Clean up old UI results and config files

### Example

```typescript
import {
    UiApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new UiApi(configuration);

const { status, data } = await apiInstance.cleanupUIStorage();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**any**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getResultConfig**
> any getResultConfig()

Retrieve the configuration file used for a specific result

### Example

```typescript
import {
    UiApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new UiApi(configuration);

let id: string; //Result ID (UUID) (default to undefined)

const { status, data } = await apiInstance.getResultConfig(
    id
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] | Result ID (UUID) | defaults to undefined|


### Return type

**any**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getUIResult**
> StoredResultResponseUIData getUIResult()

Retrieve a stored UI result by ID (UUID or human-readable)

### Example

```typescript
import {
    UiApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new UiApi(configuration);

let id: string; //Result ID (UUID or human-readable) (default to undefined)
let verbose: string; //Show full result data including base64 images (optional) (default to undefined)

const { status, data } = await apiInstance.getUIResult(
    id,
    verbose
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] | Result ID (UUID or human-readable) | defaults to undefined|
| **verbose** | [**string**] | Show full result data including base64 images | (optional) defaults to undefined|


### Return type

**StoredResultResponseUIData**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getUIResultStatus**
> any getUIResultStatus()

Check if a UI result exists

### Example

```typescript
import {
    UiApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new UiApi(configuration);

let id: string; //Result ID (UUID or human-readable) (default to undefined)

const { status, data } = await apiInstance.getUIResultStatus(
    id
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] | Result ID (UUID or human-readable) | defaults to undefined|


### Return type

**any**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getUIStorageInfo**
> any getUIStorageInfo()

Get statistics about UI result storage

### Example

```typescript
import {
    UiApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new UiApi(configuration);

const { status, data } = await apiInstance.getUIStorageInfo();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**any**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **listUIResults**
> any listUIResults()

Get list of all stored UI results with metadata (sorted by date, newest first)

### Example

```typescript
import {
    UiApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new UiApi(configuration);

const { status, data } = await apiInstance.listUIResults();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**any**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

