A minimal 8-bit style graphic shows a geometric computer screen or code editor next to a gear, symbolizing a Node.js setup. Around them are simple flat icons: a cube for packages, an arrow representing API imports, and a circular loop for worker threads or process spawning. The design uses only five bold corporate colors on a white background, with no people, text, gradients, or shadows, at a size of 128 by 128 pixels.

Node.JS API

GenAIScript runs in a (slightly modified) Node.JS environment where additional globals have been added. This environment is configured by the cli. Therefore, in order to run a GenAIScript in a “vanilla” Node.JS process, you will need to the Node.JS run API. This API loads and executes a GenAIScript script in a separate worker thread.

This page describes how to import and use the GenAIScript as an API in your Node.JS application.

Configuration

Assuming you have have added the cli as a dependency in your project, you can import the cli as follows:

npm i -D genaiscript

pnpm add -D genaiscript

yarn add -D genaiscript

Usage

The API can be imported using imports from “genaiscript/api”.

import { run } from "@genaiscript/api"

The imported api.mjs wrapper is a tiny, zero dependency loader that spawns a Node.JS worker thread to run GenAIScript.

No pollution of the globals
No side effects on the process

`run`

The run function wraps the cli run command.

import { run } from "@genaiscript/api"

const results = await run("summarize", ["myfile.txt"])

Environment variables

You can set the environment variables for the GenAIScript process by passing an object as the env field in the options. By default, the worker will inherit process.env.

const results = await run("summarize", ["myfile.txt"], {
    env: {
        MY_ENV_VAR: "value",
    },
})