Update tool description

curl -X PATCH https://api.hume.ai/v0/evi/tools/your-tool-id/version/1 \
     -H "X-Hume-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "version_description": "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user'\''s region."
}'

{
  "created_on": 1715277014228,
  "id": "00183a3f-79ba-413d-9f3b-609864268bea",
  "modified_on": 1715277602313,
  "name": "string",
  "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\"] }",
  "tool_type": "FUNCTION",
  "version": 1,
  "version_type": "FIXED",
  "description": "This tool is for getting the current weather.",
  "fallback_content": "Unable to fetch current weather.",
  "version_description": "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region."
}

Updates the description of a specified Tool version.

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

Authentication

X-Hume-Api-Keystring

API Key authentication via header

Path parameters

idstringRequiredformat: "uuid"

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_descriptionstring or nullOptional

An optional description of the Tool version.

Response

Success

created_onlong

The timestamp when the first version of this tool was created.

idstring

Identifier for a Tool. Formatted as a UUID.

modified_onlong

The timestamp when this version of the tool was created.

namestring

Name of the built-in tool to use. Hume supports the following built-in tools:

web_search: enables EVI to search the web for up-to-date information when applicable.
hang_up: closes the WebSocket connection when appropriate (e.g., after detecting a farewell in the conversation).

For more information, see our guide on using built-in tools.

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.

tool_typeenum

Allowed values:

versioninteger

Version number for a Tool. Version numbers should be integers. The combination of configId and version number is unique.

version_typeenum

Allowed values:

descriptionstring or nullOptional

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

fallback_contentstring or nullOptional

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.

version_descriptionstring or nullOptional

An optional description of the Tool version.