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
    • Overview
    • Errors
  • SDK
    • Overview
    • Decorators
    • Run Evaluation
  • API
      • POSTCall Tool
      • POSTLog to a Tool
      • PATCHUpdate Tool Log
      • GETList Tools
      • POSTUpsert Tool
      • GETGet Tool
      • DELDelete Tool
      • PATCHMove Tool
      • GETList Versions of a Tool
      • DELDelete Tool Version
      • PATCHUpdate Tool Version
      • POSTDeploy Tool
      • DELRemove Deployment
      • GETList a Tool's Environments
      • POSTUpdate Monitoring
      • GETGet Environment Variables
      • POSTAdd Environment Variable
      • DELDelete Environment Variable
LogoLogo
Sign inBook a demo
APITools

Get Tool

GET
https://api.humanloop.com/v5/tools/:id
GET
/v5/tools/:id
$curl https://api.humanloop.com/v5/tools/tl_789ghi \
>     -H "X-API-KEY: <apiKey>"
1{
2  "path": "math-tool",
3  "id": "tl_789ghi",
4  "name": "math-tool",
5  "version_id": "tv_012jkl",
6  "created_at": "2024-05-01T12:00:00Z",
7  "updated_at": "2024-05-01T12:00:00Z",
8  "last_used_at": "2024-05-01T12:00:00Z",
9  "version_logs_count": 1,
10  "total_logs_count": 1,
11  "inputs": [
12    {
13      "name": "operation"
14    }
15  ],
16  "version_name": "math-tool-v1",
17  "version_description": "Simple math tool that multiplies two numbers",
18  "type": "tool"
19}

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.

Was this page helpful?
Previous

Delete Tool

Next
Built with

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

idstringRequired
Unique identifier for Tool.

Query parameters

version_idstringOptional
A specific Version ID of the Tool to retrieve.
environmentstringOptional
Name of the Environment to retrieve a deployed Version from.

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
Get Tools ID Get Request Unprocessable Entity Error