Overview

​

Application Overview

​

Why Use Workflow Applications?

• Travel Planning: Users select parameters such as destination via a workflow plugin, and the system automatically generates a comprehensive travel plan—including flight bookings, accommodations, and attraction recommendations.
• Report Analysis: For complex datasets, workflows combine data processing, analytical, and visualization plugins to generate structured, formatted analytical reports tailored to diverse business needs.
• Customer Support: Automated workflows handle customer inquiries—including issue classification—to accelerate response times and improve accuracy.
• Content Creation: Workflows generate articles, marketing copy, and other content types. Users only need to provide a topic and requirements; the system produces compliant drafts automatically.
• Education & Training: Workflows design personalized learning paths—including progress tracking and assessments—to enable self-directed student learning.
• Medical Triage: Based on patient-reported symptoms, workflows integrate multiple analytical tools to produce preliminary diagnoses or recommend relevant tests—assisting physicians in further evaluation.

​

Node Types

​

Session Variables

​

Test the Application

​

Text Conversation

1. From the drop-down list at the top of the test panel, select text conversation mode (selected by default). If the workflow contains custom variables, enter their values in the parameter configuration area.
2. In the input box, enter your test content (text and file attachments are supported), and then click the Send button or press Enter to run the test.
3. Review the test results. You can click a node to view its detailed input and output, or switch the output format between Text and JSON.
4. To continue the conversation, enter your next turn in the input box and send it. To start a new conversation, click the Clear All button.

​

Text Generation

• Synchronous run: For simple, fast tasks. Returns the result immediately upon completion.
• Asynchronous run: For complex, time-consuming tasks. Returns a Task ID that you can use to query the result.

​

Synchronous Run

1. In the input box, enter your test content and click the Run button to start the test.
2. After the workflow finishes running, switch to the Result tab to view the output. You can click a node to view its detailed input and output, or switch the output format between Text and JSON.

​

Asynchronous Run

1. In the input box, enter your test content and click the Run button to start the test. The system immediately returns a Task ID.
2. While the asynchronous task is running, the test panel displays an "Executing" status. You can click the Refresh button to refresh the status.
3. After the task is complete, view the output on the Result tab. The output includes an "Async" tag and the Task ID. You can click a node to view its detailed input and output, or switch the output format between Text and JSON.

​

Voice Interaction and Video Interaction

• We do not recommend using models with high latency for real-time audio and video conversations, as it may affect the conversation experience. Examples include the DeepSeek-R1 and QwQ series models.
• The DeepSeek V3 model does not support video chat.

1. Create a workflow by configuring a Start node, a large language model node, and an End node.
2. In Test > Text Chat, debug the application until it performs as expected.
3. After you are satisfied with the text conversation performance, switch to Interactive voice response or Video Interaction mode. Then, click Configure to set up the API key to call the application.
4. In Audio & Video Settings, configure the parameters, and then click Call to debug the audio and video interaction. Under speech-to-text, you can select the language; under text-to-speech, you can select the voice model and timbre.
5. Once you are satisfied with the test results, click the Try button in the upper-right corner to generate a temporary QR code for testing. You can scan the QR code with WeChat, DingTalk, or a mobile browser to test the interaction. The QR code is valid for 24 hours.
6. After confirming the performance, click the Publish button to publish the application. Then, go to the Publish Channel, activate Intelligent Media Service, grant SLR authorization, and create an interactive agent.

​

Checklist

​

Publishing and Invocation

To invoke using the Responses API, see Responses API Invocation.

​

Prerequisites

1. You have obtained an API Key and configured it in your environment variables.
2. You have created a workflow application and retrieved its APP_ID from the application card on the Application Management page.
3. If invoking via the DashScope SDK, ensure the DashScope SDK is installed.

​

Quick Start

import os
from http import HTTPStatus
from dashscope import Application

response = Application.call(
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    app_id='APP_ID',  # Replace with your actual application ID
    prompt='Who are you?')

if response.status_code != HTTPStatus.OK:
    print(f'request_id={response.request_id}')
    print(f'code={response.status_code}')
    print(f'message={response.message}')
else:
    print(response.output.text)

