# Hwiyeong (휘영) — game VFX matching API
> Find particle effects in your own Unity project by describing them. Works in any major language.

Auth: X-API-Key header. Get a free key: POST /signup {"email": "you@example.com"}
Machine-readable spec: /openapi.json · Interactive docs: /docs

## Core endpoints
- POST /match {"query": "...", "top_k": 5} → candidates with file_path (the prefab path inside
  the user's Unity project), preview_b64 (peak-frame thumbnail of the rendered effect), score.
- POST /index/add — used by the Unity indexer plugin (thumbnails of rendered effects).
- POST /index/diff · GET /index/list · GET /index/status — incremental sync and inspection.
- GET /account — plan, quotas, usage.

## How it works (so agents can reason about it)
- The Unity editor plugin renders each particle prefab in edit mode (deterministic Simulate),
  picks the brightest "peak" frame, and uploads a 256px thumbnail + the prefab path.
  Effects never leave the user's machine as assets — only rendered thumbnails do.
- Search = filename text 0.65 + rendered-image embedding 0.35 (measured optimum, R@5 88%
  on a real game VFX library). Well-named packs rank by name; badly named ones by looks.
- Queries are multilingual natively — no normalization step, pass the user's words as-is.

## Indexing (one-time, in the Unity editor)
- GET /download/HwiyeongIndexer.cs → drop into Assets/Editor/ → Window > Hwiyeong.
  Scan finds every prefab containing a ParticleSystem, captures and uploads automatically.
  Re-run after adding effects — incremental. Requires no GPU beyond running Unity itself.

## Plans
- Free: 500 effects indexed, unlimited search. Indie ($12/mo or $115/yr): 30,000.
- POST /billing/checkout {"plan": "indie-monthly"|"indie-annual", "email": "<signup email>"} → {"url"}
  Payment is a human action — open the URL for your user.

Brand: https://ai.14dimension.com · Siblings: https://hyean.14dimension.com (images) ·
https://cheongmyeong.14dimension.com (sound) · Contact: admin@14dimension.com