Update tool description

Updates the description of a specified Tool version.

Refer to our tool use guide for comprehensive instructions on defining and integrating tools into EVI.

Path parameters

idstringRequired

Identifier for a Tool. Formatted as a UUID.

versionintegerRequired

Version number for a Tool.

Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.

Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.

Request

This endpoint expects an object.

version_descriptionstringOptional

An optional description of the Tool version.

Response

This endpoint returns an optional object.

tool_type"BUILTIN" or "FUNCTION"

Allowed values: BUILTINFUNCTION

Type of Tool. Either BUILTIN for natively implemented tools, like web search, or FUNCTION for user-defined tools.

idstring

Identifier for a Tool. Formatted as a UUID.

versioninteger

Version number for a Tool.

Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.

Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.

version_type"FIXED" or "LATEST"

Allowed values: FIXEDLATEST

Versioning method for a Tool. Either FIXED for using a fixed version number or LATEST for auto-updating to the latest version.

namestring

Name applied to all versions of a particular Tool.

created_onlong

Time at which the Tool was created. Measured in seconds since the Unix epoch.

modified_onlong

Time at which the Tool was last modified. Measured in seconds since the Unix epoch.

parametersstring

Stringified JSON defining the parameters used by this version of the Tool.

These parameters define the inputs needed for the Tool’s execution, including the expected data type and description for each input field. Structured as a stringified JSON schema, this format ensures the tool receives data in the expected format.

version_descriptionstringOptional

An optional description of the Tool version.

fallback_contentstringOptional

Optional text passed to the supplemental LLM in place of the tool call result. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation if the Tool errors.

descriptionstringOptional

An optional description of what the Tool does, used by the supplemental LLM to choose when and how to call the function.

1	curl -X PATCH https://api.hume.ai/v0/evi/tools/00183a3f-79ba-413d-9f3b-609864268bea/version/1 \
2	-H "X-Hume-Api-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"version_description": "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user\'s region."
6	}'

1	{
2	"tool_type": "FUNCTION",
3	"id": "00183a3f-79ba-413d-9f3b-609864268bea",
4	"version": 1,
5	"version_type": "FIXED",
6	"version_description": "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
7	"name": "string",
8	"created_on": 1715277014228,
9	"modified_on": 1715277602313,
10	"fallback_content": "Unable to fetch current weather.",
11	"description": "This tool is for getting the current weather.",
12	"parameters": "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\", \"kelvin\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }"
13	}