Hlix Environments API
The environments API from Hlix — 2 operation(s) for environments.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/hlix-ai:hlix-ai-environments-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
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 Environments API
version: 1.0.0
servers:
- url: https://server.hlix.ai
description: API server
security:
- apiKey: []
- sessionCookie: []
tags:
- name: Environments
paths:
/v1/api/environments/project/{projectId}:
get:
operationId: listProjectEnvironments
parameters:
- in: path
name: projectId
required: true
schema:
type: string
- $ref: '#/components/parameters/OrganizationId'
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Environment'
type: array
description: Every environment on the project, active or not.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The request named no active organization.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: No valid session or API key.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
summary: List a project's environments
tags:
- Environments
post:
operationId: createProjectEnvironment
parameters:
- in: path
name: projectId
required: true
schema:
type: string
- $ref: '#/components/parameters/OrganizationId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEnvironment'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Environment'
description: The stored environment.
'400':
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/ValidationError'
- $ref: '#/components/schemas/ApiError'
description: The JSON body failed schema validation (`ValidationError`), or the request named no active organization (`ApiError`).
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: No valid session or API key.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The project does not exist in this workspace. Projects in other workspaces return the same 404 response.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The environment could not be written.
summary: Create an environment
tags:
- Environments
/v1/api/environments/project/{projectId}/{id}:
delete:
operationId: deleteProjectEnvironment
parameters:
- in: path
name: projectId
required: true
schema:
type: string
- in: path
name: id
required: true
schema:
type: string
- $ref: '#/components/parameters/OrganizationId'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeletedAck'
description: The environment is gone. Deleting one that was never there answers the same 200 — the call is idempotent.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The request named no active organization.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: No valid session or API key.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
summary: Delete an environment
tags:
- Environments
patch:
operationId: updateProjectEnvironment
parameters:
- in: path
name: projectId
required: true
schema:
type: string
- in: path
name: id
required: true
schema:
type: string
- $ref: '#/components/parameters/OrganizationId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEnvironment'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Environment'
description: The updated environment.
'400':
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/ValidationError'
- $ref: '#/components/schemas/ApiError'
description: The JSON body failed schema validation (`ValidationError`), or the request named no active organization (`ApiError`).
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: No valid session or API key.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: No such environment in this workspace.
summary: Update an environment
tags:
- Environments
components:
schemas:
ApiError:
additionalProperties: {}
properties:
error:
type: string
required:
- error
type: object
UpdateEnvironment:
properties:
config:
properties:
files:
items:
properties:
content:
type: string
encoding:
enum:
- utf8
- base64
type: string
executable:
type: boolean
path:
type: string
required:
- path
- content
type: object
type: array
managedPaths:
items:
type: string
type: array
mcpServers:
items: {}
type: array
skills:
items:
type: string
type: array
vars:
additionalProperties:
type: string
default: {}
propertyNames:
type: string
type: object
type: object
isActive:
type: boolean
label:
maxLength: 100
minLength: 1
type: string
type: object
Environment:
properties:
config:
properties:
files:
items:
properties:
content:
type: string
encoding:
enum:
- utf8
- base64
type: string
executable:
type: boolean
path:
type: string
required:
- path
- content
type: object
type: array
managedPaths:
items:
type: string
type: array
mcpServers:
items: {}
type: array
skills:
items:
type: string
type: array
vars:
additionalProperties:
type: string
default: {}
propertyNames:
type: string
type: object
type: object
createdAt:
type: string
id:
type: string
isActive:
type: boolean
label:
type: string
organizationId:
type: string
projectId:
type: string
updatedAt:
type: string
required:
- id
- organizationId
- projectId
- label
- config
- isActive
- createdAt
- updatedAt
type: object
DeletedAck:
properties:
ok:
const: true
type: boolean
required:
- ok
type: object
ValidationError:
properties:
error:
properties:
message:
type: string
name:
type: string
required:
- name
- message
type: object
success:
const: false
type: boolean
required:
- success
- error
type: object
CreateEnvironment:
properties:
config:
properties:
files:
items:
properties:
content:
type: string
encoding:
enum:
- utf8
- base64
type: string
executable:
type: boolean
path:
type: string
required:
- path
- content
type: object
type: array
managedPaths:
items:
type: string
type: array
mcpServers:
items: {}
type: array
skills:
items:
type: string
type: array
vars:
additionalProperties:
type: string
default: {}
propertyNames:
type: string
type: object
type: object
isActive:
type: boolean
label:
maxLength: 100
minLength: 1
type: string
required:
- label
- config
type: object
parameters:
OrganizationId:
description: The workspace (organization) to act in. Omitted, the session's active organization is used.
in: header
name: X-Organization-Id
required: false
schema:
type: string
example: YOUR_WORKSPACE_ID
securitySchemes:
apiKey:
description: An API key issued through `/v1/api/auth/api-key/*`. Browser clients can use their session cookie instead.
in: header
name: x-api-key
type: apiKey
sessionCookie:
description: The complete session Cookie header issued by sign-in at the selected API host. Cookie names vary by hosting region and environment; preserve the issued name and value. Browsers send these HTTP-only cookies automatically. Session-only operations require this user session and do not accept an API key.
in: header
name: Cookie
type: apiKey