# WeaviateApi.ModelManifestsApi

All URIs are relative to *https://localhost/weaviate/v1-alpha*

Method | HTTP request | Description
------------- | ------------- | -------------
[**weaveModelManifestsGet**](ModelManifestsApi.md#weaveModelManifestsGet) | **GET** /modelManifests/{modelManifestId} | 
[**weaveModelManifestsList**](ModelManifestsApi.md#weaveModelManifestsList) | **GET** /modelManifests | 
[**weaveModelManifestsValidateCommandDefs**](ModelManifestsApi.md#weaveModelManifestsValidateCommandDefs) | **POST** /modelManifests/validateCommandDefs | 
[**weaveModelManifestsValidateComponents**](ModelManifestsApi.md#weaveModelManifestsValidateComponents) | **POST** /modelManifests/validateComponents | 
[**weaveModelManifestsValidateDeviceState**](ModelManifestsApi.md#weaveModelManifestsValidateDeviceState) | **POST** /modelManifests/validateDeviceState | 


<a name="weaveModelManifestsGet"></a>
# **weaveModelManifestsGet**
> ModelManifest weaveModelManifestsGet(modelManifestId, opts)



Returns a particular model manifest.

### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

var apiInstance = new WeaviateApi.ModelManifestsApi();

var modelManifestId = "modelManifestId_example"; // String | Unique ID of the model manifest.

var opts = { 
  'alt': "json", // String | Data format for the response.
  'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
  'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
  'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
  'hl': "hl_example" // String | Specifies the language code that should be used for text values in the API response.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **modelManifestId** | **String**| Unique ID of the model manifest. | 
 **alt** | **String**| Data format for the response. | [optional] [default to json]
 **fields** | **String**| Selector specifying which fields to include in a partial response. | [optional] 
 **key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional] 
 **oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional] 
 **prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
 **quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional] 
 **userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional] 
 **hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional] 

### Return type

[**ModelManifest**](ModelManifest.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

 - **Content-Type**: application/json, application/protobuf, application/xml
 - **Accept**: application/json, application/protobuf, application/xml

<a name="weaveModelManifestsList"></a>
# **weaveModelManifestsList**
> ModelManifestsListResponse weaveModelManifestsList(ids, opts)



Lists all model manifests.

### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

var apiInstance = new WeaviateApi.ModelManifestsApi();

var ids = ["ids_example"]; // [String] | Model manifest IDs to include in the result

var opts = { 
  'alt': "json", // String | Data format for the response.
  'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
  'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
  'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
  'hl': "hl_example", // String | Specifies the language code that should be used for text values in the API response.
  'maxResults': 56, // Number | 
  'startIndex': 56, // Number | 
  'token': "token_example" // String | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ids** | [**[String]**](String.md)| Model manifest IDs to include in the result | 
 **alt** | **String**| Data format for the response. | [optional] [default to json]
 **fields** | **String**| Selector specifying which fields to include in a partial response. | [optional] 
 **key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional] 
 **oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional] 
 **prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
 **quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional] 
 **userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional] 
 **hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional] 
 **maxResults** | **Number**|  | [optional] 
 **startIndex** | **Number**|  | [optional] 
 **token** | **String**|  | [optional] 

### Return type

[**ModelManifestsListResponse**](ModelManifestsListResponse.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

 - **Content-Type**: application/json, application/protobuf, application/xml
 - **Accept**: application/json, application/protobuf, application/xml

<a name="weaveModelManifestsValidateCommandDefs"></a>
# **weaveModelManifestsValidateCommandDefs**
> ModelManifestsValidateCommandDefsResponse weaveModelManifestsValidateCommandDefs(opts)



Validates given command definitions and returns errors.

### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

var apiInstance = new WeaviateApi.ModelManifestsApi();

var opts = { 
  'alt': "json", // String | Data format for the response.
  'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
  'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
  'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
  'hl': "hl_example", // String | Specifies the language code that should be used for text values in the API response.
  'body': new WeaviateApi.ModelManifestsValidateCommandDefsRequest() // ModelManifestsValidateCommandDefsRequest | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **alt** | **String**| Data format for the response. | [optional] [default to json]
 **fields** | **String**| Selector specifying which fields to include in a partial response. | [optional] 
 **key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional] 
 **oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional] 
 **prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
 **quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional] 
 **userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional] 
 **hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional] 
 **body** | [**ModelManifestsValidateCommandDefsRequest**](ModelManifestsValidateCommandDefsRequest.md)|  | [optional] 

### Return type

[**ModelManifestsValidateCommandDefsResponse**](ModelManifestsValidateCommandDefsResponse.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

 - **Content-Type**: application/json, application/protobuf, application/xml
 - **Accept**: application/json, application/protobuf, application/xml

<a name="weaveModelManifestsValidateComponents"></a>
# **weaveModelManifestsValidateComponents**
> ModelManifestsValidateComponentsResponse weaveModelManifestsValidateComponents(opts)



Validates given components definitions and returns errors.

### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

var apiInstance = new WeaviateApi.ModelManifestsApi();

var opts = { 
  'alt': "json", // String | Data format for the response.
  'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
  'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
  'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
  'hl': "hl_example", // String | Specifies the language code that should be used for text values in the API response.
  'body': new WeaviateApi.ModelManifestsValidateComponentsRequest() // ModelManifestsValidateComponentsRequest | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **alt** | **String**| Data format for the response. | [optional] [default to json]
 **fields** | **String**| Selector specifying which fields to include in a partial response. | [optional] 
 **key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional] 
 **oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional] 
 **prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
 **quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional] 
 **userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional] 
 **hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional] 
 **body** | [**ModelManifestsValidateComponentsRequest**](ModelManifestsValidateComponentsRequest.md)|  | [optional] 

### Return type

[**ModelManifestsValidateComponentsResponse**](ModelManifestsValidateComponentsResponse.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

 - **Content-Type**: application/json, application/protobuf, application/xml
 - **Accept**: application/json, application/protobuf, application/xml

<a name="weaveModelManifestsValidateDeviceState"></a>
# **weaveModelManifestsValidateDeviceState**
> ModelManifestsValidateDeviceStateResponse weaveModelManifestsValidateDeviceState(opts)



Validates given device state object and returns errors.

### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

var apiInstance = new WeaviateApi.ModelManifestsApi();

var opts = { 
  'alt': "json", // String | Data format for the response.
  'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
  'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
  'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
  'hl': "hl_example", // String | Specifies the language code that should be used for text values in the API response.
  'body': new WeaviateApi.ModelManifestsValidateDeviceStateRequest() // ModelManifestsValidateDeviceStateRequest | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **alt** | **String**| Data format for the response. | [optional] [default to json]
 **fields** | **String**| Selector specifying which fields to include in a partial response. | [optional] 
 **key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional] 
 **oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional] 
 **prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
 **quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional] 
 **userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional] 
 **hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional] 
 **body** | [**ModelManifestsValidateDeviceStateRequest**](ModelManifestsValidateDeviceStateRequest.md)|  | [optional] 

### Return type

[**ModelManifestsValidateDeviceStateResponse**](ModelManifestsValidateDeviceStateResponse.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

 - **Content-Type**: application/json, application/protobuf, application/xml
 - **Accept**: application/json, application/protobuf, application/xml