Management API
Overview
The management API is used to manage models and deployments. It supports monitoring, CI/CD, and automation at both the model and workspace levels.
Model endpoints
Method | Endpoint | Description |
---|---|---|
GET | /v1/models | Get all models |
GET | /v1/models/{model_id} | Get models by ID |
DEL | /v1/models/{model_id} | Delete models |
Chain endpoints
Method | Endpoint | Description |
---|---|---|
GET | /v1/chains | Get all Chains |
GET | /v1/chains/{chain_id} | Get all Chains by ID |
DEL | /v1/chains/{chain_id} | Delete Chains |
Deployment endpoints
Activate a model deployment
Method | Endpoint | Description |
---|---|---|
POST | /v1/models/{model_id}/environments/{env_name}/activate | Activate a environment |
POST | /v1/models/{model_id}/deployments/development/activate | Activate development |
POST | /v1/models/{model_id}/deployments/{deployment_id}/activate | Activate a deployment |
Deactivate a model deployment
Method | Endpoint | Description |
---|---|---|
POST | /v1/models/{model_id}/environments/{env_name}/activate | Deactivate a environment |
POST | /v1/models/{model_id}/environments/{env_name}/activate | Deactivate development |
POST | /v1/models/{model_id}/environments/{env_name}/activate | Deactivate a deployment |
Promote a model deployment
Method | Endpoint | Description |
---|---|---|
POST | /v1/models/{model_id}/environments/{env_name}/promote | Promote to model environment |
POST | /v1/models/{model_id}/deployments/development/promote | Promote development deployment |
POST | /v1/models/{model_id}/deployments/{deployment_id}/promote | Promote any deployment |
Autoscaling
Method | Endpoint | Description |
---|---|---|
POST | .../deployments/production/autoscaling_settings | Updates production autoscaling settings |
POST | .../deployments/development/autoscaling_settings | Updates development’s autoscaling settings |
POST | .../deployments/{deployment_id}/autoscaling_settings | Updates a deployment’s autoscaling settings |
Manage deployment endpoints
Method | Endpoint | Description |
---|---|---|
POST | /v1/models/{model_id}/deployments | Get all model deployments |
POST | /v1/models/{model_id}/deployments/production | Production model deployment |
POST | /v1/models/{model_id}/deployments/development | Development model deployment |
POST | /v1/models/{model_id}/deployments/{deployment_id} | Any model deployment by ID |
DEL | /v1/models/{model_id}/deployments/{deployment_id} | Delete model deployments |
Environment endpoints
Method | Endpoint | Description |
---|---|---|
POST | /v1/models/{model_id}/environments | Create environment |
GET | /v1/models/{model_id}/environments | Get all environments |
GET | /v1/models/{model_id}/environments/{env_name} | Get an environment details |
PATCH | /v1/models/{model_id}/environments/{env_name} | Update model environment |
Secret endpoints
Method | Endpoint | Description |
---|---|---|
GET | /v1/secrets | Get all secrets |
POST | /v1/secrets | Create a new secret or updates an existing secret secret. |
Was this page helpful?