Yume API Documentation
The uncensored AI anime generation API. Generate stunning anime art with one endpoint — no restrictions, pay with $YUME.
Introduction
The Yume API lets you generate uncensored AI anime images programmatically. Build bots, apps, or integrate into your platform — all powered by Yume Engine.
All endpoints accept JSON and return JSON. HTTPS is required.
Authentication
Authenticate requests by including your API key in the X-API-Key header.
curl https://api.yume.wtf/v1/generate \ -H "X-API-Key: yume_sk_your_key_here"
Never expose your API key in client-side code or public repositories. Use environment variables.
Rate Limits
| Plan | Cost | Rate Limit |
|---|---|---|
| Free | $0 | 3 requests / day |
| Pay-per-use | 1 $YUME / generation | 60 requests / min |
| Unlimited | 500 $YUME / month | 120 requests / min |
Rate limit headers: X-RateLimit-Remaining, X-RateLimit-Reset
POSTGenerate Image
/v1/generate
Generate an AI anime image from a text prompt.
Request Body
| Parameter | Type | Description |
|---|---|---|
prompt required | string | Danbooru-style tags describing the image |
nsfw | boolean | Enable uncensored content (default: false) |
size | string | 832x1216 (portrait), 1024x1024, 1216x832 |
Example Request
curl -X POST https://api.yume.wtf/v1/generate \ -H "Content-Type: application/json" \ -H "X-API-Key: yume_sk_xxxxx" \ -d '{ "prompt": "1girl, silver hair, purple eyes, elegant dress", "nsfw": true, "size": "832x1216" }'
Response
// 200 OK { "id": "gen_a7x9k2", "image_url": "https://cdn.yume.wtf/gen/a7x9k2.jpg", "prompt": "1girl, silver hair, purple eyes, elegant dress", "credits_remaining": 49 }
POSTInspire Prompt
/v1/inspire
Get an AI-generated creative prompt for inspiration.
| Parameter | Type | Description |
|---|---|---|
nsfw | boolean | Generate NSFW prompt (default: false) |
theme | string | Theme hint: "onsen", "beach", "cyberpunk", etc. |
curl -X POST https://api.yume.wtf/v1/inspire \ -H "Content-Type: application/json" \ -d '{ "nsfw": true, "theme": "onsen" }'
// 200 OK { "prompt": "long black hair, amber eyes, nude, onsen, steam, wet skin..." }
GETGallery
/v1/gallery
Browse the community gallery of generated images.
| Parameter | Type | Description |
|---|---|---|
wallet | string | Filter by Solana wallet address |
limit | number | Max results (default: 50) |
curl https://api.yume.wtf/v1/gallery?limit=10
GETHealth Check
/v1/health
// 200 OK { "status": "ok", "engine": "Yume Engine v1.0" }
SDK Installation
npm install @yume-wtf/sdk
SDK Usage
import { YumeClient } from '@yume-wtf/sdk'; const yume = new YumeClient({ apiKey: 'yume_sk_xxxxx' }); // Generate const result = await yume.generate({ prompt: '1girl, silver hair, purple eyes', nsfw: true, }); console.log(result.imageUrl); // Get inspiration const idea = await yume.inspire({ nsfw: true, theme: 'onsen' }); console.log(idea.prompt); // Browse gallery const items = await yume.gallery({ limit: 10 }); console.log(items.length, 'dreams');
Error Handling
import { YumeError } from '@yume-wtf/sdk'; try { await yume.generate({ prompt: 'test' }); } catch (err) { if (err instanceof YumeError) { console.log(err.message); // "Daily limit reached" console.log(err.status); // 429 } }
$YUME Token
| Property | Value |
|---|---|
| Name | Yume |
| Ticker | $YUME |
| Network | Solana |
| Total Supply | 1,000,000,000 |
| Launch | PumpFun |
| Burn | Deflationary (5% on API purchases) |
Holder Tiers
| Tier | Hold Amount | Supply % | Access |
|---|---|---|---|
| Wanderer | Free | — | 3/day, watermark |
| Dreamer | 500K $YUME | 0.05% | No watermark, 10/day |
| Lucid | 2M $YUME | 0.2% | Unlimited, HD |
| Ethereal | 5M $YUME | 0.5% | All models, priority |
| Astral | 20M $YUME | 2% | Beta, API credits |