Prerequisites — Node.js 18.10.0 or higher, an API token from the Pixio dashboard, and a deployed workflow with a
deployment_id.1. Install the SDK
2. Store your key
Put the token in a.env file — never in source control.
3. Create the client
4. Run a workflow
Pass thedeployment_id and whatever inputs your graph expects:
5. Retrieve the output
Use therun_id to fetch the run:
status. Keep polling until it’s success:
Keeping the SDK current
Local development notes
If you’re running a local server alongside the SDK and hit a port clash:EADDRINUSE error means something else already holds that port — change the port or stop the other process.
Next
Workflows & deployments
How versions and deployments work, and how to ship changes safely.
Files & uploads
Feed images and other media into a run.
Running a workflow
Inputs, polling, and output handling in depth.
Troubleshooting
Token errors, failed runs, and stuck jobs.
