http-request-tool prompts JSON format error in workflow

[greycodee]

Self Checks

• [X] This is only for bug report, if you would like to ask a question, please head to Discussions.
• [X] I have searched for existing issues search for existing issues, including closed ones.
• [X] I confirm that I am using English to submit this report (我已阅读并同意 Language Policy).
• [X] 请务必使用英文提交 Issue，否则会被关闭。谢谢！:）
• [X] Please do not modify this template :) and fill in all the required fields.

Dify version

0.6.15

Cloud or Self Hosted

Self Hosted (Docker)

Steps to reproduce

workflow

✔️ Expected Behavior

Ability to successfully request

❌ Actual Behavior

In the Http request step, a json format error occurs.

But when running on a separate node, it works fine.

[dosubot[bot]]

Hi @greycodee! I'm here to help you with bugs, questions, and becoming a contributor. Let's solve this together!

To resolve the JSON format error in your workflow when using the http-request-tool to send a POST request to http://my_flask_container:5000/post, ensure that the JSON body is correctly formatted. Here is an example of how you can structure the JSON body for the POST request:

request_body = {
    'point': APIBasedExtensionPoint.APP_EXTERNAL_DATA_TOOL_QUERY.value,
    'params': {
        'app_id': app_model.id,
        'tool_variable': tool_variable,
        'inputs': inputs,
        'query': '{{#sys.query#}}' if app_model.mode == AppMode.CHAT.value else ''
    }
}

request_body_json = json.dumps(request_body)
request_body_json = request_body_json.replace(r'\{\{', '{{').replace(r'\}\}', '}}')

http_request_node = {
    "id": f"http_request_{index}",
    "position": None,
    "data": {
        "title": f"HTTP REQUEST {api_based_extension.name}",
        "type": NodeType.HTTP_REQUEST.value,
        "method": "post",
        "url": "http://my_flask_container:5000/post",
        "authorization": {
            "type": "api-key",
            "config": {
                "type": "bearer",
                "api_key": api_key
            }
        },
        "headers": {
            "Content-Type": "application/json"
        },
        "params": "",
        "body": {
            "type": "json",
            "data": request_body_json
        }
    }
}

Ensure that the request_body_json is correctly formatted and does not contain any escape characters that could cause a JSON format error. Additionally, make sure that the Content-Type header is set to application/json if it is not already set, as shown in the HttpExecutor class:

if node_data.body.type == 'json' and not content_type_is_set:
    self.headers['Content-Type'] = 'application/json'

This ensures that the server correctly interprets the body of the request as JSON. Also, make sure that the inputs parameter in your request body is a dictionary and not another data type, as required by the WorkflowRunApi class in your Flask application:

parser = reqparse.RequestParser()
parser.add_argument('inputs', type=dict, required=True, nullable=False, location='json')
parser.add_argument('files', type=list, required=False, location='json')
args = parser.parse_args()

By ensuring that the inputs parameter is a dictionary and correctly formatted, you can avoid JSON format errors in your workflow ^[1][2][3][4].

To continue talking to Dosu, mention @dosu.