Built by Metorial, the integration platform for agentic AI.
Generate a single-use presigned URL for embedding a Hex app. The URL grants access and must be treated as a credential. Opening it can execute the app unless testMode is enabled.
Create a new collection or update an existing collection's name and description. Collections serve as organizational containers for Hex projects.
Create a new group or update an existing group's name and membership. When creating, provide a name and optionally initial member user IDs. When updating, provide the group ID and any combination of new name, users to add, and users to remove.
Request cancellation of a PENDING or RUNNING project run. The acknowledgement does not prove the run has stopped; check its status afterward.
Trigger a run of the latest published version of a Hex project. Supports custom input parameters, saved views, cache control, and notifications for run completion (via Slack, users, or groups).
Deactivate a user from the Hex workspace. The user will lose access to the workspace. If your workspace uses Directory Sync, users should be managed there instead.
List Hex projects in the workspace. Supports filtering by status, category, creator, owner, or collection. Returns paginated results sorted by most recently created first.
Retrieve safe metadata for a specific data connection, including its name, connection type and optional description. Credentials and connection configuration are excluded.
Get the current status and details of a specific project run. PENDING and RUNNING are active; COMPLETED, ERRORED, KILLED and UNABLE_TO_ALLOCATE_KERNEL are terminal. Timing values can be null; elapsed time uses milliseconds.
List all collections in the Hex workspace. Collections are organizational containers for projects. Returns one page with collection names and descriptions when supplied by Hex.
Add or remove a status (including endorsements) from a Hex project. Set status to null to remove the current status.
List workspace users with their name, email, role, and last login date. Results are paginated and can be sorted.
List all groups in the Hex workspace. Returns group names, IDs, and creation dates with pagination support.
List all data connections configured in the Hex workspace. Returns connection names, types, and metadata with pagination support.
Delete a group from the Hex workspace. This removes the group and its associated permissions.
Retrieve detailed metadata about a single Hex project, including title, description, status, categories, creator, owner, timestamps, and optionally sharing permissions.
List one page of API-triggered Hex project runs, optionally filtered by status. Returns run IDs, state and nullable timing metadata. Notification recipient details are excluded.
Retrieve the list of warehouse tables queried by a Hex project. Useful for observability and understanding data dependencies. Returns connection and table information.
Configure sharing permissions for a Hex project. Supports setting access at multiple levels: individual users, groups, collections, workspace-wide, and public web. Access levels include NONE, APP_ONLY, CAN_VIEW, CAN_EDIT, and FULL_ACCESS. You can update one or more sharing levels in a single call.
Create an empty draft Hex project with a title and optional description. This does not publish or execute code. The public API has no project deletion endpoint.
Download a Hex project as a .hex.yaml file. Select the draft notebook, latest published version, or a specific positive version number. The export includes the project code and configuration accessible to your token; handle it according to its sensitivity.
Read a Hex group by its ID. Member details are not included in this API response.
Read the selected Hex collection. Description and timestamps are returned only when supplied by the provider.
Read the authenticated Hex workspace identity and, for personal tokens, the current user. Workspace tokens omit user details. No token value is returned.