Sideload Avatar Generator

Sideload Avatar Generator

Generate 3D avatars from text prompts or reference images using Sideload.gg. Pay-per-use via the x402 protocol — $2 USDC per generation on Base.

Works with any x402 wallet. Bring your own wallet and private key — no proprietary wallet required.

What You Get

Each generation produces four formats:

| Format | File | Use Case | |--------|------|----------| | GLB | .glb | Universal 3D — Three.js, Unity, Unreal, web viewers | | VRM | .vrm | Avatar standard — VRChat, VTubing, social apps | | MML | URL | Metaverse Markup Language — for MML-compatible worlds | | PNG | .png | Processed reference image used for generation |

🎭 Rendering Avatars with @pixiv/three-vrm

The VRM output is designed to work with @pixiv/three-vrm — the standard Three.js library for loading, displaying, and animating VRM avatars. If you're already building with Three.js, generated avatars plug right in with full skeleton support:

import * as THREE from 'three';
import { GLTFLoader } from 'three/examples/jsm/loaders/GLTFLoader';
import { VRMLoaderPlugin } from '@pixiv/three-vrm';
const loader = new GLTFLoader();
loader.register((parser) => new VRMLoaderPlugin(parser));
loader.load('https://aiml.sideload.gg/models/avt-xxx.vrm', (gltf) => {
  const vrm = gltf.userData.vrm;
  scene.add(vrm.scene);
  // Animate bone transforms, look-at, etc.
});

This makes it easy to generate an avatar with Sideload and immediately use it in any Three.js scene — games, social apps, virtual worlds, VTubing, and more.

For more on building interactive 3D experiences in the metaverse, see awesome-mml — a curated list of MML (Metaverse Markup Language) resources.

Prerequisites

  # Check the cost first
  node scripts/generate.js --probe
  # Generate with your x402 token
  node scripts/generate.js --prompt "..." --x402-token 
  

Use any x402-compatible client to obtain a payment token: Coinbase x402 SDK, Thirdweb x402, or your own signing flow.

Setup

npm install

Usage

Generate from Text Prompt

node scripts/generate.js --prompt "A cyberpunk samurai with glowing red armor" --x402-token 

Generate from Image URL

node scripts/generate.js --image https://example.com/character.png --x402-token 

Generate from Local Image

node scripts/generate.js --image /path/to/photo.jpg --x402-token 

Check Cost (No Payment)

node scripts/generate.js --probe

Check Job Status

node scripts/status.js avt-a1b2c3d4

Options

| Flag | Description | |------|-------------| | --prompt "text" | Text description of the avatar | | --image | Reference image (URL or local file path) | | --x402-token | x402 payment token (required for generation) | | --probe | Check cost without generating | | --output | Custom filename for downloaded files | | --no-download | Skip downloading result files |

API Reference

See SIDELOAD-API.md for the full API documentation, or visit sideload.gg/agents/raw.

Quick Reference

Generate:

POST https://sideload.gg/api/agent/generate
Headers: Content-Type: application/json, x-payment: 

Text: { "type": "text", "prompt": "description" } Image: { "type": "image", "imageUrl": "https://..." }

Poll: GET https://sideload.gg/api/agent/generate/{jobId}/status (no auth needed)

Prompt Tips

Be specific about:

Good prompts:

Image Tips

Rate Limits & Cost

Links

Generate from Text Prompt

node scripts/generate.js --prompt "A cyberpunk samurai with glowing red armor" --x402-token 

Generate from Image URL

node scripts/generate.js --image https://example.com/character.png --x402-token 

Generate from Local Image

node scripts/generate.js --image /path/to/photo.jpg --x402-token 

Check Cost (No Payment)

node scripts/generate.js --probe

Check Job Status

node scripts/status.js avt-a1b2c3d4

Options

| Flag | Description | |------|-------------| | --prompt "text" | Text description of the avatar | | --image | Reference image (URL or local file path) | | --x402-token | x402 payment token (required for generation) | | --probe | Check cost without generating | | --output | Custom filename for downloaded files | | --no-download | Skip downloading result files |

| Flag | Description | |------|-------------| | --prompt "text" | Text description of the avatar | | --image | Reference image (URL or local file path) | | --x402-token | x402 payment token (required for generation) | | --probe | Check cost without generating | | --output | Custom filename for downloaded files | | --no-download | Skip downloading result files |