Privacy Policy | Terms of Use | Support
The Heta Compiler API provides an interface for compiling Heta platforms, customizing compilation workflows, and exporting results. This documentation details the API structure, parameters, and examples for developers.
Base URL: https://heta-api.insysbio.com
OpenAPI specification: /schema
POST /build accepts an optional utm_source query parameter for logging only: 1–64 ASCII letters, digits, dots, underscores, or hyphens. Other unknown query parameters are rejected. The GET endpoints /download/{taskId}, /info, and /schema ignore additional query parameters.
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.
3600 (1 hour). Set to 0 to remove files immediately after the response..heta, .json, .yaml, .yml, .xml, .sbml, .csv, .tsv, and .txt. XLSX files must use binary encoding. Each object has:
"index.heta"). Absolute paths and .. segments are rejected."utf8" or "binary"; defaults to "utf8"."index.heta")."heta", "json").true, checks unit consistency. Default: false... segments are rejected. Default: "dist"."JSON", "SBML").distDir. Absolute paths and .. segments are rejected.{
"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" }
]
}
}
Success (200): Returns outputFiles (including generated file content), logs, taskId, lifeend, downloadLink and filesLink. Check logs for compilation diagnostics even when the HTTP status is 200.
Errors:
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.
Success (200): A ZIP archive is returned as binary data.
Errors:
Method: GET
Endpoint: /info
Retrieve version and connectivity details for the Heta Compiler API.
Returns a description, the running Heta compiler version, the Node.js version, and the /schema path. Versions depend on the deployed server.
Method: GET
Endpoint: /schema
Retrieve the complete OpenAPI schema for the Heta Compiler API.
Returns the full OpenAPI 3.1.0 JSON document, including paths, request and response schemas, and examples.
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, temporary download links, and a DynMS Viewer link for test simulations when a DynMS file is available.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.
For more details or support, contact the API team.