{
  "opencollection": "1.0.0",
  "info": {
    "name": "Speech-to-speech (EVI) subpackage_tools API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_tools",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List tools",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hume.ai/v0/evi/tools",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page_number",
                "value": "",
                "type": "query",
                "description": "Specifies the page number to retrieve, enabling pagination.\n\nThis 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."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.\n\nFor example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10."
              },
              {
                "name": "restrict_to_most_recent",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Filter to only include tools with name."
              }
            ]
          },
          "docs": "Fetches a paginated list of **Tools**.\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI."
        },
        {
          "info": {
            "name": "Create tool",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hume.ai/v0/evi/tools",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a **Tool** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI."
        },
        {
          "info": {
            "name": "List tool versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hume.ai/v0/evi/tools/:id",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "page_number",
                "value": "",
                "type": "query",
                "description": "Specifies the page number to retrieve, enabling pagination.\n\nThis 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."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.\n\nFor example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10."
              },
              {
                "name": "restrict_to_most_recent",
                "value": "",
                "type": "query",
                "description": "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."
              }
            ]
          },
          "docs": "Fetches a list of a **Tool's** versions.\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI."
        },
        {
          "info": {
            "name": "Create tool version",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hume.ai/v0/evi/tools/:id",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier for a Tool. Formatted as a UUID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a **Tool** by creating a new version of the **Tool**.\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI."
        },
        {
          "info": {
            "name": "Update tool name",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.hume.ai/v0/evi/tools/:id",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier for a Tool. Formatted as a UUID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the name of a **Tool**.\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI."
        },
        {
          "info": {
            "name": "Delete tool",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.hume.ai/v0/evi/tools/:id",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier for a Tool. Formatted as a UUID."
              }
            ]
          },
          "docs": "Deletes a **Tool** and its versions.\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI."
        },
        {
          "info": {
            "name": "Get tool version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hume.ai/v0/evi/tools/:id/version/:version",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier for a Tool. Formatted as a UUID."
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "Version number for a Tool.\n\nTools, 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.\n\nVersion numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number."
              }
            ]
          },
          "docs": "Fetches a specified version of a **Tool**.\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI."
        },
        {
          "info": {
            "name": "Update tool description",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.hume.ai/v0/evi/tools/:id/version/:version",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier for a Tool. Formatted as a UUID."
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "Version number for a Tool.\n\nTools, 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.\n\nVersion numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the description of a specified **Tool** version.\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI."
        },
        {
          "info": {
            "name": "Delete tool version",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.hume.ai/v0/evi/tools/:id/version/:version",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier for a Tool. Formatted as a UUID."
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "Version number for a Tool.\n\nTools, 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.\n\nVersion numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number."
              }
            ]
          },
          "docs": "Deletes a specified version of a **Tool**.\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI."
        }
      ]
    }
  ],
  "bundled": true
}