Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.simplismart.ai/llms.txt

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

Manage deployments using simplismart deployments.

List Deployments

Lists deployments with optional filtering.
simplismart deployments list [options]
OptionDescription
--model-repo-id UUIDFilter by model repo UUID
--status STATUSFilter by status
--offset NPagination offset (default: 0)
--count NPage size (default: 20)

Status Options

ValueDescription
DEPLOYEDDeployment is running
PENDINGDeployment is being created
FAILEDDeployment failed
STOPPEDDeployment is stopped
DELETEDDeployment has been deleted
Example:
# List all deployments
simplismart deployments list --offset 0 --count 20

# Filter by status
simplismart deployments list --status DEPLOYED --offset 0 --count 20

# Filter by model repo
simplismart deployments list --model-repo-id <MODEL_REPO_ID> --status FAILED
Expected output
[
  {
    "deployment_id": "<DEPLOYMENT_ID>",
    "deployment_name": "whisper-nemo-diarization",
    "model_repo_id": "<MODEL_REPO_ID>",
    "model_repo_name": "whisper-nemo-diarization",
    "model_type": "unknown",
    "accelerator_type": ["nvidia-h100"],
    "accelerator_count": 1,
    "status": "DEPLOYED"
  },
  {
    "deployment_id": "<DEPLOYMENT_ID>",
    "deployment_name": "Gemma-3-4B",
    "model_repo_id": "<MODEL_REPO_ID>",
    "model_repo_name": "gemma-3-4b-optim-v2",
    "model_type": "llm",
    "accelerator_type": ["nvidia-h100"],
    "accelerator_count": 1,
    "status": "DEPLOYED"
  }
]

Create Deployment

Creates a deployment for a model repo.
simplismart deployments create [options]
OptionDescription
--model-repo UUIDModel repo UUID (required)
--org UUIDOrganization UUID (required)
--gpu-id IDGPU type (required) - e.g., nvidia-h100, A10
--name NAMEDeployment name (required)
--min-pod-replicas NMinimum pod replicas (required)
--max-pod-replicas NMaximum pod replicas (required)
--autoscale-config JSON/@fileAutoscaling config (required)
--env-variables JSON/@fileEnvironment variables
--deployment-custom-configuration JSON/@fileCustom deployment config
--healthcheck JSON/@fileHealth check config
--ports JSON/@filePort mappings
--metrics-path JSON/@fileMetrics paths
--persistent-volume-claims JSON/@filePVC configurations
--fast-scaleupEnable fast scale up
--deployment-tag TAGDeployment tag
Example:
# Create deployment
simplismart deployments create-private \
  --model-repo <MODEL_REPO_ID> \
  --org "$ORG_ID" \
  --gpu-id nvidia-h100 \
  --name vision-deploy \
  --min-pod-replicas 1 \
  --max-pod-replicas 2 \
  --autoscale-config @autoscale.json
Where autoscale.json contains:
{
  "targets": [
    {"metric": "gpu", "target": 80}
  ]
}

Get Deployment

