Returns a fresh run_id (UUID) that you can use to identify or track a workflow execution.

Get Run IDs

Unauthorized. Check your API key or token.

Payment required. Subscription or plan issue.

Forbidden. You lack permission to perform this action.

Internal Server Error. Something went wrong on the server.

Retrieve a new Run ID

Playbook Docs

Introduction to Playbook 3D

Blender Add-On

Houdini (Coming Soon)

Playbook 3D is a generative media platform designed for running ComfyUI in the cloud, enabling users to build, manage, and deploy AI workflows as scalable, serverless APIs or shareable playgrounds.

Overview

Python SDK

JS SDK

Unity SDK

Get Users

Returns a list of all teams associated with the authenticated user.

Get Teams

Creates a new workflow associated with the specified team (and owned by the user sending the request).

Post Workflows

Deletes the specified workflow by ID (could be a soft-delete or permanent, depending on server logic). Requires both JWT and x-api-key.

Delete Workflows by ID

Retrieves all workflows associated with the current user or their teams.

Get Workflows

Retrieves a single workflow record by ID. Requires both JWT and x-api-key.

Get Workflows by ID

Updates fields of a workflow specified by workflow_id. Requires JWT and x-api-key.

Patch Workflows by ID

Cancel Workflow Run

Enqueues or starts a run of the given workflow ID under the specified team and run ID. The `origin` field determines the calling context (e.g. '2' for Unity).

Run Workflow by ID

Returns a signed URL (or other info) for the output associated with a given run ID.

Get Run Result by Run ID

Get Runs

Upload Image

Upload Video

A node that processes text input with optional trigger words.

Playbook Text

A node that generates an integer value within a specified range.

Playbook Number

A node that outputs a boolean value based on user input.

Playbook Boolean

A node that outputs a floating-point number within a specified range.

Playbook Float

A node that loads an image from a URL or a default value.

Playbook Image

A node that processes video frames from a URL or default input.

Playbook Video

A node that selects an aspect ratio from predefined options.

Playbook Aspect Ratio Select

A node that allows users to select a LoRA model for different base models.

Playbook LoRA Selection

A node that generates either a fixed or random seed.

Playbook Seed

Retrieves the Depth Render Pass from Playbook3D API, supporting both single-frame and sequence modes.

Playbook Depth

Retrieves the Outline Render Pass from Playbook3D API, supporting both single-frame and sequence modes.

Playbook Outline

Retrieves the Mask Render Pass from Playbook3D API, supporting both single-frame and sequence modes.

Playbook Mask

Retrieves the Beauty Render Pass from Playbook3D API, supporting both single-frame and sequence modes.

API Reference

SDK Libraries

Users

Teams

Workflows

Runs

Upload Assets

Get Run IDs

Headers

Response