Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hex Cells API

The Cells API from Hex — 3 operation(s) for cells.

Hex Cells API is one of 9 APIs that Hex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cells. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://app.hex.tech/api.

6 operations 3 paths 14 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://app.hex.tech/api/v1
Authentication
HTTP Bearer
License
UNLICENSED
Resource Areas
1

Authentication & Security 1

Hex Cells API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Cells 6
GET
/v1/cells
List all cells Returns cells from the draft version of the project only, not the published app. Requires a project id for filtering. For SQL and CODE cells, includes the source code content.
ListCells 4 params → 200400403404500
POST
/v1/cells
Create a new cell Creates a new cell in the draft version of a project. Currently only CODE and SQL cell types are supported. Requires EDITPROJECTCONTENTS permission on the project.
CreateCell body → 201400403404500
GET
/v1/cells/{cellId}
Get a single cell by ID Returns cells from the draft version of the project only, not the published app. Returns the cell details including id, staticId, cellType, label, dataConnectionId, source con…
GetCell 1 param → 200403404500
PATCH
/v1/cells/{cellId}
Update a cell's source and/or data connection Updates the source code and/or data connection ID for a cell. For SQL cells, can update SQL source and data connection ID. For code cells, can update cod…
UpdateCell 1 param body → 200400403404500
DELETE
/v1/cells/{cellId}
Delete a cell Permanently deletes a cell from the draft version of a project. Requires EDITPROJECTCONTENTS permission on the project containing the cell.
DeleteCell 1 param → 204400403404500
GET
/v1/cells/{cellId}/image
Get the rendered PNG image of a chart cell from the current notebook session by cellId. The "cellId" path parameter should be the cell's ID (scoped to a specific version), as opposed to its staticId…
GetChartImageFromLogic 1 param → 200400403404422500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are CellApiResource (7 properties), ChartImageResponsePayload (3 properties), TsoaErrorResponsePayload (3 properties), PaginationApiResource (2 properties). Each schema is shown below with its type and property counts.

TraceId
string
A unique identifier for this API request. The Hex Support team may request this value when debugging an issue.
StaticCellId
string
Unique static ID for a cell. This can be found by going into the menu of a cell in the notebook.
TsoaErrorResponsePayload
object
3 properties 1 required
CellId
string
Unique ID for a cell. This can be found by going into the menu of a cell in the notebook.
ApiPaginationCursor
string
A cursor string used with before and after parameters to paginate through a list of items on the API.
CellType
ChartImageResponsePayload
object
3 properties 3 required
EnumValues_typeofCellType_
string
CellApiResource
object
7 properties 7 required
PaginationApiResource
object
2 properties 2 required
DataConnectionId
string
Unique ID for a data connection.
PageSize
integer
Number of results to fetch per page for paginated requests
ProjectId
string
Unique ID for a Hex project. This can be found in the Variables side bar of the Logic View of a project, or by visiting the Project, and copying the UUID after…
CellsListApiResource
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hexa-cells-api-openapi.yml Raw ↑

Other APIs Hex publishes across the network.

Hex Collections API
Hex Data Connections API
Hex Embedding API
Hex Groups API
Hex Guides API
Hex Projects API
Hex Semantic (projects|models) API
Hex Users API