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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Hex

Hex Projects API

The Projects API from Hex — 10 operation(s) for projects.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 14 operations across 10 paths, and defines 66 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.

14 operations 10 paths 66 schemas 1 DELETE6 GET5 PATCH2 POST

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

Paths & Operations 14

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

Projects 14
POST
/v1/projects
Create a new project. Creates a new project in the workspace with the specified title. Optionally provide a description and project language.
CreateProject body → 201400403500
GET
/v1/projects
List all viewable projects, sorted by most recently created first.
ListProjects 14 params → 200400403
GET
/v1/projects/{projectId}
Get metadata about a single project.
GetProject 2 params → 200403404
PATCH
/v1/projects/{projectId}
Use this endpoint to add or remove a status (including endorsements) from a project
UpdateProject 1 param body → 200400403404500
GET
/v1/projects/{projectId}/queriedTables
Given a project ID, return the list of warehouse tables queried in the project.
GetQueriedTables 4 params → 200400403404422500
PATCH
/v1/projects/{projectId}/sharing/collections
Add a project to collections or remove it from collections. For projects, use CANVIEW to grant the UI permission labeled "Can explore". Use APPONLY to grant the UI permission labeled "Can view app".…
EditProjectSharingCollections 1 param body → 200400403404500
PATCH
/v1/projects/{projectId}/sharing/workspaceAndPublic
Update workspace or public-web sharing for a project. For projects, use CANVIEW to grant the UI permission labeled "Can explore". Use APPONLY to grant the UI permission labeled "Can view app".
EditProjectSharingOrgAndPublic 1 param body → 200400403404500
PATCH
/v1/projects/{projectId}/sharing/groups
Add groups to a project or update/remove their project sharing access. For projects, use CANVIEW to grant the UI permission labeled "Can explore". Use APPONLY to grant the UI permission labeled "Can…
EditProjectSharingGroups 1 param body → 200400403404500
PATCH
/v1/projects/{projectId}/sharing/users
Add users to a project or update/remove their project sharing access. For projects, use CANVIEW to grant the UI permission labeled "Can explore". Use APPONLY to grant the UI permission labeled "Can v…
EditProjectSharingUsers 1 param body → 200400403404500
POST
/v1/projects/{projectId}/runs
Trigger a run of the latest published version of a project. This API endpoint is subject to a maximum of 20 requests per minute and 60 requests per hour.
RunProject 2 params body → 201400403422503
GET
/v1/projects/{projectId}/runs
Get the status of runs of a project. By default, all run types are returned (API-triggered, scheduled, and publish/refresh runs). Use the runTriggerFilter parameter to filter to a specific type.
GetProjectRuns 5 params → 200400403422
GET
/v1/projects/{projectId}/runs/{runId}
Get the status of a project run.
GetRunStatus 3 params → 200400403422
DELETE
/v1/projects/{projectId}/runs/{runId}
Cancel a project run.
CancelRun 2 params → 204400403422
GET
/v1/projects/{projectId}/runs/{runId}/cells/{staticId}/image
Get the rendered PNG image of a chart cell from a completed run by staticCellId. The "staticId" path parameter should be the cell's staticId (which remains stable across project versions), as opposed…
GetChartImageFromRun 3 params → 200400403404422500

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are ProjectApiResource (17 properties), ProjectStatusResponsePayload (13 properties), ProjectRunNotification (8 properties), ProjectRunNotificationRecipient (7 properties). Each schema is shown below with its type and property counts.

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…
ProjectStatusResponsePayload
object
Response format returned by the getRunStatus endpoint
13 properties 10 required
EditProjectSharingCollectionsResponse
object
2 properties 1 required
InputRunId
string
Unique ID for a run of a Hex project. This ID is part of the response returned by the RunProject endpoint. The GetProjectRuns endpoint can also be used to find…
ShareProjectWithWorkspaceError
object
2 properties 2 required
EditProjectSharingUsersResponse
object
2 properties 1 required
ProjectRunNotification
object
The configuration details for notifications, which are sent after a run has completed.
8 properties 2 required
ProjectsListApiResource
object
2 properties 2 required
PublicWebAccessLevel
ScheduleCadenceApiEnum
Types of cadence of a schedule for a Hex project.
TsoaErrorResponsePayload
object
3 properties 1 required
AccessLevelEnum
Access level granted by sharing endpoints. For projects, CANVIEW is the API value that corresponds to the UI permission labeled "Can explore". APPONLY is the A…
ProjectQueriedTableResource
object
3 properties 3 required
ProjectStatusRunTrigger
string
How a run of a project was triggered (API, SCHEDULED, or APPREFRESH)
Offset
integer
Offset for paginated requests
DataConnectionId
string
Unique ID for a data connection.
ProjectApiResource
object
17 properties 16 required
ResponseRunId
string
Unique ID for a run of a Hex project
ChartImageFromRunResponsePayload
object
5 properties 5 required
StaticCellId
string
Unique static ID for a cell. This can be found by going into the menu of a cell in the notebook.
ScreenshotFormatType
string
The file format of the generated screenshot.
NextPageUrl
string
URL to fetch the next page of results for a paginated API request
ProjectVersion
integer
The version of the Hex project that was run. Project versions are ordered, starting at 1 and incrementing on each saved version. Project versions can be found…
EnumValues_typeofScheduleCadenceApiEnum_
string
ProjectQueriedTablesApiResource
object
3 properties 3 required
PageSize
integer
Number of results to fetch per page for paginated requests
RunNotificationType
string
The condition that determines whether or not the notification should be delivered based on these types.
InvalidParam
object
Information about an input parameter pass to the API call that could not be parsed.
4 properties 4 required
RunProjectRequestBody
object
Request body format for triggering a project run
7 properties
Timestamp
string
An ISO 8601 timestamp with timezone like 1970-01-01T00:00:00Z.
ProjectRunNotificationRecipient
object
The recipient of a project run notification, which will include the type of recipient and additional configuration details. This is used to determine who to se…
7 properties 4 required
EnumValues_typeofRunTypeFilter_
string
EnumValues_typeofProjectTypeApiEnum_
string
ScheduleApiResource
object
7 properties 7 required
CollectionId
string
Unique ID for a collection.
StateEvent
object
Response format returned by the runProject endpoint
3 properties 3 required
EnumValues_typeofSortDirectionEnum_
string
NotificationRecipient
object
3 properties 2 required
ShareProjectWithUserError
object
2 properties 2 required
ProjectRunsResponsePayload
object
4 properties 4 required
EditProjectSharingWorkspaceAndPublicResponse
object
2 properties 1 required
ShareProjectWithCollectionError
object
2 properties 2 required
ProjectRunStatus
string
Current status of a project run
NotificationRecipientType
string
The delivery type of a notification recipient.
NotFoundParam
string
Name of an input parameter passed to the API call that was not found in the project.
SortDirectionEnum
GroupId
string
Unique ID for a group. This can be found from the groups page (in Settings).
EnumValues_typeofSortByEnum_
string
RunStatusUrl
string
URL to query the status of the project run via the Hex API
EditProjectSharingGroupsResponse
object
2 properties 1 required
ShareProjectWithGroupError
object
2 properties 2 required
SortByEnum
SharingResource
object
6 properties 6 required
InvalidParamPayload
object
3 properties 3 required
TimezoneDesignator
string
An ISO 8601 timezone designator like +08:00.
ProjectTypeApiEnum
The type of the ProjectApiResource being returned.
TraceId
string
A unique identifier for this API request. The Hex Support team may request this value when debugging an issue.
UserId
string
Unique ID for a user. This can be found from the users page (in Settings).
EnumValues_typeofAccessLevelEnum_
string
RunUrl
string
URL to view the current progress of the project run in the Hex UI
DayOfWeekApiEnum
RunTypeFilter
ProjectRunResponsePayload
object
Response format returned by the runProject endpoint
7 properties 6 required
EnumValues_typeofDayOfWeekApiEnum_
string
ApiPaginationCursor
string
A cursor string used with before and after parameters to paginate through a list of items on the API.
PaginationApiResource
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hexa-projects-api-openapi.yml Raw ↑

Other APIs Hex publishes across the network.

Hex Cells API
AE Profile APIs.io
Hex Collections API
AE Profile APIs.io
Hex Data Connections API
AE Profile APIs.io
Hex Embedding API
AE Profile APIs.io
Hex Groups API
AE Profile APIs.io
Hex Guides API
AE Profile APIs.io
Hex Semantic (projects|models) API
AE Profile APIs.io
Hex Users API
AE Profile APIs.io
#Project
← Back to H APIs
API Details
ID
hexa:hexa-projects-api
Base URL
https://app.hex.tech/api/v1
Docs
https://learn.hex.tech/docs/api/api-reference
Provider
Hex
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=hexa-projects-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/hexa-projects-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Hex Projects 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.