Hlix Hosting API

Workspace hosting regions and regional entry points.

GitHub OpenAPI

Operations 2

GET /v1/api/hosting-regions List configured regional entry points #
GET /v1/api/settings/hosting Read the workspace's immutable hosting region #

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-hosting-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

hlix-ai-hosting-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 Hosting API
  version: 1.0.0
servers:
- url: https://server.hlix.ai
  description: API server
security:
- apiKey: []
- sessionCookie: []
tags:
- description: Workspace hosting regions and regional entry points.
  name: hosting
paths:
  /v1/api/hosting-regions:
    get:
      operationId: listHostingRegions
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HostingCatalog'
          description: Deployment catalog; contains no workspace data
        '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.
      security: []
      summary: List configured regional entry points
      tags:
      - hosting
  /v1/api/settings/hosting:
    get:
      operationId: getWorkspaceHosting
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceHosting'
          description: Workspace hosting and regional entry points
        '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: Workspace not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Workspace belongs to another regional server
      summary: Read the workspace's immutable hosting region
      tags:
      - hosting
components:
  schemas:
    WorkspaceHosting:
      properties:
        canCreateWorkspace:
          type: boolean
        currentRegion:
          enum:
          - eu
          - us
          type: string
        hostingRegion:
          enum:
          - eu
          - us
          type: string
        identityRegion:
          enum:
          - eu
          - us
          type: string
        regions:
          items:
            properties:
              apiUrl:
                type:
                - string
                - 'null'
              appUrl:
                type:
                - string
                - 'null'
              available:
                type: boolean
              id:
                enum:
                - eu
                - us
                type: string
            required:
            - id
            - available
            - appUrl
            - apiUrl
            type: object
          type: array
        sharedLogin:
          type: boolean
      required:
      - currentRegion
      - identityRegion
      - sharedLogin
      - regions
      - hostingRegion
      - canCreateWorkspace
      type: object
    ApiError:
      additionalProperties: {}
      properties:
        error:
          type: string
      required:
      - error
      type: object
    HostingCatalog:
      properties:
        currentRegion:
          enum:
          - eu
          - us
          type: string
        identityRegion:
          enum:
          - eu
          - us
          type: string
        regions:
          items:
            properties:
              apiUrl:
                type:
                - string
                - 'null'
              appUrl:
                type:
                - string
                - 'null'
              available:
                type: boolean
              id:
                enum:
                - eu
                - us
                type: string
            required:
            - id
            - available
            - appUrl
            - apiUrl
            type: object
          type: array
        sharedLogin:
          type: boolean
      required:
      - currentRegion
      - identityRegion
      - sharedLogin
      - regions
      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