Rasa X | HTTP Documentation - Chat Endpoint fails

[Deprecated] Rasa X Community Edition
1

As per Rasa X, Http documentation the request should be send with below body (along with authorization key):

{
"messages": "How to reset my password?"
}

But this fails and returns below message:

{
    "version": "0.20.2",
    "status": "failure",
    "message": "The payload schema is invalid.Please check the API specification at https://rasa.com/docs/rasa-x/api/rasa-x-http-api/ for the correct schema.",
    "reason": "WrongSchema",
    "details": {
        "absolute_path": [],
        "absolute_schema_path": [
            "required"
        ],
        "args": [
            "'message' is a required property",
            {},
            [],
            null,
            [],
            {},
            {},
            {},
            [],
            null
        ],
        "cause": null,
        "context": [],
        "instance": {
            "messages": "How to reset my password?"
        },
        "message": "'message' is a required property",
        "parent": null,
        "path": [],
        "relative_path": [],
        "relative_schema_path": [
            "required"
        ],
        "schema": {
            "type": "object",
            "required": [
                "message"
            ],
            "properties": {
                "message": {
                    "type": "string"
                }
            }
        },
        "schema_path": [
            "required"
        ],
        "validator": "required",
        "validator_value": [
            "message"
        ]
    },
    "help": null,
    "code": 400
}

However, this works once the message body is changed as below - request succeeds:

{
"message": "How to reset my password?"
}

How to change the HTTP documentation so that this problem can be avoided for others?

2

Hi @saideep-g, thanks for pointing this out! We actually have an issue for this already, but it just hasn’t been updated yet. Unfortunately the Rasa X HTTP API comes from the Rasa X source code, so it’s not open source, but rest assured it will be updated soon!