1. Compile a Platform

Method: POST

Endpoint: /build

This endpoint compiles a Heta platform and generates files based on the provided configuration. All operations are synchronous, and results are returned immediately.

Request Body

• lifetime (optional, number): The time in seconds for keeping the files on the server. Default: 3600 (1 hour). Set to 0 to remove files immediately after the response.
• inputFiles (required, non-empty array): An array of platform files. Each object has:
  • filepath (required string): Path or name of the file (e.g., "index.heta").
  • format (optional string): Encoding, either "utf8" or "binary"; defaults to "utf8".
  • filebody (string): File content to write before compilation.
• declaration (optional, object): Describes how the compilation should proceed.
  • importModule (object): Specifies the entry point for compilation.
    • source (string): Name of the main file (e.g., "index.heta").
    • type (string): Format of the file (e.g., "heta", "json").
  • options (object): Additional compilation settings.
    • unitsCheck (boolean): If true, checks unit consistency. Default: false.
    • debug (boolean): Enables debugging mode. Default: false.
    • distDir (string): Directory for saving exported files. Default: "dist".
    • metaDir (string): Directory for saving metadata. Default: "meta".
  • export (array): List of export formats. Each format can include:
    • format (string): Type of export format (e.g., "JSON", "SBML").
    • version (string): File version (optional).

Example Request

{
    "lifetime": 1800,
    "inputFiles": [
        {
            "filepath": "index.heta",
            "format": "utf8",
            "filebody": "x1 @Record := 1.2;\nc1 @Compartment .= 5;"
        }
    ],
    "declaration": {
        "importModule": {
            "source": "index.heta",
            "type": "heta"
        },
        "export": [
            { "format": "JSON" }
        ]
    }
}

Response

2. Download Build Results

Method: GET

Endpoint: /download/{taskId}

Download a ZIP archive containing the files from a compilation task using its task ID. The link is available until the task expires.

Path Parameters

• taskId (required, string): Unique identifier for the compilation task.

Response

3. Get API Info

Method: GET

Endpoint: /info

Retrieve version and connectivity details for the Heta Compiler API.

Response

Returns a description, the running Heta compiler version, the Node.js version, and the /schema path. Versions depend on the deployed server.

4. Retrieve OpenAPI Schema

Method: GET

Endpoint: /schema

Retrieve the complete OpenAPI schema for the Heta Compiler API.

Response

Returns the full OpenAPI 3.1.0 JSON document, including paths, request and response schemas, and examples.

5. Connect an MCP Client

Transport: Streamable HTTP (POST)

Endpoint: https://heta-api.insysbio.com/mcp

Configure this URL in an MCP client to use the Heta compiler. The endpoint does not require authentication and does not keep client sessions.

• buildPlatform: compile or validate a platform using the same input as POST /build. MCP also adds SBML L2V5, Dot, and DynMS exports under _mcp/ in the export directory. Returns logs, generated files, and temporary download links.
• getInfo: get the running compiler and Node.js versions.

Build results can be downloaded through the existing /download/{taskId} URL. A browser GET request to /mcp returns 405 because MCP requests use POST.