Hex

Run and manage Hex projects

Hex is a collaborative platform for analytics and data science that allows you to build, run, and share interactive data projects and notebooks. Hex lets teams work together on data exploration, transformation, and visualization, making it easy to turn analysis into shareable insights.

With Hex, you can:

  • Create and run powerful notebooks: Blend SQL, Python, and visualizations in a single, interactive workspace.
  • Collaborate and share: Work together with teammates in real time and publish interactive data apps for broader audiences.
  • Automate and orchestrate workflows: Schedule notebook runs, parameterize runs with inputs, and automate data tasks.
  • Visualize and communicate results: Turn analysis results into dashboards or interactive apps that anyone can use.
  • Integrate with your data stack: Connect easily to data warehouses, APIs, and other sources.

The Sim Hex integration allows your AI agents or workflows to:

  • List, get, and manage Hex projects directly from Sim.
  • Trigger and monitor notebook runs, check their statuses, or cancel them as part of larger automation flows.
  • Retrieve run results and use them within Sim-powered processes and decision-making.
  • Leverage Hex’s interactive analytics capabilities right inside your automated Sim workflows.

Whether you’re empowering analysts, automating reporting, or embedding actionable data into your processes, Hex and Sim provide a seamless way to operationalize analytics and bring data-driven insights to your team.

Usage Instructions

Integrate Hex into your workflow. Run projects, check run status, manage collections and groups, list users, and view data connections. Requires a Hex API token.

Tools

hex_cancel_run

Cancel an active Hex project run.

Input

ParameterTypeRequiredDescription
apiKeystringYesHex API token (Personal or Workspace)
projectIdstringYesThe UUID of the Hex project
runIdstringYesThe UUID of the run to cancel

Output

ParameterTypeDescription
successbooleanWhether the run was successfully cancelled
projectIdstringProject UUID
runIdstringRun UUID that was cancelled

hex_create_collection

Create a new collection in the Hex workspace to organize projects.

Input

ParameterTypeRequiredDescription
apiKeystringYesHex API token (Personal or Workspace)
namestringYesName for the new collection
descriptionstringNoOptional description for the collection

Output

ParameterTypeDescription
idstringNewly created collection UUID
namestringCollection name
descriptionstringCollection description
creatorobjectCollection creator
emailstringCreator email
idstringCreator UUID

hex_get_collection

Retrieve details for a specific Hex collection by its ID.

Input

ParameterTypeRequiredDescription
apiKeystringYesHex API token (Personal or Workspace)
collectionIdstringYesThe UUID of the collection

Output

ParameterTypeDescription
idstringCollection UUID
namestringCollection name
descriptionstringCollection description
creatorobjectCollection creator
emailstringCreator email
idstringCreator UUID

hex_get_data_connection

Retrieve details for a specific data connection including type, description, and configuration flags.

Input

ParameterTypeRequiredDescription
apiKeystringYesHex API token (Personal or Workspace)
dataConnectionIdstringYesThe UUID of the data connection

Output

ParameterTypeDescription
idstringConnection UUID
namestringConnection name
typestringConnection type (e.g., snowflake, postgres, bigquery)
descriptionstringConnection description
connectViaSshbooleanWhether SSH tunneling is enabled
includeMagicbooleanWhether Magic AI features are enabled
allowWritebackCellsbooleanWhether writeback cells are allowed

hex_get_group

Retrieve details for a specific Hex group.

Input

ParameterTypeRequiredDescription
apiKeystringYesHex API token (Personal or Workspace)
groupIdstringYesThe UUID of the group

Output

ParameterTypeDescription
idstringGroup UUID
namestringGroup name
createdAtstringCreation timestamp

hex_get_project

Get metadata and details for a specific Hex project by its ID.

Input

ParameterTypeRequiredDescription
apiKeystringYesHex API token (Personal or Workspace)
projectIdstringYesThe UUID of the Hex project

Output

