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 Semantic (projects|models) API

The Semantic (projects|models) API from Hex — 2 operation(s) for semantic (projects|models).

Hex Semantic (projects models) API is one of 11 APIs that Hex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Semantic (projects models). The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 2 operations across 2 paths, and defines 17 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.

2 operations 2 paths 17 schemas 1 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 Semantic (projects|models) API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 2

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

Semantic (projects|models) 2
POST
/v1/semantic-(projects|models)/{semanticProjectId}/ingest
Ingest a semantic project from a zip file. This API endpoint is subject to a maximum of 3 requests per minute.
IngestSemanticProject 1 param body → 201400403415500502
PATCH
/v1/semantic-(projects|models)/{semanticProjectId}
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 validatio…
UpdateSemanticProject 1 param body → 200400403404

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are SemanticProjectsSyncResponsePayload (6 properties), HexSLTypes.PublicProblem (5 properties), UpdateStatusErrorDetail (4 properties), TsoaErrorResponsePayload (3 properties). Each schema is shown below with its type and property counts.

MetricflowModelSchemas
UpdateSemanticProjectResponse
object
Response body for successful status updates
1 property 1 required
HexSLTypes.PublicProblem
object
A problem encountered during the import of a public HexSL project.
5 properties 4 required
Pick_TsoaErrorResponsePayload.Exclude_keyofTsoaErrorResponsePayload.details__
object
From T, pick a set of properties whose keys are in the union K
2 properties 1 required
UpdateStatusErrorDetail
object
Details about a failed update
4 properties 3 required
TsoaErrorResponsePayload
object
3 properties 1 required
SemanticProjectsSyncResponsePayload
object
6 properties 2 required
HexSLProblemWithDisplay
ProblemSeverity
string
ProblemKeyPath
array
Record_string.Record_string.HexSLTypes.DataType__
object
Construct a type with a set of properties K of type T
SemanticProjectId
string
Unique ID for a Hex semantic project. This can be found from the semantic projects admin panel (in Settings).
TraceId
string
A unique identifier for this API request. The Hex Support team may request this value when debugging an issue.
Omit_TsoaErrorResponsePayload.details_
Construct a type with the properties of T except for those in type K.
SemanticObjectUpdate
object
A single update for a semantic object (dataset or view) Currently, only status updates are supported.
3 properties 3 required
UpdateSemanticProjectRequest
object
Request body for updating semantic datasets and views Currently, only status updates are supported.
1 property 1 required
ProblemMessage
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hex-semantic-projects-models-api-openapi.yml Raw ↑

Other APIs Hex publishes across the network.

Hex Cells API
Hex Collections API
Hex Context API
Hex Data Connections API
Hex Embedding API
Hex Groups API
Hex Guides API
Hex Projects API
Hex Threads API
Hex Users API