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).
• inputFiles (required, array): An array of objects representing the platform files to be compiled. Each object must include:
  • filepath (string): Path or name of the file (e.g., "index.heta").
  • format (string): File format, either "utf8" or "binary".
  • filebody (string): File content in plain text or binary format.
• 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".
    • logMode (string): Controls log generation. Options: "never", "error", "always". Default: "error".
    • logPath (string): Path for log file. Default: "build.log".
    • logFormat (string): Format of the log file. Options: "string", "json". Default: "string".
  • 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,
    "files": [
        {
            "filepath": "index.heta",
            "format": "utf8",
            "filebody": "x1 @Record := 1.2;"
        }
    ],
    "declaration": {
        "importModule": {
            "source": "index.heta",
            "type": "heta"
        },
        "options": {
            "unitsCheck": true,
            "debug": false
        },
        "export": [
            { "format": "JSON" },
            { "format": "SBML", "version": "L3V2" }
        ]
    }
}

Response

{
    "outputFiles": [{"filepath": "dist/json/model.json"}, {"filepath": "dist/sbml/model.xml"}],
    "logs": ["Compilation finished successfully."],
    "taskId": "example-task-id",
    "lifeend": 1634025600
}

2. Download a File

Method: GET

Endpoint: /download/{taskId}

Retrieve a file generated during a compilation task using the task ID.

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

{
    "version": "1.0.0",
    "node": "v14.17.0",
    "description": "Heta Compiler API"
}

4. Retrieve OpenAPI Schema

Method: GET

Endpoint: /schema

Retrieve the complete OpenAPI schema for the Heta Compiler API.

Response

{
    "openapi": "3.1.0"
}