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 Embedding API

The Embedding API from Hex — 1 operation(s) for embedding.

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

Tagged areas include Embedding. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 1 operation across 1 path, and defines 5 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.

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

Paths & Operations 1

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

Embedding 1
POST
/v1/embedding/createPresignedUrl/{projectId}
Create an embedded url for a project
CreatePresignedUrl 1 param body → 200400403422

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are EmbeddingRequest (6 properties), TsoaErrorResponsePayload (3 properties), EmbeddingResponse (1 property). Each schema is shown below with its type and property counts.

EmbeddingRequest
object
6 properties
EmbeddingResponse
object
1 property 1 required
TsoaErrorResponsePayload
object
3 properties 1 required
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…
TraceId
string
A unique identifier for this API request. The Hex Support team may request this value when debugging an issue.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hex-embedding-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 Groups API
Hex Guides API
Hex Projects API
Hex Semantic (projects|models) API
Hex Threads API
Hex Users API