How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hex Guides API

The Guides API from Hex — 4 operation(s) for guides.

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

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

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

4 operations 4 paths 19 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 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.

Guides 4
PUT
/v1/guides/draft
Update or create guide drafts by filePath. Accepts a dictionary mapping file paths to their contents. For each file: - If the guide doesn't exist, it will be created. - If the guide exists but has no…
UpsertGuideDraft body → 200400403500
POST
/v1/guides/publish
Publish all currently drafted guides.
PublishGuideDrafts body → 200400403500
DELETE
/v1/guides/draft/{orgGuideFileId}
DeleteGuideDraft 1 param → 204400403500
GET
/v1/guides/draft/list
ListDraftGuides
ListDraftGuides 4 params → 200400401403404500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are GithubExternalSourceLocatorInput (4 properties), PublishGuidesResponsePayload (3 properties), error.NOT_FOUND (3 properties), TsoaErrorResponsePayload (3 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.
UnknownExternalSourceLocatorInput
object
2 properties 1 required
error.FORBIDDEN
object
The error information
3 properties 2 required
GithubExternalSourceLocatorInput
object
4 properties 3 required
PublishGuidesResponsePayload
object
3 properties 3 required
error.INTERNAL_SERVER_ERROR
object
The error information
3 properties 2 required
error.NOT_FOUND
object
The error information
3 properties 2 required
UpsertGuideDraftResponsePayload
object
3 properties 3 required
OrgGuideFileId
string
Unique ID for a guide file. This can be found by going into the menu of a guide file in the guide files side bar.
UpsertGuideDraftRequestBody
object
2 properties 1 required
GuideFileApiResource
object
2 properties 2 required
TsoaErrorResponsePayload
object
3 properties 1 required
GithubExternalSourceLocatorWithMetadataInput
PublishGuidesRequestBody
object
2 properties
UnknownExternalSourceInput
error.UNAUTHORIZED
object
The error information
3 properties 2 required
ExternalSourceInput
A unique identifier for a file that is sourced from an external source. This is used to track the where the guide file was authored from and where we expect up…
error.BAD_REQUEST
object
The error information
3 properties 2 required
GithubExternalSourceInput

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hex-guides-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 Projects API
Hex Semantic (projects|models) API
Hex Threads API
Hex Users API
Where this information came from

This is an independent, third-party profile of Hex Guides API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.