Getting Started

npm i pixio-api

import { PixioAPI, collectOutputs } from "pixio-api";

const pixio = new PixioAPI({ apiKey: process.env.PIXIO_API_KEY! });

// 1. Queue the run — returns immediately with a run id
const { runId } = await pixio.run.queue({
  deploymentId: "<your-deployment-id>",
  inputs: {
    // keys = the input names you exposed with external input nodes
    prompt: "A cinematic photo of a lighthouse in a storm",
  },
  // recommended for production — push instead of poll:
  // webhook: "https://yourapp.com/api/webhook",
});

// 2. Wait for a terminal state (polls every 3s; use webhooks in production)
const run = await pixio.run.wait(runId, {
  onProgress: (r) => console.log(r.status, Math.round(r.progress * 100) + "%"),
});

if (run.status === "success") {
  for (const img of collectOutputs(run, "images")) console.log("→", img.url);
} else {
  console.error("Run ended:", run.status);
}

pip install pixio-api

import os
from pixio_api import PixioAPI

pixio = PixioAPI(api_key=os.environ["PIXIO_API_KEY"])

# 1. Queue the run — returns immediately with a run id
run_id = pixio.queue_run(
    deployment_id="<your-deployment-id>",
    inputs={
        # keys = the input names you exposed with external input nodes
        "prompt": "A cinematic photo of a lighthouse in a storm",
    },
    # recommended for production — push instead of poll:
    # webhook="https://yourapp.com/api/webhook",
)

# 2. Wait for a terminal state (polls every 3s; use webhooks in production)
run = pixio.wait_for_run(run_id, on_progress=lambda r: print(r["status"], r["progress"]))

if run["status"] == "success":
    for img in pixio.collect_outputs(run, "images"):
        print("→", img["url"])
else:
    print("Run ended:", run["status"])

pip install requests

import os, time, requests

API = "https://pixio-api-workers-production.up.railway.app/api"
HEADERS = {"Authorization": f"Bearer {os.environ['PIXIO_API_KEY']}"}

# 1. Queue the run — returns immediately with a run id
resp = requests.post(
    f"{API}/run/deployment/queue",
    headers=HEADERS,
    json={
        "deployment_id": "<your-deployment-id>",
        "inputs": {
            # keys = the input names you exposed with external input nodes
            "prompt": "A cinematic photo of a lighthouse in a storm",
        },
        # recommended for production — push instead of poll:
        # "webhook": "https://yourapp.com/api/webhook",
    },
)
resp.raise_for_status()
run_id = resp.json()["run_id"]
print("queued:", run_id)

# 2. Poll until it reaches a terminal state
TERMINAL = {"success", "failed", "timeout", "cancelled"}
while True:
    run = requests.get(f"{API}/run/{run_id}", headers=HEADERS).json()
    print(f'{run["status"]}  {round((run.get("progress") or 0) * 100)}%')

    if run["status"] in TERMINAL:
        if run["status"] == "success":
            for output in run.get("outputs") or []:
                for img in (output.get("data") or {}).get("images") or []:
                    print("→", img["url"])
        else:
            print("Run ended:", run["status"])
        break
    time.sleep(3)

queued: 5e9f8a…
not-started  0%
queued  0%
started  0%          ← cold start: machine + model loading (unbilled queue, then billed)
running  35%
running  80%
uploading  100%
success  100%
→ https://…/output_00001.png