Skip to content
hlix docs

HLIX Repos

Generated from contract version 1.0.0 — the same document /v1/api/openapi.json serves.

Prerequisites

Section titled “Prerequisites”
  • An API key in x-api-key, or a browser session cookie
  • X-Organization-Id naming the workspace to act in, unless the session already has an active one
  • The base URL for your deployment, https://server.hlix.ai by default

Operations

Section titled “Operations”
Method Path Operation
GET /v1/api/projects/{id}/protected-files Read encrypted project files with manage access
POST /v1/api/projects/{id}/repos/{repoId}/access Get short-lived Git access to a repository in HLIX Repos
GET /v1/api/projects/{id}/repos/{repoId}/head Read a repository head without waking its workspace

Read encrypted project files with manage access

Section titled “Read encrypted project files with manage access”

GET /v1/api/projects/{id}/protected-files · operation ID getProjectProtectedFiles

Parameters

Name In Required Type Description
id path yes string
X-Organization-Id header no string The workspace (organization) to act in. Omitted, the session’s active organization is used.

Responses

Status Body Description
200 ProjectProtectedFiles Decrypted protected files; private, no-store
400 ApiError The request named no active organization.
401 ApiError No valid session or API key.
403 ApiError Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
404 ApiError Project not found

Get short-lived Git access to a repository in HLIX Repos

Section titled “Get short-lived Git access to a repository in HLIX Repos”

POST /v1/api/projects/{id}/repos/{repoId}/access · operation ID createRepoAccess

Parameters

Name In Required Type Description
id path yes string
repoId path yes string
X-Organization-Id header no string The workspace (organization) to act in. Omitted, the session’s active organization is used.

Request body — application/json, RepoAccess (required)

Property Type Required Notes
scope read write yes

Responses

Status Body Description
200 RepoAccessResponse Repository credentials; private, no-store
400 ValidationError | ApiError The JSON body failed schema validation (ValidationError), or the request named no active organization (ApiError).
401 ApiError No valid session or API key.
403 ApiError Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
404 ApiError Project or repository not found

Read a repository head without waking its workspace

Section titled “Read a repository head without waking its workspace”

GET /v1/api/projects/{id}/repos/{repoId}/head · operation ID getRepoHead

Parameters

Name In Required Type Description
id path yes string
repoId path yes string
X-Organization-Id header no string The workspace (organization) to act in. Omitted, the session’s active organization is used.

Responses

Status Body Description
200 RepoHeadResponse Current repository commit
400 ApiError The request named no active organization.
401 ApiError No valid session or API key.
403 ApiError Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
404 ApiError Project or repository not found

If a request fails

Section titled “If a request fails”

These apply to every operation on this page.

  • 400 — the body failed schema validation, or the request named no active organization. A ValidationError body carries the failing fields; an ApiError body carries only error.
  • 401 — no valid session or API key.
  • 403 — authenticated, but not a member of the named organization, or a client collaborator without the required access.
  • 404 — no such resource in this workspace. Absent and not-visible are deliberately the same answer; do not infer cross-tenant existence from it.
  • 409 — the expected revision or state is stale, or another operation currently owns the transition.
  • 500 — the operation failed server-side. Retry only where an idempotency key makes that safe.

Next steps

Section titled “Next steps”
API referenceEvery resource in the published contract, and what is deliberately not in it.
API & OpenAPIDownload the contract, generate a client, and read the compatibility policy.
TypeScript SDKAuth, retries, typed errors, uploads and streaming, already built.
CLI referenceThe same operations from a terminal, with a stable JSON envelope.