Chatflow 앱 API

Chatflow 앱은 advanced-chat 모드로 돌아요. 답변과 함께 워크플로 레벨 이벤트(노드 시작, 완료, 반복, 일시정지)를 스트리밍하죠. 이전 턴이 컨텍스트로 남아 있어서, 이후 메시지가 앞선 내용을 참조할 수 있어요.

출처: 공식문서

인증, 베이스 URL, 엔드 유저 데이터를 스코프하는 `user` 필드는 [Get Started](/en/api-reference/guides/get-started)와 [End User Identity](/en/api-reference/guides/end-user-identity)에서 다뤄요.

메시지 보내고 답변 스트리밍하기

Send Chat Message: Chatflow 앱에 쿼리를 보냅니다. 스트리밍 모드는 답변 텍스트와 함께 워크플로·노드 이벤트를 실어 보내고, blocking 모드는 실행이 끝나면 반환돼요.
Stop Chat Message Generation: 끝나기 전에 스트리밍 답변을 중단합니다.
Get Next Suggested Questions: 답변이 끝난 뒤 지금까지의 대화를 바탕으로 후속 질문을 제안해요.

대화 관리하기

List Conversations: 현재 유저의 대화를 최근 활동 순으로 나열해요.
List Conversation Messages: 대화 하나의 메시지 기록. 스크롤하는 채팅 UI를 위해 써요.
Rename Conversation: 표시 이름을 설정하거나 자동 생성해요.
Delete Conversation: 대화를 제거해요.
List Conversation Variables: 세션이 턴에 걸쳐 유지하는 값들을 읽어요.
Update Conversation Variable: 그 값 중 하나를 직접 바꿔요.

파일 다루기

Upload File: Send Chat Message가 참조할 이미지·문서·오디오·비디오 파일을 업로드해요. 파일은 업로드한 엔드 유저에게 스코프됩니다.
Download File: 앱의 메시지에 속한 파일이라면 미리보기나 다운로드가 가능해요.
Get End User Info: 엔드 유저 ID(Upload File 응답의 created_by 같은 것)로 세부 정보를 조회해요.

음성을 텍스트로, 텍스트를 음성으로

Convert Audio to Text: 업로드한 오디오(MP3·M4A·WAV·AMR·MPGA, 최대 30MB)를 받아쓰기해, 엔드 유저가 타이핑 대신 말로 입력하게 해줘요.
Convert Text to Audio: 답변을 다시 음성으로 합성해요.

Human Input 위해 멈추기

실행이 전달 방식이 웹 앱인 Human Input 노드에 도달하면, 일시정지를 API로 완료하면 돼요:

일시정지 신호 듣기 — 이벤트 스트림이 form_token과 실행의 workflow_run_id를 실은 human_input_required를 내보내고, workflow_paused 이벤트로 끝납니다.
폼 가져오기 — form_token으로 Get Human Input Form을 호출해 폼 내용을 불러와요.
응답 제출하기 — Submit Human Input Form으로 수신자의 입력을 보냅니다. 제출하면 실행이 재개돼요.
스트림 재개하기 — 멈춘 스트림의 workflow_run_id로 Stream Workflow Events 새 스트림을 열고, 남은 이벤트를 따라 최종 답변까지 내려가요.

파일 첨부 제출과 전체 이벤트 시퀀스는 Human Input Flow 가이드를 보세요.

워크플로 실행 조사하기

Get Workflow Run Detail: 채팅 답변과 함께 스트리밍되는 워크플로·노드 이벤트에 나타나는 workflow_run_id로, 실행의 상태와 출력을 확인해요.
List Workflow Logs: 노드별 실행 로그가 아니라 실행 레벨 요약(상태, 토큰 사용량, 스텝 수, 시간)을 보여줘요.

앱 정보와 설정 가져오기

Get App Info: 앱의 이름, 설명, 태그, 모드.
Get App Parameters: 호출이 inputs로 보내는 필드(이름·타입·기본값)와 앱의 기능 스위치—요청이나 클라이언트 UI를 만들 때의 기반이 돼요.
Get App Meta: 도구 아이콘과 그 밖의 설정 메타데이터.
Get App WebApp Settings: 웹 앱의 사이트 설정, 테마, 커스터마이즈 옵션.

피드백과 어노테이션 수집

Submit Message Feedback: 엔드 유저가 답변을 like/dislike로 평가할 수 있고, 선택적으로 텍스트 코멘트를 달 수 있어요.
List App Feedbacks: 앱 전체에서 엔드 유저와 관리자 양쪽이 제출한 모든 피드백.

어노테이션은 질문을 고정 답변과 짝지어, 새 응답을 생성하는 대신 그 답을 바로 돌려주는 기능이에요:

Create Annotation, List Annotations, Update Annotation, Delete Annotation: 어노테이션 세트 관리.
Configure Annotation Reply: 어노테이션 매칭을 켜거나 끕니다. 변경은 비동기로 실행돼요.
Get Annotation Reply Job Status: 반환된 job ID로 폴링해 변경이 끝났는지 확인해요.

더 알아보기 (Learn more)

Workflow 앱 API — 워크플로 실행·제어·재개
스트리밍 응답 사용하기 — Chatflow 이벤트 종료 시퀀스(message_end 후 workflow_finished)
Human Input 흐름 — 일시정지 완료 시퀀스 전체