Skip to content
Changelog

Report a bug

Hex integration: operations for AI agents

Hex connects to Type.com as an integration. This page lists the 60 operations documented for Claude and Codex in Type.com: 28 read, 12 write, 20 destructive.

About Hex

Hex API reference operations, subject to Type setup and account permissions.

Categories: Analytics & Data

How to connect Hex to Type.com

Connect
Configure the Hex API target and bearer credentials.
Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

60 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

60 operations listed.

Hex API

  • Read

    List Projects

    List all viewable projects, sorted by most recently created first.

    GET /api/v1/projects

  • Read

    Get Queried Tables

    Given a project ID, return the list of warehouse tables queried in the project.

    GET /api/v1/projects/{projectId}/queriedTables

  • Read

    GetRunStatus

    Get the status of a project run. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    GET /api/v1/projects/{projectId}/runs/{runId}

  • Read

    Get Group

    Get Group

    GET /api/v1/groups/{groupId}

  • Read

    List Groups

    List Groups

    GET /api/v1/groups

  • Read

    ListDataConnections

    List the workspace's data connections. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    GET /api/v1/data-connections

  • Read

    GetDataConnection

    Get a single data connection by its ID. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    GET /api/v1/data-connections/{dataConnectionId}

  • Read

    Get Collection

    Get Collection

    GET /api/v1/collections/{collectionId}

  • Read

    List Collections

    List Collections

    GET /api/v1/collections

  • Read

    GetCell

    Get a single cell by ID This endpoint is subject to the following rate limits: - `hex-api-30rpm`: Rate limit group for the Hex API at 30 requests per minute - Max 30 requests per minute

    GET /api/v1/cells/{cellId}

  • Read

    GetCellOutput

    **Unstable**: This endpoint is unstable API. Hex may make breaking changes to this endpoint without notice. Get the latest output preview for a SQL cell in the active draft notebook session. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    GET /api/v1/cells/{cellId}/output

  • Read

    ListCells

    List cells from the draft version of a project. Returns code, SQL, and markdown cell contents. This endpoint is subject to the following rate limits: - `hex-api-30rpm`: Rate limit group for the Hex API at 30 requests per minute - Max 30 requests per minute

    GET /api/v1/cells

  • Read

    GetChartImageFromLogic

    Get the rendered PNG image of a chart cell from the project's current notebook (draft) session. The cell must have been executed and must not be in an error state. Only chart-type cells are supported. This endpoint is subject to the following rate limits: - `hex-chart-image`: Rate limits for rendering chart images - Max 20 requests per minute

    GET /api/v1/cells/{cellId}/image

  • Read

    ExportProject

    Exports a Hex project in the *.hex.yaml format. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    POST /api/v1/projects/export

  • Read

    GetChartImageFromRun

    Get the rendered PNG image of a chart cell from a completed run by staticCellId. The cell must have been executed and must not be in an error state. Only chart-type cells are supported. This endpoint is subject to the following rate limits: - `hex-chart-image`: Rate limits for rendering chart images - Max 20 requests per minute

    GET /api/v1/projects/{projectId}/runs/{runId}/cells/{staticId}/image

  • Read

    GetProject

    Get metadata about a single project. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    GET /api/v1/projects/{projectId}

  • Read

    GetProjectRuns

    Get the status of runs of a project. By default, all run types are returned (API-triggered, scheduled, and publish/refresh runs). Use the `runTriggerFilter` parameter to filter to a specific type. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    GET /api/v1/projects/{projectId}/runs

  • Read

    GetSuggestion

    Get a single context suggestion by id, including its evidence sources and the proposed changes from its most recent review run. This endpoint is subject to the following rate limits: - `hex-api-30rpm`: Rate limit group for the Hex API at 30 requests per minute - Max 30 requests per minute

    GET /api/v1/suggestions/{suggestionId}

  • Read

    ListSuggestions

    List context suggestions for the workspace. This endpoint is subject to the following rate limits: - `hex-api-30rpm`: Rate limit group for the Hex API at 30 requests per minute - Max 30 requests per minute

    GET /api/v1/suggestions

  • Read

    ListThreads

    List agent threads in the workspace, sorted by most recently created first. Requires Manager org role or higher. Workspace admins receive every non-private thread; managers receive threads they created plus Threads-type threads on projects they have access to. Threads marked private are returned with their title redacted. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    GET /api/v1/threads

  • Read

    GetThread

    Get the response of an agent thread. Returns the current status (RUNNING, IDLE, or ERROR) and the agent's response content when available. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    GET /api/v1/threads/{id}

  • Read

    GetThreadMessages

    List the messages in an agent thread, rendered as a single flat list of text blocks. Within a page messages are chronological (oldest first); each text block is prefixed with the authoring role, and thinking and error blocks are tagged. Each block includes the creation time of its originating message. Tool-call, tool-result, and mention blocks are omitted, and inline references are left as raw tags. By default the most recent page is returned (matching the MCP get_thread tool); pass the `before` cursor to fetch older messages and `after` to fetch newer ones. Set `full` to include JSON-encoded message records with thinking, tool calls, results, and mentions. Supports cursor pagination with a maximum page size of 50. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    GET /api/v1/threads/{threadId}/messages

  • Read

    ListAgentUsage

    List per-agent-run credit usage for the workspace, most recent run first. Requires workspace admin, or a workspace token with the agent usage read scope. Each row aggregates one agent run's credit consumption. Availability of this endpoint is subject to the following requirement: - The agent usage API requires the Enterprise plan. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    GET /api/v1/agent-usage

  • Read

    ListCreditGrants

    List the workspace's credit grants, most recent first. Requires workspace admin, or a workspace token with the agent usage read scope. Each row is one credit grant. Availability of this endpoint is subject to the following requirement: - The credit grants API requires the Enterprise plan. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    GET /api/v1/credit-grants

  • Read

    Me

    Returns information about the current logged in user. User metadata will be omitted when authenticating with a workspace token. This endpoint is subject to the following rate limits: - `hex-api-30rpm`: Rate limit group for the Hex API at 30 requests per minute - Max 30 requests per minute

    GET /api/v1/users/me

  • Read

    ListUsers

    List all users in the workspace This endpoint is subject to the following rate limits: - `hex-api-30rpm`: Rate limit group for the Hex API at 30 requests per minute - Max 30 requests per minute

    GET /api/v1/users

  • Read

    ListTopics

    List thread topics in the workspace, sorted by name. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    GET /api/v1/context/topics

  • Read

    ListDraftGuides

    List draft guides This endpoint is subject to the following rate limits: - `hex-api-30rpm`: Rate limit group for the Hex API at 30 requests per minute - Max 30 requests per minute

    GET /api/v1/guides/draft/list

  • Write

    Create Presigned Url

    Create an embedded url for a project

    POST /api/v1/embedding/createPresignedUrl/{projectId}

  • Write

    CreateProject

    Create a new project in the workspace with the specified title, and optionally a description. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    POST /api/v1/projects

  • Write

    Create Group

    Create Group

    POST /api/v1/groups

  • Write

    Create Data Connection

    Create Data Connection

    POST /api/v1/data-connections

  • Write

    Create Collection

    Create Collection

    POST /api/v1/collections

  • Write

    CreateCell

    Create a new cell in the draft version of a project This endpoint is subject to the following rate limits: - `hex-api-30rpm`: Rate limit group for the Hex API at 30 requests per minute - Max 30 requests per minute

    POST /api/v1/cells

  • Write

    RunProject

    Trigger a run of the latest published version of a project. This endpoint is subject to the following rate limits: - `hex-run-kernel`: Rate limits for starting project runs, sending thread messages, or executing kernels - Max requests per minute may vary - Max requests per hour may vary

    POST /api/v1/projects/{projectId}/runs

  • Write

    UpdateSuggestion

    Update the status of a context suggestion. This endpoint is subject to the following rate limits: - `hex-api-30rpm`: Rate limit group for the Hex API at 30 requests per minute - Max 30 requests per minute

    POST /api/v1/suggestions/{suggestionId}

  • Write

    UpdateSuggestionChange

    Update the status of an individual proposed change within a context suggestion. The change is either a file update or a data-warehouse update, selected by `updateTarget`. This endpoint is subject to the following rate limits: - `hex-api-30rpm`: Rate limit group for the Hex API at 30 requests per minute - Max 30 requests per minute

    POST /api/v1/suggestions/{suggestionId}/changes/{changeId}

  • Write

    TriggerSuggestionReview

    Trigger a background review agent run for the given context suggestion. If a review is already in flight for this suggestion, returns the current run. This endpoint is subject to the following rate limits: - `hex-api-30rpm`: Rate limit group for the Hex API at 30 requests per minute - Max 30 requests per minute

    POST /api/v1/suggestions/{suggestionId}/review

  • Write

    CreateThread

    Start an agent thread with a prompt. The Hex agent will analyze data and respond to the prompt. The thread runs asynchronously — poll its status or visit the returned URL to view progress. This endpoint is subject to the following rate limits: - `hex-run-kernel`: Rate limits for starting project runs, sending thread messages, or executing kernels - Max requests per minute may vary - Max requests per hour may vary

    POST /api/v1/threads

  • Write

    ContinueThread

    Continue an existing agent thread with a follow-up prompt. This endpoint does not support queuing: the thread must be idle before a follow-up can be sent. This endpoint is subject to the following rate limits: - `hex-run-kernel`: Rate limits for starting project runs, sending thread messages, or executing kernels - Max requests per minute may vary - Max requests per hour may vary

    POST /api/v1/threads/{id}/followup

  • Destructive

    Edit Project Sharing Collections

    Add a project to collections or remove it from collections. For projects, use `CAN_VIEW` to grant the UI permission labeled "Can explore". Use `APP_ONLY` to grant the UI permission labeled "Can view app". Workspace tokens calling this endpoint need to have "Collections -> Write access" scope in addition to "Projects -> Write access" scope.

    PATCH /api/v1/projects/{projectId}/sharing/collections

  • Destructive

    Ingest Semantic Project

    Ingest a semantic project from a zip file. This API endpoint is subject to a maximum of 3 requests per minute.

    POST /api/v1/semantic-(projects|models)/{semanticProjectId}/ingest

  • Destructive

    Update Semantic Project

    Use this endpoint to add or remove a status (including endorsements) from datasets and views within a semantic project This endpoint uses atomic semantics - if any update in the batch fails validation, the entire request fails and no changes are applied.

    PATCH /api/v1/semantic-(projects|models)/{semanticProjectId}

  • Destructive

    Cancel Run

    Cancel a project run.

    DELETE /api/v1/projects/{projectId}/runs/{runId}

  • Destructive

    Delete Group

    Delete Group

    DELETE /api/v1/groups/{groupId}

  • Destructive

    Edit Group

    Edit Group

    PATCH /api/v1/groups/{groupId}

  • Destructive

    Edit Data Connection

    Edit Data Connection

    PATCH /api/v1/data-connections/{dataConnectionId}

  • Destructive

    Update Data Connection Schema

    Use this endpoint to add or remove a status (including endorsements) from databases, schemas, and tables within a data connection This endpoint uses atomic semantics - if any update in the batch fails validation, the entire request fails and no changes are applied

    PATCH /api/v1/data-connections/{dataConnectionId}/schema

  • Destructive

    Upsert Guide Draft

    Update or create guide drafts by filePath. Accepts a dictionary mapping file paths to their contents. For each file: - If the guide doesn't exist, it will be created. - If the guide exists but has no draft, a new draft will be created. - If the guide exists with a draft, the draft contents will be updated.

    PUT /api/v1/guides/draft

  • Destructive

    Publish Guide Drafts

    Publish all currently drafted guides.

    POST /api/v1/guides/publish

  • Destructive

    Delete Guide Draft

    Delete Guide Draft

    DELETE /api/v1/guides/draft/{orgGuideFileId}

  • Destructive

    Edit Collection

    Edit Collection

    PATCH /api/v1/collections/{collectionId}

  • Destructive

    UpdateCell

    Update a cell's source and/or data connection. For SQL cells, can update the SQL source, output dataframe, and data connection. For code and markdown cells, can update the source. Returns the updated cell. This endpoint is subject to the following rate limits: - `hex-api-30rpm`: Rate limit group for the Hex API at 30 requests per minute - Max 30 requests per minute

    PATCH /api/v1/cells/{cellId}

  • Destructive

    DeleteCell

    Delete a cell from the draft version of a project by ID This endpoint is subject to the following rate limits: - `hex-api-30rpm`: Rate limit group for the Hex API at 30 requests per minute - Max 30 requests per minute

    DELETE /api/v1/cells/{cellId}

  • Destructive

    BatchUpdateComputeProfile

    Update the compute profile (kernel image and/or kernel size) on one or more projects in a single request. At least one of kernelImage or kernelSize must be provided; the change applies to both the logic and published compute profiles. The caller must have edit permission on every project in the batch — a single failure rejects the whole batch (no partial updates). Cross-org project IDs are silently dropped. Batch size is capped at 250 IDs per request; larger batches should be paged. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    POST /api/v1/projects/compute-profile/batch

  • Destructive

    EditProjectSharingGroups

    Add groups to a project or update/remove their project sharing access. Use CAN_VIEW for the UI permission labeled "Can explore" and APP_ONLY for "Can view app". Use NONE to remove a group's access. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    PATCH /api/v1/projects/{projectId}/sharing/groups

  • Destructive

    EditProjectSharingUsers

    Add users to a project or update/remove their project sharing access. Use CAN_VIEW for the UI permission labeled "Can explore" and APP_ONLY for "Can view app". Use NONE to remove a user's access. This endpoint is subject to the following rate limits: - `hex-api-30rpm`: Rate limit group for the Hex API at 30 requests per minute - Max 30 requests per minute

    PATCH /api/v1/projects/{projectId}/sharing/users

  • Destructive

    EditProjectSharingOrgAndPublic

    Update workspace or public-web sharing for a project. For projects, use CAN_VIEW to grant the UI permission labeled "Can explore" and APP_ONLY for "Can view app". Use NONE to remove access. Omitted fields are left unchanged. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    PATCH /api/v1/projects/{projectId}/sharing/workspaceAndPublic

  • Destructive

    UpdateProject

    Add or remove a status, including endorsements, from a project. This endpoint is subject to the following rate limits: - `hex-api`: Default rate limit group for the Hex API - Max requests per minute may vary (default: 30) - Max requests per hour may vary (default: 1800)

    PATCH /api/v1/projects/{projectId}

  • Destructive

    DeactivateUser

    Deactivate a user This endpoint is subject to the following rate limits: - `hex-api-30rpm`: Rate limit group for the Hex API at 30 requests per minute - Max 30 requests per minute

    POST /api/v1/users/{userId}/deactivate

See How connections work for access and permissions, or browse all integrations.