Get Active Config

GET

Retrieves a config to use to execute your model.

A config will be selected based on the project’s active config settings.

Path parameters

idstringRequired

String ID of project. Starts with pr_.

Query parameters

environmentstringOptional

Name for the environment. E.g. ‘production’. If not provided, will return the active config for the default environment.

Response

Successful Response

project_idstring

String ID of project the model config belongs to. Starts with pr_.

project_namestring

Name of the project the model config belongs to.

created_atdatetime

updated_atdatetime

last_useddatetime

configobject

num_datapointsintegerOptional

Number of datapoints associated with this project model config.

evaluation_aggregateslist of objectsOptional

Aggregates of evaluators for the model config.

environment_idstringOptional

ID of environment to reference in subsequent log calls.

Errors

GET

1 curl https://api.humanloop.com/v4/projects/id/active-config \
2      -H "X-API-KEY: <apiKey>"

1 {
2   "project_id": "project_id",
3   "project_name": "project_name",
4   "created_at": "2024-01-15T09:30:00Z",
5   "updated_at": "2024-01-15T09:30:00Z",
6   "last_used": "2024-01-15T09:30:00Z",
7   "config": {
8     "type": "generic",
9     "id": "config",
10     "name": "config",
11     "status": "config",
12     "created_by": {
13       "id": "id",
14       "email_address": "email_address",
15       "verified": true,
16       "full_name": "full_name"
17     },
18     "description": "config",
19     "other": {
20       "key": "value"
21     }
22   },
23   "num_datapoints": 1,
24   "evaluation_aggregates": [
25     {
26       "model_config_id": "model_config_id",
27       "evaluator_id": "evaluator_id",
28       "evaluator_version_id": "evaluator_version_id",
29       "aggregate_value": 1.1
30     }
31   ],
32   "environment_id": "environment_id"
33 }

Deactivate Config

Up Next

Built with

1	curl https://api.humanloop.com/v4/projects/id/active-config \
2	-H "X-API-KEY: <apiKey>"

1	{
2	"project_id": "project_id",
3	"project_name": "project_name",
4	"created_at": "2024-01-15T09:30:00Z",
5	"updated_at": "2024-01-15T09:30:00Z",
6	"last_used": "2024-01-15T09:30:00Z",
7	"config": {
8	"type": "generic",
9	"id": "config",
10	"name": "config",
11	"status": "config",
12	"created_by": {
13	"id": "id",
14	"email_address": "email_address",
15	"verified": true,
16	"full_name": "full_name"
17	},
18	"description": "config",
19	"other": {
20	"key": "value"
21	}
22	},
23	"num_datapoints": 1,
24	"evaluation_aggregates": [
25	{
26	"model_config_id": "model_config_id",
27	"evaluator_id": "evaluator_id",
28	"evaluator_version_id": "evaluator_version_id",
29	"aggregate_value": 1.1
30	}
31	],
32	"environment_id": "environment_id"
33	}