Hex Guides API
The Guides API from Hex — 4 operation(s) for guides.
Hex Guides API is one of 9 APIs that Hex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Guides. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 4 operations across 4 paths, and defines 18 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Hex Guides API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 4
Across 4 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Schemas 18
The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are GithubExternalSourceLocatorInput (4 properties), TsoaErrorResponsePayload (3 properties), PublishGuidesResponsePayload (3 properties), ListDraftGuidesResponse (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Hex 8
Other APIs Hex publishes across the network.