← Back to all apps

Overview

Tools Available4
CategoryBusiness

Ask questions, run analyses

Available Tools

Hex provides 4 tools that can be used to interact with its services.

Continue thread

continue_thread
Full Description

Continue a Hex Thread by adding a new message and triggering the agent to process it. The thread must be in IDLE status to be continued. If the thread is currently running, this will return an error. The thread will take a few minutes to complete - you should warn the user about this. While the thread is running, you can use the get_thread tool to check on its status.

Parameters

Required
idstring

The ID of the thread to continue

promptstring

The message to add to continue the thread

Create a thread

create_thread
Full Description

Create a new Hex Thread to ask a question about your data. Hex will use its Threads Agent to analyze your data and then provide a response. The thread will take a few minutes to complete - you should warn the user about this. While the thread is running, you can use the get_thread tool to check on its status. You should check at least 10 times, or until the response has the information the user asked for. Once the thread is complete (status is IDLE), you can use the continue_thread tool to add follow-up questions or continue the conversation.

Parameters

Required
promptstring

Get a thread by ID

get_thread
Full Description

Fetch a Hex Thread using its ID. You can get an ID when you call the create_thread tool. If the thread is not finished yet, it will sleep for a number of seconds before returning the messages. You should warn the user about this. Once the thread is complete (status is IDLE), you can use the continue_thread tool to add follow-up questions or continue the conversation.

Parameters

Required
idstring

Search Projects

search_projects
Full Description

Search for projects

Parameters

Required
querystring

The search query to find relevant projects. This should be a non-empty string without wildcards.