APITools

Deploy Tool

Deploy Tool to an Environment. Set the deployed version for the specified Environment. This Prompt will be used for calls made to the Tool in this Environment.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

idstringRequired
Unique identifier for Tool.
environment_idstringRequired
Unique identifier for the Environment to deploy the Version to.

Query parameters

version_idstringRequired
Unique identifier for the specific version of the Tool.

Response

Successful Response
pathstring
Path of the Tool, including the name, which is used as a unique identifier.
idstring
Unique identifier for the Tool.
namestring
Name of the Tool, which is used as a unique identifier.
version_idstring
Unique identifier for the specific Tool Version. If no query params provided, the default deployed Tool Version is returned.
created_atdatetime
updated_atdatetime
last_used_atdatetime
version_logs_countinteger
The number of logs that have been generated for this Tool Version
total_logs_countinteger
The number of logs that have been generated across all Tool Versions
inputslist of objects
Inputs associated to the Prompt. Inputs correspond to any of the variables used within the Tool template.
directory_idstring
ID of the directory that the file is in on Humanloop.
functionobject
Callable function specification of the Tool shown to the model for tool calling.
source_codestring
Code source of the Tool.
setup_valuesmap from strings to any
Values needed to setup the Tool, defined in JSON Schema format: https://json-schema.org/
attributesmap from strings to any
Additional fields to describe the Tool. Helpful to separate Tool versions from each other with details on how they were created or used.
tool_typeenum
Type of Tool.
version_namestring
Unique identifier for this Tool version. Each Tool can only have one version with a given name.
version_descriptionstring
Description of the Version.
descriptionstring
Description of the Tool.
readmestring
Long description of the file.
tagslist of strings
List of tags associated with the file.
type"tool"
environmentslist of objects
The list of environments the Tool Version is deployed to.
created_byany
The user who created the Tool.
evaluatorslist of objects
Evaluators that have been attached to this Tool that are used for monitoring logs.
signaturestring
Signature of the Tool.
evaluator_aggregateslist of objects
Aggregation of Evaluator results for the Tool Version.

Errors

422
Set Deployment Tools ID Environments Environment ID Post Request Unprocessable Entity Error