Resources & Documentation
Everything you need to
build with FAE.
A complete guide to every tool, feature, and use case on the platform. Whether you're launching your first app, minting an NFT collection, or embedding an AI character into your own site — this is where to start.
API-first
Everything is accessible via REST
Free
Start building at no cost
New here? Start by creating an account, then create a Workspace. Everything — your apps, characters, files, NFTs — lives inside a workspace.
1
Create an account
Sign up with email/password or GitHub OAuth at
/login. Free accounts include 10 monthly credits.
2
Create a workspace
Workspaces are your project containers. Give it a name, description, and logo. Invite collaborators later.
3
Pick a tool and build
Launch the App Builder, create an AI character, upload media, or start a code project — all from your workspace dashboard.
4
Publish or embed
Deploy your app to a URL, share your character widget, or use the FAE API to pull your content into any external project.
A workspace is your root container for everything in FAE. Apps, characters, media, NFT collections, bots, and code projects are all scoped to a workspace. You can own multiple workspaces and invite collaborators to each.
Screenshot placeholder — Workspace dashboard view
Multiple Workspaces
Create separate workspaces per project, client, or team. Switch instantly from the top nav.
Collaborators
Invite other FAE users as editors. All workspace content is shared within the team.
Storage Quota
Each workspace has a storage limit (plan-dependent). A progress bar shows how much you've used.
Scoped Permissions
API keys are workspace-scoped. External apps can only read/write the workspace they're authorized for.
One workspace per client project
Shared workspace for a team
Dev workspace + production workspace
Isolated workspace per app you ship
Every workspace can generate API keys. Use them to authenticate requests to the FAE REST API from any external app, script, or service — without exposing your account credentials.
Screenshot placeholder — API key manager page
1
Go to API Keys
Navigate to
/api-keys or open Settings → API Keys from your workspace.
2
Generate a key
Click "New Key", give it a label, and copy the generated token. It is only shown once.
3
Use in requests
Pass your key as a header: X-API-Key: your_key along with X-Workspace-ID on each request.
// Example: fetch characters from your workspace
fetch('/api/characters?workspaceId=YOUR_WS_ID', {
headers: {
'X-API-Key': 'YOUR_API_KEY'
}
})
.then(r => r.json())
.then(data => console.log(data));
Rotate keys anytime from the key manager. Old keys are immediately invalidated. Use the built-in test panel to verify a key works before deploying.
FAE uses a credit system to meter AI inference, NFT minting, and API calls. Credits reset monthly with your subscription plan. Your workspace dashboard always shows current usage.
| Plan |
Monthly Credits |
Storage |
Collaborators |
Price |
| Free |
10 |
500 MB |
1 |
$0 |
| Basic |
100 |
5 GB |
3 |
— |
| Pro |
400 |
20 GB |
10 |
— |
| Enterprise |
2,000 |
Unlimited |
Unlimited |
Contact us |
Earn credits for free — running the FAE Desktop app and providing local AI compute earns you credits automatically for each inference you fulfill.
Create and host full web applications directly from your workspace. Start from a template or scratch, manage all files, link a GitHub repo, and deploy to a live URL — all with no server configuration required.
Screenshot placeholder — App Builder main view
1
Create a new app
From your workspace, open the Apps tab and click "New App". Give it a name and choose a template (blank, portfolio, dashboard, landing page, and more).
2
Edit files
All app files are stored in Google Cloud Storage. Open the in-browser Code Editor for inline editing, or sync a GitHub repo for git-based deployments.
3
Assign a domain
Each app gets a FAE subdomain automatically. You can map a custom domain from your app settings panel.
4
Deploy
Trigger a deploy from the dashboard. Your app is containerized and served behind Nginx. Preview URL appears immediately.
Template picker
File manager view
Portfolio sites
SaaS landing pages
Community dashboards
Internal tools
Coming-soon pages
Marketing microsites
GitHub Integration
Connect any public or private repo. FAE lists branches and commits; trigger builds from the dashboard.
Templates
Starter templates include Vanilla JS, Dashboard, Landing Page, Portfolio, Three.js game, and Vite-style.
Custom Domains
Map your own domain via DNS settings. FAE handles the proxy routing and SSL.
GCS File Storage
All files versioned in Google Cloud Storage. Download or restore any file from the file manager.
A real-time collaborative code editor that lives inside FAE — and can be embedded in your own products. Supports multiple open files, live preview, AI chat, and automatic cloud saving. Built on CodeMirror.
Screenshot placeholder — Code Editor with live preview open
Real-time Collaboration
Multiple users see each other's cursors and edits live. Powered by WebSocket rooms.
Live Preview
Preview panel renders your HTML/CSS/JS changes instantly in a sandboxed iframe.
AI Assist
Chat with AI in the sidebar. Ask it to write functions, explain errors, or generate boilerplate — it sees your current file context.
Auto-save
Files are continuously saved to GCS. No data loss even if you close the tab mid-edit.
Multi-language
Syntax highlighting for HTML, CSS, JS, TypeScript, Python, JSON, Markdown, and more.
Embeddable
The editor lives at /tools/code-editor/. Pass a workspace ID and API key as URL params to embed it in your own site.
Pair programming sessions
Code interview rooms
Embedded coding widgets for tutorials
Rapid prototyping
Live demos and presentations
Starter Templates
Blank
Empty HTML/CSS/JS starting point.
Dashboard
Card grid layout, stats widgets, dark theme.
Landing Page
Hero, features grid, CTA section, footer.
Three.js Game
3D scene setup with orbit controls and lighting.
Design AI-powered characters with full personality profiles. Each character gets a system prompt, traits, catchphrases, backstory, avatar, and an assigned language model. Chat with them instantly or embed them into your products.
Screenshot placeholder — Character builder form with avatar and traits
1
Create a character
Open the Characters tab in your workspace. Click "New Character", fill in the name, role, and description.
2
Define their personality
Add traits (curious, sarcastic, helpful...), catchphrases, backstory, and a detailed system prompt that shapes every response.
3
Set a model
Pick any registered Ollama model (e.g. Llama 3, Mistral, Gemma). Desktop app users can add local models.
4
Test and deploy
Chat with your character from the dashboard. Share a widget link or embed via the Echo AI Widget to put them on any page.
Traits panel
System prompt editor
Chat preview
Customer support bots
Game NPCs with memory
Branded Discord personas
Interactive story characters
Educational tutors
Fan-made anime companions
Pro tip: The system prompt is the most powerful field. Write it like you're briefing an actor — describe their voice, knowledge, what they will and won't say, and how they open conversations.
Create master NFTs, mint editions, and organize them into collections — all managed from your workspace. List for sale in-platform or connect to Magic Eden. On-chain Solana minting is completing; Ethereum support is planned.
Screenshot placeholder — NFT collection view with mint controls
1
Create a Master NFT
Upload artwork, set a name, description, attributes, royalty percentage, and max supply. This is the blueprint for editions.
2
Mint editions
Mint single or bulk editions from the master. Each gets a unique token ID and on-chain record. Lazy minting defers gas until purchase.
3
Build a collection
Group masters into a named Collection. Set milestones, collection-level royalties, and a public storefront page.
4
List for sale
Set a price per edition. Buyers purchase through the FAE marketplace or Magic Eden. Royalties are enforced on secondary sales.
Digital artwork collections
Game item minting
Membership / access passes
Community collectibles
Limited edition character skins
Status: Master/edition creation, collections, and metadata editing are live. On-chain Solana minting and Magic Eden listing are completing. Ethereum/EVM is planned for a future release.
A visual book and story creator with a page-by-page editor, chapter organization, cover art, and export. Designed for digital illustrated books, webtoons, and interactive fiction. The backend model and editor UI are live — full AI writing assistance and reader flow are in progress.
Screenshot placeholder — Book Studio editor with sidebar chapters
Web comics & webtoons
Interactive fiction books
Illustrated short stories
Character lore & world-building docs
Coming soon: AI writing assistance (generate chapters, suggest next scenes, auto-illustrate pages with Fooocus) and a public reader view for sharing stories as standalone pages.
Create and manage automation bots that react to events, token prices, AI outputs, and external data. The CRUD layer is live — scripting, scheduling, and trigger configuration are in active development.
Screenshot placeholder — Bot manager list view
Discord notification bots
Price alert bots
Automated NFT minting triggers
Trading bots (Desktop only)
Scheduled content posts
Desktop-only features: Advanced trading bot mode (on-chain transaction execution) requires the FAE desktop app to be running. Web bots are trigger/notify only.
Track any cryptocurrency token in real time. Connect a token address (Solana or EVM), and FAE pulls live price, market cap, 24h change, and volume via Moralis. Portfolio analytics and alerting are planned.
Screenshot placeholder — Token dashboard with price cards
Monitor your own project token
Community price dashboard
Portfolio tracking
Integrate live price data into your apps
Run on-chain or in-app raffles with NFT prizes, SOL/token ticket pricing, wallet-based entry, and automatic winner selection. Backend is fully operational — frontend payment flow and UI are staged.
NFT giveaways
Community engagement campaigns
Token-entry raffles
Whitelist spot lotteries
A visual Three.js compositor for building interactive 3D scenes directly in the browser. Place characters, import GLTF assets from the Media Manager, configure lighting, and export scenes for embedding. The backend scene model and CRUD API are live — the visual editor is in development.
Screenshot placeholder — 3D scene builder (coming soon)
Virtual showrooms
Interactive product displays
World maps & environments
Animated character displays
The FAE Electron app transforms your computer into a local AI compute provider. Run Ollama (text LLMs) and Fooocus (image generation) locally — no cloud bills. You earn credits for every inference you fulfill for other users on the network.
Screenshot placeholder — Desktop app with Ollama model manager
Local LLMs via Ollama
Download and run any Ollama-compatible model (Llama 3, Mistral, Gemma, etc.) directly on your machine.
Image Gen via Fooocus
Runs Stable Diffusion locally through Fooocus. Generate images with no API cost and no request limits.
AI Relay Provider
Connect to the FAE relay and serve AI requests from web users. Your machine processes the inference and earns credits.
Earn Credits
Every fulfilled inference earns workspace credits. More compute time = more credits = more plan features.
Auto-updates
Built on electron-updater. New versions download and apply in the background.
Stats Dashboard
A built-in overlay shows real-time inference stats, model status, and relay connection health.
Ideal setup: Leave the desktop app running in the background. It auto-connects to the relay on login. Even an idle mid-tier gaming PC can earn meaningful credits serving inference requests.
FAE's relay is the backbone of all AI features. Rather than sending every inference to a cloud API, the relay routes requests to available Electron desktop clients — turning user hardware into a distributed compute network.
Diagram placeholder — Web client → Relay server → Electron provider → Response
1
Web client sends request
Echo widget or any tool calls /api/ai-relay with a prompt, model ID, and workspace auth.
2
Relay queues and routes
The WebSocket relay picks an available Electron provider from the registry and forwards the job.
3
Electron processes locally
The desktop app runs inference via Ollama (text) or Fooocus (image) on the local machine — no cloud.
4
Response returned + credits paid
The relay streams the response back to the requesting web client and awards credits to the provider's workspace.
Graceful degradation: If no Electron providers are online, FAE falls back to cloud AI endpoints (when configured). Tools always have an offline-safe state.
Every FAE tool is designed to work as a standalone embed. Drop a Code Editor, AI chat widget, App Builder, or Book Studio into your existing site without rebuilding any infrastructure — just pass your workspace ID and API key.
Code Editor
Embed at /tools/code-editor/?ws=ID&key=KEY
App Builder
Embed at /tools/app-builder/?ws=ID&key=KEY
Book Studio
Embed at /tools/book-studio/?ws=ID&key=KEY
Echo Widget
Script-tag drop-in. Pass config object with workspace ID, character ID, and theme overrides.
// Example: embed Echo chat on your site
<script
src="https://faeframeworks.com/embed/echo.js"
data-workspace="YOUR_WORKSPACE_ID"
data-key="YOUR_API_KEY"
data-character="CHARACTER_ID"
data-theme="dark"
></script>
White-label: On paid plans, hide the FAE branding and apply your own color theme via CSS variables passed in the config. Tools render inside an iframe with a shared style contract.
Add AI chat to your own site
Embed a code playground in a tutorial
White-label the whole toolkit
Use the REST API with your own front-end
The public-facing discovery layer. Browse all public bots, apps, tokens, NFTs, and stories from creators on the platform. Use it to find inspiration, discover tools from the community, or let your own creations be found.
Screenshot placeholder — Explore page with categorized cards
Visibility: Resources are public by default when you publish them. Mark any item as private in its settings to hide it from Explore.
You're building games, webtoons, AI characters, or digital products — but you don't want to spend months on infrastructure. FAE gives you the whole stack out of the box.
AI-powered game NPC
Build a character, assign a model, and embed the chat widget in your Three.js game. The NPC remembers conversation context and responds in-character.
NFT art collection
Generate artwork with Fooocus (no API costs), mint masters, create editions, organize into a collection, and list on Magic Eden — all in one workflow.
Illustrated webtoon
Use Book Studio to lay out chapters and pages. Upload panel art to Media Manager. Publish as an interactive book readers can access via a shareable link.
Portfolio + app hosting
Spin up a portfolio site from a template, link your GitHub, and deploy with a custom domain. No Vercel, no Netlify accounts needed.
You want to move fast and integrate AI, storage, and hosting without reinventing wheels. FAE is API-first — everything you see in the UI is callable from your own code.
REST API for everything
Characters, apps, media, NFTs, bots — all CRUD-accessible with an API key. Build your own front-end on top of the FAE backend.
Embeddable tool widgets
Drop the Code Editor or AI chat into your SaaS product in minutes. No backend work required — just an API key.
AI relay WebSocket
Connect to the relay directly via WebSocket. Stream token-by-token AI responses into any interface you build.
GCS-backed storage
Upload files via the Media Manager API and get permanent GCS URLs back. No S3 setup, no signed-URL complexity.
// List all apps in a workspace
const res = await fetch('/api/apps?workspaceId=MY_WS', {
headers: { 'X-API-Key': 'MY_KEY' }
});
const { apps } = await res.json();
// Dispatch an AI prompt via relay
const relay = await fetch('/api/ai-relay/dispatch', {
method: 'POST',
headers: { 'X-API-Key': 'MY_KEY', 'Content-Type': 'application/json' },
body: JSON.stringify({ prompt: 'Tell me a story', model: 'llama3' })
});
Running a project, a token community, or a DAO? FAE gives you the tools to engage, reward, and govern your community without cobbling together five different services.
Community AI character
Give your community a mascot bot. Embed it on your site, Discord-link it, and let members interact with it 24/7.
NFT raffles & giveaways
Run raffles with SOL or token entry. Reward holders, drive engagement, and pick winners automatically.
Live token dashboard
Add a live price widget to your community site. Pulls from Moralis — just drop in the token address.
Membership NFTs
Mint access-pass NFTs for your community. Gate content, tools, or bot interactions by NFT ownership.
Coming soon: DAO governance tools — proposal creation, token-weighted voting, and treasury dashboards — are on the roadmap and will integrate directly with your workspace.