Spaces:
Running on Zero
Running on Zero
|
Download docs/API_REFERENCE.md from ArshPathan/TexuteCraft: direct link, hf CLI and curl.
- Browser
- Download file 2.16 kB
-
https://huggingface.co/spaces/ArshPathan/TexuteCraft/resolve/main/docs/API_REFERENCE.md
- Command line
-
hf download hf://spaces/ArshPathan/TexuteCraft/docs/API_REFERENCE.md
-
curl -L -o API_REFERENCE.md https://huggingface.co/spaces/ArshPathan/TexuteCraft/resolve/main/docs/API_REFERENCE.md
2.16 kB
| # API Reference | |
| ## High-level flow | |
| ```mermaid | |
| sequenceDiagram | |
| participant Client | |
| participant API as Texture API | |
| participant Engine as TextureEngine | |
| participant Model as Diffusion Model | |
| Client->>API: POST /v1/textures/generate | |
| API->>Engine: generate_batch(prompt, seed, steps) | |
| Engine->>Model: run inference | |
| Model-->>Engine: generated 256x256 image | |
| Engine-->>API: 16x16 tile + base64 payload | |
| API-->>Client: JSON response with image data | |
| ``` | |
| ### Example gallery | |
|  | |
| ## GET /health | |
| Returns engine and GPU status. | |
| ```json | |
| { | |
| "status": "ready", | |
| "device": "cuda", | |
| "cuda_available": true, | |
| "gpu_name": "NVIDIA RTX 4070", | |
| "vram_total_gb": 12.0, | |
| "vram_allocated_gb": 1.2, | |
| "model_path": "models/minecraft-item-16px" | |
| } | |
| ``` | |
| ## POST /v1/textures/generate | |
| Generate one or more 16x16 transparent textures from a prompt. | |
| The engine removes the model's magenta chroma-key and attempts to remove other flat or repeating backgrounds that connect to the image corners. Background removal is heuristic; complex backgrounds or items touching the corners may need manual cleanup. | |
| Request body: | |
| ```json | |
| { | |
| "prompt": "ruby broadsword with glowing runes", | |
| "negative_prompt": "blurry, low quality", | |
| "variants": 2, | |
| "seed": 42, | |
| "steps": 30, | |
| "guidance_scale": 9.0 | |
| } | |
| ``` | |
| Response: | |
| ```json | |
| { | |
| "prompt": "ruby broadsword with glowing runes", | |
| "count": 2, | |
| "results": [ | |
| { | |
| "variant_index": 1, | |
| "seed": 42, | |
| "latency_sec": 1.4, | |
| "base64_png": "...", | |
| "data_uri": "data:image/png;base64,..." | |
| } | |
| ] | |
| } | |
| ``` | |
| ## Example usage flow | |
| ```bash | |
| curl -X POST http://127.0.0.1:8000/v1/textures/generate \ | |
| -H "Content-Type: application/json" \ | |
| -d '{ | |
| "prompt": "frost potion with blue crystal glow", | |
| "variants": 3, | |
| "seed": 77, | |
| "steps": 30, | |
| "guidance_scale": 9.0 | |
| }' | |
| ``` | |
| This is useful when you want to generate several candidate item textures for a UI mockup, a plugin idea, or an AI asset pipeline before choosing the best result. | |