Deployment

Configuration

Define how models are served.
View as Markdown

A deployment configuration defines how a model is served after training.

Create a configuration before deploying a model. The deployed model then uses the configuration to determine the serving mode and resources.

Choose a deployment type

Deployment configurations are created as either SERVERLESS or REALTIME.

TypeUse
SERVERLESSUse for on-demand workloads where scaling to zero is useful and cold starts are acceptable.
REALTIMEUse for low-latency workloads where the model should stay ready for requests.

Serverless configurations use memory size and maximum concurrency. Real-time configurations use a serving machine type and machine count.

Create a serverless configuration

Create a serverless configuration when the model only needs to serve requests on demand.

POST
/deployment-configurations
1curl -X POST https://api.hi.umnai.com/deployment-configurations \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "deployment_type": "SERVERLESS",
6  "maximum_concurrency": 1,
7  "memory_size": 1024,
8  "name": "Sample Serverless Deployment Configuration"
9}'
Response
1{
2  "deployment_type": "SERVERLESS",
3  "account": {
4    "id": "e268443e43d93dab7ebef303bbe9642f",
5    "name": "Sample Account"
6  },
7  "created_at": "2026-03-15T10:15:30.000000Z",
8  "id": "8be6a0ea7db3303d3fb3568c0b583d9d",
9  "maximum_concurrency": 1,
10  "memory_size": 1024,
11  "name": "Sample Serverless Deployment Configuration",
12  "created_by": {
13    "id": "dad46b2058752ffde5eaf02f1eb6abd5",
14    "name": "Sample User"
15  },
16  "updated_at": "2026-03-15T10:15:30.000000Z"
17}

Save the returned configuration id. You will use it when deploying a model.

Create a real-time configuration

Create a real-time configuration when the model needs to stay ready for low-latency requests.

Before creating the configuration, retrieve the available serving machine types.

GET
/machine-types
1curl https://api.hi.umnai.com/machine-types \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json"
Response
1{
2  "data": [
3    {
4      "name": "ml.m5.large",
5      "cpus": 2,
6      "cpu_memory_gb": 8,
7      "created_at": "2026-03-15T10:15:30.000000Z",
8      "component": "SERVING",
9      "gpus": 0,
10      "gpu_memory_gb": 0
11    },
12    {
13      "name": "ml.m5.xlarge",
14      "cpus": 4,
15      "cpu_memory_gb": 16,
16      "created_at": "2026-03-15T10:15:30.000000Z",
17      "component": "SERVING",
18      "gpus": 0,
19      "gpu_memory_gb": 0
20    }
21  ],
22  "pagination": {
23    "total_items": 2,
24    "items_per_page": 2,
25    "current_page": 1,
26    "total_pages": 1
27  }
28}

Then create the deployment configuration with deployment_type set to REALTIME.

POST
/deployment-configurations
1curl -X POST https://api.hi.umnai.com/deployment-configurations \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "deployment_type": "REALTIME",
6  "machine_count": 1,
7  "machine_type": "ml.m5.large",
8  "name": "Sample Real-Time Deployment Configuration"
9}'
Response
1{
2  "deployment_type": "REALTIME",
3  "account": {
4    "id": "e268443e43d93dab7ebef303bbe9642f",
5    "name": "Sample Account"
6  },
7  "created_at": "2026-03-15T10:20:30.000000Z",
8  "id": "bf9e7f0b8f5f42a782c7cc48a19cf15b",
9  "machine_count": 1,
10  "machine_type": "ml.m5.large",
11  "name": "Sample Real-Time Deployment Configuration",
12  "created_by": {
13    "id": "dad46b2058752ffde5eaf02f1eb6abd5",
14    "name": "Sample User"
15  },
16  "updated_at": "2026-03-15T10:20:30.000000Z"
17}

Save the returned configuration id. You will use it when deploying a model.

Retrieve configurations

Retrieve deployment configurations when you need to reuse an existing configuration.

GET
/deployment-configurations
1curl https://api.hi.umnai.com/deployment-configurations \
2     -H "Authorization: Bearer <token>"
Response
1{
2  "data": [
3    {
4      "id": "ea8b745ead39ec442fc3b4fba359bf98",
5      "name": "Sample Organisation",
6      "status": "ACTIVE",
7      "created_at": "2026-03-11T16:04:19.749000Z",
8      "updated_at": null
9    }
10  ],
11  "pagination": {
12    "total_items": 1,
13    "items_per_page": 10,
14    "current_page": 1,
15    "total_pages": 1
16  }
17}

To inspect a specific configuration, retrieve it by id.

GET
/deployment-configurations/:deploymentConfigurationId
1curl https://api.hi.umnai.com/deployment-configurations/{deploymentConfigurationId} \
2     -H "Authorization: Bearer <token>"
Response
1{
2  "data": [
3    {
4      "id": "ea8b745ead39ec442fc3b4fba359bf98",
5      "name": "Sample Organisation",
6      "status": "ACTIVE",
7      "created_at": "2026-03-11T16:04:19.749000Z",
8      "updated_at": null
9    }
10  ],
11  "pagination": {
12    "total_items": 1,
13    "items_per_page": 10,
14    "current_page": 1,
15    "total_pages": 1
16  }
17}

Update a configuration

Update a deployment configuration when you need to rename it.

PATCH
/deployment-configurations/:deploymentConfigurationId
1curl -X PATCH https://api.hi.umnai.com/deployment-configurations/deploymentConfigurationId \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "name": "Sample Deployment Configuration"
6}'
Response
1{
2  "deployment_type": "SERVERLESS",
3  "account": {
4    "id": "e268443e43d93dab7ebef303bbe9642f",
5    "name": "Sample Account"
6  },
7  "created_at": "2026-03-15T10:15:30.000000Z",
8  "id": "8be6a0ea7db3303d3fb3568c0b583d9d",
9  "maximum_concurrency": 1,
10  "memory_size": 10,
11  "name": "Sample Deployment Configuration",
12  "created_by": {
13    "id": "dad46b2058752ffde5eaf02f1eb6abd5",
14    "name": "Sample User"
15  },
16  "updated_at": "2026-03-15T10:15:30.000000Z"
17}

Delete a configuration

Delete a deployment configuration when it should no longer be used by future deployments.

DELETE
/deployment-configurations/:deploymentConfigurationId
1curl -X DELETE https://api.hi.umnai.com/deployment-configurations/deploymentConfigurationId \
2     -H "Authorization: Bearer <token>"