Model Groups

model_groups

Methods

Create Model Group ->
post/v4/model-groups

Description

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

Delete Model Group ->
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<>
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.

Get Model Group ->
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 ->
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.models

Methods

Add Model To Group ->
post/v4/model-groups/{model_group_id}/models/{model_instance_id}

TODO: Add model instance to a model group.

Model Groups

Usage Statistics

model_groups.usage_statistics

Methods

Get Model Usage For A Group ->
get/v4/model-groups/{model_group_id}/usage-statistics

Get Model usage for a group