Label deployments

Labels are a JSON object stored with a deployment. Use them to record metadata such as the owning team, source commit, or CI run. Published deployment labels remain fixed after creation. To change them, create another deployment with new labels. For a development deployment, passing labels on a later push replaces its current labels. Omitting labels preserves them. A label object can be up to 2 KB after JSON serialization. Label keys and string values can contain printable ASCII characters except spaces.

Set labels

Baseten CLI
Truss CLI
Python SDK
REST API
CI/CD

To label a deployment:

baseten model push --labels '{"team": "ml-platform", "env": "staging"}'

For more information, see baseten model push.

To label a deployment:

truss push --labels '{"team": "ml-platform", "env": "staging"}'

For more information, see truss push.

To label a deployment:

import truss

truss.push("./my-model", labels={"team": "ml-platform", "env": "staging"})

For more information, see truss.push().

To label a deployment:Add labels to the deployment object in both the prepare and create requests:

{
  "labels": {
    "team": "ml-platform",
    "env": "staging"
  }
}

For the complete prepare, upload, and create sequence, see Create a model with the REST API.

To label a deployment:

- uses: basetenlabs/action-truss-push@v0.1
  with:
    truss-directory: "./my-model"
    baseten-api-key: ${{ secrets.BASETEN_API_KEY }}
    labels: '{"team": "ml-platform", "triggered-by": "ci"}'

For more information, see the deploy GitHub Action and Deploy with labels.

View labels

After you push the deployment, view its labels in the console, the Baseten CLI, or the Management API:

UI
Baseten CLI
REST API

To view a deployment’s labels:

Sign in to your workspace at app.baseten.co and choose Dedicated Inference in the sidebar.
Select your model.
Select the deployment under Deployments.
Find Labels in the deployment details, below Truss config.

To view a deployment’s labels:JSON output includes labels. The text summary omits them.Print the whole deployment record with --output json:

baseten model deployment describe --model-id abc123 --deployment-id def456 --output json

{
  "id": "def456",
  "name": "deployment-1",
  "model_id": "abc123",
  "status": "ACTIVE",
  "instance_type_name": "1x2 - 1 vCPU, 2 GiB RAM",
  "labels": {
    "env": "staging",
    "team": "ml-platform"
  },
  ...
}

Print just the labels with --jq:

baseten model deployment describe --model-id abc123 --deployment-id def456 --jq '.labels'

{
  "env": "staging",
  "team": "ml-platform"
}

For more information, see baseten model deployment describe.

To view a deployment’s labels:

curl "https://api.baseten.co/v1/models/{model_id}/deployments/{deployment_id}" \
  -H "Authorization: Bearer $BASETEN_API_KEY"

{
  "id": "def456",
  "name": "deployment-1",
  "model_id": "abc123",
  "status": "ACTIVE",
  "labels": {
    "team": "ml-platform",
    "env": "staging"
  },
  ...
}

For more information, see Get a model’s deployment by ID.

Next steps

Use labels in CI/CD to compare the deployment running on Baseten with the commit or workflow run that created it.

Manage the deployment lifecycle to promote or retire a labeled deployment.
CI/CD to attach labels automatically from GitHub Actions.
Deployments for how deployments, environments, and promotion fit together.

Get started

Model APIs

Inference

Training

Development

Deployment

Engines

Model Labs

Organization

Hosting options

Observability

Troubleshooting

Label deployments

Set labels

View labels

Next steps

​Set labels

​View labels

​Next steps

Set labels

View labels

Next steps