APIAgents

Deserialize

Deserialize an Agent from the .agent file format.

This returns a subset of the attributes required by an Agent. This subset is the bit that defines the Agent version (e.g. with model and temperature etc)

Headers

X-API-KEYstringRequired

Request

This endpoint expects an object.
agentstringRequired

Response

Successful Response

modelstring

The model instance used, e.g. gpt-4. See supported models

endpointenumOptional

The provider model endpoint used.

Allowed values:
templatestring or list of objectsOptional

The template contains the main structure and instructions for the model, including input variables for dynamic values.

For chat models, provide the template as a ChatTemplate (a list of messages), e.g. a system message, followed by a user message with an input variable. For completion models, provide a prompt template as a string.

Input variables should be specified with double curly bracket syntax: {{input_name}}.

template_languageenumOptional

The template language to use for rendering the template.

Allowed values:
providerenumOptional

The company providing the underlying model service.

max_tokensintegerOptionalDefaults 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

temperaturedoubleOptionalDefaults to 1

What sampling temperature to use when making a generation. Higher values means the model will be more creative.

top_pdoubleOptionalDefaults 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 stringsOptional

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

presence_penaltydoubleOptionalDefaults 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_penaltydoubleOptionalDefaults 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.

othermap from strings to anyOptional

Other parameter values to be passed to the provider call.

seedintegerOptional

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

response_formatobjectOptional

The format of the response. Only {"type": "json_object"} is currently supported for chat.

reasoning_effortenum or integerOptional

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.

toolslist of objectsOptional
attributesmap from strings to anyOptional

Additional fields to describe the Prompt. Helpful to separate Prompt versions from each other with details on how they were created or used.

max_iterationsintegerOptional

The maximum number of iterations the Agent can run. This is used to limit the number of times the Agent model is called.

Errors