Nodes/playbook3d-comfyui-nodes/Playbook Beauty Render Pass
ComfyUI Node

Playbook Beauty Render Pass

The final render, straight from a cloud render farm

By playbook3d·Created 2 years ago·Updated about a year ago· 21
Playbook Beauty Render Pass
  • default_value
  • Image
api_key
run_id

Playbook Beauty is the node that delivers the goods: the finished, lit render of your 3D scene as a plain ComfyUI image. It's the first node most Playbook3D workflows start from, because "beauty" is render-farm speak for the final shaded frame - the image you'd actually show someone, before any compositing.

Playbook3D is a cloud 3D rendering service. You set up a scene in their web app (beta.playbook3d.com), hit render, and their machines do the heavy lifting. This node is how the result lands in ComfyUI. It makes an API call to their backend, grabs the beauty pass, decodes it, and hands you an IMAGE you can feed into an img2img, IP-Adapter, or ControlNet pipeline. It's the local-comfy-ecosystem workflow you know, with the 3D source supplied from the cloud instead of a prompt.

How it works

Three things happen under the hood, and understanding them saves you confusion later:

  1. It exchanges your api_key for a short-lived user token by calling accounts.playbook3d.com/token-wrapper/get-tokens/<your key>.
  2. It asks for the download URLs for your render, with or without a run_id.
  3. It downloads the beauty image from that response, converts it to a float tensor, and returns it as Image.

The run_id is optional and worth knowing about. Leave it blank and the node fetches whatever render is currently associated with your account; supply a run_id and it pulls that specific run. If you're iterating on a scene, you usually leave it empty and let the "latest render" logic do its thing.

There's also a default_value image input, which is easy to overlook and genuinely useful. If the API call fails - no key, bad key, unreachable server - the node silently returns default_value instead of erroring. The code logs a message to your console but does not raise. So if you want your workflow to keep running (or degrade gracefully) when Playbook is having a bad day, wire a fallback image into default_value. If you leave it disconnected, a failure hands None downstream, which will trip up whatever's waiting for an image.

One quirk: the node forces itself to re-run every queue via a time-based IS_CHANGED, so it hits the API on every execution. That's by design - renders update - but it means every run is a network round trip, not a cached read.

Install

Standard for this pack. ComfyUI Manager, search for Playbook Nodes, or:

cd ComfyUI/custom_nodes
git clone https://github.com/playbook3d/playbook3d-comfyui-nodes

Restart ComfyUI. There are no model downloads and no requirements.txt - ComfyUI already ships requests, PIL, numpy, and torch, which is all this node uses. The one thing you do need is a Playbook3D account and API key from beta.playbook3d.com, pasted into the api_key field.

Troubleshooting

The most common failure is an empty or wrong API key - the node won't tell you loudly, it'll just hand you the default image or nothing. Check your console log for "Could not retrieve user_token" or "No api_key provided". If the render isn't finished on their side, there's no beauty URL yet, and again you get the default. That's the quiet-failure trap of this whole pack: it's designed to degrade, not shout. Also note the README mentions a Canny node that doesn't actually exist in this pack - if you want edges, that's the Playbook Outline node, not Canny.

CategoryPlaybook 3D

Inputs (3)

NameTypeDefaultDescription
api_keySTRING
run_idoptSTRING
default_valueoptIMAGE

Outputs (1)

NameTypeDescription
ImageIMAGE