Hlix

Hlix Projects API

Projects, their repositories, roadmap, artifacts and Cloud Machine.

GitHub OpenAPI

Operations 86

GET /v1/api/projects List the workspace's projects #
POST /v1/api/projects Create a project #
GET /v1/api/projects/initial-proposal-by-id/{proposalId} Resolve a proposal deep link #
DELETE /v1/api/projects/{id} Delete a project #
GET /v1/api/projects/{id} Get one project #
PATCH /v1/api/projects/{id} Update a project's configuration #
GET /v1/api/projects/{id}/architecture Read the application's source dependency graph #
POST /v1/api/projects/{id}/archive Archive a project #
GET /v1/api/projects/{id}/artifacts List a project's stored artifacts #
GET /v1/api/projects/{id}/artifacts/{filename} Get a signed download URL for one project artifact #
PATCH /v1/api/projects/{id}/assign Hand a project to a teammate #
GET /v1/api/projects/{id}/board Read the rows a project's board shows #
GET /v1/api/projects/{id}/budget Get the project's delivery budget and spend to date #
GET /v1/api/projects/{id}/canvas Read the project canvas without waking its Cloud Machine #
GET /v1/api/projects/{id}/canvas/agent Read the project canvas as an agent may see it #
POST /v1/api/projects/{id}/canvas/agent/ops Draw on the project canvas as hlix, for the caller #
POST /v1/api/projects/{id}/canvas/agent/undo Undo hlix's most recent canvas edit #
GET /v1/api/projects/{id}/computers List the project's task execution computers #
GET /v1/api/projects/{id}/computers/{computerId} Read the exact execution computer's availability #
POST /v1/api/projects/{id}/computers/{computerId}/control Take, renew or release managed computer input #
GET /v1/api/projects/{id}/computers/{computerId}/evidence/{kind} Download retained execution screen or replay evidence #
POST /v1/api/projects/{id}/computers/{computerId}/input Send input to the computer currently owned by the caller #
GET /v1/api/projects/{id}/cycle-metrics Get a project's flow metrics computed from cycle stage history #
POST /v1/api/projects/{id}/delivery Open the project's pull request now #
GET /v1/api/projects/{id}/desktop Report whether a graphical desktop is reachable #
POST /v1/api/projects/{id}/desktop Start the desktop #
POST /v1/api/projects/{id}/detect-commands Re-run command detection without writing anything #
GET /v1/api/projects/{id}/diagnostics Read why a project failed or is waiting #
GET /v1/api/projects/{id}/director Watch the Director Explainer's evolving video segments #
GET /v1/api/projects/{id}/director/clips/{clipId} Read an audience-scoped Director video segment #
GET /v1/api/projects/{id}/environment Read the project's saved Cloud Machine environment #
POST /v1/api/projects/{id}/environment/keepalive Tell a running environment it is still in use #
GET /v1/api/projects/{id}/image-builds List the project's Cloud Machine image builds #
GET /v1/api/projects/{id}/initial-proposal Read the current initial SDD/SOW #
POST /v1/api/projects/{id}/initial-proposal/approve Approve the initial plan and release delivery #
GET /v1/api/projects/{id}/initial-proposal/comments List section-anchored proposal comments #
POST /v1/api/projects/{id}/initial-proposal/comments Comment on a proposal section #
PATCH /v1/api/projects/{id}/initial-proposal/comments/{commentId} Resolve or reopen a proposal comment #
POST /v1/api/projects/{id}/initial-proposal/decision Record the invited client reviewer's optional decision #
POST /v1/api/projects/{id}/initial-proposal/publish Publish a branded proposal revision #
GET /v1/api/projects/{id}/initial-proposal/revisions List proposal revision history #
POST /v1/api/projects/{id}/initial-proposal/revisions Request a targeted AI revision #
PUT /v1/api/projects/{id}/initial-proposal/revisions/manual Create a manual business-copy revision #
GET /v1/api/projects/{id}/insights Get a project's Cloud Machine totals and estimated completion #
GET /v1/api/projects/{id}/linear-sessions List the Linear conversations delegated into this project #
GET /v1/api/projects/{id}/messages Read the project's conversation #
POST /v1/api/projects/{id}/mobile/agent-sessions Start a native test device for this agent run #
DELETE /v1/api/projects/{id}/mobile/agent-sessions/{sessionId} Stop this agent run's native test device #
GET /v1/api/projects/{id}/mobile/agent-sessions/{sessionId} Read this agent run's native test device #
GET /v1/api/projects/{id}/mobile/builds List saved native builds #
POST /v1/api/projects/{id}/mobile/builds Build a native app preview #
POST /v1/api/projects/{id}/mobile/sessions Start a private app preview #
DELETE /v1/api/projects/{id}/mobile/sessions/{sessionId} End your private app preview #
GET /v1/api/projects/{id}/mobile/sessions/{sessionId} Read your private app preview #
GET /v1/api/projects/{id}/mobile/targets List native app targets #
PUT /v1/api/projects/{id}/mobile/targets Configure native app targets #
GET /v1/api/projects/{id}/repos List a project's repositories #
POST /v1/api/projects/{id}/repos Attach a repository to a project #
POST /v1/api/projects/{id}/repos/github Attach an existing GitHub repository by owner/name #
DELETE /v1/api/projects/{id}/repos/{repoId} Detach a repository from a project #
PATCH /v1/api/projects/{id}/repos/{repoId} Update a repository's branch or label #
POST /v1/api/projects/{id}/repos/{repoId}/primary Make a repository the project's primary #
POST /v1/api/projects/{id}/resume Resume a stopped project, or start one that never started #
GET /v1/api/projects/{id}/review Read recorded verification evidence for completed project cycles #
POST /v1/api/projects/{id}/review/merge Merge a reviewed preview pull request at its exact head commit #
GET /v1/api/projects/{id}/roadmap Get the project's roadmap #
GET /v1/api/projects/{id}/sequence Watch a cycle's narrated Sequence #
POST /v1/api/projects/{id}/start Start the project's autonomous run #
GET /v1/api/projects/{id}/status Read a project's delivery status #
POST /v1/api/projects/{id}/stop Stop every agent working on the project #
POST /v1/api/projects/{id}/suggest-stack Propose a stack string from the project's own evidence #
GET /v1/api/projects/{id}/terminal Open a shell into the project's Cloud Machine #
GET /v1/api/projects/{id}/threads Get the project's conversation tree #
POST /v1/api/projects/{id}/unarchive Restore an archived project #
GET /v1/api/projects/{id}/usage Get the project's cost and token roll-up #
POST /v1/api/projects/{id}/workspace/exec Run a command in the project's Cloud Machine #
POST /v1/api/projects/{id}/workspace/fs Read or write a file in the project's Cloud Machine #
GET /v1/api/projects/{projectId}/designs List native project designs #
POST /v1/api/projects/{projectId}/designs Submit a native prototype brief #
GET /v1/api/projects/{projectId}/designs/{designId} Read a design revision and its review threads #
POST /v1/api/projects/{projectId}/designs/{designId}/build Submit implementation of an accepted prototype #
POST /v1/api/projects/{projectId}/designs/{designId}/comments Comment on a frame without dispatching work #
PATCH /v1/api/projects/{projectId}/designs/{designId}/comments/{commentId} Resolve or reopen a design comment #
POST /v1/api/projects/{projectId}/designs/{designId}/decisions Accept a revision or submit revision work #
POST /v1/api/projects/{projectId}/designs/{designId}/revisions Publish a tested playable prototype #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/hlix-ai/openapi/hlix-ai-projects-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/hlix-ai:hlix-ai-projects-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

hlix-ai-projects-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Explore the Hlix API for projects, agent teams, and delivery workflows. Authenticate with `x-api-key` and select a Workspace with `X-Organization-Id`. Session-only operations require a signed-in user session. Authentication setup.
  title: reference Projects API
  version: 1.0.0
servers:
- url: https://server.hlix.ai
  description: API server
security:
- apiKey: []
- sessionCookie: []
tags:


# --- truncated at 32 KB (489 KB total) ---
# Full source: https://artifacts.apis.io/hlix-ai/openapi/hlix-ai-projects-api-openapi.yml