ParameterTypeDescription
idstringProject UUID
titlestringProject title
descriptionstringProject description
statusobjectProject status
namestringStatus name (e.g., PUBLISHED, DRAFT)
typestringProject type (PROJECT or COMPONENT)
creatorobjectProject creator
emailstringCreator email
ownerobjectProject owner
emailstringOwner email
categoriesarrayProject categories
namestringCategory name
descriptionstringCategory description
lastEditedAtstringISO 8601 last edited timestamp
lastPublishedAtstringISO 8601 last published timestamp
createdAtstringISO 8601 creation timestamp
archivedAtstringISO 8601 archived timestamp
trashedAtstringISO 8601 trashed timestamp

hex_get_project_runs

Retrieve API-triggered runs for a Hex project with optional filtering by status and pagination.

Input

ParameterTypeRequiredDescription
apiKeystringYesHex API token (Personal or Workspace)
projectIdstringYesThe UUID of the Hex project
limitnumberNoMaximum number of runs to return (1-100, default: 25)
offsetnumberNoOffset for paginated results (default: 0)
statusFilterstringNoFilter by run status: PENDING, RUNNING, ERRORED, COMPLETED, KILLED, UNABLE_TO_ALLOCATE_KERNEL

Output

ParameterTypeDescription
runsarrayList of project runs
projectIdstringProject UUID
runIdstringRun UUID
runUrlstringURL to view the run
statusstringRun status (PENDING, RUNNING, COMPLETED, ERRORED, KILLED, UNABLE_TO_ALLOCATE_KERNEL)
startTimestringRun start time
endTimestringRun end time
elapsedTimenumberElapsed time in seconds
traceIdstringTrace ID
projectVersionnumberProject version number
totalnumberTotal number of runs returned
traceIdstringTop-level trace ID

hex_get_queried_tables

Return the warehouse tables queried by a Hex project, including data connection and table names.

Input

ParameterTypeRequiredDescription
apiKeystringYesHex API token (Personal or Workspace)
projectIdstringYesThe UUID of the Hex project
limitnumberNoMaximum number of tables to return (1-100)

Output

ParameterTypeDescription
tablesarrayList of warehouse tables queried by the project
dataConnectionIdstringData connection UUID
dataConnectionNamestringData connection name
tableNamestringTable name
totalnumberTotal number of tables returned

hex_get_run_status

Check the status of a Hex project run by its run ID.

Input

ParameterTypeRequiredDescription
apiKeystringYesHex API token (Personal or Workspace)
projectIdstringYesThe UUID of the Hex project
runIdstringYesThe UUID of the run to check

Output

ParameterTypeDescription
projectIdstringProject UUID
runIdstringRun UUID
runUrlstringURL to view the run
statusstringRun status (PENDING, RUNNING, COMPLETED, ERRORED, KILLED, UNABLE_TO_ALLOCATE_KERNEL)
startTimestringISO 8601 run start time
endTimestringISO 8601 run end time
elapsedTimenumberElapsed time in seconds
traceIdstringTrace ID for debugging
projectVersionnumberProject version number

hex_list_collections

List all collections in the Hex workspace.

Input

ParameterTypeRequiredDescription
apiKeystringYesHex API token (Personal or Workspace)
limitnumberNoMaximum number of collections to return (1-500, default: 25)
sortBystringNoSort by field: NAME

Output

ParameterTypeDescription
collectionsarrayList of collections
idstringCollection UUID
namestringCollection name
descriptionstringCollection description
creatorobjectCollection creator
emailstringCreator email
idstringCreator UUID
totalnumberTotal number of collections returned

hex_list_data_connections

List all data connections in the Hex workspace (e.g., Snowflake, PostgreSQL, BigQuery).

Input

ParameterTypeRequiredDescription
apiKeystringYesHex API token (Personal or Workspace)
limitnumberNoMaximum number of connections to return (1-500, default: 25)
sortBystringNoSort by field: CREATED_AT or NAME
sortDirectionstringNoSort direction: ASC or DESC

Output

ParameterTypeDescription
connectionsarrayList of data connections
idstringConnection UUID
namestringConnection name
typestringConnection type (e.g., athena, bigquery, databricks, postgres, redshift, snowflake)
descriptionstringConnection description
connectViaSshbooleanWhether SSH tunneling is enabled
includeMagicbooleanWhether Magic AI features are enabled
allowWritebackCellsbooleanWhether writeback cells are allowed
totalnumberTotal number of connections returned

hex_list_groups

