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 |
|---|---|---|
PATCH | .../deployments/production/autoscaling_settings | Updates production autoscaling settings |
PATCH | .../deployments/development/autoscaling_settings | Updates development’s autoscaling settings |
PATCH | .../deployments/{deployment_id}/autoscaling_settings | Updates a deployment’s autoscaling settings |
Manage deployment endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/models/{model_id}/deployments | Get all model deployments |
GET | /v1/models/{model_id}/deployments/production | Production model deployment |
GET | /v1/models/{model_id}/deployments/development | Development model deployment |
GET | /v1/models/{model_id}/deployments/{deployment_id} | Any model deployment by ID |
DEL | /v1/models/{model_id}/deployments/{deployment_id} | Delete model deployments |
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 |
|---|---|---|
PATCH | .../deployments/production/autoscaling_settings | Updates production autoscaling settings |
PATCH | .../deployments/development/autoscaling_settings | Updates development’s autoscaling settings |
PATCH | .../deployments/{deployment_id}/autoscaling_settings | Updates a deployment’s autoscaling settings |
Manage deployment endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/models/{model_id}/deployments | Get all model deployments |
GET | /v1/models/{model_id}/deployments/production | Production model deployment |
GET | /v1/models/{model_id}/deployments/development | Development model deployment |
GET | /v1/models/{model_id}/deployments/{deployment_id} | Any model deployment by ID |
DEL | /v1/models/{model_id}/deployments/{deployment_id} | Delete model deployments |
Promote a Chain deployment
| Method | Endpoint | Description |
|---|---|---|
POST | /v1/chains/{chain_id}/environments/{env_name}/promote | Promote to chain environment |
Autoscaling
| Method | Endpoint | Description |
|---|---|---|
PATCH | .../chainlet_settings/autoscaling_settings | Update chainlet environment’s autoscaling settings |
Manage Chain deployments
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/chains/{chain_id}/deployments | Get all chain deployments |
GET | /v1/chains/{chain_id}/deployments/{chain_deployment_id} | Any chain deployment by ID |
DEL | /v1/chains/{chain_id}/deployments/{chain_deployment_id} | Delete chain 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 |
| 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 |
| Method | Endpoint | Description |
|---|---|---|
POST | /v1/chains/{chain_id}/environments | Create chain environment |
GET | /v1/chains/{chain_id}/environments | Get all chain environments |
GET | /v1/chains/{chain_id}/environments/{env_name} | Get a chain environment |
PATCH | /v1/chains/{chain_id}/environments/{env_name} | Update chain environment |
POST | /v1/chains/{chain_id}/environments/{env_name}/chainlet_settings/instance_types/update | Update chainlet environment’s instance type |
Secret endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/secrets | Get all secrets |
POST | /v1/secrets | Create a new secret or updates an existing secret secret. |
API Key endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/api_keys | Get all API keys. |
POST | /v1/api_keys | Create a new API key. |
DELETE | /v1/api_keys | Delete an API key by its prefix. |
Training Job endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/training_projects/{training_project_id}/jobs | Get all training jobs |
GET | /v1/training_projects/{training_project_id}/jobs/{training_job_id} | Get training job by ID |
POST | /v1/training_jobs/search | Search training jobs |
POST | /v1/training_projects/{training_project_id}/jobs/{training_job_id}/stop | Stop a training job |
POST | /v1/training_projects/{training_project_id}/jobs/{training_job_id}/recreate | Recreate a training job |
GET | /v1/training_projects/{training_project_id}/jobs/{training_job_id}/checkpoints | Get training job checkpoints |
GET | /v1/training_projects/{training_project_id}/jobs/{training_job_id}/checkpoint_files | Get training job checkpoint files |
GET | /v1/training_projects/{training_project_id}/jobs/{training_job_id}/logs | Get training job logs |
GET | /v1/training_projects/{training_project_id}/jobs/{training_job_id}/metrics | Get training job metrics |
GET | /v1/training_projects/{training_project_id}/jobs/{training_job_id}/download | Download training job artifacts |