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 — 4 operation(s) for cells.

Hex Cells API is one of 11 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 authentication docs.

This API exposes 7 operations across 4 paths, and defines 10 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

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

7 operations 4 paths 10 schemas 1 DELETE4 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
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 7

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

Cells 7
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 4 params → 200400403404422500
GET
/v1/cells/{cellId}
GetCell
GetCell 1 param → 200400401403404500
PATCH
/v1/cells/{cellId}
UpdateCell
UpdateCell 1 param body → 200400401403404500
DELETE
/v1/cells/{cellId}
DeleteCell
DeleteCell 1 param → 200400401403404500
GET
/v1/cells/{cellId}/output
GetCellOutput
GetCellOutput 1 param → 200400401403404500
POST
/v1/cells
CreateCell
CreateCell body → 200400401403500
GET
/v1/cells
ListCells
ListCells 4 params → 200400401403404500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are error.UNAUTHORIZED (3 properties), ChartImageResponsePayload (3 properties), error.FORBIDDEN (3 properties), error.BAD_REQUEST (3 properties). Each schema is shown below with its type and property counts.

error.BAD_REQUEST
object
The error information
3 properties 2 required
ChartImageResponsePayload
object
3 properties 3 required
error.UNAUTHORIZED
object
The error information
3 properties 2 required
ChartImageDimension
integer
Chart image total dimension (width or height) in pixels.
TsoaErrorResponsePayload
object
3 properties 1 required
error.NOT_FOUND
object
The error information
3 properties 2 required
TraceId
string
A unique identifier for this API request. The Hex Support team may request this value when debugging an issue.
error.INTERNAL_SERVER_ERROR
object
The error information
3 properties 2 required
CellId
string
Unique ID for a cell. This can be found by going into the menu of a cell in the notebook.
error.FORBIDDEN
object
The error information
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hex-cells-api-openapi.yml Raw ↑

Other APIs Hex publishes across the network.

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