advanced-chat mode, streaming workflow-level events (node starts, finishes, iterations, and pauses) alongside the reply. Previous turns persist as context, so later messages can reference earlier ones.
Authentication, the base URL, and the
user field that scopes end-user data are covered in Get Started and End User Identity.Send Messages and Stream Replies
- Send Chat Message: send a query to your Chatflow app. Streaming mode carries workflow and node events alongside the answer text; blocking mode returns once the run finishes.
- Stop Chat Message Generation: interrupt a streaming reply before it finishes.
- Get Next Suggested Questions: propose follow-up questions after a reply completes, based on the conversation so far.
Manage Conversations
- List Conversations: the current user’s conversations, ordered by most recent activity.
- List Conversation Messages: one conversation’s message history, for a scrolling chat UI.
- Rename Conversation: set or auto-generate a display name.
- Delete Conversation: remove a conversation.
- List Conversation Variables: read the values the session persists across turns.
- Update Conversation Variable: change one of those values directly.
Handle Files
- Upload File: upload an image, document, audio, or video file for Send Chat Message to reference. Files are scoped to the uploading end user.
- Download File: preview or download an uploaded file, as long as it belongs to a message in your app.
- Get End User Info: look up an end user’s details from an end-user ID, such as the
created_byin the Upload File response.
Transcribe and Synthesize Speech
- Convert Audio to Text: transcribe an uploaded audio file (MP3, M4A, WAV, AMR, or MPGA, up to 30 MB) so end users can speak their input instead of typing it.
- Convert Text to Audio: synthesize a reply back into speech.
Pause for Human Input
When a run reaches a Human Input node whose delivery method is WebApp, complete the pause over the API:Listen for the pause
The event stream emits
human_input_required carrying a form_token and the run’s workflow_run_id, then ends with the workflow_paused event.Fetch the form
Load the form’s contents with Get Human Input Form, using the
form_token.Submit the response
Send the recipient’s input with Submit Human Input Form. Submitting resumes the run.
Resume the stream
Open a new stream with Stream Workflow Events, using the
workflow_run_id from the paused stream, and follow the remaining events through the final answer.Inspect Workflow Runs
- Get Workflow Run Detail: a run’s status and outputs, by the
workflow_run_idthat appears in the workflow and node events streamed alongside a chat reply. - List Workflow Logs: run-level summaries covering status, token usage, step count, and timing, rather than a node-by-node execution log.
Retrieve App Info and Settings
- Get App Info: the app’s name, description, tags, and mode.
- Get App Parameters: the fields your calls send in
inputs(names, types, defaults) plus the app’s feature switches—the basis for building requests or a client UI. - Get App Meta: tool icons and other configuration metadata.
- Get App WebApp Settings: the WebApp’s site configuration, theme, and customization options.
Collect Feedback and Annotations
- Submit Message Feedback: end users rate a reply as
likeordislike, with an optional text comment. - List App Feedbacks: every feedback submitted across the app, from both end users and admins.
- Create Annotation, List Annotations, Update Annotation, Delete Annotation: manage the annotation set.
- Configure Annotation Reply: turn annotation matching on or off. The change runs asynchronously.
- Get Annotation Reply Job Status: poll with the returned job ID to confirm the change finished.