Hex

使用说明

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.

工具

`hex_cancel_run`

Cancel an active Hex project run.

输入

参数	类型	必填	描述
`apiKey`	string	是	Hex API token (Personal or Workspace)
`projectId`	string	是	The UUID of the Hex project
`runId`	string	是	The UUID of the run to cancel

输出

参数	类型	描述
`success`	boolean	Whether the run was successfully cancelled
`projectId`	string	Project UUID
`runId`	string	Run UUID that was cancelled

`hex_create_collection`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Hex API token (Personal or Workspace)
`name`	string	是	Name for the new collection
`description`	string	否	Optional description for the collection

输出

参数	类型	描述
`id`	string	Newly created collection UUID
`name`	string	Collection name
`description`	string	Collection description
`creator`	object	Collection creator
↳ `email`	string	Creator email
↳ `id`	string	Creator UUID

`hex_get_collection`

Retrieve details for a specific Hex collection by its ID.

输入

参数	类型	必填	描述
`apiKey`	string	是	Hex API token (Personal or Workspace)
`collectionId`	string	是	The UUID of the collection

输出

参数	类型	描述
`id`	string	Collection UUID
`name`	string	Collection name
`description`	string	Collection description
`creator`	object	Collection creator
↳ `email`	string	Creator email
↳ `id`	string	Creator UUID

`hex_get_data_connection`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Hex API token (Personal or Workspace)
`dataConnectionId`	string	是	The UUID of the data connection

输出

参数	类型	描述
`id`	string	Connection UUID
`name`	string	Connection name
`type`	string	Connection type (e.g., snowflake, postgres, bigquery)
`description`	string	Connection description
`connectViaSsh`	boolean	Whether SSH tunneling is enabled
`includeMagic`	boolean	Whether Magic AI features are enabled
`allowWritebackCells`	boolean	Whether writeback cells are allowed

`hex_get_group`

Retrieve details for a specific Hex group.

输入

参数	类型	必填	描述
`apiKey`	string	是	Hex API token (Personal or Workspace)
`groupId`	string	是	The UUID of the group

输出

参数	类型	描述
`id`	string	Group UUID
`name`	string	Group name
`createdAt`	string	Creation timestamp

`hex_get_project`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Hex API token (Personal or Workspace)
`projectId`	string	是	The UUID of the Hex project

输出

参数	类型	描述
`id`	string	Project UUID
`title`	string	Project title
`description`	string	Project description
`status`	object	Project status
↳ `name`	string	Status name (e.g., PUBLISHED, DRAFT)
`type`	string	Project type (PROJECT or COMPONENT)
`creator`	object	Project creator
↳ `email`	string	Creator email
`owner`	object	Project owner
↳ `email`	string	Owner email
`categories`	array	Project categories
↳ `name`	string	Category name
↳ `description`	string	Category description
`lastEditedAt`	string	ISO 8601 last edited timestamp
`lastPublishedAt`	string	ISO 8601 last published timestamp
`createdAt`	string	ISO 8601 creation timestamp
`archivedAt`	string	ISO 8601 archived timestamp
`trashedAt`	string	ISO 8601 trashed timestamp

`hex_get_project_runs`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Hex API token (Personal or Workspace)
`projectId`	string	是	The UUID of the Hex project
`limit`	number	否	Maximum number of runs to return (1-100, default: 25)
`offset`	number	否	Offset for paginated results (default: 0)
`statusFilter`	string	否	Filter by run status: PENDING, RUNNING, ERRORED, COMPLETED, KILLED, UNABLE_TO_ALLOCATE_KERNEL

输出

参数	类型	描述
`runs`	array	List of project runs
↳ `projectId`	string	Project UUID
↳ `runId`	string	Run UUID
↳ `runUrl`	string	URL to view the run
↳ `status`	string	Run status (PENDING, RUNNING, COMPLETED, ERRORED, KILLED, UNABLE_TO_ALLOCATE_KERNEL)
↳ `startTime`	string	Run start time
↳ `endTime`	string	Run end time
↳ `elapsedTime`	number	Elapsed time in seconds
↳ `traceId`	string	Trace ID
↳ `projectVersion`	number	Project version number
`total`	number	Total number of runs returned
`traceId`	string	Top-level trace ID

`hex_get_queried_tables`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Hex API token (Personal or Workspace)
`projectId`	string	是	The UUID of the Hex project
`limit`	number	否	Maximum number of tables to return (1-100)

输出

参数	类型	描述
`tables`	array	List of warehouse tables queried by the project
↳ `dataConnectionId`	string	Data connection UUID
↳ `dataConnectionName`	string	Data connection name
↳ `tableName`	string	Table name
`total`	number	Total number of tables returned

`hex_get_run_status`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Hex API token (Personal or Workspace)
`projectId`	string	是	The UUID of the Hex project
`runId`	string	是	The UUID of the run to check

输出

参数	类型	描述
`projectId`	string	Project UUID
`runId`	string	Run UUID
`runUrl`	string	URL to view the run
`status`	string	Run status (PENDING, RUNNING, COMPLETED, ERRORED, KILLED, UNABLE_TO_ALLOCATE_KERNEL)
`startTime`	string	ISO 8601 run start time
`endTime`	string	ISO 8601 run end time
`elapsedTime`	number	Elapsed time in seconds
`traceId`	string	Trace ID for debugging
`projectVersion`	number	Project version number

`hex_list_collections`

List all collections in the Hex workspace.

输入

