Skip to main content
GET
/
v1
/
template
/
{id}
Get Template
curl --request GET \
  --url https://api.comfycontrol.app/v1/template/{id} \
  --header 'Authorization: Bearer <token>'
{
  "401": {},
  "404": {},
  "id": "<string>",
  "user_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "body": {},
  "created_at": "<string>",
  "updated_at": "<string>"
}

​
Overview

Retrieve detailed information about a specific template by its ID, including the complete workflow definition.

​
Path Parameters

​
id
string
required
The unique identifier (UUID) of the template to retrieve.

​
Response

​
id
string
required
Unique identifier (UUID) for the template.
​
user_id
string
required
UUID of the user who owns this template.
​
name
string
required
The template’s name.
​
description
string
required
The template’s description.
​
body
object
required
The ComfyUI workflow definition as a JSON object.
​
created_at
string
required
ISO 8601 timestamp when the template was created.
​
updated_at
string
required
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"
}

​
Error Responses

​
401
error
Unauthorized - invalid or missing authentication token.
​
404
error
Not Found - template with the specified ID does not exist or does not belong to your account.