BlurHash of an image
Compute the BlurHash string of an image: a short text placeholder that decodes to a blurred preview.
Input
Result
Choose a file and press Run.
Files you upload and the results are stored for one hour, then deleted. Anyone who has the link can open them, so don't upload anything private.
Use it from code or an agent
# 1. Upload the file. The reply ends with a line "ref <id>/f1": that is the file reference.
curl -T sample.jpg https://setget.net/drop/
# 2. Run the tool with that reference. "wait" holds the reply for up to 30 seconds while the job runs.
curl -s https://setget.net/v1/tools/image-blurhash \
-H 'Content-Type: application/json' \
-d '{"input":{"image":"DROP_ID/f1"},"wait":30}'
# 3. The reply is {"tool", "ms", "result", "files": [{"name", "size", "url", "ref"}], "job"}.
# Download a result file from its "url", or pass its "ref" to another tool.
# Still running after the wait? The reply is 202 with "job": follow it with
# curl -s https://setget.net/v1/jobs/JOB_ID?wait=30
import json, urllib.parse, urllib.request
BASE = "https://setget.net"
def call(method, path, body=None, headers=None):
request = urllib.request.Request(BASE + path, body, headers or {}, method=method)
return json.load(urllib.request.urlopen(request))
def upload(path):
"""Step 1: upload a file and get its reference."""
name = path.replace("\\", "/").rsplit("/", 1)[-1]
with open(path, "rb") as handle:
reply = call("PUT", "/drop/" + urllib.parse.quote(name), handle.read(), {"Accept": "application/json"})
return reply["file"]["ref"]
# Step 2: run the tool with the reference.
body = {"input": {'image': upload("sample.jpg")}, "wait": 30}
reply = call("POST", "/v1/tools/image-blurhash", json.dumps(body).encode(), {"Content-Type": "application/json"})
# Step 3: a job that is still running comes back as {"job": ...}. Wait for it.
while "result" not in reply and reply.get("job", reply).get("status") in ("queued", "running"):
reply = call("GET", "/v1/jobs/" + reply.get("job", reply)["id"] + "?wait=30")
if "error" in reply:
raise SystemExit(reply["error"]["message"])
print(reply["result"])
for file in reply["files"]: # result files: download from "url", or pass "ref" to another tool
print(file["name"], file["size"], file["url"], file["ref"])
const BASE = "https://setget.net";
// Step 1: upload a file and get its reference. file: a File or Blob
// (in Node: new Blob([fs.readFileSync(path)])).
async function upload(file, name) {
const response = await fetch(`${BASE}/drop/${encodeURIComponent(name)}`, {
method: "PUT", headers: {Accept: "application/json"}, body: file,
});
return (await response.json()).file.ref;
}
// Step 2: run the tool with the reference.
let reply = await (await fetch(`${BASE}/v1/tools/image-blurhash`, {
method: "POST",
headers: {"Content-Type": "application/json"},
body: JSON.stringify({input: {"image":await upload(file, "sample.jpg")}, wait: 30}),
})).json();
// Step 3: a job that is still running comes back as {job}. Wait for it.
while (!reply.result && ["queued", "running"].includes((reply.job || reply).status)) {
reply = await (await fetch(`${BASE}/v1/jobs/${(reply.job || reply).id}?wait=30`)).json();
}
if (reply.error) throw new Error(reply.error.message);
console.log(reply.result);
for (const file of reply.files) console.log(file.name, file.size, file.url, file.ref);
1. Upload. Tool: drop
Arguments:
{
"action": "create",
"files": [
{
"name": "sample.jpg",
"size": "<bytes>"
}
]
}
PUT each file's bytes to its "upload.url" with the listed headers, and keep its "ref".
With a shell, one command does both: curl -T FILE https://setget.net/drop/
2. Run. Tool: run_tool
Arguments:
{
"slug": "image-blurhash",
"input": {
"image": "DROP_ID/f1"
}
}
3. The answer holds "result" and "files" (each with "url" and "ref").
If it holds a "job" that is still running instead, follow it. Tool: job
Arguments:
{
"action": "wait",
"id": "JOB_ID"
}
{
"input": {
"image": "DROP_ID/f1"
},
"wait": 30
}
This is a file tool, so a call takes three steps: upload the file to get a reference, run the tool with that reference, then read the result and download its files. Uploads and results are public by link and expire after one hour.
Endpoint: POST /v1/tools/image-blurhash. Over MCP: run_tool with slug: "image-blurhash".
Machine-readable: input schema, Markdown. Connect an agent.
Inputs
| Name | Type | Required | What it does |
|---|---|---|---|
image |
file | yes | The image to encode. In the API: a file reference such as DROP_ID/f1. Accepts: image. |
components_x |
integer | no | Detail across the image, 1-9. More gives a longer string with more detail. Default: 4. From 1 to 9. |
components_y |
integer | no | Detail down the image, 1-9. Default: 3. From 1 to 9. |
Examples
Standard 4 x 3 BlurHash
{
"image": "sample.jpg"
}Press the example button above to run it on the sample file.
More detail
{
"image": "sample.png",
"components_x": 6,
"components_y": 4
}Press the example button above to run it on the sample file.
Questions
- What is a BlurHash for?
- Store the short string next to an image, and your app or page can show a soft blurred preview straight away while the real image loads. Decoders exist for most platforms.
- Which component counts should I use?
- 4 x 3 suits landscape images and 3 x 4 portrait ones. More components give more detail but a longer string: its length is 4 + 2 x components_x x components_y.
- What happens to transparency?
- Transparent areas are treated as white, because a BlurHash cannot hold transparency.
Related tools
- Colour palette from an imageExtract the dominant colours of an image as hex and RGB values with their share, plus a swatch image.
image-palette - Perceptual image hashCompute aHash, dHash and pHash fingerprints of an image, and compare two images to see if they look alike.
image-perceptual-hash - Image to data URITurn an image into a base64 data URI, with HTML img and CSS background-image snippets ready to paste.
image-to-data-uri - Resize imageResize an image to a width, a height or both, keeping its proportions, cropping to fill, or stretching.
image-resize - Add a text watermarkAdd a text watermark to an image in a corner, in the centre or tiled across it, with adjustable opacity and size.
image-watermark - Add padding or a borderAdd padding, margin or a coloured border around an image, the same on every side or set per side.
image-pad