Create ask assistant

POST

/admin/v1/support/assistant/questions

One request, one answer: the question and the assistant's reply come back together

API key ability: support:write.

Request

Authorization

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Headers

Bodyapplication/json

🟠401AuthenticationException

🟠404ModelNotFoundException

🟠422ValidationException

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://dashboard.shantaweb.com/admin/v1/support/assistant/questions' \
--header 'Accept-Language;' \
--header 'X-Website-ID;' \
--header 'Content-Type: application/json' \
--data '{
    "body": "string",
    "client_message_id": "94a38f22-8fc5-4aec-a7cd-27937477340c",
    "page_title": "string",
    "pages": [
        {
            "title": "string",
            "url": "string"
        }
    ]
}'

Response Example

201 - Example 1

{
    "status": 201,
    "success": true,
    "data": {
        "conversation": {
            "id": 0,
            "status": "string",
            "subject": "string",
            "with_assistant": true,
            "last_message_at": "string",
            "user_last_read_at": "string",
            "created_at": "string"
        },
        "messages": [
            {
                "id": 0,
                "sender_type": "string",
                "body": "string",
                "image": "string",
                "client_message_id": "string",
                "answer": {
                    "outcome": "string",
                    "handoff_reason": "string",
                    "helpful": "string",
                    "page": "string",
                    "sources": [
                        null
                    ]
                },
                "created_at": "string"
            }
        ]
    },
    "meta": [
        null
    ]
}

Modified at 2026-10-25 03:06:51

List setup steps

Create ask assistant