Hlix

Hlix Mobile Provider API

Workspace Limrun keys for mobile emulators and devices.

Documentation GitHub OpenAPI

Operations 5

GET /v1/api/mobile-provider Read mobile emulators and devices billing configuration #

PATCH /v1/api/mobile-provider Choose workspace or Hlix funding for new mobile builds #

DELETE /v1/api/mobile-provider/key Remove the key for new builds; existing resources retain their cleanup… #

PUT /v1/api/mobile-provider/key Verify and save a workspace Limrun key for new builds #

POST /v1/api/mobile-provider/test Check a supplied or saved Limrun key without allocating a device #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/hlix-ai/openapi/hlix-ai-mobile-provider-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-mobile-provider-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

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 Mobile Provider API
  version: 1.0.0
servers:
- url: https://server.hlix.ai
  description: API server
security:
- apiKey: []
- sessionCookie: []
tags:
- description: Workspace Limrun keys for mobile emulators and devices.
  name: mobile-provider
paths:
  /v1/api/mobile-provider:
    get:
      operationId: getMobileProvider
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MobileProviderState'
          description: Workspace mobile-provider state; no credentials are returned.
        '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: Agency-only reads; owner or admin required for credential changes and tests.
        '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.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Settings are temporarily unavailable.
      summary: Read mobile emulators and devices billing configuration
      tags:
      - mobile-provider
    patch:
      operationId: toggleMobileProvider
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToggleMobileProvider'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MobileProviderState'
          description: Workspace mobile-provider state; no credentials are returned.
        '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: Agency-only reads; owner or admin required for credential changes and tests.
        '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.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Save a key before enabling it.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Settings are temporarily unavailable.
      summary: Choose workspace or Hlix funding for new mobile builds
      tags:
      - mobile-provider
  /v1/api/mobile-provider/key:
    delete:
      operationId: removeMobileProviderKey
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MobileProviderState'
          description: Workspace mobile-provider state; no credentials are returned.
        '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: Agency-only reads; owner or admin required for credential changes and tests.
        '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.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Settings are temporarily unavailable.
      summary: Remove the key for new builds; existing resources retain their cleanup…
      tags:
      - mobile-provider
    put:
      operationId: saveMobileProviderKey
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveMobileProviderKey'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MobileProviderState'
          description: Workspace mobile-provider state; no credentials are returned.
        '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: Agency-only reads; owner or admin required for credential changes and tests.
        '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.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Limrun could not verify the key; no key material is returned.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Settings are temporarily unavailable.
      summary: Verify and save a workspace Limrun key for new builds
      tags:
      - mobile-provider
  /v1/api/mobile-provider/test:
    post:
      operationId: testMobileProviderKey
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestMobileProviderKey'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MobileProviderTest'
          description: The account can be read with this key; no billable instance was started.
        '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: Agency-only reads; owner or admin required for credential changes and tests.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No key has been saved.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Limrun could not verify the key; no key material is returned.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Settings are temporarily unavailable.
      summary: Check a supplied or saved Limrun key without allocating a device
      tags:
      - mobile-provider
components:
  schemas:
    ApiError:
      additionalProperties: {}
      properties:
        error:
          type: string
      required:
      - error
      type: object
    TestMobileProviderKey:
      additionalProperties: false
      properties:
        apiKey:
          maxLength: 4096
          minLength: 8
          type: string
      type: object
    MobileProviderTest:
      properties:
        ok:
          const: true
          type: boolean
      required:
      - ok
      type: object
    MobileProviderState:
      properties:
        credentialSource:
          enum:
          - organization
          - hlix
          type: string
        enabled:
          type: boolean
        hasApiKey:
          type: boolean
        platformAvailable:
          type: boolean
        provider:
          const: limrun
          type: string
      required:
      - provider
      - hasApiKey
      - enabled
      - credentialSource
      - platformAvailable
      type: object
    SaveMobileProviderKey:
      additionalProperties: false
      properties:
        apiKey:
          maxLength: 4096
          minLength: 8
          type: string
      required:
      - apiKey
      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
    ToggleMobileProvider:
      additionalProperties: false
      properties:
        enabled:
          type: boolean
      required:
      - enabled
      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