Overview
Create a new template to store and reuse ComfyUI workflow definitions. Templates allow you to save workflow structures that can be reused across multiple workflow executions.
The API playground does not support file uploads. Use cURL, Postman, or your application code to test this endpoint.
Content Type
This endpoint requires multipart/form-data content type.
Request Parameters
A descriptive name for your template (1-100 characters).
A description of what this template does (1-500 characters).
A JSON file containing the ComfyUI workflow definition.
Response
Unique identifier (UUID) for the template.
UUID of the user who owns this template.
The template’s description.
The ComfyUI workflow definition as a JSON object.
ISO 8601 timestamp when the template was created.
ISO 8601 timestamp when the template was last updated.
Example Response
{
"id": "t1e2m3p4-l5a6-7890-abcd-ef1234567890",
"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Text to Image - Standard",
"description": "Basic text-to-image generation with SDXL",
"body": {
"nodes": [...],
"links": [...],
"config": {...}
},
"created_at": "2024-01-15T10:00:00Z",
"updated_at": "2024-01-15T10:00:00Z"
}
cURL Example
Since the API playground doesn’t support file uploads, use this cURL command to test:
curl -X POST https://api.comfycontrol.app/v1/template \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-F "name=My Template Name" \
-F "description=A description of what this template does" \
-F "body=@/path/to/workflow.json"
Replace:
YOUR_API_TOKEN with your actual API token
/path/to/workflow.json with the path to your ComfyUI workflow JSON file
The -F flag automatically handles multipart/form-data with proper boundaries.
Error Responses
Bad request - validation error in the request.Common causes:
- Missing required fields
- Name or description too long
- Invalid JSON in body file
Unauthorized - invalid or missing authentication token.
Forbidden - template limit exceeded for your tier.
Notes
- Templates are personal and not shared with other users
- Use templates to standardize workflows across your organization
- Templates can be used as a starting point for creating workflows
- The body field stores the complete ComfyUI workflow JSON structure
- Templates count toward your tier’s template limit
- Use cURL, Postman, or application code for testing - the API playground doesn’t support file uploads