> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.umnai.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.umnai.com/_mcp/server.

# Deployed models

A deployed model is a trained model made available for inference and explanations.

It references the model being served and the deployment configuration that defines how it is served.

## Deploy a model

Deploy a model when you have a trained model and a deployment configuration ready.

### Request

POST [https://api.hi.umnai.com/deployed-models](https://api.hi.umnai.com/deployed-models)

```curl
curl -X POST https://api.hi.umnai.com/deployed-models \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Sample Deployed Model",
  "model_id": "20f35e630daf44dbfa4c3f68f5399d8c",
  "deployment_configuration_id": "8be6a0ea7db3303d3fb3568c0b583d9d"
}'
```

```python
import requests

url = "https://api.hi.umnai.com/deployed-models"

payload = {
    "name": "Sample Deployed Model",
    "model_id": "20f35e630daf44dbfa4c3f68f5399d8c",
    "deployment_configuration_id": "8be6a0ea7db3303d3fb3568c0b583d9d"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.hi.umnai.com/deployed-models';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Sample Deployed Model","model_id":"20f35e630daf44dbfa4c3f68f5399d8c","deployment_configuration_id":"8be6a0ea7db3303d3fb3568c0b583d9d"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hi.umnai.com/deployed-models"

	payload := strings.NewReader("{\n  \"name\": \"Sample Deployed Model\",\n  \"model_id\": \"20f35e630daf44dbfa4c3f68f5399d8c\",\n  \"deployment_configuration_id\": \"8be6a0ea7db3303d3fb3568c0b583d9d\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.hi.umnai.com/deployed-models")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Sample Deployed Model\",\n  \"model_id\": \"20f35e630daf44dbfa4c3f68f5399d8c\",\n  \"deployment_configuration_id\": \"8be6a0ea7db3303d3fb3568c0b583d9d\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.hi.umnai.com/deployed-models")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Sample Deployed Model\",\n  \"model_id\": \"20f35e630daf44dbfa4c3f68f5399d8c\",\n  \"deployment_configuration_id\": \"8be6a0ea7db3303d3fb3568c0b583d9d\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.hi.umnai.com/deployed-models', [
  'body' => '{
  "name": "Sample Deployed Model",
  "model_id": "20f35e630daf44dbfa4c3f68f5399d8c",
  "deployment_configuration_id": "8be6a0ea7db3303d3fb3568c0b583d9d"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.hi.umnai.com/deployed-models");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Sample Deployed Model\",\n  \"model_id\": \"20f35e630daf44dbfa4c3f68f5399d8c\",\n  \"deployment_configuration_id\": \"8be6a0ea7db3303d3fb3568c0b583d9d\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "Sample Deployed Model",
  "model_id": "20f35e630daf44dbfa4c3f68f5399d8c",
  "deployment_configuration_id": "8be6a0ea7db3303d3fb3568c0b583d9d"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hi.umnai.com/deployed-models")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Response (201)

```json
{
  "id": "abf66c365bddf8b064bdfe2ca5ee662a",
  "account": {
    "id": "e268443e43d93dab7ebef303bbe9642f",
    "name": "Sample Account"
  },
  "name": "Sample Deployed Model",
  "status": "STARTING",
  "created_at": "2026-03-15T10:15:30.000000Z",
  "model": {
    "id": "20f35e630daf44dbfa4c3f68f5399d8c",
    "name": "Sample Model"
  },
  "deployment_configuration": {
    "id": "8be6a0ea7db3303d3fb3568c0b583d9d",
    "name": "Sample Deployment Configuration"
  },
  "created_by": {
    "id": "dad46b2058752ffde5eaf02f1eb6abd5",
    "name": "Sample User"
  },
  "updated_at": "2026-03-15T10:15:30.000000Z",
  "tags": [
    {
      "name": "Sample Tag"
    }
  ]
}
```

Save the returned deployed model `id`. You will use it to monitor the deployment, query deployed model views, rename the deployment, or delete it when it is no longer needed.

## Monitor deployment status

Retrieve a deployed model to check whether it is available for inference.

### Request

GET [https://api.hi.umnai.com/deployed-models/\{deployedModelId}](https://api.hi.umnai.com/deployed-models/\{deployedModelId})

```curl
curl https://api.hi.umnai.com/deployed-models/{deployedModelId} \
     -H "Authorization: Bearer <token>"
```

```python
import requests

url = "https://api.hi.umnai.com/deployed-models/:deployedModelId"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.hi.umnai.com/deployed-models/:deployedModelId';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hi.umnai.com/deployed-models/:deployedModelId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.hi.umnai.com/deployed-models/:deployedModelId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.hi.umnai.com/deployed-models/:deployedModelId")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.hi.umnai.com/deployed-models/:deployedModelId', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.hi.umnai.com/deployed-models/:deployedModelId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hi.umnai.com/deployed-models/:deployedModelId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Response (200)

```json
{
  "data": [
    {
      "id": "ea8b745ead39ec442fc3b4fba359bf98",
      "name": "Sample Organisation",
      "status": "ACTIVE",
      "created_at": "2026-03-11T16:04:19.749000Z",
      "updated_at": null
    }
  ],
  "pagination": {
    "total_items": 1,
    "items_per_page": 10,
    "current_page": 1,
    "total_pages": 1
  }
}
```

A deployed model is ready for inference when its status is `RUNNING`.

| Status       | Meaning                                                 |
| ------------ | ------------------------------------------------------- |
| `STARTING`   | The deployment is being prepared.                       |
| `RUNNING`    | The deployed model is ready for inference.              |
| `FINALIZING` | The deployment is completing shutdown or cleanup tasks. |
| `STOPPED`    | The deployed model has been stopped.                    |
| `FAILED`     | The deployment stopped because of an error.             |
| `COMPLETED`  | The deployment process completed successfully.          |

## Retrieve deployed models

Retrieve deployed models when you need to find an existing deployment.

### Request

GET [https://api.hi.umnai.com/deployed-models](https://api.hi.umnai.com/deployed-models)

```curl
curl https://api.hi.umnai.com/deployed-models \
     -H "Authorization: Bearer <token>"
```

```python
import requests

url = "https://api.hi.umnai.com/deployed-models"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.hi.umnai.com/deployed-models';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hi.umnai.com/deployed-models"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.hi.umnai.com/deployed-models")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.hi.umnai.com/deployed-models")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.hi.umnai.com/deployed-models', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.hi.umnai.com/deployed-models");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hi.umnai.com/deployed-models")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Response (200)

```json
{
  "data": [
    {
      "id": "ea8b745ead39ec442fc3b4fba359bf98",
      "name": "Sample Organisation",
      "status": "ACTIVE",
      "created_at": "2026-03-11T16:04:19.749000Z",
      "updated_at": null
    }
  ],
  "pagination": {
    "total_items": 1,
    "items_per_page": 10,
    "current_page": 1,
    "total_pages": 1
  }
}
```

## Update a deployed model

Update a deployed model when you need to rename it.

### Request

PATCH [https://api.hi.umnai.com/deployed-models/\{deployedModelId}](https://api.hi.umnai.com/deployed-models/\{deployedModelId})

```curl
curl -X PATCH https://api.hi.umnai.com/deployed-models/deployedModelId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Sample Deployed Model"
}'
```

```python
import requests

url = "https://api.hi.umnai.com/deployed-models/:deployedModelId"

payload = { "name": "Sample Deployed Model" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.hi.umnai.com/deployed-models/:deployedModelId';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Sample Deployed Model"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hi.umnai.com/deployed-models/:deployedModelId"

	payload := strings.NewReader("{\n  \"name\": \"Sample Deployed Model\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.hi.umnai.com/deployed-models/:deployedModelId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Sample Deployed Model\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.hi.umnai.com/deployed-models/:deployedModelId")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Sample Deployed Model\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.hi.umnai.com/deployed-models/:deployedModelId', [
  'body' => '{
  "name": "Sample Deployed Model"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.hi.umnai.com/deployed-models/:deployedModelId");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Sample Deployed Model\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["name": "Sample Deployed Model"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hi.umnai.com/deployed-models/:deployedModelId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Response (200)

```json
{
  "id": "abf66c365bddf8b064bdfe2ca5ee662a",
  "account": {
    "id": "e268443e43d93dab7ebef303bbe9642f",
    "name": "Sample Account"
  },
  "name": "Sample Deployed Model",
  "status": "STARTING",
  "created_at": "2026-03-15T10:15:30.000000Z",
  "model": {
    "id": "20f35e630daf44dbfa4c3f68f5399d8c",
    "name": "Sample Model"
  },
  "deployment_configuration": {
    "id": "8be6a0ea7db3303d3fb3568c0b583d9d",
    "name": "Sample Deployment Configuration"
  },
  "created_by": {
    "id": "dad46b2058752ffde5eaf02f1eb6abd5",
    "name": "Sample User"
  },
  "updated_at": "2026-03-15T10:15:30.000000Z",
  "tags": [
    {
      "name": "Sample Tag"
    }
  ]
}
```

## Delete a deployed model

Delete a deployed model when it should no longer be available for inference.

### Request

DELETE [https://api.hi.umnai.com/deployed-models/\{deployedModelId}](https://api.hi.umnai.com/deployed-models/\{deployedModelId})

```curl
curl -X DELETE https://api.hi.umnai.com/deployed-models/deployedModelId \
     -H "Authorization: Bearer <token>"
```

```python
import requests

url = "https://api.hi.umnai.com/deployed-models/deployedModelId"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.hi.umnai.com/deployed-models/deployedModelId';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hi.umnai.com/deployed-models/deployedModelId"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.hi.umnai.com/deployed-models/deployedModelId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.delete("https://api.hi.umnai.com/deployed-models/deployedModelId")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.hi.umnai.com/deployed-models/deployedModelId', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.hi.umnai.com/deployed-models/deployedModelId");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hi.umnai.com/deployed-models/deployedModelId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

## Views

Deployed model views help inspect inference results, explanations, diagnostics, and evaluation outputs.

In the platform, predictions and explanations are returned as view outputs. To query a deployed model, generate a deployed model view such as the Results view and include the query rows in the view request.

* [Results](/guides/views/deployed-model-views/results-view) shows the raw explanation for a query.
* [Feature attribution](/guides/views/deployed-model-views/feature-attribution-view) shows how input features contributed to a prediction.
* [Module attribution](/guides/views/deployed-model-views/module-attribution-view) shows how modules and activated rules contributed to a prediction.
* [Decision actions](/guides/views/deployed-model-views/decision-action-table-view) shows decisions, actions, context, and explanations.
* [Module dependency](/guides/views/deployed-model-views/module-dependency-view) shows relationships between modules, rules, and features.
* [Anomalies](/guides/views/deployed-model-views/anomaly-view) helps detect and understand anomalous inputs or outputs.
* [Strengths and weaknesses](/guides/views/deployed-model-views/saw-view) shows error, strength, and uncertainty metrics.
* [Classification evaluation](/guides/views/deployed-model-views/classification-evaluation-view) evaluates classification performance.
* [Regression evaluation](/guides/views/deployed-model-views/regression-evaluation-view) evaluates regression performance.