For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inBook a demo
DocsReferenceChangelog
DocsReferenceChangelog
  • Introduction
    • SDKs
    • Errors
  • Humanloop API
      • GETList For Project
      • GETList For Project
      • GETList
      • POSTCreate
      • GETGet
      • DELDelete
      • PATCHUpdate
      • GETList Configs
      • POSTCreate Feedback Type
      • PATCHUpdate Feedback Types
      • POSTExport
        • GETGet Active Config
        • DELDeactivate Config
LogoLogo
Sign inBook a demo
Humanloop APIProjectsActive Config

Get Active Config

GET
https://api.humanloop.com/v4/projects/:id/active-config
GET
/v4/projects/:id/active-config
$curl https://api.humanloop.com/v4/projects/id/active-config \
>     -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": "model",
9    "id": "id",
10    "model": "model",
11    "chat_template": [
12      {
13        "role": "user"
14      }
15    ],
16    "description": "description",
17    "endpoint": "complete",
18    "frequency_penalty": 1.1,
19    "max_tokens": 1,
20    "name": "name",
21    "other": {
22      "key": "value"
23    },
24    "presence_penalty": 1.1,
25    "prompt_template": "prompt_template",
26    "provider": "anthropic",
27    "reasoning_effort": "high",
28    "response_format": {
29      "type": "json_object",
30      "json_schema": {
31        "key": "value"
32      }
33    },
34    "seed": 1,
35    "stop": "stop",
36    "temperature": 1.1,
37    "template_language": "default",
38    "tools": [
39      {
40        "id": "id",
41        "name": "name"
42      }
43    ],
44    "top_p": 1.1,
45    "tool_configs": [
46      {
47        "id": "id",
48        "status": "status",
49        "name": "name"
50      }
51    ]
52  },
53  "num_datapoints": 1,
54  "evaluation_aggregates": [
55    {
56      "model_config_id": "model_config_id",
57      "evaluator_id": "evaluator_id",
58      "evaluator_version_id": "evaluator_version_id",
59      "aggregate_value": 1.1
60    }
61  ],
62  "environment_id": "environment_id"
63}
Retrieves a config to use to execute your model. A config will be selected based on the project's active config settings.
Was this page helpful?
Previous

Deactivate Config

Next
Built with

Authentication

X-API-KEYstring
API Key authentication via header

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_datapointsinteger
Number of datapoints associated with this project model config.
evaluation_aggregateslist of objects
Aggregates of evaluators for the model config.
environment_idstring
ID of environment to reference in subsequent log calls.

Errors

422
Active Config Get Request Unprocessable Entity Error