Skip to main content
This guide walks you through setting up the Inworld Node.js Runtime.

​
Prerequisites

Before you get started, please make sure you have the following installed:

​
Installation

1

Create a Node.js project

We recommend starting with downloading and extracting our starter project, which has the necessary package structure to get you up and running quickly.
2

Install package

In the starter project directory’s root, install the Inworld Runtime SDK by running the following command:
yarn install
If you are not using the starter project, you can install the Runtime SDK with the following command:
yarn add @inworld/runtime
3

Run an example

If using the starter project, run the example with the following command using your Base64 Runtime API key:
INWORLD_API_KEY=<your_api_key_here> npx ts-node index.ts
Alternatively, you can also create a .env file in the root directory and populate it with your API key:
.env
INWORLD_API_KEY=<your_api_key_here>
and run
npx ts-node index.ts
With these steps, you’ll be all set to start building with the capabilities of the Inworld Runtime!
Backend Engine + Any Frontend: The Runtime is an AI graph-based backend that works with any frontend—React, Vue, mobile apps, or game engines. See our Voice Agent template for an Express + Vite + React example.

​
Next steps

Core Concepts

Understand the core concepts behind the Runtime.

Explore templates

Explore our templates for building with the Runtime SDK.

Runtime reference

Dive into our Runtime reference.