Ask AnswerGenius

Send a query to AnswerGenius.

POST answergenius/ask

Authentication

This request requires basic authentication.

Request Parameters

Body params

query	string	The query to send to AnswerGenius
chatId	string	[optional] The ID of a specific chat conversation with AnswerGenius. Specifying the chatId adds more context to a conversation.
projectId	string	[optional] The ID of a publication for prioritized search.

Samples

Request sample

Copy Code

Bash (Unix Shell)

curl --location -g --request POST 'https://{portal-url}/api/v1/answergenius/ask' \
--data-raw '{
  "query": "Information Boxes and Text Boxes",
  "chatId": "7a19acd5-a982-4c79-b553-ab90c92b8d9c",
  "projectId": "my-manual-publication"
}'

Response sample

Copy Code

JSON

{
    "id": "7a19acd5-a982-4c79-b553-ab90c92b8d9c",
    "messages": [
        {
            "html": "<p>In ClickHelp, you can create templated elements for quick reuse, including information boxes and text boxes. These are premade Quick Parts that allow you to highlight important points or provide additional information in a highly visible form. You can use ready-made information boxes such as warning boxes, success boxes, note boxes, and error boxes. Additionally, dropdowns and popups can be created within help topics to display content when clicked.</p>\n<h2 class='AnswerGenius_sourcesText'>Sources:</h2><ul class='AnswerGenius_sourcesList'><li><a href='https://anastasiademo.clickhelp.co/articles/#!pub1/quick-reference' title='Quick Reference' class='AnswerGenius_articleLink' target='_blank'>Quick Reference</a></li></ul>",
            "type": "Assistant"
        }
    ]
}

Response fields

id	The ID of the chat conversation with AnswerGenius.
messages	The answer to the query.
messages[].html	The HTML content of the answer.
messages[].type	The type of the answer, for example: Assistant.