Deployments
Deploy models and manage API endpoints.
All methods are accessed via client.deployments.
deploy() POST /v1/deployments/create Deploy a model version.
Parameters
model_version_id str Required
ID of the model version to deploy
Returns
CreateDeploymentResponse — CreateDeploymentResponse containing the deployment_id
Example
1 result = 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_id str Required
ID of the deployment
description str default: ''
Description of the deploy key use case
days_until_expiry int default: 90
Number of days until the key expires
Returns
str — The deploy key UUID
Example
1 result = 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_id str default: None
Optional team ID (uses session team_id if not provided)
Returns
list — List of deployment information
Example
1 result = 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_id str Required
ID of the deployment
Returns
list — List of deploy key information
Example
1 result = 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_id str default: None
Optional team ID (uses session team_id if not provided)
Returns
int — Count of active deploy keys
Example
1 result = client . deployments . get_active_team_deploy_keys_count (
2 team_id = "team_abc123"
3 )
revoke_deploy_key() PATCH /v1/deployments/revoke-key Revoke a deploy key for a deployment.
Parameters
deployment_id str Required
ID of the deployment
key_id str Required
ID of the deploy key to revoke
Returns
dict — Success message
Example
1 result = 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_id str Required
ID of the deployment to delete
Returns
dict — Success message
Example
1 result = client . deployments . delete_deployment (
2 deployment_id = "deploy_abc123"
3 )
activate_deployment() PATCH /v1/deployments/ {deployment_id} /activate Activate a deployment.
Parameters
deployment_id str Required
ID of the deployment to activate
Returns
dict — Success message
Example
1 result = 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_id str Required
ID of the deployment
Returns
list — List containing sample data dictionary for inference
Example
1 result = client . deployments . get_deployment_payload (
2 deployment_id = "deploy_abc123"
3 )
deactivate_deployment() PATCH /v1/deployments/ {deployment_id} /deactivate Deactivate a deployment.
Parameters
deployment_id str Required
ID of the deployment to deactivate
Returns
dict — Success message
Example
1 result = client . deployments . deactivate_deployment (
2 deployment_id = "deploy_abc123"
3 )
update_deployment_version() PATCH /v1/deployments/ {deployment_id} /version Repoint a deployment at another version of the SAME model. Used by the retrain path: the deployment id, deploy keys, and firewall are unchanged; only the served model version is swapped.
Parameters
deployment_id str Required
ID of the deployment to repoint.
model_version_id str Required
The new model version to serve. Must belong to the same model the deployment currently serves (409 otherwise).
Returns
dict — Dict with the deployment_id and the now-served model_version_id.
Example
1 result = client . deployments . update_deployment_version (
2 deployment_id = "deploy_abc123" ,
3 model_version_id = "version_xyz789"
4 )
