API_KEY
hex_api_key
Developer setup
No fields declared in this snapshot.
User connection
- API Tokengeneric_api_key · stringRequired
HEX
Hex is a collaborative data workspace that combines SQL, Python, and R notebooks for analytics and data science
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
32
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
API_KEY
No fields declared in this snapshot.
Capability index
Showing 1–30 of 32 actions
HEX_CANCEL_RUN
Tool to cancel a project run that is in progress. Use when you need to stop a currently executing Hex project run before it completes.
Untrusted display-only summary
HEX_CREATE_CELL
Tool to create a new cell in the draft version of a Hex project. Use when adding CODE or SQL cells to a project. Only CODE and SQL cell types are supported. Requires EDIT_PROJECT_CONTENTS permission.
Untrusted display-only summary
HEX_CREATE_COLLECTION
Tool to create a new collection in the Hex workspace. Use when you need to organize projects and resources into a collection.
Untrusted display-only summary
HEX_CREATE_GROUP
Tool to create a new group in the Hex workspace. Use when you need to organize users into groups for collaboration and access control.
Untrusted display-only summary
HEX_DEACTIVATE_USER
Deactivates a user in the Hex workspace. Use this when you need to deactivate a user by their ID.
Untrusted display-only summary
HEX_DELETE_CELL
Permanently delete a cell from the draft version of a project. Requires EDIT_PROJECT_CONTENTS permission. Use when you need to remove a cell from a Hex project's draft.
Untrusted display-only summary
HEX_DELETE_GROUP
Deletes a group from the Hex workspace. Use this when you need to permanently remove a group by its ID.
Untrusted display-only summary
HEX_DELETE_GUIDE_DRAFT
Deletes a guide draft by ID from Hex. Use this when you need to permanently remove a draft guide.
Untrusted display-only summary
HEX_EDIT_COLLECTION
Tool to edit a collection's name, description, and sharing settings in Hex. Use when you need to update collection metadata or change sharing permissions.
Untrusted display-only summary
HEX_EDIT_GROUP
Tool to edit a group's name and/or members in Hex. Use when you need to update group details, add users to a group, or remove users from a group.
Untrusted display-only summary
HEX_EDIT_PROJECT_SHARING_COLLECTIONS
Tool to add a project to collections or remove it from collections. Use when you need to update project sharing by adding or modifying collection access. Workspace tokens need Collections -> Write access scope in addition to Projects -> Write access scope.
Untrusted display-only summary
HEX_EDIT_PROJECT_SHARING_GROUPS
Tool to edit project sharing settings for groups in Hex. Use when you need to add or modify group access to a project. Supports up to 25 groups per request.
Untrusted display-only summary
HEX_EDIT_PROJECT_SHARING_ORG_AND_PUBLIC
Tool to edit project sharing settings for workspace members and public web access. Use when you need to control who can access a Hex project and what permissions they have.
Untrusted display-only summary
HEX_EDIT_PROJECT_SHARING_USERS
Tool to edit project sharing settings for individual users in Hex. Add or modify user access to a project by specifying access levels (NONE, APP_ONLY, CAN_VIEW, CAN_EDIT, FULL_ACCESS). Use when you need to grant or update project permissions for specific users. Maximum 25 users per request.
Untrusted display-only summary
HEX_GET_CELL
Tool to get a single cell by ID from the draft version of a Hex project. Use when you need to retrieve cell details including source contents for CODE and SQL cells. Returns complete cell information including cell type, contents, and associated metadata.
Untrusted display-only summary
HEX_GET_COLLECTION
Tool to get information about a specific collection in Hex. Returns collection details including name, description, creator, and sharing settings. Use when you need to retrieve metadata about a collection by its ID.
Untrusted display-only summary
HEX_GET_GROUP
Tool to retrieve information about a specific Hex group. Use when you need to get details about a group including its ID, name, and creation date.
Untrusted display-only summary
HEX_GET_PROJECT
Tool to get metadata about a single Hex project. Use when you need to retrieve project details including title, description, creator, owner, status, categories, analytics, schedules, and sharing information.
Untrusted display-only summary
HEX_GET_PROJECT_RUNS
Tool to retrieve the status of API-triggered runs for a specific Hex project. Use when you need to check the execution status, timing, or history of project runs. Returns a paginated list of runs with detailed status information.
Untrusted display-only summary
HEX_GET_RUN_CHART_IMAGE
Tool to retrieve a rendered chart image from a Hex project run. Use when you need to get a visual representation of a chart cell from a completed run. Only supports chart-type cells that have executed successfully without errors. Rate limited to 20 requests per minute.
Untrusted display-only summary
HEX_GET_RUN_STATUS
Tool to retrieve the status of a specific Hex project run. Use when you need to check the current state, timing, or completion status of a project execution. Returns detailed information including start/end times, elapsed time, status, and notification details.
Untrusted display-only summary
HEX_LIST_CELLS
Tool to list all cells from the draft version of a Hex project. Use when you need to retrieve cells with source code for SQL and CODE cells. Returns paginated results with cell details including type, label, and contents.
Untrusted display-only summary
HEX_LIST_COLLECTIONS
Tool to retrieve all collections in the workspace with pagination support. Use when you need to list or discover available collections.
Untrusted display-only summary
HEX_LIST_DATA_CONNECTIONS
Tool to list all data connections in the Hex workspace with pagination support. Use when you need to retrieve, browse, or audit data connections configured in Hex. Supports filtering by sort criteria and cursor-based pagination for large result sets.
Untrusted display-only summary
HEX_LIST_GROUPS
Tool to list all groups in the Hex workspace with pagination support. Use when you need to retrieve groups with optional sorting and pagination.
Untrusted display-only summary
HEX_LIST_PROJECTS
Tool to list all viewable Hex projects with pagination and filtering support. Use when you need to retrieve projects sorted by creation date or filter by status, categories, creator, owner, or collection.
Untrusted display-only summary
HEX_LIST_USERS
Tool to list all users in the Hex workspace with pagination support. Returns user details including names, emails, roles, and last login dates. Use when you need to retrieve users, filter by group, or paginate through large user lists.
Untrusted display-only summary
HEX_PUBLISH_GUIDE_DRAFTS
Tool to publish all currently drafted guides or specific guides by ID. Use when you need to make draft guides publicly available. Specify either publishAllDraftGuides=true or provide specific guide IDs.
Untrusted display-only summary
HEX_RUN_PROJECT
Tool to trigger a run of the latest published version of a Hex project. Use when you need to execute a project programmatically. Rate limited to 20 requests per minute and 60 requests per hour.
Untrusted display-only summary
HEX_UPDATE_CELL
Tool to update a cell's source code and/or data connection in Hex. Use when you need to modify the contents of a code cell or SQL cell. Requires EDIT_PROJECT_CONTENTS permission.
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.