Scale API | Model Groups › List Model Groups

Model Groups

model_groups

Methods

Create Model Group ->

ModelGroup

post/v4/model-groups

Description

Model groups are grouping models together. You can add models with the same base_model_id.

Delete Model Group ->

GenericDeleteResponse

delete/v4/model-groups/{model_group_id}

Description

Deletes a model group

Details

This API can be used to delete a model group by ID. To use this API, pass in the id that was returned from your Create Model Group API call as a path parameter.

List Model Groups -> PageResponse<

ModelGroup

get/v4/model-groups

Description

Lists all model groups accessible to the user.

Details

This API can be used to list model groups. If a user has access to multiple accounts, all model groups from all accounts the user is associated with will be returned.

Security

API Key Header

Example: x-api-key: My API Key

Parameters

account_id: string

Optional

limit: number

Optional

Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.

page: number

Optional

Page number for pagination to be returned by the given endpoint. Starts at page 1

Response fields

PaginatedModelGroups

Request example

curl https://api.egp.scale.com/v4/model-groups \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "current_page": 0,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by_user_id": "created_by_user_id",
      "name": "name",
      "description": "description"
    }
  ],
  "items_per_page": 0,
  "total_item_count": 0
}

Get Model Group ->

ModelGroup

get/v4/model-groups/{model_group_id}

Description

Gets the details of a model group

Details

This API can be used to get information about a single model group by ID. To use this API, pass in the id that was returned from your Create Model Group API call as a path parameter.

Review the response schema to see the fields that will be returned.

Update Model Group ->

ModelGroup

patch/v4/model-groups/{model_group_id}

Description

Updates a model group

Details

This API can be used to update the model group that matches the ID that was passed in as a path parameter. To use this API, pass in the id that was returned from your Create Model Group API call as a path parameter.

Review the request schema to see the fields that can be updated.

Domain types

ModelGroup = { id, account_id, created_at, 3 more... }

PaginatedModelGroups = { current_page, items, items_per_page, 1 more... }

Model Groups