Retrieve the Tool with the given ID.
By default, the deployed version of the Tool is returned. Use the query parameters
version_id
or environment
to target a specific version of the Tool.
Unique identifier for Tool.
A specific Version ID of the Tool to retrieve.
Name of the Environment to retrieve a deployed Version from.
Successful Response
Path of the Tool, including the name, which is used as a unique identifier.
Unique identifier for the Tool.
Name of the Tool, which is used as a unique identifier.
Unique identifier for the specific Tool Version. If no query params provided, the default deployed Tool Version is returned.
The status of the Tool Version.
The number of logs that have been generated for this Tool Version
The number of logs that have been generated across all Tool Versions
Inputs associated to the Prompt. Inputs correspond to any of the variables used within the Tool template.
ID of the directory that the file is in on Humanloop.
Callable function specification of the Tool shown to the model for tool calling.
Code source of the Tool.
Values needed to setup the Tool, defined in JSON Schema format: https://json-schema.org/
Additional fields to describe the Tool. Helpful to separate Tool versions from each other with details on how they were created or used.
Type of Tool.
Message describing the changes made.
The list of environments the Tool Version is deployed to.
The user who created the Tool.
The user who committed the Tool Version.
The date and time the Tool Version was committed.
Evaluators that have been attached to this Tool that are used for monitoring logs.
Signature of the Tool.
Aggregation of Evaluator results for the Tool Version.