# ReflectorchApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getAvailableModelsApiReflectorchModelsGet**](#getavailablemodelsapireflectorchmodelsget) | **GET** /api/reflectorch/models | Get Available Models|
|[**getParametersApiReflectorchModelParametersGet**](#getparametersapireflectorchmodelparametersget) | **GET** /api/reflectorch/{model}/parameters | Get Parameters|
|[**getStandardConfigApiReflectorchStandardConfigGet**](#getstandardconfigapireflectorchstandardconfigget) | **GET** /api/reflectorch/standard-config | Get Standard Config|

# **getAvailableModelsApiReflectorchModelsGet**
> Array<AvailableModel> getAvailableModelsApiReflectorchModelsGet()

Get available models for reflectometry analysis.  Returns:     List[AvailableModel]: List of available models with their configurations  Raises:     HTTPException: If the configuration directory is not found

### Example

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

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

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

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


### Return type

**Array<AvailableModel>**

### 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)

# **getParametersApiReflectorchModelParametersGet**
> ReflectometryModelParameters getParametersApiReflectorchModelParametersGet()

Get parameters for a specific reflectometry model.  Args:     model (str): Name of the model  Returns:     ReflectometryModelParameters: Parameters for the model  Raises:     HTTPException: If the model configuration is not found

### Example

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

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

let model: string; // (default to undefined)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **model** | [**string**] |  | defaults to undefined|


### Return type

**ReflectometryModelParameters**

### 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)

# **getStandardConfigApiReflectorchStandardConfigGet**
> VIPRInferenceOutput getStandardConfigApiReflectorchStandardConfigGet()

Generate standard Reflectorch configuration.  This endpoint migrated from vipr-core to vipr-framework. It calls the VIPR runner to generate standard configuration.  Returns:     Dict containing standard VIPR configuration  Raises:     HTTPException: If config generation fails

### Example

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

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

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

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


### Return type

**VIPRInferenceOutput**

### 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)

