HouseKraft API

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photo
const photo = await upload("room.jpg");

// 2. Run Wall Paint
let { job } = await call("POST", "/api/v1/tools/walls/run", {
  "image": photo,
  "color_id": "sage green",
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") console.log("Result:", job.output.url);
else console.log("Failed:", job.error.message, "| refunded:", job.credits.refunded);

{
  "mcpServers": {
    "housekraft": {
      "url": "https://app.housekraft.co/api/v1/mcp",
      "headers": {
        "Authorization": "Bearer hk_mcp_…"
      }
    }
  }
}

{
  "inputs": [
    {
      "type": "promptString",
      "id": "housekraft-mcp-key",
      "description": "HouseKraft MCP key",
      "password": true
    }
  ],
  "servers": {
    "housekraft": {
      "type": "http",
      "url": "https://app.housekraft.co/api/v1/mcp",
      "headers": {
        "Authorization": "Bearer ${input:housekraft-mcp-key}"
      }
    }
  }
}

{
  "mcpServers": {
    "housekraft": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://app.housekraft.co/api/v1/mcp",
        "--header",
        "Authorization:${HOUSEKRAFT_AUTH}"
      ],
      "env": {
        "HOUSEKRAFT_AUTH": "Bearer hk_mcp_…"
      }
    }
  }
}

https://app.housekraft.co/api/v1/mcp
Authorization: Bearer hk_mcp_…

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photo
photo = upload("room.jpg")

