Skip to main content
GET
/
deployments
/
{id}
Together AI SDK (v2)
from together import Together
client = Together()

deployment = client.beta.jig.retrieve("my-deployment")
print(deployment)
{
  "args": [
    "<string>"
  ],
  "autoscaling": {
    "metric": "HTTPTotalRequests",
    "target": 100,
    "time_interval_minutes": 10
  },
  "command": [
    "<string>"
  ],
  "cpu": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "desired_replicas": 123,
  "environment_variables": [
    {
      "name": "<string>",
      "value": "<string>",
      "value_from_secret": "<string>"
    }
  ],
  "gpu_count": 123,
  "health_check_path": "<string>",
  "id": "<string>",
  "image": "<string>",
  "max_replicas": 123,
  "memory": 123,
  "min_replicas": 123,
  "name": "<string>",
  "object": "<unknown>",
  "port": 123,
  "ready_replicas": 123,
  "replica_events": {},
  "storage": 123,
  "termination_grace_period_seconds": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "volumes": [
    {
      "mount_path": "<string>",
      "name": "<string>",
      "version": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
default:default
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Deployment ID or name

Response

Deployment details

​
args
string[]

Args are the arguments passed to the container's command

​
autoscaling
object

Autoscaling contains autoscaling configuration parameters for this deployment. Omitted when autoscaling is disabled (nil)

​
command
string[]

Command is the entrypoint command run in the container

​
cpu
number

CPU is the amount of CPU resource allocated to each replica in cores (fractional value is allowed)

​
created_at
string<date-time>

CreatedAt is the ISO8601 timestamp when this deployment was created

​
description
string

Description provides a human-readable explanation of the deployment's purpose or content

​
desired_replicas
integer

DesiredReplicas is the number of replicas that the orchestrator is targeting

​
environment_variables
object[]

EnvironmentVariables is a list of environment variables set in the container

​
gpu_count
integer

GPUCount is the number of GPUs allocated to each replica in this deployment

​
gpu_type
enum<string>

GPUType specifies the type of GPU requested (if any) for this deployment

Available options:
h100-80gb,
h100-40gb-mig,
h200-140gb,
b200-192gb
​
health_check_path
string

HealthCheckPath is the HTTP path used for health checks of the application

​
id
string

ID is the unique identifier of the deployment

​
image
string

Image specifies the container image used for this deployment

​
max_replicas
integer

MaxReplicas is the maximum number of replicas to run for this deployment

​
memory
number

Memory is the amount of memory allocated to each replica in GiB (fractional value is allowed)

​
min_replicas
integer

MinReplicas is the minimum number of replicas to run for this deployment

​
name
string

Name is the name of the deployment

​
object
any

The object type, which is always deployment.

​
port
integer

Port is the container port that the deployment exposes

​
ready_replicas
integer

ReadyReplicas is the current number of replicas that are in the Ready state

​
replica_events
object

ReplicaEvents is a mapping of replica names or IDs to their status events

​
status
enum<string>

Status represents the overall status of the deployment (e.g., Updating, Scaling, Ready, Failed)

Available options:
Updating,
Scaling,
Ready,
Failed,
ScaledToZero
​
storage
integer

Storage is the amount of storage (in MB or units as defined by the platform) allocated to each replica

​
termination_grace_period_seconds
integer

TerminationGracePeriodSeconds is the time in seconds to wait for graceful shutdown before forcefully terminating the replica

​
updated_at
string<date-time>

UpdatedAt is the ISO8601 timestamp when this deployment was last updated

​
volumes
object[]

Volumes is a list of volume mounts for this deployment