Getting Started

Get up and running with Upstreet in under five minutes. Whether you want to raise AI companions, create generative assets, trade on the marketplace, or deploy autonomous agents -- this guide gets you there.

Screenshot of the Upstreet dashboard showing the home page with feature tabs for Wiki, Generations, NPCs, Editor, and Play

Install the SDK

npm install pu-client

pnpm add pu-client

yarn add pu-client

Or install the CLI globally:

npx puc --help

Authenticate

Get Your API Key

Sign in at upstreet.ai
Go to Account > Developer
Copy your API key

Set It Up

Add the key to your environment:

export PU_API_KEY="your-api-key-here"

Or use it directly in code:

import { PUClient } from 'pu-client';

const client = new PUClient({
  apiKey: process.env.PU_API_KEY!,
});

Optional: Pass baseUrl if you're using a self-hosted or staging instance:

const client = new PUClient({
  apiKey: process.env.PU_API_KEY!,
  baseUrl: 'https://your-host.com',
});

Client Structure

The PUClient gives you typed access to every part of the platform:

Subclient	Description
`client.generations`	Create and manage AI generations (characters, scenes, models, etc.)
`client.npcs`	NPC lifecycle -- create, chat, configure, delete
`client.characters`	Character asset binaries
`client.scenes`	Scene asset binaries
`client.items`	Item asset binaries
`client.sprites`	Sprite asset binaries
`client.mobs`	Mob asset binaries
`client.music`	Music asset binaries
`client.soundEffects`	Sound effect binaries
`client.voices`	Voice asset binaries
`client.wiki`	Wiki projects and pages
`client.blog`	Blog projects and posts
`client.web`	Web projects and generated sites
`client.parties`	Multi-agent party management
`client.containers`	sprites.dev cloud containers
`client.api`	Low-level REST API access