​

Node Execution Status

​

Multi-turn Conversations

import os
from http import HTTPStatus
from dashscope import Application

def call_with_session():
    response = Application.call(
        api_key=os.getenv("DASHSCOPE_API_KEY"),
        app_id='APP_ID',
        prompt='Who are you?')

    if response.status_code != HTTPStatus.OK:
        print(f'request_id={response.request_id}')
        print(f'code={response.status_code}')
        print(f'message={response.message}')
        return response

    responseNext = Application.call(
                api_key=os.getenv("DASHSCOPE_API_KEY"),
                app_id='APP_ID',
                prompt='What skills do you have?',
                session_id=response.output.session_id)

    if responseNext.status_code != HTTPStatus.OK:
        print(f'request_id={responseNext.request_id}')
        print(f'code={responseNext.status_code}')
        print(f'message={responseNext.message}')
    else:
        print('%s\n session_id=%s\n' % (responseNext.output.text, responseNext.output.session_id))

if __name__ == '__main__':
    call_with_session()

​

Passing Custom Parameters

• prompt: Carries the user’s primary input. This content is automatically mapped to the built-in workflow variable {{query}}, requiring no manual definition.
• biz_params: Passes custom business parameters as key-value pairs (e.g., {"city": "Hangzhou"}). These must be pre-declared in the workflow’s Start node, after which they become globally accessible across all nodes via {{parameter_name}}.

​

Import or Export a Workflow

1. Import or export a Model Studio workflow Click the more icon at the top of the workflow page and select Export DSL or Import Model Studio DSL.
2. Import a Dify workflow One-click import of Dify workflows is supported for easy migration and reuse.
   1. Click the more icon at the top of the workflow page and select Import Dify DSL.
   2. Adjust the parameters for each node. The node compatibility details are as follows:

   Dify node	Mapped node	Compatibility
   start	start	sys.query maps to query; sys.dialogue_count maps to maximum memory turns.
   LLM	LLM	Model: unsupported models are cleared and must be selected manually, supported models are fully compatible; Prompt: Dify's System maps to the main prompt, User maps to the user prompt; vision capability is fully compatible; context: the raw fields from Dify's context are incorporated directly into the system prompt.
   knowledge retrieval	knowledge base	Input: the content field is consistently used as input; knowledge base: cleared after import and must be associated manually; retrieval settings: Dify's Top-k maps to the number of retrieved fragments.
   Direct Reply	output node	Fully compatible.
   agent	None	Only the name is retained. Click the node and select a specific node as a replacement.
   Question Classifier	intent classification	Unsupported models are cleared and must be selected manually; supported models are fully compatible.
   Iteration	batch processing	Input maps to Batch Array; output variable maps to Output Variable.
   loop	loop	Fully compatible.
   code execution	script	Python and JavaScript scripts are distinguished.
   Template Transform	None	Not compatible. A custom node is generated.
   Variable Aggregator	Variable Processing	Maps to the Aggregate Groups output mode of the Variable Processing node.
   Document Extractor	None	Not compatible. A custom node is generated.
   Variable Assignment	Variable Settings	Fully compatible.
   Parameter Extractor	parameter extraction	Inference mode is not supported; other features are fully compatible.
   HTTP request	API	Fully compatible, but you must re-authenticate.
   List Operation	None	Not compatible. A custom node is generated.
   Tool	plugin, MCP	Not compatible. A custom node is generated.
   comment	None	Not compatible.
   end	end	If a Dify workflow contains multiple end nodes, they are converted into a single Variable Processing node and a single end node.

​

Manage Workflow Versions

1. Click Publish in the top-right corner of the workflow configuration page. In the Publish dialog box, enter version information, such as 1.0.0, and click OK.
2. Click Version Management at the top of the page. In the Historical Versions panel, you can view or use different versions of the current workflow application as needed by clicking Overwrite Current Draft or Return to Current Version. You can also click Export DSL for This Version to export the DSL of the selected historical version.
3. (Optional) In the Node Library, view or search for nodes.

​

Delete and Copy Workflow Applications

​

FAQ

​

Workflow Applications

​

Nodes