Skip to documentation content
Developer Docs
API Reference
OverviewPOSTCreate a JobGETList JobsGETGet Job status and resultsPOSTCancel JobsPOSTCancel all JobsGETGet all node infoGETGet one node info

REST API

7 operations

API Reference

Explore the requests and responses for creating Jobs and retrieving results.

api-keystring · header · required

Send your API key in the api-key header. A Pro subscription is required.

Endpoints

POST/v1/api/job/comfy-prompt

Create a Job

Create one asynchronous Job from a complete ComfyUI API-format prompt.

GET/v1/api/job/list

List Jobs

List the authenticated user’s Jobs created through this API in newest-first order.

GET/v1/api/job/{id}

Get Job status and results

Read the current status, terminal error, and saved output URLs for one Job.

POST/v1/api/job/cancel

Cancel Jobs

Cancel your API Jobs in the Pending state, before execution preparation begins.

POST/v1/api/job/cancel-all

Cancel all Jobs

Cancel all Pending API Jobs on your account at the start of this request, across all API keys.

GET/v1/api/comfy/object-info

Get all ComfyUI node info

Return input and output definitions for every installed ComfyUI node class.

GET/v1/api/comfy/object-info/{className}

Get one ComfyUI node info

Return the definition for one ComfyUI node class.