List tool versions

Fetches a list of a Tool’s versions.

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"

Query parameters

page_numberintegerOptionalDefaults to 0

Specifies the page number to retrieve, enabling pagination.

This parameter uses zero-based indexing. For example, setting page_number to 0 retrieves the first page of results (items 0-9 if page_size is 10), setting page_number to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.

Specifies the page number to retrieve, enabling pagination. This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.

page_sizeintegerOptional

Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.

For example, if page_size is set to 10, each page will include up to 10 items. Defaults to 10.

restrict_to_most_recentbooleanOptional

By default, restrict_to_most_recent is set to true, returning only the latest version of each tool. To include all versions of each tool in the list, set restrict_to_most_recent to false.

Response

Success

page_numberinteger

The page number of the returned list.

This value corresponds to the page_number parameter specified in the request. Pagination uses zero-based indexing.

page_sizeinteger

The maximum number of items returned per page.

This value corresponds to the page_size parameter specified in the request.

tools_pagelist of objects

List of tools returned for the specified page_number and page_size.

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.

total_pagesinteger

The total number of pages in the collection.