Viewcomfy Api Rules

What it does

This skill provides expert guidance and assistance for integrating the ViewComfy API into web applications using Python. The ViewComfy API is a serverless FastAPI service that executes custom ComfyUI workflows, and this skill helps developers understand its technical details, operational considerations (like cold starts), and best practices for implementation. It focuses on enabling integration via Python and utilizes the httpx library for making requests.

When to use it

• When building a web application that needs to execute ComfyUI workflows programmatically.
• If you are encountering performance issues, such as cold starts or long generation times, when using the ViewComfy API.
• To understand and correctly handle the API's response format, including prompt IDs, status updates, and file outputs.
• When needing to implement streaming (SSE) functionality for real-time workflow tracking.

Key capabilities

• Expertise in Python, FastAPI integrations, and web app development related to ViewComfy API integration.
• Guidance on handling cold start delays and variable generation times.
• Explanation of parameter requirements, specifically that the params object cannot be empty.
• Detailed description of the API response format (prompt_id, status, completed, execution_time_seconds, prompt, outputs).
• Best practices for secure credential storage and error handling.

Example prompts

• "Explain how to handle cold start delays when using the ViewComfy API."
• "What is the structure of a typical ViewComfy API response?"
• "How do I use the infer_with_logs endpoint for streaming workflow updates?"

Tips & gotchas

• Be prepared for potential cold starts, especially on initial API calls.
• Always validate parameters before sending requests to avoid unnecessary API usage and errors.
• The params object in your request must not be empty; if it is, consider modifying the seed value instead.