List all groups in the Hex workspace with optional sorting.

Input

ParameterTypeRequiredDescription
apiKeystringYesHex API token (Personal or Workspace)
limitnumberNoMaximum number of groups to return (1-500, default: 25)
sortBystringNoSort by field: CREATED_AT or NAME
sortDirectionstringNoSort direction: ASC or DESC

Output

ParameterTypeDescription
groupsarrayList of workspace groups
idstringGroup UUID
namestringGroup name
createdAtstringCreation timestamp
totalnumberTotal number of groups returned

hex_list_projects

List all projects in your Hex workspace with optional filtering by status.

Input

ParameterTypeRequiredDescription
apiKeystringYesHex API token (Personal or Workspace)
limitnumberNoMaximum number of projects to return (1-100)
includeArchivedbooleanNoInclude archived projects in results
statusFilterstringNoFilter by status: PUBLISHED, DRAFT, or ALL

Output

ParameterTypeDescription
projectsarrayList of Hex projects
idstringProject UUID
titlestringProject title
descriptionstringProject description
statusobjectProject status
namestringStatus name (e.g., PUBLISHED, DRAFT)
typestringProject type (PROJECT or COMPONENT)
creatorobjectProject creator
emailstringCreator email
ownerobjectProject owner
emailstringOwner email
lastEditedAtstringLast edited timestamp
lastPublishedAtstringLast published timestamp
createdAtstringCreation timestamp
archivedAtstringArchived timestamp
totalnumberTotal number of projects returned

hex_list_users

List all users in the Hex workspace with optional filtering and sorting.

Input

ParameterTypeRequiredDescription
apiKeystringYesHex API token (Personal or Workspace)
limitnumberNoMaximum number of users to return (1-100, default: 25)
sortBystringNoSort by field: NAME or EMAIL
sortDirectionstringNoSort direction: ASC or DESC
groupIdstringNoFilter users by group UUID

Output

ParameterTypeDescription
usersarrayList of workspace users
idstringUser UUID
namestringUser name
emailstringUser email
rolestringUser role (ADMIN, MANAGER, EDITOR, EXPLORER, MEMBER, GUEST, EMBEDDED_USER, ANONYMOUS)
totalnumberTotal number of users returned

hex_run_project

Execute a published Hex project. Optionally pass input parameters and control caching behavior.

Input

ParameterTypeRequiredDescription
apiKeystringYesHex API token (Personal or Workspace)
projectIdstringYesThe UUID of the Hex project to run
inputParamsjsonNoJSON object of input parameters for the project (e.g., {"date": "2024-01-01"})
dryRunbooleanNoIf true, perform a dry run without executing the project
updateCachebooleanNo(Deprecated) If true, update the cached results after execution
updatePublishedResultsbooleanNoIf true, update the published app results after execution
useCachedSqlResultsbooleanNoIf true, use cached SQL results instead of re-running queries

Output

ParameterTypeDescription
projectIdstringProject UUID
runIdstringRun UUID
runUrlstringURL to view the run
runStatusUrlstringURL to check run status
traceIdstringTrace ID for debugging
projectVersionnumberProject version number

hex_update_project

Update a Hex project status label (e.g., endorsement or custom workspace statuses).

Input

ParameterTypeRequiredDescription
apiKeystringYesHex API token (Personal or Workspace)
projectIdstringYesThe UUID of the Hex project to update
statusstringYesNew project status name (custom workspace status label)

Output

ParameterTypeDescription
idstringProject UUID
titlestringProject title
descriptionstringProject description
statusobjectUpdated project status
namestringStatus name (e.g., PUBLISHED, DRAFT)
typestringProject type (PROJECT or COMPONENT)
creatorobjectProject creator
emailstringCreator email
ownerobjectProject owner
emailstringOwner email
categoriesarrayProject categories
namestringCategory name
descriptionstringCategory description
lastEditedAtstringLast edited timestamp
lastPublishedAtstringLast published timestamp
createdAtstringCreation timestamp
archivedAtstringArchived timestamp
trashedAtstringTrashed timestamp

On this page

Start building today
Trusted by over 60,000 builders.
Build Agentic workflows visually on a drag-and-drop canvas or with natural language.
Get started