tools

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.

post/tools/{id}/environments/{environment_id}

Request

  • Base URL: https://api.humanloop.com/v5
  • URL: https://api.humanloop.com/v5/tools/{id}/environments/{environment_id}
  • Auth: API key in header X-API-KEY

Path parameters

idstring required

Unique identifier for Tool.

environment_idstring required

Unique identifier for the Environment to deploy the Version to.

Query parameters

version_idstring required

Unique identifier for the specific version of the Tool.

Response

Successful Response

pathstring required

Path of the Tool, including the name, which is used as a unique identifier.

idstring required

Unique identifier for the Tool.

directory_idstring

ID of the directory that the file is in on Humanloop.

source_codestring

Code source of the Tool.

setup_valuesobject

Values needed to setup the Tool, defined in JSON Schema format: https://json-schema.org/

attributesobject

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

tool_type'pinecone_search' | 'google' | 'mock' | 'snippet' | 'json_schema' | 'get_api_call' | 'python'

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.

namestring required

Name of the Tool, which is used as a unique identifier.

descriptionstring

Description of the Tool.

readmestring

Long description of the file.

tagsstring[]

List of tags associated with the file.

version_idstring required

Unique identifier for the specific Tool Version. If no query params provided, the default deployed Tool Version is returned.

type'tool'
created_atstring date-time required
updated_atstring date-time required
created_byunknown
last_used_atstring date-time required
version_logs_countinteger required

The number of logs that have been generated for this Tool Version

total_logs_countinteger required

The number of logs that have been generated across all Tool Versions

signaturestring

Signature of the Tool.

Changes

No recorded changes to this operation across all 1 revision of this API.