Hlix Imports API

Secure project snapshot upload, verification and finalization.

GitHub OpenAPI

Operations 3

POST /v1/api/projects/{id}/resources/agent Create a project-scoped agent from local instructions #
POST /v1/api/projects/{id}/resources/mcp Explicitly activate a validated MCP server for one project #
POST /v1/api/projects/{id}/resources/skill Activate a skill for one project #

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-imports-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-imports-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 Imports API
  version: 1.0.0
servers:
- url: https://server.hlix.ai
  description: API server
security:
- apiKey: []
- sessionCookie: []
tags:
- description: Secure project snapshot upload, verification and finalization.
  name: Imports
paths:
  /v1/api/projects/{id}/resources/agent:
    post:
      operationId: importProjectAgent
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportAgent'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportedAgent'
          description: The project-scoped agent was created.
        '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 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: The agent name is already taken, or the manifest declares a second intake agent for this scope.
      summary: Create a project-scoped agent from local instructions
      tags:
      - Imports
  /v1/api/projects/{id}/resources/mcp:
    post:
      operationId: importProjectMcp
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportMcp'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportedMcp'
          description: The MCP server was activated with secret references.
        '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 resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
      summary: Explicitly activate a validated MCP server for one project
      tags:
      - Imports
  /v1/api/projects/{id}/resources/skill:
    post:
      operationId: importProjectSkill
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportSkill'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportedSkill'
          description: The skill is available in this project’s Cloud Machine.
        '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 resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
      summary: Activate a skill for one project
      tags:
      - Imports
components:
  schemas:
    ImportedSkill:
      properties:
        skill:
          properties:
            path:
              type: string
            slug:
              type: string
          required:
          - slug
          - path
          type: object
      required:
      - skill
      type: object
    ImportSkill:
      additionalProperties: false
      properties:
        content:
          maxLength: 200000
          minLength: 1
          type: string
        slug:
          maxLength: 100
          minLength: 1
          pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
          type: string
      required:
      - slug
      - content
      type: object
    ApiError:
      additionalProperties: {}
      properties:
        error:
          type: string
      required:
      - error
      type: object
    ImportAgent:
      additionalProperties: false
      properties:
        description:
          maxLength: 2000
          type: string
        duty:
          enum:
          - executor
          - intake
          type: string
        instructions:
          maxLength: 20000
          minLength: 1
          type: string
        name:
          maxLength: 120
          minLength: 1
          type: string
        runtimeKind:
          anyOf:
          - enum:
            - claude-code
            - codex
            - opencode
            - goose
            - qwen-code
            - pi
            - hlix
            type: string
          - type: 'null'
      required:
      - name
      - instructions
      type: object
    ImportedMcp:
      properties:
        mcpServer:
          properties:
            envKeys:
              items:
                type: string
              type: array
            name:
              type: string
            transport:
              enum:
              - stdio
              - http
              - sse
              type: string
          required:
          - name
          - transport
          - envKeys
          type: object
      required:
      - mcpServer
      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
    ImportedAgent:
      properties:
        agent:
          properties:
            duty:
              enum:
              - executor
              - intake
              type: string
            id:
              type: string
            name:
              type: string
            projectId:
              type: string
          required:
          - id
          - name
          - projectId
          - duty
          type: object
      required:
      - agent
      type: object
    ImportMcp:
      additionalProperties: false
      properties:
        args:
          items:
            maxLength: 500
            type: string
          maxItems: 64
          type: array
        command:
          maxLength: 100
          type: string
        envKeys:
          default: []
          items:
            pattern: ^[A-Za-z_][A-Za-z0-9_]*$
            type: string
          maxItems: 100
          type: array
        headers:
          additionalProperties:
            maxLength: 2000
            type: string
          propertyNames:
            type: string
          type: object
        name:
          maxLength: 100
          minLength: 1
          type: string
        transport:
          enum:
          - stdio
          - http
          - sse
          type: string
        url:
          format: uri
          maxLength: 2000
          type: string
      required:
      - name
      - transport
      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