Humanloop APIModel Configs

Get

Get a specific model config by ID.

Path parameters

idstringRequired

String ID of the model config. Starts with config_.

Headers

X-API-KEYstringRequired

Response

Successful Response
idstring

String ID of config. Starts with config_.

modelstring

The model instance used. E.g. text-davinci-002.

othermap from strings to any or null
Other parameter values to be passed to the provider call.
namestring or null
A friendly display name for the model config. If not provided, a name will be generated.
descriptionstring or null
A description of the model config.
providerenum or null
The company providing the underlying model service.
max_tokensinteger or nullDefaults to -1

The maximum number of tokens to generate. Provide max_tokens=-1 to dynamically calculate the maximum number of tokens to generate given the length of the prompt

temperaturedouble or nullDefaults to 1
What sampling temperature to use when making a generation. Higher values means the model will be more creative.
top_pdouble or nullDefaults to 1

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.

stopstring or list of strings or null

The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.

presence_penaltydouble or nullDefaults to 0

Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the generation so far.

frequency_penaltydouble or nullDefaults to 0

Number between -2.0 and 2.0. Positive values penalize new tokens based on how frequently they appear in the generation so far.

seedinteger or null
If specified, model will make a best effort to sample deterministically, but it is not guaranteed.
response_formatobject or null

The format of the response. Only type json_object is currently supported for chat.

reasoning_effortenum or integer or null

Guidance on how many reasoning tokens it should generate before creating a response to the prompt. OpenAI reasoning models (o1, o3-mini) expect a OpenAIReasoningEffort enum. Anthropic reasoning models expect an integer, which signifies the maximum token budget.

template_languageenum or null
The template language to use for rendering the template.
Allowed values:
prompt_templatestring or null

Prompt template that will take your specified inputs to form your final request to the model. NB: Input variables within the prompt template should be specified with syntax: {{input_name}}.

chat_templatelist of objects or null

Messages prepended to the list of messages sent to the provider. These messages that will take your specified inputs to form your final request to the provider model. NB: Input variables within the template should be specified with syntax: {{input_name}}.

toolslist of objects or null
Tools shown to the model.
endpointenum or null
The provider model endpoint used.
Allowed values:
tool_configslist of objects or nullDeprecated

NB: Deprecated with tools field. Definition of tools shown to the model.

Errors