参数	类型	必填	描述
`apiKey`	string	是	Hex API token (Personal or Workspace)
`limit`	number	否	Maximum number of collections to return (1-500, default: 25)
`sortBy`	string	否	Sort by field: NAME

输出

参数	类型	描述
`collections`	array	List of collections
↳ `id`	string	Collection UUID
↳ `name`	string	Collection name
↳ `description`	string	Collection description
↳ `creator`	object	Collection creator
↳ `email`	string	Creator email
↳ `id`	string	Creator UUID
`total`	number	Total number of collections returned

`hex_list_data_connections`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Hex API token (Personal or Workspace)
`limit`	number	否	Maximum number of connections to return (1-500, default: 25)
`sortBy`	string	否	Sort by field: CREATED_AT or NAME
`sortDirection`	string	否	Sort direction: ASC or DESC

输出

参数	类型	描述
`connections`	array	List of data connections
↳ `id`	string	Connection UUID
↳ `name`	string	Connection name
↳ `type`	string	Connection type (e.g., athena, bigquery, databricks, postgres, redshift, snowflake)
↳ `description`	string	Connection description
↳ `connectViaSsh`	boolean	Whether SSH tunneling is enabled
↳ `includeMagic`	boolean	Whether Magic AI features are enabled
↳ `allowWritebackCells`	boolean	Whether writeback cells are allowed
`total`	number	Total number of connections returned

`hex_list_groups`

List all groups in the Hex workspace with optional sorting.

输入

参数	类型	必填	描述
`apiKey`	string	是	Hex API token (Personal or Workspace)
`limit`	number	否	Maximum number of groups to return (1-500, default: 25)
`sortBy`	string	否	Sort by field: CREATED_AT or NAME
`sortDirection`	string	否	Sort direction: ASC or DESC

输出

参数	类型	描述
`groups`	array	List of workspace groups
↳ `id`	string	Group UUID
↳ `name`	string	Group name
↳ `createdAt`	string	Creation timestamp
`total`	number	Total number of groups returned

`hex_list_projects`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Hex API token (Personal or Workspace)
`limit`	number	否	Maximum number of projects to return (1-100)
`includeArchived`	boolean	否	Include archived projects in results
`statusFilter`	string	否	Filter by status: PUBLISHED, DRAFT, or ALL

输出

参数	类型	描述
`projects`	array	List of Hex projects
↳ `id`	string	Project UUID
↳ `title`	string	Project title
↳ `description`	string	Project description
↳ `status`	object	Project status
↳ `name`	string	Status name (e.g., PUBLISHED, DRAFT)
↳ `type`	string	Project type (PROJECT or COMPONENT)
↳ `creator`	object	Project creator
↳ `email`	string	Creator email
↳ `owner`	object	Project owner
↳ `email`	string	Owner email
↳ `lastEditedAt`	string	Last edited timestamp
↳ `lastPublishedAt`	string	Last published timestamp
↳ `createdAt`	string	Creation timestamp
↳ `archivedAt`	string	Archived timestamp
`total`	number	Total number of projects returned

`hex_list_users`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Hex API token (Personal or Workspace)
`limit`	number	否	Maximum number of users to return (1-100, default: 25)
`sortBy`	string	否	Sort by field: NAME or EMAIL
`sortDirection`	string	否	Sort direction: ASC or DESC
`groupId`	string	否	Filter users by group UUID

输出

参数	类型	描述
`users`	array	List of workspace users
↳ `id`	string	User UUID
↳ `name`	string	User name
↳ `email`	string	User email
↳ `role`	string	User role (ADMIN, MANAGER, EDITOR, EXPLORER, MEMBER, GUEST, EMBEDDED_USER, ANONYMOUS)
`total`	number	Total number of users returned

`hex_run_project`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Hex API token (Personal or Workspace)
`projectId`	string	是	The UUID of the Hex project to run
`inputParams`	json	否	JSON object of input parameters for the project (e.g., {"date": "2024-01-01"})
`dryRun`	boolean	否	If true, perform a dry run without executing the project
`updateCache`	boolean	否	(Deprecated) If true, update the cached results after execution
`updatePublishedResults`	boolean	否	If true, update the published app results after execution
`useCachedSqlResults`	boolean	否	If true, use cached SQL results instead of re-running queries

输出

参数	类型	描述
`projectId`	string	Project UUID
`runId`	string	Run UUID
`runUrl`	string	URL to view the run
`runStatusUrl`	string	URL to check run status
`traceId`	string	Trace ID for debugging
`projectVersion`	number	Project version number

`hex_update_project`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Hex API token (Personal or Workspace)
`projectId`	string	是	The UUID of the Hex project to update
`status`	string	是	New project status name (custom workspace status label)

输出

参数	类型	描述
`id`	string	Project UUID
`title`	string	Project title
`description`	string	Project description
`status`	object	Updated project status
↳ `name`	string	Status name (e.g., PUBLISHED, DRAFT)
`type`	string	Project type (PROJECT or COMPONENT)
`creator`	object	Project creator
↳ `email`	string	Creator email
`owner`	object	Project owner
↳ `email`	string	Owner email
`categories`	array	Project categories
↳ `name`	string	Category name
↳ `description`	string	Category description
`lastEditedAt`	string	Last edited timestamp
`lastPublishedAt`	string	Last published timestamp
`createdAt`	string	Creation timestamp
`archivedAt`	string	Archived timestamp
`trashedAt`	string	Trashed timestamp

On this page