Deployments

Deploy models and manage API endpoints.

All methods are accessed via client.deployments.

deploy()

POST/v1/deployments/create-deploy-key

Deploy a model version.

Parameters

model_version_idstrRequired

ID of the model version to deploy

Returns

CreateDeploymentResponse — CreateDeploymentResponse containing the deployment_id

Example

1result = client.deployments.deploy(

2 model_version_id="version_xyz789"

3)

---

generate_deploy_key()

PUT/v1/deployments/create-deploy-key

Generate a deploy key for a deployment.

Parameters

deployment_idstrRequired

ID of the deployment

descriptionstrdefault: ''

Description of the deploy key use case

days_until_expiryintdefault: 90

Number of days until the key expires

Returns

str — The deploy key UUID

Example

1result = client.deployments.generate_deploy_key(

2 deployment_id="deploy_abc123",

3 description="A description",

4 days_until_expiry=90

5)

---

list_deployments()

GET/v1/deployments/teams/{team_id}

List all deployments for a team.

Parameters

team_idstrdefault: None

Optional team ID (uses session team_id if not provided)

Returns

list — List of deployment information

Example

1result = client.deployments.list_deployments(

2 team_id="team_abc123"

3)

---

list_deploy_keys()

GET/v1/deployments/{deployment_id}

List all deploy keys for a deployment.

Parameters

deployment_idstrRequired

ID of the deployment

Returns

list — List of deploy key information

Example

1result = client.deployments.list_deploy_keys(

2 deployment_id="deploy_abc123"

3)

---

get_active_team_deploy_keys_count()

GET/v1/deployments/teams/{team_id}/active-keys

Get count of active deploy keys for a team.

Parameters

team_idstrdefault: None

Optional team ID (uses session team_id if not provided)

Returns

int — Count of active deploy keys

Example

1result = client.deployments.get_active_team_deploy_keys_count(

2 team_id="team_abc123"

3)

---

revoke_deploy_key()

PATCH/v1/deployments/create-deploy-key

Revoke a deploy key for a deployment.

Parameters

deployment_idstrRequired

ID of the deployment

key_idstrRequired

ID of the deploy key to revoke

Returns

dict — Success message

Example

1result = client.deployments.revoke_deploy_key(

2 deployment_id="deploy_abc123",

3 key_id="key_abc123"

4)

---

delete_deployment()

DELETE/v1/deployments/{deployment_id}

Delete a deployment.

Parameters

deployment_idstrRequired

ID of the deployment to delete

Returns

dict — Success message

Example

1result = client.deployments.delete_deployment(

2 deployment_id="deploy_abc123"

3)

---

activate_deployment()

PATCH/v1/deployments/{deployment_id}/activate

Activate a deployment.

Parameters

deployment_idstrRequired

ID of the deployment to activate

Returns

dict — Success message

Example

1result = client.deployments.activate_deployment(

2 deployment_id="deploy_abc123"

3)

---

get_deployment_payload()

GET/v1/deployments/{deployment_id}/payload

Get sample payload data for a deployment.

Parameters

deployment_idstrRequired

ID of the deployment

Returns

list — List containing sample data dictionary for inference

Example

1result = client.deployments.get_deployment_payload(

2 deployment_id="deploy_abc123"

3)

---

deactivate_deployment()

PATCH/v1/deployments/{deployment_id}/activate

Deactivate a deployment.

Parameters

deployment_idstrRequired

ID of the deployment to deactivate

Returns

dict — Success message

Example

1result = client.deployments.deactivate_deployment(

2 deployment_id="deploy_abc123"

3)

---