Skip to main content
POST
/
api
/
models
/
{model}
/
deployments
Create a deployment for a model
curl --request POST \
  --url https://api.example.com/api/models/{model}/deployments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "model": {
    "model_name": "<string>",
    "model_version": "<string>",
    "model_alias": "<string>"
  },
  "source": {
    "schema": "<string>",
    "table": "<string>",
    "catalog": "iceberg",
    "filter_sql": "<string>",
    "snapshot_id": 123
  },
  "target": {
    "schema": "<string>",
    "table": "<string>",
    "catalog": "iceberg"
  },
  "entity_columns": [
    "<string>"
  ],
  "domain": "<string>",
  "owner": "<string>",
  "type": "batch",
  "schedule": "<string>",
  "rerun_behavior": "overwrite_partition",
  "partition_column": "scored_at",
  "trigger_now": false,
  "allowed_roles": [
    "<string>"
  ]
}
'
{
  "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "domain": "<string>",
  "owner": "<string>",
  "model": {
    "model_name": "<string>",
    "model_version": "<string>",
    "model_alias": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "resolved_model_version": "<string>",
  "dag_id": "<string>",
  "dag_s3_uri": "<string>",
  "schedule": "<string>",
  "last_run": {
    "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "airflow_run_id": "<string>",
    "rows_scored": 123,
    "started_at": "2023-11-07T05:31:56Z",
    "finished_at": "2023-11-07T05:31:56Z"
  },
  "service_url": "<string>",
  "replica_count": 123,
  "ready_replicas": 123,
  "allowed_roles": [
    "<string>"
  ],
  "error_message": "<string>",
  "stopped_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
model
string
required

MLflow registered model name.

Body

application/json
​
name
string
required

Human-friendly identity. DNS-1123 (lowercase letters, digits, '-'; start/end alphanumeric; max 63 chars). Unique per registered model.

​
model
ModelReference · object
required

A registered MLflow model + either a version pin or an alias.

Exactly one of model_version / model_alias must be set. Pinning is the platform default; aliases are an opt-in for promotion-tracking.

​
source
SourceTable · object
required

Iceberg table the batch scorer reads from.

​
target
TargetTable · object
required

Iceberg table the batch scorer writes predictions to.

​
entity_columns
string[]
required

Columns from the source carried forward into the predictions table.

Minimum array length: 1
​
domain
string
required
​
owner
string
required
​
type
string
default:batch
Allowed value: "batch"
​
schedule
string | null

Cron expression. None = manual-trigger only.

​
rerun_behavior
enum<string>
default:overwrite_partition
Available options:
overwrite_partition,
append_dedup
​
partition_column
string
default:scored_at

Partition column for overwrite_partition mode.

​
trigger_now
boolean
default:false
​
allowed_roles
string[] | null

Keycloak roles whose user-PSKs are allowed to invoke or manage this deployment. None / empty means platform-PSK access only.

Response

Successful Response

​
deployment_id
string<uuid>
required
​
name
string
required
​
type
enum<string>
required
Available options:
batch,
online
​
status
enum<string>
required
Available options:
pending,
deploying,
active,
failed,
stopped,
archived
​
domain
string
required
​
owner
string
required
​
model
ModelReference · object
required

A registered MLflow model + either a version pin or an alias.

Exactly one of model_version / model_alias must be set. Pinning is the platform default; aliases are an opt-in for promotion-tracking.

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
resolved_model_version
string | null

Concrete version this deployment is pinned to right now (resolved from alias if needed).

​
dag_id
string | null
​
dag_s3_uri
string | null
​
schedule
string | null
​
last_run
DeploymentRunSummary · object
​
service_url
string | null
​
replica_count
integer | null
​
ready_replicas
integer | null
​
allowed_roles
string[] | null
​
error_message
string | null
​
stopped_at
string<date-time> | null