Comfy Cloud API
Comfy Cloud API는 Comfy Cloud 인프라에서 워크플로우를 실행하기 위한 프로그래밍 방식 접근을 제공합니다. 이 API는 로컬 ComfyUI의 API와 호환되므로 기존 통합을 쉽게 마이그레이션할 수 있습니다.구독 필요: API 접근은 스탠다드, 크리에이터, 프로 계층에서 이용 가능합니다. 무료 계층에는 API 접근이 포함되지 않습니다. 자세한 내용은 가격 정책을 참조하십시오.
크레딧 및 사용법
API 요청은 Comfy Cloud 웹 UI와 동일한 월별 크레딧 할당량을 사용합니다 — 별도의 API 크레딧 풀은 없습니다. 각 계층에 포함된 크레딧, 추가 옵션 및 워크플로우당 런타임 제한은 UI 작업과 정확히 동일하게 API 작업에도 적용됩니다. 가격 페이지에서 스탠다드, 크리에이터 및 프로 계층의 월별 크레딧 수치를 확인하십시오. 한 달 중간에 크레딧이 부족해지면 계정 대시보드에서 추가 구매가 가능합니다.기본 URL
인증
모든 API 요청에는X-API-Key 헤더를 통해 전달되는 API 키가 필요합니다.
API 키 얻기
API 키 생성 및 관리에 대한 지침은 API 키 얻기를 참조하십시오.API 키 사용하기
모든 요청 시X-API-Key 헤더에 API 키를 전달하십시오:
핵심 개념
워크플로우
ComfyUI 워크플로우는 노드 그래프를 설명하는 JSON 객체입니다. API는 ComfyUI 프론트엔드의 “저장(API 형식)” 옵션으로 생성된 “API 형식”(노드 ID를 키로 하며 class_type, inputs 등이 포함된) 워크플로우를 수락합니다.작업
워크플로우를 제출하면 작업이 생성됩니다. 작업은 비동기적으로 실행됩니다:POST /api/prompt을 통해 워크플로우 제출prompt_id(작업 ID) 받기- WebSocket을 통해 진행 상태 모니터링 또는 상태 조회
- 완료 시 출력물 가져오기
병렬 실행(동시 작업)
API 사용자는 이전 작업이 완료될 때까지 기다릴 필요 없이 여러 워크플로우를 동시에 제출할 수 있습니다. 단순히 여러POST /api/prompt 요청을 보내기만 하면 되며, 특별한 헤더나 매개변수는 필요하지 않습니다. 디스패처는 구독 계층의 제한 내에서 병렬로 실행합니다.
| 구독 계층 | 동시 작업 |
|---|---|
| 스탠다드 | 1 |
| 크리에이터 | 3 |
| 프로 | 5 |
현재 병렬 실행은 API를 통해서만 이용 가능합니다. 구독 상세 정보는 가격 정책을 참조하십시오.
예제: 병렬로 여러 작업 제출하기
출력물
생성된 콘텐츠(이미지, 동영상, 오디오)는 클라우드 스토리지에 저장됩니다. 출력 파일은/api/view 엔드포인트를 통해 다운로드할 수 있으며, 이 엔드포인트는 임시 서명된 URL로 302 리다이렉트를 반환합니다.
빠른 시작
워크플로우를 제출하고 진행 상태를 모니터링하며 출력물을 가져오는 방법을 보여주는 전체 예제입니다:1단계: 워크플로우 제출
2단계: ���업 진행 상태 모니터링
폴링 또는 WebSocket을 사용해 작업 완료 여부를 모니터링할 수 있습니다.옵션 A: 폴링(간단함)
작업 상태 값: API는 다음 상태 값을 반환합니다:| 상태 | 설명 |
|---|---|
pending | 작업이 대기 중이며 시작을 기다리고 있습니다 |
in_progress | 작업이 현재 실행 중입니다 |
completed | 작업이 성공적으로 완료되었습니다 |
failed | 작업 중 오류가 발생했습니다 |
cancelled | 사용자가 작업을 취소했습니다 |
옵션 B: WebSocket(실시간 진행 상태)
실시간 진행 상태 업데이트 및 출력 메타데이터 수집을 위해:WebSocket 참조를 참조해 세부 메시지 유형 및 바이너리 미리보기 이미지 처리 방법을 확인하십시오.
3단계: 출력물 다운로드
작업이 완료되면 생성된 파일을 다운로드하세요. WebSocket에서 반환되거나 히스토리 엔드포인트를 통해 이용 가능한outputs 객체는 노드 ID별로 정리된 출력 데이터를 포함합니다. 각 노드의 출력에는 images, video 또는 audio 배열과 파일 메타데이터가 포함될 수 있습니다.
출력물 구조 예시:
"9" 예시)는 워크플로우의 SaveImage 또는 기타 출력 노드에 해당합니다. 워크플로우 JSON 파일을 열어 class_type이 SaveImage, VHS_VideoCombine 등의 노드를 찾으면 이 ID를 확인할 수 있습니다.
/api/view 엔드포인트는 임시 서명된 URL로 302 리다이렉트를 반환합니다. HTTP 클라이언트는 리다이렉트를 따라야만 파일을 다운로드할 수 있습니다.전체 예제
세 단계를 모두 결합한 전체 엔드투엔드 예제입니다:사용 가능한 엔드포인트
다음 단계
위의 빠른 시작은 워크플로우 제출과 결과 가져오기에 대한 기본 사항을 다룹니다. 더 고급 사용 사례를 위해서는 클라우드 API 참조를 참고하십시오:- 입력 파일 업로드 - 워크플로우에 외부 입력이 필요한 경우 이미지, 마스크 또는 기타 사용자 제공 콘텐츠 업로드
- 워크플로우 입력 수정 - 제출 전에 프롬프트, 시드 또는 노드 설정과 같은 워크플로우 파라미터를 동적으로 변경
- 파트너 노드 사용 - 추가 API 키 구성이 필요한 외부 AI 서비스(Flux Pro, Ideogram 등) 호출
- 대기열 관리 - 대기열 상태 모니터링, 작업 취소 또는 실행 중인 작업 중단
- 오류 처리 - HTTP 오류, 실행 실패 처리 및 예외 유형 이해
- OpenAPI 규격 - 코드 생성을 위한 기계 판독 가능한 API 규격