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.
Start buildingGet support
DocumentationAPI ReferenceChangelogDiscord
  • Voices
    • POSTCreate voice
    • GETList voices
    • DELDelete voice
  • Text-to-Speech (TTS)
    • WSSStream Input
    • STREAMText-to-Speech (Streamed JSON)
    • POSTText-to-Speech (Streamed File)
    • POSTText-to-Speech (Json)
    • POSTText-to-Speech (File)
    • POSTVoice Conversion (Streamed File)
    • STREAMVoice Conversion (Streamed JSON)
  • Speech-to-speech (EVI)
    • WSSChat
      • POSTCreate tool
      • GETList tools
      • GETList tool versions
      • GETGet tool version
      • POSTCreate tool version
      • PATCHUpdate tool name
      • PATCHUpdate tool description
      • DELDelete tool
      • DELDelete tool version
  • Expression Measurement API
Start buildingGet support
LogoLogo
LogoLogo
Speech-to-speech (EVI)Tools

List tools

GET
https://api.hume.ai/v0/evi/tools
GET
/v0/evi/tools
$curl -G https://api.hume.ai/v0/evi/tools \
>     -H "X-Hume-Api-Key: <apiKey>" \
>     -d page_number=0 \
>     -d page_size=2
200Retrieved
1{
2  "page_number": 0,
3  "page_size": 2,
4  "tools_page": [
5    {
6      "created_on": 1715267200693,
7      "id": "d20827af-5d8d-4f66-b6b9-ce2e3e1ea2b2",
8      "modified_on": 1715267200693,
9      "name": "get_current_location",
10      "parameters": "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }}, \"required\": [\"location\"] }",
11      "tool_type": "FUNCTION",
12      "version": 0,
13      "version_type": "FIXED",
14      "description": "Fetches user's current location.",
15      "fallback_content": "Unable to fetch location.",
16      "version_description": "Fetches user's current location."
17    },
18    {
19      "created_on": 1715266126705,
20      "id": "4442f3ea-9038-40e3-a2ce-1522b7de770f",
21      "modified_on": 1715266126705,
22      "name": "get_current_weather",
23      "parameters": "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }",
24      "tool_type": "FUNCTION",
25      "version": 0,
26      "version_type": "FIXED",
27      "description": "Fetches current weather and uses celsius or fahrenheit based on location of user.",
28      "fallback_content": "Unable to fetch location.",
29      "version_description": "Fetches current weather and uses celsius or fahrenheit based on location of user."
30    }
31  ],
32  "total_pages": 1
33}

Fetches a paginated list of Tools.

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

Was this page helpful?
Previous

List tool versions

Next
Built with

Authentication

X-Hume-Api-Keystring
API Key authentication via header

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.

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.

namestringOptional
Filter to only include tools with name.

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.

total_pagesinteger
The total number of pages in the collection.