Scale API

Evaluation Configs

evaluation_configs

Methods

Create Evaluation Config ->
EvaluationConfig
post/v4/evaluation-configs

Description

Creates a evaluation config

Details

This API can be used to create a evaluation config. To use this API, review the request schema and pass in all fields that are required to create a evaluation config.

Delete Evaluation Config ->
GenericDeleteResponse
delete/v4/evaluation-configs/{evaluation_config_id}

Description

Deletes a evaluation config

Details

This API can be used to delete a evaluation config by ID. To use this API, pass in the id that was returned from your Create Evaluation Config API call as a path parameter.

List Evaluation Configs -> PageResponse<
EvaluationConfig
>
get/v4/evaluation-configs

Description

Lists all evaluation configs accessible to the user.

Details

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

Get Evaluation Config ->
EvaluationConfig
get/v4/evaluation-configs/{evaluation_config_id}

Description

Gets the details of a evaluation config

Details

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

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

Domain types

EvaluationConfig = { id, account_id, created_at, 5 more... }
PaginatedEvaluationConfigs = { current_page, items, items_per_page, 1 more... }