Gets deployment details by ID.
simplismart deployments get [options]
OptionDescription
--deployment-id UUIDDeployment UUID (required)
Example:
simplismart deployments get --deployment-id <DEPLOYMENT_ID>
Expected output Returns a single deployment object with full details (e.g. deployment_id, deployment_name, model_repo_id, model_repo_name, status, accelerator_type, accelerator_count, and other configuration fields).
{
  "uuid": "<DEPLOYMENT_UUID>",
  "avatar": {
    ...
  },
  "created_by": {
    ...
  },
  "persistent_volume_claims": [],
  "autoscale_config": {
    "targets": [
      {
        "unit": "%",
        "metric": "cpu",
        "target": 80,
        "description": "Average CPU usage across all pods"
      }
    ]
  },
  "deployment_custom_configuration": {
    "command": []
  },
  "ports": {
    "http": {
      "port": 8000
    }
  },
  "healthcheck": {
    "path": "/health",
    "port": 8000,
    "initialDelaySeconds": 30,
    "periodSeconds": 10,
    "timeoutSeconds": 5
  },
  "env_variables": {},
  "metrics_path": [],
  "metrics_http_method_overrides": {},
  "created_at": "2026-03-02T11:53:05.744416Z",
  "updated_at": "2026-03-02T12:05:17.018284Z",
  "is_public": false,
  "name": "whisper-nemo-diarization",
  "display_name": "whisper-nemo-diarization",
  "proxy_name": "",
  "status": "DEPLOYED",
  "slug": "fi0pjr7jaf",
  "autoscaling": true,
  "min_pod_replicas": 1,
  "max_pod_replicas": 8,
  "scale_to_zero_enabled": false,
  "model_cloud": "",
  "accelerator_type": "nvidia-h100",
  "accelerator_request": 1.0,
  "accelerator_limit": 1.0,
  "cpu_request": 23.0,
  "cpu_limit": 23.0,
  "memory_request": 190.0,
  "memory_limit": 190.0,
  "node_affinity": "none",
  "ended_at": null,
  "image_url": null,
  "tags": null,
  "proxy_url": "<PROXY_URL>",
  "api_details": {},
  "input_configuration": {},
  "deleted_at": null,
  "deployment_details": {},
  "advanced_configuration": {},
  "extra_details": {
    "deployment_tag": "production",
    "deletion_retry_count": 0
  },
  "external_deployment_id": null,
  "is_deployable": true,
  "model_output_type": "",
  "paused_at": null,
  "resumed_at": null,
  "async_deployment_type": "SYNC",
  "has_custom_proxy": false,
  "is_private_request_tracking_enabled": false,
  "is_privately_deployed": true,
  "status_description": null,
  "image_prepuller": false,
  "is_warmpool_deployment": false,
  "additional_tags": {},
  "cluster_selection_logic": [
    ...
  ],
  "org": "<ORG_ID>",
  "updated_by": null,
  "model_repo": "<MODEL_REPO_ID>",
  "cluster": "<CLUSTER_ID>",
  "pricing_catalog": null,
  "additional_usage_details": null,
  "input_volume_mounts": null,
  "output_volume_mounts": null,
  "source_secret": null,
  "deployment_config": null,
  "pricing_config": null,
  "node_groups": [
    "<NODE_GROUP_ID>"
  ]
}

Update Deployment

Updates deployment configuration.
simplismart deployments update [options]
OptionDescription
--deployment-id UUIDDeployment UUID (required)
--payload JSON/@fileJSON object with editable fields (required)
Example:
simplismart deployments update --deployment-id <DEPLOYMENT_ID> --payload @edit-payload.json

Stop Deployment

Stops a running deployment.
simplismart deployments stop [options]
OptionDescription
--deployment-id UUIDDeployment UUID (required)
Example:
simplismart deployments stop --deployment-id <DEPLOYMENT_ID>

Start Deployment

Starts a stopped deployment.
simplismart deployments start [options]
OptionDescription
--deployment-id UUIDDeployment UUID (required)
Example:
simplismart deployments start --deployment-id <DEPLOYMENT_ID>

Scale Deployment

Updates deployment autoscaling configuration.
simplismart deployments scale [options]
OptionDescription
--deployment-id UUIDDeployment UUID (required)
--min-replicas NMinimum replicas (required)
--max-replicas NMaximum replicas (required)
Example:
simplismart deployments scale \
  --deployment-id <DEPLOYMENT_ID> \
  --min-replicas 1 \
  --max-replicas 3

Delete Deployment

Deletes a deployment.
simplismart deployments delete [options]
OptionDescription
--deployment-id UUIDDeployment UUID (required)
Example:
simplismart deployments delete --deployment-id <DEPLOYMENT_ID>

BYOC Deployment

Create a BYOC deployment with a payload (cluster, nodegroup, etc.). See Bring your own compute and Deploy on imported cluster.
simplismart deployments create-byoc --payload @byoc-create.json
Your byoc-create.json should match the API schema (e.g. cluster ID, nodegroup ID, model/repo references). Use the dashboard or API docs to confirm the exact payload shape.