429 responses.
To deploy a model archive programmatically, see Create a model with the REST API. For a task-oriented guide to the deployment endpoints (scale, pause, promote, clean up, logs), see Manage deployments.
Model endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/models | Get all models |
GET | /v1/models/{model_id} | Get models by ID |
POST | /v1/prepare_model_upload | Prepare a model upload |
POST | /v1/models | Create a model from a source |
DEL | /v1/models/{model_id} | Delete models |
Chain endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/chains | Get all Chains |
GET | /v1/chains/{chain_id} | Get a Chain by ID |
DEL | /v1/chains/{chain_id} | Delete Chains |
GET | /v1/chains/{chain_id}/deployments/{chain_deployment_id}/chainlets/{chainlet_id}/logs | Get chainlet logs |
Deployment endpoints
- Models
- Chains
Activate a model deployment
| Method | Endpoint | Description |
|---|---|---|
POST | /v1/models/{model_id}/environments/{env_name}/activate | Activate an environment |
POST | /v1/models/{model_id}/deployments/development/activate | Activate development |
POST | /v1/models/{model_id}/deployments/{deployment_id}/activate | Activate a deployment |
POST | /v1/models/{model_id}/deployments/production/activate | Activate production |
Deactivate a model deployment
| Method | Endpoint | Description |
|---|---|---|
POST | /v1/models/{model_id}/environments/{env_name}/deactivate | Deactivate an environment |
POST | /v1/models/{model_id}/deployments/development/deactivate | Deactivate development |
POST | /v1/models/{model_id}/deployments/{deployment_id}/deactivate | Deactivate a deployment |
POST | /v1/models/{model_id}/deployments/production/deactivate | Deactivate production |
Retry a model deployment
| Method | Endpoint | Description |
|---|---|---|
POST | /v1/models/{model_id}/deployments/development/retry | Retry development |
POST | /v1/models/{model_id}/deployments/{deployment_id}/retry | Retry a deployment |
POST | /v1/models/{model_id}/deployments/production/retry | Retry production |
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}/environments/{env_name}/cancel_promotion | Cancel a promotion to an environment |
POST | /v1/models/{model_id}/deployments/development/promote | Promote development deployment |
POST | /v1/models/{model_id}/deployments/{deployment_id}/promote | Promote any deployment |
POST | /v1/models/{model_id}/environments/{env_name}/pause_promotion | Pause rolling deployment |
POST | /v1/models/{model_id}/environments/{env_name}/resume_promotion | Resume rolling deployment |
POST | /v1/models/{model_id}/environments/{env_name}/force_cancel_promotion | Force cancel rolling deployment |
POST | /v1/models/{model_id}/environments/{env_name}/force_roll_forward_promotion | Force roll forward promotion |
Autoscaling
| Method | Endpoint | Description |
|---|---|---|
PATCH | .../deployments/development/autoscaling_settings | Updates development’s autoscaling settings |
PATCH | .../deployments/{deployment_id}/autoscaling_settings | Updates a deployment’s autoscaling settings |
PATCH | .../deployments/production/autoscaling_settings | Updates production’s autoscaling settings |
Manage deployment endpoints
Deactivate a Chain deployment
| Method | Endpoint | Description |
|---|---|---|
POST | /v1/chains/{chain_id}/deployments/{chain_deployment_id}/deactivate | Deactivate a Chain deployment |
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
- Models
- Chains
| 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 |
GET | /v1/models/{model_id}/environments/{env_name}/logs | Get environment logs |
GET | /v1/models/{model_id}/environments/{env_name}/metrics | Get environment metrics |
DELETE | /v1/models/{model_id}/environments/{env_name} | Delete an 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 |
Instance type endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/instance_types | Get all instance types |
GET | /v1/instance_type_prices | Get instance type prices |
Region endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/regions | List regions |
GET | /v1/teams/{team_id}/regions | List a team’s regions |
Model API endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/model_apis | List Model APIs |
GET | /v1/model_apis/{model_api_name} | Get a Model API by name |
Team endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/teams | Get all teams |
GET | /v1/teams/{team_id} | Get a team by ID |
User endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/users | List users |
GET | /v1/users/me | Get the current user |
GET | /v1/users/{user_id} | Get a user by ID |
Environment group endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/environment_groups | List environment groups |
GET | /v1/environment_groups/{env_name} | Get an environment group |
PATCH | /v1/environment_groups/{env_name} | Update an environment group |
GET | /v1/teams/{team_id}/environment_groups | List team environment groups |
GET | /v1/teams/{team_id}/environment_groups/{env_name} | Get a team environment group |
PATCH | /v1/teams/{team_id}/environment_groups/{env_name} | Update a team environment group |
Library listing endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/library_listings | List library listings |
POST | /v1/library_listings | Create a library listing |
GET | /v1/library_listings/{user_defined_listing_id} | Get a library listing |
PATCH | /v1/library_listings/{user_defined_listing_id} | Update a library listing |
DELETE | /v1/library_listings/{user_defined_listing_id} | Delete a library listing |
GET | /v1/library_listings/{user_defined_listing_id}/versions | List listing versions |
POST | /v1/library_listings/{user_defined_listing_id}/versions | Create a listing version |
GET | /v1/library_listings/{user_defined_listing_id}/versions/{version_tag} | Get a listing version |
PATCH | /v1/library_listings/{user_defined_listing_id}/versions/{version_tag} | Update a listing version |
DELETE | /v1/library_listings/{user_defined_listing_id}/versions/{version_tag} | Delete a listing version |
Secret endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/secrets | Get all secrets |
POST | /v1/secrets | Create or update a secret |
GET | /v1/teams/{team_id}/secrets | Get all team secrets |
POST | /v1/teams/{team_id}/secrets | Create or update a team secret |
API Key endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/api_keys | Get all API keys |
POST | /v1/api_keys | Create an API key |
DELETE | /v1/api_keys/{api_key_prefix} | Delete an API key |
POST | /v1/teams/{team_id}/api_keys | Create a team API key |
Billing endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/billing/usage_summary | Get billing usage summary |
Audit log endpoints
Query the same events shown on the activity log in the dashboard.| Method | Endpoint | Description |
|---|---|---|
GET | /v1/audit_logs | Get workspace audit logs |
GET | /v1/models/{model_id}/audit_logs | Get model audit logs |
GET | /v1/chains/{chain_id}/audit_logs | Get chain audit logs |
Training endpoints
For a complete reference and request schemas, see the Training API overview.Training projects
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/training_projects | List all training projects |
POST | /v1/training_projects | Create a training project |
GET | /v1/training_projects/{training_project_id} | Get a training project |
DELETE | /v1/training_projects/{training_project_id} | Delete a training project |
POST | /v1/teams/{team_id}/training_projects | Create a team training project |
GET | /v1/training_projects/{training_project_id}/cache/summary | Get training project cache summary |
Training jobs
Frontier Gateway endpoints
For the conceptual guide and end-to-end examples, see the Frontier Gateway overview.Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | /v1/gateway/endpoints | Create an endpoint |
GET | /v1/gateway/endpoints | List endpoints |
GET | /v1/gateway/endpoints/{endpoint_id} | Get an endpoint |
PATCH | /v1/gateway/endpoints/{endpoint_id} | Update an endpoint |
DELETE | /v1/gateway/endpoints/{endpoint_id} | Delete an endpoint |
Groups
| Method | Endpoint | Description |
|---|---|---|
POST | /v1/gateway/groups | Create a group |
GET | /v1/gateway/groups | List groups |
GET | /v1/gateway/groups/{group_id} | Get a group |
PATCH | /v1/gateway/groups/{group_id} | Update a group |
DELETE | /v1/gateway/groups/{group_id} | Delete a group |
API keys
| Method | Endpoint | Description |
|---|---|---|
POST | /v1/gateway/groups/{group_id}/api_keys | Create an API key |
GET | /v1/gateway/groups/{group_id}/api_keys | List API keys for a group |
GET | /v1/gateway/groups/{group_id}/api_keys/{api_key_prefix} | Get an API key |
DELETE | /v1/gateway/groups/{group_id}/api_keys/{api_key_prefix} | Revoke an API key |