# 2. Run Wall Paint
job = call("POST", "/api/v1/tools/walls/run", json={
    "image": photo,
    "color_id": "sage green",
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    print("Result:", job["output"]["url"])
else:
    print("Failed:", job["error"]["message"], "| refunded:", job["credits"]["refunded"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photo
const photo = await upload("room.jpg");

// 2. Run Wall Paint
let { job } = await call("POST", "/api/v1/tools/walls/run", {
  "image": photo,
  "color_id": "sage green",
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") console.log("Result:", job.output.url);
else console.log("Failed:", job.error.message, "| refunded:", job.credits.refunded);

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "walls",
    "status": "running",
    "created_at": 1793700000,
    "finished_at": null,
    "credits": {
      "charged": 1,
      "refunded": false
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "color_id": "sage green"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": null,
    "poll_after_seconds": 3
  },
  "check": {
    "message": "Still running after 50 seconds. The job carries on; get the result from this URL. Nothing is lost if this connection closes, and GET /api/v1/jobs lists your recent jobs.",
    "url": "https://app.housekraft.co/api/v1/jobs/7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "command": "curl -s https://app.housekraft.co/api/v1/jobs/7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8 -H \"Authorization: Bearer $HOUSEKRAFT_KEY\""
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "walls",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 1,
      "refunded": true
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "color_id": "sage green"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "The image model could not finish this request."
    }
  }
}

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photo
photo = upload("room.jpg")

# 2. Run Flooring
job = call("POST", "/api/v1/tools/flooring/run", json={
    "image": photo,
    "flooring_id": "oak_hardwood",
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    print("Result:", job["output"]["url"])
else:
    print("Failed:", job["error"]["message"], "| refunded:", job["credits"]["refunded"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photo
const photo = await upload("room.jpg");

// 2. Run Flooring
let { job } = await call("POST", "/api/v1/tools/flooring/run", {
  "image": photo,
  "flooring_id": "oak_hardwood",
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") console.log("Result:", job.output.url);
else console.log("Failed:", job.error.message, "| refunded:", job.credits.refunded);

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "flooring",
    "status": "running",
    "created_at": 1793700000,
    "finished_at": null,
    "credits": {
      "charged": 1,
      "refunded": false
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "flooring_id": "oak_hardwood"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": null,
    "poll_after_seconds": 3
  },
  "check": {
    "message": "Still running after 50 seconds. The job carries on; get the result from this URL. Nothing is lost if this connection closes, and GET /api/v1/jobs lists your recent jobs.",
    "url": "https://app.housekraft.co/api/v1/jobs/7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "command": "curl -s https://app.housekraft.co/api/v1/jobs/7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8 -H \"Authorization: Bearer $HOUSEKRAFT_KEY\""
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "flooring",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 1,
      "refunded": true
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "flooring_id": "oak_hardwood"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "The image model could not finish this request."
    }
  }
}

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photo
photo = upload("room.jpg")

# 2. Run Material
job = call("POST", "/api/v1/tools/material/run", json={
    "image": photo,
    "material_id": "white_marble",
    "custom_prompt": "the kitchen countertop",
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    print("Result:", job["output"]["url"])
else:
    print("Failed:", job["error"]["message"], "| refunded:", job["credits"]["refunded"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photo
const photo = await upload("room.jpg");

// 2. Run Material
let { job } = await call("POST", "/api/v1/tools/material/run", {
  "image": photo,
  "material_id": "white_marble",
  "custom_prompt": "the kitchen countertop",
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") console.log("Result:", job.output.url);
else console.log("Failed:", job.error.message, "| refunded:", job.credits.refunded);

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "material",
    "status": "done",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 2,
      "refunded": false
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "material_id": "white_marble",
      "custom_prompt": "the kitchen countertop"
    },
    "warnings": [],
    "check_overridden": false,
    "output": {
      "id": "a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5",
      "type": "generated",
      "tool": "material",
      "url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.jpg",
      "thumbnail_url": "https://…/thumbnails/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.jpg",
      "width": 1024,
      "height": 1024,
      "created_at": 1793700025,
      "kind": "image"
    },
    "error": null
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "material",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 2,
      "refunded": true
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "material_id": "white_marble",
      "custom_prompt": "the kitchen countertop"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "The image model could not finish this request."
    }
  }
}

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photo
photo = upload("room.jpg")

# 2. Run Object Placement
job = call("POST", "/api/v1/tools/furniture/run", json={
    "image": photo,
    "action": "add",
    "furniture_type": "walnut side table",
    "position": {"x": 50, "y": 65, "width": 22, "height": 25},
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    print("Result:", job["output"]["url"])
else:
    print("Failed:", job["error"]["message"], "| refunded:", job["credits"]["refunded"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photo
const photo = await upload("room.jpg");

// 2. Run Object Placement
let { job } = await call("POST", "/api/v1/tools/furniture/run", {
  "image": photo,
  "action": "add",
  "furniture_type": "walnut side table",
  "position": {"x": 50, "y": 65, "width": 22, "height": 25},
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") console.log("Result:", job.output.url);
else console.log("Failed:", job.error.message, "| refunded:", job.credits.refunded);

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "furniture",
    "status": "done",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 2,
      "refunded": false
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "action": "add",
      "furniture_type": "walnut side table",
      "position": {
        "x": 50,
        "y": 65,
        "width": 22,
        "height": 25
      }
    },
    "warnings": [],
    "check_overridden": false,
    "output": {
      "id": "a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5",
      "type": "generated",
      "tool": "furniture",
      "url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.jpg",
      "thumbnail_url": "https://…/thumbnails/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.jpg",
      "width": 1024,
      "height": 1024,
      "created_at": 1793700025,
      "kind": "image"
    },
    "error": null
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "furniture",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 2,
      "refunded": true
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "action": "add",
      "furniture_type": "walnut side table",
      "position": {
        "x": 50,
        "y": 65,
        "width": 22,
        "height": 25
      }
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "The image model could not finish this request."
    }
  }
}

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photo
photo = upload("room.jpg")

# 2. Run Time of Day
job = call("POST", "/api/v1/tools/lighting/run", json={
    "image": photo,
    "time_of_day": "sunset",
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    print("Result:", job["output"]["url"])
else:
    print("Failed:", job["error"]["message"], "| refunded:", job["credits"]["refunded"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photo
const photo = await upload("room.jpg");

// 2. Run Time of Day
let { job } = await call("POST", "/api/v1/tools/lighting/run", {
  "image": photo,
  "time_of_day": "sunset",
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") console.log("Result:", job.output.url);
else console.log("Failed:", job.error.message, "| refunded:", job.credits.refunded);

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "lighting",
    "status": "running",
    "created_at": 1793700000,
    "finished_at": null,
    "credits": {
      "charged": 1,
      "refunded": false
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "time_of_day": "sunset"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": null,
    "poll_after_seconds": 3
  },
  "check": {
    "message": "Still running after 50 seconds. The job carries on; get the result from this URL. Nothing is lost if this connection closes, and GET /api/v1/jobs lists your recent jobs.",
    "url": "https://app.housekraft.co/api/v1/jobs/7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "command": "curl -s https://app.housekraft.co/api/v1/jobs/7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8 -H \"Authorization: Bearer $HOUSEKRAFT_KEY\""
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "lighting",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 1,
      "refunded": true
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "time_of_day": "sunset"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "The image model could not finish this request."
    }
  }
}

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photo
photo = upload("room.jpg")

# 2. Run Weather
job = call("POST", "/api/v1/tools/weather/run", json={
    "image": photo,
    "weather": "snowy",
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    print("Result:", job["output"]["url"])
else:
    print("Failed:", job["error"]["message"], "| refunded:", job["credits"]["refunded"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photo
const photo = await upload("room.jpg");

// 2. Run Weather
let { job } = await call("POST", "/api/v1/tools/weather/run", {
  "image": photo,
  "weather": "snowy",
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") console.log("Result:", job.output.url);
else console.log("Failed:", job.error.message, "| refunded:", job.credits.refunded);

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "weather",
    "status": "running",
    "created_at": 1793700000,
    "finished_at": null,
    "credits": {
      "charged": 1,
      "refunded": false
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "weather": "snowy"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": null,
    "poll_after_seconds": 3
  },
  "check": {
    "message": "Still running after 50 seconds. The job carries on; get the result from this URL. Nothing is lost if this connection closes, and GET /api/v1/jobs lists your recent jobs.",
    "url": "https://app.housekraft.co/api/v1/jobs/7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "command": "curl -s https://app.housekraft.co/api/v1/jobs/7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8 -H \"Authorization: Bearer $HOUSEKRAFT_KEY\""
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "weather",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 1,
      "refunded": true
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "weather": "snowy"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "The image model could not finish this request."
    }
  }
}

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photo
photo = upload("room.jpg")

# 2. Run Stage
job = call("POST", "/api/v1/tools/stage/run", json={
    "image": photo,
    "prompt": "Scandinavian, light oak and linen",
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    print("Result:", job["output"]["url"])
else:
    print("Failed:", job["error"]["message"], "| refunded:", job["credits"]["refunded"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photo
const photo = await upload("room.jpg");

// 2. Run Stage
let { job } = await call("POST", "/api/v1/tools/stage/run", {
  "image": photo,
  "prompt": "Scandinavian, light oak and linen",
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") console.log("Result:", job.output.url);
else console.log("Failed:", job.error.message, "| refunded:", job.credits.refunded);

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "stage",
    "status": "running",
    "created_at": 1793700000,
    "finished_at": null,
    "credits": {
      "charged": 2,
      "refunded": false
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "prompt": "Scandinavian, light oak and linen"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": null,
    "poll_after_seconds": 3
  },
  "check": {
    "message": "Still running after 50 seconds. The job carries on; get the result from this URL. Nothing is lost if this connection closes, and GET /api/v1/jobs lists your recent jobs.",
    "url": "https://app.housekraft.co/api/v1/jobs/7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "command": "curl -s https://app.housekraft.co/api/v1/jobs/7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8 -H \"Authorization: Bearer $HOUSEKRAFT_KEY\""
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "stage",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 2,
      "refunded": true
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "prompt": "Scandinavian, light oak and linen"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "The image model could not finish this request."
    }
  }
}

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photo
photo = upload("room.jpg")

# 2. Run Unstage
job = call("POST", "/api/v1/tools/unstage/run", json={
    "image": photo,
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    print("Result:", job["output"]["url"])
else:
    print("Failed:", job["error"]["message"], "| refunded:", job["credits"]["refunded"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photo
const photo = await upload("room.jpg");

// 2. Run Unstage
let { job } = await call("POST", "/api/v1/tools/unstage/run", {
  "image": photo,
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") console.log("Result:", job.output.url);
else console.log("Failed:", job.error.message, "| refunded:", job.credits.refunded);

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "unstage",
    "status": "running",
    "created_at": 1793700000,
    "finished_at": null,
    "credits": {
      "charged": 1,
      "refunded": false
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": null,
    "poll_after_seconds": 3
  },
  "check": {
    "message": "Still running after 50 seconds. The job carries on; get the result from this URL. Nothing is lost if this connection closes, and GET /api/v1/jobs lists your recent jobs.",
    "url": "https://app.housekraft.co/api/v1/jobs/7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "command": "curl -s https://app.housekraft.co/api/v1/jobs/7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8 -H \"Authorization: Bearer $HOUSEKRAFT_KEY\""
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "unstage",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 1,
      "refunded": true
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "The image model could not finish this request."
    }
  }
}

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photo
photo = upload("room.jpg")

# 2. Run POV
job = call("POST", "/api/v1/tools/pov/run", json={
    "image": photo,
    "azimuth": -45,
    "elevation": 0,
    "zoom": 5,
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    print("Result:", job["output"]["url"])
else:
    print("Failed:", job["error"]["message"], "| refunded:", job["credits"]["refunded"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photo
const photo = await upload("room.jpg");

// 2. Run POV
let { job } = await call("POST", "/api/v1/tools/pov/run", {
  "image": photo,
  "azimuth": -45,
  "elevation": 0,
  "zoom": 5,
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") console.log("Result:", job.output.url);
else console.log("Failed:", job.error.message, "| refunded:", job.credits.refunded);

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "pov",
    "status": "done",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 2,
      "refunded": false
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "azimuth": -45,
      "elevation": 0,
      "zoom": 5
    },
    "warnings": [],
    "check_overridden": false,
    "output": {
      "id": "a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5",
      "type": "generated",
      "tool": "pov",
      "url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.jpg",
      "thumbnail_url": "https://…/thumbnails/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.jpg",
      "width": 1024,
      "height": 1024,
      "created_at": 1793700025,
      "kind": "image"
    },
    "error": null
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "pov",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 2,
      "refunded": true
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "azimuth": -45,
      "elevation": 0,
      "zoom": 5
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "The image model could not finish this request."
    }
  }
}

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photo
photo = upload("room.jpg")

# 2. Run AI Annotate
job = call("POST", "/api/v1/tools/editor/run", json={
    "image": photo,
    "prompt": "make the pendant lamp brass",
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    print("Result:", job["output"]["url"])
else:
    print("Failed:", job["error"]["message"], "| refunded:", job["credits"]["refunded"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photo
const photo = await upload("room.jpg");

// 2. Run AI Annotate
let { job } = await call("POST", "/api/v1/tools/editor/run", {
  "image": photo,
  "prompt": "make the pendant lamp brass",
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") console.log("Result:", job.output.url);
else console.log("Failed:", job.error.message, "| refunded:", job.credits.refunded);

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "editor",
    "status": "done",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 3,
      "refunded": false
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "prompt": "make the pendant lamp brass"
    },
    "warnings": [],
    "check_overridden": false,
    "output": {
      "id": "a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5",
      "type": "generated",
      "tool": "editor",
      "url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.jpg",
      "thumbnail_url": "https://…/thumbnails/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.jpg",
      "width": 1024,
      "height": 1024,
      "created_at": 1793700025,
      "kind": "image"
    },
    "error": null
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "editor",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 3,
      "refunded": true
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "prompt": "make the pendant lamp brass"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "The image model could not finish this request."
    }
  }
}

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photo
photo = upload("floor-plan.png")

# 2. Run Floor Plan to Dollhouse
job = call("POST", "/api/v1/tools/dollhouse/run", json={
    "image": photo,
    "style": "scandinavian",
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    print("Result:", job["output"]["url"])
else:
    print("Failed:", job["error"]["message"], "| refunded:", job["credits"]["refunded"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photo
const photo = await upload("floor-plan.png");

// 2. Run Floor Plan to Dollhouse
let { job } = await call("POST", "/api/v1/tools/dollhouse/run", {
  "image": photo,
  "style": "scandinavian",
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") console.log("Result:", job.output.url);
else console.log("Failed:", job.error.message, "| refunded:", job.credits.refunded);

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "dollhouse",
    "status": "running",
    "created_at": 1793700000,
    "finished_at": null,
    "credits": {
      "charged": 1,
      "refunded": false
    },
    "input": {
      "image": "<asset id of a floor plan>",
      "style": "scandinavian"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": null,
    "poll_after_seconds": 3
  },
  "check": {
    "message": "Still running after 50 seconds. The job carries on; get the result from this URL. Nothing is lost if this connection closes, and GET /api/v1/jobs lists your recent jobs.",
    "url": "https://app.housekraft.co/api/v1/jobs/7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "command": "curl -s https://app.housekraft.co/api/v1/jobs/7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8 -H \"Authorization: Bearer $HOUSEKRAFT_KEY\""
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "dollhouse",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 1,
      "refunded": true
    },
    "input": {
      "image": "<asset id of a floor plan>",
      "style": "scandinavian"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "The image model could not finish this request."
    }
  }
}

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photos
photos = [upload(path) for path in ["view-1.jpg", "view-2.jpg", "view-3.jpg"]]

# 2. Run 360° Panorama
job = call("POST", "/api/v1/tools/panorama/run", json={
    "images": photos,
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    print("Result:", job["output"]["url"])
else:
    print("Failed:", job["error"]["message"], "| refunded:", job["credits"]["refunded"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photos
const photos = await Promise.all(["view-1.jpg", "view-2.jpg", "view-3.jpg"].map(upload));

// 2. Run 360° Panorama
let { job } = await call("POST", "/api/v1/tools/panorama/run", {
  "images": photos,
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") console.log("Result:", job.output.url);
else console.log("Failed:", job.error.message, "| refunded:", job.credits.refunded);

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "panorama",
    "status": "done",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 3,
      "refunded": false
    },
    "input": {
      "images": [
        "<photo 1>",
        "<photo 2>",
        "<photo 3>"
      ]
    },
    "warnings": [],
    "check_overridden": false,
    "output": {
      "id": "a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5",
      "type": "generated",
      "tool": "panorama",
      "url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.jpg",
      "thumbnail_url": "https://…/thumbnails/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.jpg",
      "width": 2048,
      "height": 1024,
      "created_at": 1793700025,
      "kind": "panorama"
    },
    "error": null
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "panorama",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 3,
      "refunded": true
    },
    "input": {
      "images": [
        "<photo 1>",
        "<photo 2>",
        "<photo 3>"
      ]
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "The image model could not finish this request."
    }
  }
}

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photo
photo = upload("room.jpg")

# 2. Run Walkthrough Video
job = call("POST", "/api/v1/tools/walkthrough/run", json={
    "image": photo,
    "duration": 6,
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    print("Result:", job["output"]["url"])
else:
    print("Failed:", job["error"]["message"], "| refunded:", job["credits"]["refunded"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photo
const photo = await upload("room.jpg");

// 2. Run Walkthrough Video
let { job } = await call("POST", "/api/v1/tools/walkthrough/run", {
  "image": photo,
  "duration": 6,
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") console.log("Result:", job.output.url);
else console.log("Failed:", job.error.message, "| refunded:", job.credits.refunded);

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "walkthrough",
    "status": "done",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 10,
      "refunded": false
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "duration": 6
    },
    "warnings": [],
    "check_overridden": false,
    "output": {
      "id": "a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5",
      "type": "generated",
      "tool": "walkthrough",
      "url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.mp4",
      "thumbnail_url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.mp4",
      "width": null,
      "height": null,
      "created_at": 1793700025,
      "kind": "video"
    },
    "error": null
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "walkthrough",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 10,
      "refunded": true
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "duration": 6
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "The image model could not finish this request."
    }
  }
}

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photos
photos = [upload(path) for path in ["front-of-house.jpg", "hallway.jpg", "living-room.jpg"]]

# 2. Run Walkthrough Video (multiple photos)
job = call("POST", "/api/v1/tools/walkthrough_multi/run", json={
    "images": photos,
    "duration": 8,
    "scope": "property",
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    print("Result:", job["output"]["url"])
else:
    print("Failed:", job["error"]["message"], "| refunded:", job["credits"]["refunded"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photos
const photos = await Promise.all(["front-of-house.jpg", "hallway.jpg", "living-room.jpg"].map(upload));

// 2. Run Walkthrough Video (multiple photos)
let { job } = await call("POST", "/api/v1/tools/walkthrough_multi/run", {
  "images": photos,
  "duration": 8,
  "scope": "property",
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") console.log("Result:", job.output.url);
else console.log("Failed:", job.error.message, "| refunded:", job.credits.refunded);

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "walkthrough_multi",
    "status": "done",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 2,
      "refunded": false
    },
    "input": {
      "images": [
        "<front of house>",
        "<hallway>",
        "<living room>"
      ],
      "duration": 8,
      "scope": "property"
    },
    "warnings": [],
    "check_overridden": false,
    "output": {
      "id": "a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5",
      "type": "generated",
      "tool": "walkthrough",
      "url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.mp4",
      "thumbnail_url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.mp4",
      "width": null,
      "height": null,
      "created_at": 1793700025,
      "kind": "video"
    },
    "error": null
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "walkthrough_multi",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 2,
      "refunded": true
    },
    "input": {
      "images": [
        "<front of house>",
        "<hallway>",
        "<living room>"
      ],
      "duration": 8,
      "scope": "property"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "The image model could not finish this request."
    }
  }
}

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photos
photos = [upload(path) for path in ["room-1.jpg", "room-2.jpg", "room-3.jpg"]]

# 2. Run Bulk Staging
job = call("POST", "/api/v1/tools/bulk_stage/run", json={
    "images": photos,
    "prompt": "Scandinavian, light oak and linen",
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    for item in job["outputs"]:          # one per photo or reference, in order
        print(item["index"], item["status"], item["output"]["url"] if item["output"] else item["error"])
else:
    print("Failed:", job["error"]["message"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photos
const photos = await Promise.all(["room-1.jpg", "room-2.jpg", "room-3.jpg"].map(upload));

// 2. Run Bulk Staging
let { job } = await call("POST", "/api/v1/tools/bulk_stage/run", {
  "images": photos,
  "prompt": "Scandinavian, light oak and linen",
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") {
  // one per photo or reference, in order
  for (const item of job.outputs) console.log(item.index, item.status, item.output ? item.output.url : item.error);
} else {
  console.log("Failed:", job.error.message);
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "bulk_stage",
    "status": "done",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 6,
      "refunded": false,
      "refunded_credits": 0
    },
    "input": {
      "images": [
        "<photo 1>",
        "<photo 2>",
        "<photo 3>"
      ],
      "prompt": "Scandinavian, light oak and linen"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": null,
    "progress": {
      "total": 3,
      "done": 3,
      "failed": 0
    },
    "outputs": [
      {
        "index": 0,
        "status": "done",
        "output": {
          "id": "a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5",
          "type": "generated",
          "tool": "stage",
          "url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.jpg",
          "thumbnail_url": "https://…/thumbnails/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.jpg",
          "width": 1024,
          "height": 1024,
          "created_at": 1793700025,
          "kind": "image"
        },
        "error": null
      },
      {
        "index": 1,
        "status": "done",
        "output": {
          "id": "a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b6",
          "type": "generated",
          "tool": "stage",
          "url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b6.jpg",
          "thumbnail_url": "https://…/thumbnails/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b6.jpg",
          "width": 1024,
          "height": 1024,
          "created_at": 1793700025,
          "kind": "image"
        },
        "error": null
      },
      {
        "index": 2,
        "status": "done",
        "output": {
          "id": "a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b7",
          "type": "generated",
          "tool": "stage",
          "url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b7.jpg",
          "thumbnail_url": "https://…/thumbnails/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b7.jpg",
          "width": 1024,
          "height": 1024,
          "created_at": 1793700025,
          "kind": "image"
        },
        "error": null
      }
    ],
    "sku": "HK-3F9A1C2B"
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "bulk_stage",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 0,
      "refunded": true,
      "refunded_credits": 6
    },
    "input": {
      "images": [
        "<photo 1>",
        "<photo 2>",
        "<photo 3>"
      ],
      "prompt": "Scandinavian, light oak and linen"
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "None of the photos could be finished. Their credits have been refunded."
    },
    "progress": {
      "total": 3,
      "done": 0,
      "failed": 3
    },
    "outputs": [
      {
        "index": 0,
        "status": "failed",
        "output": null,
        "error": "The image model could not finish this photo."
      },
      {
        "index": 1,
        "status": "failed",
        "output": null,
        "error": "The image model could not finish this photo."
      },
      {
        "index": 2,
        "status": "failed",
        "output": null,
        "error": "The image model could not finish this photo."
      }
    ],
    "sku": "HK-3F9A1C2B"
  }
}

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photos
photos = [upload(path) for path in ["room-1.jpg", "room-2.jpg", "room-3.jpg"]]

# 2. Run Bulk Unstaging
job = call("POST", "/api/v1/tools/bulk_unstage/run", json={
    "images": photos,
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    for item in job["outputs"]:          # one per photo or reference, in order
        print(item["index"], item["status"], item["output"]["url"] if item["output"] else item["error"])
else:
    print("Failed:", job["error"]["message"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photos
const photos = await Promise.all(["room-1.jpg", "room-2.jpg", "room-3.jpg"].map(upload));

// 2. Run Bulk Unstaging
let { job } = await call("POST", "/api/v1/tools/bulk_unstage/run", {
  "images": photos,
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") {
  // one per photo or reference, in order
  for (const item of job.outputs) console.log(item.index, item.status, item.output ? item.output.url : item.error);
} else {
  console.log("Failed:", job.error.message);
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "bulk_unstage",
    "status": "done",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 3,
      "refunded": false,
      "refunded_credits": 0
    },
    "input": {
      "images": [
        "<photo 1>",
        "<photo 2>",
        "<photo 3>"
      ]
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": null,
    "progress": {
      "total": 3,
      "done": 3,
      "failed": 0
    },
    "outputs": [
      {
        "index": 0,
        "status": "done",
        "output": {
          "id": "a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5",
          "type": "generated",
          "tool": "unstage",
          "url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.jpg",
          "thumbnail_url": "https://…/thumbnails/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.jpg",
          "width": 1024,
          "height": 1024,
          "created_at": 1793700025,
          "kind": "image"
        },
        "error": null
      },
      {
        "index": 1,
        "status": "done",
        "output": {
          "id": "a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b6",
          "type": "generated",
          "tool": "unstage",
          "url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b6.jpg",
          "thumbnail_url": "https://…/thumbnails/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b6.jpg",
          "width": 1024,
          "height": 1024,
          "created_at": 1793700025,
          "kind": "image"
        },
        "error": null
      },
      {
        "index": 2,
        "status": "done",
        "output": {
          "id": "a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b7",
          "type": "generated",
          "tool": "unstage",
          "url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b7.jpg",
          "thumbnail_url": "https://…/thumbnails/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b7.jpg",
          "width": 1024,
          "height": 1024,
          "created_at": 1793700025,
          "kind": "image"
        },
        "error": null
      }
    ],
    "sku": "HK-3F9A1C2B"
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "bulk_unstage",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 0,
      "refunded": true,
      "refunded_credits": 3
    },
    "input": {
      "images": [
        "<photo 1>",
        "<photo 2>",
        "<photo 3>"
      ]
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "None of the photos could be finished. Their credits have been refunded."
    },
    "progress": {
      "total": 3,
      "done": 0,
      "failed": 3
    },
    "outputs": [
      {
        "index": 0,
        "status": "failed",
        "output": null,
        "error": "The image model could not finish this photo."
      },
      {
        "index": 1,
        "status": "failed",
        "output": null,
        "error": "The image model could not finish this photo."
      },
      {
        "index": 2,
        "status": "failed",
        "output": null,
        "error": "The image model could not finish this photo."
      }
    ],
    "sku": "HK-3F9A1C2B"
  }
}

# pip install requests
import os
import time

import requests

API = "https://app.housekraft.co"
HEADERS = {"Authorization": f"Bearer {os.environ['HOUSEKRAFT_KEY']}"}


def call(method, path, **kwargs):
    response = requests.request(method, API + path, headers=HEADERS, timeout=90, **kwargs)
    data = response.json()
    if response.status_code >= 400:
        raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
    return data


def upload(path):
    with open(path, "rb") as f:
        return call("POST", "/api/v1/uploads", files={"image": f})["asset"]["id"]


# 1. Upload the photos
photo = upload("room.jpg")
floor = upload("oak-floor.jpg")

# 2. Run En Masse
job = call("POST", "/api/v1/tools/enmasse/run", json={
    "image": photo,
    "references": [
      {"mode": "walls", "color": "#8A9A5B"},
      {"mode": "walls", "color": "#F2EFE6"},
      {"mode": "flooring", "image": floor}
    ],
})["job"]

# 3. If it is still running, check again until it finishes
while job["status"] == "running":
    time.sleep(job.get("poll_after_seconds", 3))
    job = call("GET", f"/api/v1/jobs/{job['id']}")["job"]

if job["status"] == "done":
    for item in job["outputs"]:          # one per photo or reference, in order
        print(item["index"], item["status"], item["output"]["url"] if item["output"] else item["error"])
else:
    print("Failed:", job["error"]["message"])

// Node 18 or newer. Save as run.mjs, then: node run.mjs
import { readFile } from "node:fs/promises";

const API = "https://app.housekraft.co";
const HEADERS = { Authorization: `Bearer ${process.env.HOUSEKRAFT_KEY}` };

async function call(method, path, body) {
  const options = { method, headers: { ...HEADERS } };
  if (body instanceof FormData) {
    options.body = body;
  } else if (body) {
    options.headers["Content-Type"] = "application/json";
    options.body = JSON.stringify(body);
  }
  const response = await fetch(API + path, options);
  const data = await response.json();
  if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
  return data;
}

async function upload(path) {
  const form = new FormData();
  form.append("image", new Blob([await readFile(path)]), path);
  return (await call("POST", "/api/v1/uploads", form)).asset.id;
}

// 1. Upload the photos
const photo = await upload("room.jpg");
const floor = await upload("oak-floor.jpg");

// 2. Run En Masse
let { job } = await call("POST", "/api/v1/tools/enmasse/run", {
  "image": photo,
  "references": [
    {"mode": "walls", "color": "#8A9A5B"},
    {"mode": "walls", "color": "#F2EFE6"},
    {"mode": "flooring", "image": floor}
  ],
});

// 3. If it is still running, check again until it finishes
while (job.status === "running") {
  await new Promise((resolve) => setTimeout(resolve, (job.poll_after_seconds || 3) * 1000));
  ({ job } = await call("GET", `/api/v1/jobs/${job.id}`));
}

if (job.status === "done") {
  // one per photo or reference, in order
  for (const item of job.outputs) console.log(item.index, item.status, item.output ? item.output.url : item.error);
} else {
  console.log("Failed:", job.error.message);
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "enmasse",
    "status": "done",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 3,
      "refunded": false,
      "refunded_credits": 0
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "references": [
        {
          "mode": "walls",
          "color": "#8A9A5B"
        },
        {
          "mode": "walls",
          "color": "#F2EFE6"
        },
        {
          "mode": "flooring",
          "image": "<asset id of a floor photo>"
        }
      ]
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": null,
    "progress": {
      "total": 3,
      "done": 3,
      "failed": 0
    },
    "outputs": [
      {
        "index": 0,
        "reference": 0,
        "mode": "walls",
        "status": "done",
        "output": {
          "id": "a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5",
          "type": "generated",
          "tool": "gridcompare",
          "url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.jpg",
          "thumbnail_url": "https://…/thumbnails/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b5.jpg",
          "width": 1024,
          "height": 1024,
          "created_at": 1793700025,
          "kind": "image"
        },
        "error": null
      },
      {
        "index": 1,
        "reference": 1,
        "mode": "walls",
        "status": "done",
        "output": {
          "id": "a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b6",
          "type": "generated",
          "tool": "gridcompare",
          "url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b6.jpg",
          "thumbnail_url": "https://…/thumbnails/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b6.jpg",
          "width": 1024,
          "height": 1024,
          "created_at": 1793700025,
          "kind": "image"
        },
        "error": null
      },
      {
        "index": 2,
        "reference": 2,
        "mode": "flooring",
        "status": "done",
        "output": {
          "id": "a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b7",
          "type": "generated",
          "tool": "gridcompare",
          "url": "https://…/generated/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b7.jpg",
          "thumbnail_url": "https://…/thumbnails/a3f0c6d1-8b27-4c5e-9f14-6e2b7d90c3b7.jpg",
          "width": 1024,
          "height": 1024,
          "created_at": 1793700025,
          "kind": "image"
        },
        "error": null
      }
    ],
    "run_id": "71973c9dc427"
  }
}

{
  "job": {
    "id": "7c1e9b02-5d4a-4e8f-b6a3-2f90d1c4e5a8",
    "tool": "enmasse",
    "status": "failed",
    "created_at": 1793700000,
    "finished_at": 1793700025,
    "credits": {
      "charged": 0,
      "refunded": false,
      "refunded_credits": 0
    },
    "input": {
      "image": "<asset id from POST /api/v1/uploads>",
      "references": [
        {
          "mode": "walls",
          "color": "#8A9A5B"
        },
        {
          "mode": "walls",
          "color": "#F2EFE6"
        },
        {
          "mode": "flooring",
          "image": "<asset id of a floor photo>"
        }
      ]
    },
    "warnings": [],
    "check_overridden": false,
    "output": null,
    "error": {
      "message": "Model returned no image. Nothing was charged."
    },
    "progress": {
      "total": 3,
      "done": 0,
      "failed": 3
    },
    "outputs": []
  }
}