| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Overview
Check the list of available endpoints and methods in the model manager management API:
Endpoints and methods | Description | ||||||
|---|---|---|---|---|---|---|---|
/models/{name} see below | Get detailed information about a model. | ||||||
/models/{name} see below | Replace the data of an existing model. | ||||||
/models/{name} see below | Create a new model. | ||||||
/models/{name} see below | Delete a model. | ||||||
/models/{name} see below | Update an existing model. | ||||||
/models/{name} see below | List the available models in the current domain. | ||||||
/images/{name} see below | Get the binary image of a model. |
Endpoints and methods
| Anchor | ||||
|---|---|---|---|---|
|
/models/{name}Get detailed information about a model.
| Note |
|---|
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models. Learn more about roles and permissions in Role permissions. |
| Expand | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Query string parametersQuery string parameters are optionally added after the path parameters, preceded by a question mark (
ExampleFind below a request example in cURL language:
|
| Expand | ||
|---|---|---|
|
Path parameters
Add the following path parameters as part of the endpoint:
...
Parameter
...
Type
...
Description
...
name required
...
string
...
Enter the name of the model you want to replace the data of.
Request body
The request JSON body must include an object with the following key-value pairs:
...
Parameter
...
Type
...
Description
...
engine
...
string
...
The engine used to train and execute the model.
...
fileName
...
string
...
description
...
string
...
The description of the model.
Example
Find below a request example in cURL language:
| Code Block |
|---|
curl -H "standAloneToken:YOUR_TOKEN" -X GET "https://api-us.devo.com/aggregations/v2/aggrtasks/myDomain/cc_myDomain:abcDE123?skipCache=true" |
...
| title | Response |
|---|
...
Code
...
Description
...
200
...
Returns a replaced model.
| Code Block |
|---|
{
"name": "string",
"engine": "string",
"location": "string",
"description": "string",
"updateDate": 0,
"creationDate": 0,
"domainName": "string",
"outputType": "string",
"image": {
"image": "string"
},
"category": "string",
"fields": [
{
"id": 0,
"name": "string",
"description": "string",
"type": "string"
}
],
"clusters": [
{
"id": 0,
"name": "string",
"description": "string",
"centroid": [
0
]
}
],
"runtimeSize": 0,
"fileSize": 0
} |
...
500
...
Returned when an error occurred internally in the server.
...
Create a model.
| Note |
|---|
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models. Learn more about roles and permissions in Role permissions. |
| Expand | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Parameter | Type | Description | ||||||||||||
|
| Enter the name of the model you want to create. | ||||||||||||
Parameter | Type | Description | ||||||||||||
|
| The engine used to train and execute the model. |
|
| ||||||||||
|
| The description of the model. | ||||||||||||
| Code Block | ||||||||||||||
| Expand | ||||||||||||||
| ||||||||||||||
Code Description 200 Model has been successfully saved to the server. Code Block |
|
...
Replace the data of an existing model.
| Note |
|---|
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and active the view and manage permissions in Models. Learn more about roles and permissions in Role permissions. |
...
| title | Request |
|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
/models/{name}Replace the data of an existing model.
| Note |
|---|
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and active the view and manage permissions in Models. Learn more about roles and permissions in Role permissions. |
| Expand | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Request bodyThe request JSON body must include an object with the following key-value pairs:
ExampleFind below a request example in cURL language:
|
| Expand | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Anchor | ||||
|---|---|---|---|---|
|
/models/{name}Create a model.
| Note |
|---|
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models. Learn more about roles and permissions in Role permissions. |
| Expand | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Request bodyThe request JSON body must include an object with the following key-value pairs:
ExampleFind below a request example in cURL language:
|
| Expand | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
| Anchor | ||||
|---|---|---|---|---|
|
/models/{name}Delete a model.
| Note |
|---|
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models. Learn more about roles and permissions in Role permissions. |
| Expand | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
ExampleFind below a request example in cURL language.
|
| Expand | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Anchor | ||||
|---|---|---|---|---|
|
/models/{name}Update an existing model.
| Note |
|---|
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models. Learn more about roles and permissions in Role permissions. |
| Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Request bodyThe request JSON body must include an object with the following key-value pairs:
ExampleFind below a request example in cURL language.
|
| Expand | ||
|---|---|---|
|
Delete a model.
| Note |
|---|
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models. Learn more about roles and permissions in Role permissions. |
...
| title | Request |
|---|
Path parameters
Add the following path parameters as part of the endpoint:
...
Parameter
...
Type
...
Description
...
name required
...
string
...
Enter the name of the model you want to delete.
Example
Find below a request example in cURL language.
| Code Block |
|---|
curl -X DELETE "https://api.stage.devo.com/mlmodelmanager/v3/models/MY FIRST MODEL" -H "accept: */*" -H "standAloneToken: cc81f6f5c73634002183d80b1fb736ec" |
...
| title | Response |
|---|
...
Code
...
Description
...
200
...
Model successfully deleted.
...
404
...
Model not found.
...
500
...
Returned when an error occurred internally in the server.
...
Update an existing model.
| Note |
|---|
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models. Learn more about roles and permissions in Role permissions. |
| Expand | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||
Parameter | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||
|
| Enter the name of the model you want to update. | ||||||||||||||||||||||||||||||||||||||||||||
Parameter | Type | Description |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |||||||||||||||||||||
| Code Block | ||||||||||||||||||||||||||||||||||||||||||||||
| Expand | ||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||
409 The model already exists. 500 Returned when an error occurred internally in the server. |
...
|
| Anchor | ||||
|---|---|---|---|---|
|
/models/{name}List the available models in the current domain.
| Note |
|---|
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models. Learn more about roles and permissions in Role permissions. |
| Expand | ||
|---|---|---|
| ||
Path parametersThere are no path parameters for this request. ExampleFind below a request example in cURL language.
|
| Expand | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Anchor | ||||
|---|---|---|---|---|
|
/images/{name}Get the binary image of a model.
| Note |
|---|
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models. Learn more about roles and permissions in Role permissions. |
| Expand | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
ExampleFind below a request example in cURL language.
|
| Expand | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|