Building with the Hyperclip API

If you're a developer, the canvas is one entry point to Hyperclip. The other is the public API. The same flow you built and tested visually runs from a POST request, with identical results.

The shape of a run

Every flow on Hyperclip exposes a stable input schema. The API lets you enumerate the flows on your account, fetch each flow's expected inputs, submit runs against them, and poll for completion.

import Hyperclip from "hyperclip";

const hc = new Hyperclip({ apiKey: process.env.HYPERCLIP_API_KEY });

const run = await hc.runs.create({
  flow_id: "flw_...",
  inputs: { topic: "The myth of Sisyphus" },
});

console.log(run.id, run.status);

Polling for completion

Runs are asynchronous. Submit a run, get back a run ID, then poll the status endpoint until the render finishes. The SDKs ship with a helper that does the polling for you in a single await.

const finished = await hc.runs.wait(run.id);
console.log(finished.output_url);

Client libraries

• Node — npm install hyperclip
• Python — pip install hyperclipco
• Plain HTTPS for any other language — the API is fully documented at docs.hyperclip.co

Same canvas, same engine

There is no second renderer behind the API. The flow you built in the canvas is the flow the API runs. When you change a flow in the dashboard, you change the API behavior for that flow on the next run — no separate deploy step.

Getting started

Generate an API key in Settings → Developer. Each call is billed in credits at the same rate as the dashboard. Read the full reference at docs.hyperclip.co, and email us if you're building something interesting — we love seeing what people wire Hyperclip into.