Skip to main content

Node.js SDK

The Node.js SDK is published on npm as @spatialflow/sdk. It needs Node.js 18 or later, and its source is in the spatialflow-node repository.

The SDK is at v1.1.1 and follows Semantic Versioning: breaking changes bump the major version, and 1.x is stable to build on.

Install​

npm install @spatialflow/sdk

Create a client​

import {SpatialFlow} from '@spatialflow/sdk';

const client = new SpatialFlow({apiKey: process.env.SPATIALFLOW_API_KEY});

Create the key under Settings > API Keys and give it permission for each resource the client uses. See Authentication and API keys.