Hex

Hex-Projekte ausführen und verwalten

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 AACFlow Hex integration allows your AI agents or workflows to:

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

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

Nutzungsanleitung

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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Hex API token (Personal or Workspace)
`projectId`	string	Ja	The UUID of the Hex project
`runId`	string	Ja	The UUID of the run to cancel

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Hex API token (Personal or Workspace)
`name`	string	Ja	Name for the new collection
`description`	string	Nein	Optional description for the collection

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Hex API token (Personal or Workspace)
`collectionId`	string	Ja	The UUID of the collection

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Hex API token (Personal or Workspace)
`dataConnectionId`	string	Ja	The UUID of the data connection

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Hex API token (Personal or Workspace)
`groupId`	string	Ja	The UUID of the group

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Hex API token (Personal or Workspace)
`projectId`	string	Ja	The UUID of the Hex project

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Hex API token (Personal or Workspace)
`projectId`	string	Ja	The UUID of the Hex project
`limit`	number	Nein	Maximum number of runs to return (1-100, default: 25)
`offset`	number	Nein	Offset for paginated results (default: 0)
`statusFilter`	string	Nein	Filter by run status: PENDING, RUNNING, ERRORED, COMPLETED, KILLED, UNABLE_TO_ALLOCATE_KERNEL

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Hex API token (Personal or Workspace)
`projectId`	string	Ja	The UUID of the Hex project
`limit`	number	Nein	Maximum number of tables to return (1-100)

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Hex API token (Personal or Workspace)
`projectId`	string	Ja	The UUID of the Hex project
`runId`	string	Ja	The UUID of the run to check

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Hex API token (Personal or Workspace)
`limit`	number	Nein	Maximum number of collections to return (1-500, default: 25)
`sortBy`	string	Nein	Sort by field: NAME

Ausgabe

Parameter	Typ	Beschreibung
`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).

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Hex API token (Personal or Workspace)
`limit`	number	Nein	Maximum number of connections to return (1-500, default: 25)
`sortBy`	string	Nein	Sort by field: CREATED_AT or NAME
`sortDirection`	string	Nein	Sort direction: ASC or DESC

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Hex API token (Personal or Workspace)
`limit`	number	Nein	Maximum number of groups to return (1-500, default: 25)
`sortBy`	string	Nein	Sort by field: CREATED_AT or NAME
`sortDirection`	string	Nein	Sort direction: ASC or DESC

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Hex API token (Personal or Workspace)
`limit`	number	Nein	Maximum number of projects to return (1-100)
`includeArchived`	boolean	Nein	Include archived projects in results
`statusFilter`	string	Nein	Filter by status: PUBLISHED, DRAFT, or ALL

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Hex API token (Personal or Workspace)
`limit`	number	Nein	Maximum number of users to return (1-100, default: 25)
`sortBy`	string	Nein	Sort by field: NAME or EMAIL
`sortDirection`	string	Nein	Sort direction: ASC or DESC
`groupId`	string	Nein	Filter users by group UUID

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

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

Ausgabe

Parameter	Typ	Beschreibung
`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).

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Hex API token (Personal or Workspace)
`projectId`	string	Ja	The UUID of the Hex project to update
`status`	string	Ja	New project status name (custom workspace status label)

Ausgabe

Parameter	Typ	Beschreibung
`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

Guardrails HFLabs FactoryD

On this page

Heute mit dem Aufbau beginnen

Über 100 000 Entwickler vertrauen uns.

Die SaaS-Plattform zum Aufbau von KI-Agenten und für Ihre agentische Belegschaft.