Upload README.md

README.md

@@ -16,4 +16,148 @@ preload_from_hub:
 hf_oauth: true
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+## Using this Space programmatically
+
+You can call this Space from Python (via `gradio_client`) or from plain `curl`.
+
+> ⚠️ Note: This README may lag behind the actual API definition shown in the Space’s “View API” page.
+> If something does not work, always double-check the latest argument list and endpoint names there.
+
+All examples assume:
+
+- Space ID: `John6666/DiffuseCraftMod`
+- You have a valid Hugging Face access token: `hf_xxx...` (read access is enough)
+- You replace `hf_xxx...` with your own token
+
+---
+
+### 1. Python examples (`gradio_client`)
+
+Install:
+
+```bash
+pip install gradio_client
+````
+
+#### 1.1 Synchronous API – `generate_image`
+
+```python
+from gradio_client import Client
+
+client = Client("John6666/DiffuseCraftMod", hf_token="hf_xxx...")
+
+status, images, info = client.predict(
+    prompt="Hello!!",
+    negative_prompt=(
+        "lowres, bad anatomy, bad hands, missing fingers, extra digit, "
+        "fewer digits, worst quality, low quality"
+    ),
+    num_images=1,
+    num_inference_steps=28,
+    guidance_scale=7.0,
+    clip_skip=0,
+    seed=-1,
+    height=1024,
+    width=1024,
+    model_name="votepurchase/animagine-xl-3.1",
+    vae_model="None",
+    task="txt2img",
+    api_name="/generate_image",
+)
+
+print(status)
+print(images)
+print(info)
+```
+
+#### 1.2 Streaming API – `generate_image_stream`
+
+```python
+from gradio_client import Client
+
+client = Client("John6666/DiffuseCraftMod", hf_token="hf_xxx...")
+
+job = client.submit(
+    prompt="Hello!!",
+    negative_prompt=(
+        "lowres, bad anatomy, bad hands, missing fingers, extra digit, "
+        "fewer digits, worst quality, low quality"
+    ),
+    num_images=1,
+    num_inference_steps=28,
+    guidance_scale=7.0,
+    clip_skip=0,
+    seed=-1,
+    height=1024,
+    width=1024,
+    model_name="votepurchase/animagine-xl-3.1",
+    vae_model="None",
+    task="txt2img",
+    api_name="/generate_image_stream",
+)
+
+for status, images, info in job:
+    # You will see progress messages, intermediate previews, and the final result.
+    print(status, images, info)
+```
+
+---
+
+### 2. `curl` examples
+
+When calling from `curl`, include your HF token; anonymous calls may be rate-limited or rejected.
+
+```bash
+export HF_TOKEN="hf_xxx..."  # your Hugging Face access token
+```
+
+#### 2.1 Synchronous API – `generate_image`
+
+```bash
+curl -X POST "https://john6666-diffusecraftmod.hf.space/call/generate_image" \
+  -H "Authorization: Bearer $HF_TOKEN" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "data": [
+      "Hello!!",
+      "lowres, bad anatomy, bad hands, missing fingers, extra digit, fewer digits, worst quality, low quality",
+      1,
+      28,
+      7.0,
+      0,
+      -1,
+      1024,
+      1024,
+      "votepurchase/animagine-xl-3.1",
+      "None",
+      "txt2img"
+    ]
+  }'
+```
+
+#### 2.2 Streaming API – `generate_image_stream`
+
+```bash
+curl -X POST "https://john6666-diffusecraftmod.hf.space/call/generate_image_stream" \
+  -H "Authorization: Bearer $HF_TOKEN" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "data": [
+      "Hello!!",
+      "lowres, bad anatomy, bad hands, missing fingers, extra digit, fewer digits, worst quality, low quality",
+      1,
+      28,
+      7.0,
+      0,
+      -1,
+      1024,
+      1024,
+      "votepurchase/animagine-xl-3.1",
+      "None",
+      "txt2img"
+    ]
+  }'
+```
+
+For full parameter coverage (all advanced options), refer to the Space’s “View API” page and adapt the
+examples above accordingly.