Model CRUD & Dashboard
Page Outline
This category provides endpoints for the fundamental lifecycle operations of models within Model Studio. It covers everything from initial creation and retrieval to archival, duplication, and activity tracking. Additionally, it includes endpoints for aggregating high-level dashboard statistics.
Key Features
- Lifecycle Management: Create, update, delete, archive, and unarchive models.
- Organization: List all models with advanced filtering and pagination.
- Cloning: Duplicate existing model configurations to iterate quickly.
- Analytics: Retrieve summary statistics for the organization-wide model dashboard.
- Auditing: Access detailed activity logs for individual models to track changes and performance over time.
API Endpoints
Below is a summary of the endpoints available in this category. For detailed request/response schemas and behavior, refer to the individual endpoint pages.
| Endpoint | Method | Path | Description |
|---|---|---|---|
| Create Model | POST | / | Initialize a new model record. |
| List Models | GET | / | Retrieve a paginated list of models. |
| Get Model | GET | /{model_id} | Fetch full details for a specific model. |
| Update Model | PATCH | /{model_id} | Modify model metadata or configuration. |
| Delete Model | DELETE | /{model_id} | Permanently remove a model record. |
| Archive Model | POST | /{model_id}/archive | Move a model to archival storage. |
| Unarchive Model | POST | /{model_id}/unarchive | Restore a previously archived model. |
| Duplicate Model | POST | /{model_id}/duplicate | Create a copy of an existing model. |
| Get Activity | GET | /{model_id}/activity | Retrieve chronological lifecycle events. |
| Dashboard Stats | GET | /stats | Get high-level metrics for the overview dashboard. |
Best Practice
When listing models, use the filter_status query parameter to narrow down results to only ready or training models for better performance in your application UI.