API reference
Every operation in the published hlix API contract, grouped by resource and generated from the contract itself.
Browse 509 Hlix API operations across 47 resources. Each page includes request fields, authentication requirements and response schemas.
Contract version 1.0.0, OpenAPI 3.1. To download the document itself or generate a client from it, see API & OpenAPI.
Prerequisites
Section titled “Prerequisites”- An hlix API key — create one in Developer tools → API keys
- The ID of a workspace you can act in
export HLIX_API_KEY='…'export HLIX_WORKSPACE_ID='<workspace-id>'export HLIX_BASE_URL='https://server.hlix.ai'Resources
Section titled “Resources”| Resource | Operations | What it covers |
|---|---|---|
| Providers | 8 | Connected model billing providers. |
| Tools | 8 | Shared tool discovery, durable invocation and usage receipts. |
| Hosting | 2 | Workspace hosting regions and regional entry points. |
| Coder accounts | 11 | Connected subscriptions and custom API keys for native coders. |
| Projects | 84 | Projects, their repositories, roadmap, artifacts and Cloud Machine. |
| Tasks | 6 | Tasks, comments and review evidence. |
| Cycles | 28 | Multi-task units of work and their conversations. |
| Imports | 3 | Secure project snapshot upload, verification and finalization. |
| Reports | 5 | Agency portfolio health and client-safe reporting views. |
| Growth | 65 | Growth projects: the Company brain, campaigns, research runs and data-provider keys. |
| CRM | 10 | The sales pipeline over client accounts: deals, contacts, notes and the client record. |
| Mobile provider | 5 | Workspace Limrun keys for mobile emulators and devices. |
| Web providers | 6 | Organization web-provider credentials and activation state. |
| Agent runs | 5 | |
| Agents | 9 | |
| AI capabilities | 18 | |
| Alerts | 7 | |
| Approvals | 5 | |
| Attention | 1 | |
| Audit log | 4 | |
| Billing | 23 | |
| Brand kit | 4 | |
| Chat | 13 | |
| Client accounts | 8 | |
| Client billing | 5 | |
| Client invoices | 9 | |
| Client billing profile | 4 | |
| Client portal | 8 | |
| Client portals | 19 | |
| Deliverables | 25 | |
| Deployments | 6 | |
| Environments | 4 | |
| Events | 2 | |
| Follows | 3 | |
| Linear | 9 | |
| MCP servers | 8 | |
| Memories | 8 | |
| Mentions | 3 | |
| Model configuration | 8 | |
| Packs | 11 | |
| Plugins | 9 | |
| Previews | 3 | |
| Changes | 9 | |
| HLIX Repos | 3 | |
| Project calls | 3 | |
| Secrets | 11 | |
| Workspaces | 1 |
Authentication
Section titled “Authentication”Use these headers for protected, tenant-scoped operations:
curl -sS "$HLIX_BASE_URL/v1/api/projects" \ -H "x-api-key: $HLIX_API_KEY" \ -H "X-Organization-Id: $HLIX_WORKSPACE_ID"x-api-key authenticates a user. X-Organization-Id selects the workspace. Send both explicitly in automation. Browser clients can use a session cookie and their active workspace. Public operations require neither header. Workspace discovery and personal-workspace bootstrap do not require an active workspace. Client portal access uses a verified user session; API keys cannot authenticate it.
Use the OpenAPI document for machine-readable schemas and operation IDs.
Use the TypeScript SDK for live project updates, Integrations for connection setup, and Authentication for credentials.
If a request fails
Section titled “If a request fails”400— the body failed schema validation, or the request named no active organization.401— no valid session or API key. Checkx-api-key.403— authenticated, but not a member of the named workspace.404— no such resource in this workspace, or a resource that was never shared with you.409— a compare-and-swap lost, or another operation owns the transition. Re-read the head and retry.429— too many requests.5xx— the operation failed server-side. Retry only where an idempotency key makes it safe.