About workflows API Issues

[green-dalii]

Self Checks

• I have searched for existing issues search for existing issues, including closed ones.
• I confirm that I am using English to submit report (我已阅读并同意 Language Policy).
• [FOR CHINESE USERS] 请务必使用英文提交 Issue，否则会被关闭。谢谢！:）
• Please do not modify this template :) and fill in all the required fields.

Provide a description of requested docs changes

About Dify's workflow, when it is published as an API, the documentation lacks clarity. If multiple workflows are active simultaneously, the documented request URL (e.g.: curl -X POST 'http://mydokcerhost.dify/v1/workflows/run') does not provide any distinction. How does Dify determine which specific workflow to execute?

[dosubot]

Hello @green-dalii! I'm here to help you with any bugs, questions, and contributions you have regarding Dify. I'm an expert bot and can assist you while you wait for a human maintainer.

To specify which workflow to execute in Dify, the API request includes certain parameters in the request body. These parameters are:

• inputs (object): Required. This allows you to pass in the values for various variables defined by the app.
• response_mode (string): Required. This specifies the response mode, which can be either streaming or blocking.
• user (string): Required. This is a user identifier used to define the identity of the end user, ensuring uniqueness within the application.

Additionally, system variables such as sys.app_id and sys.workflow_id are automatically assigned by the system and can be used to differentiate and locate distinct Workflow applications. These parameters are included in the POST request to the /workflows/run endpoint ^[1][2][3].

To continue talking to Dosu, mention @dosu.

[crazywoola]

Authentication
The Service API uses API-Key authentication. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Each time you will need a API-Key to perform a request, so that's the key to the endpoint.