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
curl -X POST https://api.hi.umnai.com/deployment-configurations \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "deployment_type": "SERVERLESS",
  "maximum_concurrency": 1,
  "memory_size": 1024,
  "name": "Sample Serverless Deployment Configuration"
}'
Response
{
  "deployment_type": "SERVERLESS",
  "account": {
    "id": "e268443e43d93dab7ebef303bbe9642f",
    "name": "Sample Account"
  },
  "created_at": "2026-03-15T10:15:30.000000Z",
  "id": "8be6a0ea7db3303d3fb3568c0b583d9d",
  "maximum_concurrency": 1,
  "memory_size": 1024,
  "name": "Sample Serverless Deployment Configuration",
  "created_by": {
    "id": "dad46b2058752ffde5eaf02f1eb6abd5",
    "name": "Sample User"
  },
  "updated_at": "2026-03-15T10:15:30.000000Z"
}

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
curl https://api.hi.umnai.com/machine-types \
     -H "Authorization: Bearer <token>"
Response
{
  "data": [
    {
      "name": "ml.m5.large",
      "cpus": 2,
      "cpu_memory_gb": 8,
      "created_at": "2026-03-15T10:15:30.000000Z",
      "component": "SERVING",
      "gpus": 0,
      "gpu_memory_gb": 0
    },
    {
      "name": "ml.m5.xlarge",
      "cpus": 4,
      "cpu_memory_gb": 16,
      "created_at": "2026-03-15T10:15:30.000000Z",
      "component": "SERVING",
      "gpus": 0,
      "gpu_memory_gb": 0
    }
  ],
  "pagination": {
    "total_items": 2,
    "items_per_page": 2,
    "current_page": 1,
    "total_pages": 1
  }
}

Then create the deployment configuration with deployment_type set to REALTIME.

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

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
curl https://api.hi.umnai.com/deployment-configurations \
     -H "Authorization: Bearer <token>"
Response
{
  "data": [
    {
      "deployment_type": "SERVERLESS",
      "account": {
        "id": "e268443e43d93dab7ebef303bbe9642f",
        "name": "Sample Account"
      },
      "created_at": "2026-03-15T10:15:30.000000Z",
      "id": "8be6a0ea7db3303d3fb3568c0b583d9d",
      "maximum_concurrency": 1,
      "memory_size": 10,
      "name": "Sample Deployment Configuration",
      "created_by": {
        "id": "dad46b2058752ffde5eaf02f1eb6abd5",
        "name": "Sample User"
      },
      "updated_at": "2026-03-15T10:15:30.000000Z"
    }
  ],
  "pagination": {
    "total_items": 2,
    "items_per_page": 1,
    "current_page": 1,
    "total_pages": 1
  }
}

To inspect a specific configuration, retrieve it by id.

GET
/deployment-configurations/:deploymentConfigurationId
curl https://api.hi.umnai.com/deployment-configurations/deploymentConfigurationId \
     -H "Authorization: Bearer <token>"
Response
{
  "deployment_type": "SERVERLESS",
  "account": {
    "id": "e268443e43d93dab7ebef303bbe9642f",
    "name": "Sample Account"
  },
  "created_at": "2026-03-15T10:15:30.000000Z",
  "id": "8be6a0ea7db3303d3fb3568c0b583d9d",
  "maximum_concurrency": 1,
  "memory_size": 10,
  "name": "Sample Deployment Configuration",
  "created_by": {
    "id": "dad46b2058752ffde5eaf02f1eb6abd5",
    "name": "Sample User"
  },
  "updated_at": "2026-03-15T10:15:30.000000Z"
}

Update a configuration

Update a deployment configuration when you need to rename it.

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

Delete a configuration

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

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