Hypermoji Developers

Generate mascot emotes with the CLI, skill, and API.

Create animated mascots and reaction emotes from a single pipeline. Use the terminal, an AI agent, or your own code.

Example Outputs

A mascot and three emotes, generated from a single prompt.

Synth-Bot
Synth-Bot mascot base image

Synth-Bot

Base mascot by Selcuk Atli.

Synth-Bot waving hello

Wave Hello

Friendly greeting emote.

Synth-Bot rocking out on guitar

Rock Out!

Playing electric guitar.

Synth-Bot typing intensely

Typing Intensifies

Focused keyboard action.

On This Page

Why HypermojiChoose your surfaceCLI quickstartAgent skillAutomation APIAPI keysExport formats

For AI Agents

llms.txt

Why Hypermoji

One mascot system for your entire product.

Replace one-off illustrations with a reusable character system. Generate, automate, and export assets from a single workflow.

Mascots for AI agents

Give your AI agent a face. Use reusable reactions for replies, states, and assistant moments.

Interactive apps and games

Add ambient reactions, achievements, and character-driven moments to playful or interactive surfaces.

Onboarding and wizards

Guide users through setup and activation with mascots that wave, point, and celebrate along the way.

Marketing and support assets

Export GIFs, videos, and stills for docs, demos, social posts, and support replies - no separate art pipeline needed.

Choose Your Surface

Pick the interface that fits your workflow.

Start with the CLI for most tasks. Use the agent skill for natural-language workflows, and the API for custom integrations.

CLI

Best for local dev, CI, and terminal workflows.

  • Install once, use anywhere - local machines or CI runners.
  • Generate mascots, download assets, and poll jobs.

Agent Skill

Best when an AI agent should drive Hypermoji for you.

  • The skill orchestrates CLI commands through natural language.
  • Great for compound workflows like create, batch, and download in one conversation.

Automation API

Best for custom scripts and programmatic integrations.

  • Versioned routes under `/api/v1/*`.
  • Bearer authentication with your Hypermoji API key.

CLI

The fastest path from prompt to asset.

Login, generate mascots, create emotes, poll jobs, and download assets - all from your terminal.

Quickstart

npm install -g @hypersocial/hypermoji-cli
hypermoji login
hypermoji mascots create "friendly robot assistant" --wait
hypermoji emotes batch <mascot-id> "wave hello" "thinking" "celebrating"
hypermoji jobs list

Browser-based login, local credential storage, and JSON output for scripts. Works in local dev and CI.

Local dev
CI
JSON output
Interactive mode

Agent Skill

Let an AI agent handle multi-step workflows for you.

The skill orchestrates CLI commands through natural language - create mascots, batch emotes, wait for jobs, and download assets in one conversation.

Mental Model

Skill = brainCLI = hands

Best For

  • Natural-language requests like "make me six reaction emotes from this mascot".
  • Chain multiple steps without writing every command by hand.
  • Works in any terminal-based agentic coding environment.

Automation API

Build your own integrations with the API.

Authenticated REST endpoints under `/api/v1/*` for mascots, emotes, imports, and jobs.

Use `/api/v1/*` for new integrations. Legacy `/api/cli/*` routes are still available for backward compatibility.

Verify a key

export HYPERMOJI_API_KEY="hm_your_key_here"
curl -X POST "$HYPERMOJI_API_URL/api/v1/auth/verify" \
  -H "Authorization: Bearer $HYPERMOJI_API_KEY" \
  -H "Content-Type: application/json"

Route groups

Auth

  • POST /api/v1/auth/verify

Mascots

  • GET /api/v1/mascots
  • POST /api/v1/mascots
  • GET /api/v1/mascot?id=...
  • POST /api/v1/mascot/select
  • DELETE /api/v1/mascot?id=...
  • POST /api/v1/mascots/import

Emotes

  • GET /api/v1/emotes
  • POST /api/v1/emotes
  • POST /api/v1/emotes/batch
  • GET /api/v1/emote?id=...

Jobs

  • GET /api/v1/jobs
  • GET /api/v1/job?id=...

API Keys

API keys authenticate the CLI and the current automation API.

Create a key from the browser login flow or your profile settings. Keys use the `hm_` prefix and should be treated like passwords.

How they work today

  • Generated securely and stored hashed on the backend.
  • Returned once at creation time, with only a masked preview shown afterward.
  • Revocable and tracked with a last-used timestamp.

Current limitations

  • No scopes yet. Any valid key has full access to your account.
  • Rate limiting is not yet formally documented.
  • Keys are personal credentials, not service accounts.

Export Formats

What you can export today.

Download stills, GIFs, and transparent video in multiple formats. Some formats are generated on demand.

Base image

PNG-style still

Available now

Static mascot or emote image for UI, docs, and previews.

GIF

.gif

Available now

Looping animation for docs, social posts, and support replies.

WebM

.webm

Legacy / when present

Transparent video when a WebM variant is available.

Animated WebP

.webp

Generated export variant

Transparent animated format for browsers and apps.

Stacked-alpha video

.mp4

Generated export variant

Transparent video for Hypervideo player playback.

Where Hypervideo fits

For high-quality transparent video in product UI, use the stacked-alpha format with the Hypervideo player. For simpler use cases, animated WebP works in any modern browser.

What the CLI does today

Use `hypermoji emotes download` to grab `image`, `video`, `gif`, or `all` assets.

What is still missing

On-demand export generation (animated WebP, stacked-alpha MP4) is not yet available via CLI or API.