Ask a question

get

https://{environment}.digitalcx.com/ask

Trigger a new interaction for the Conversational AI Cloud project within a given culture. The interaction requires input to be provided in the form of a question provided by an end-user. If a session is provided for the interaction, the conversation will continue using the state of that session. If no session is provided for the interaction a new session will be instantiated and returned with the response. If an expired session is provided a new session wil be started and the old session will be linked to the new session in the analytics environment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

customerKey

string

required

Customer identifier used for authenticating the request.

projectKey

string

required

Project identifier used for authenticating the request, and to determine what project environment the interaction will take place in.

culture

string

required

Points to the culture of the project, which determines what content within the projects scope the answer will originate from.

string

required

The input provided by an end-user.

channel

string

Determines the answer set that needs to be leveraged on matched articles, dialogs, and events. Find out more about the channel parameters behaviour here https://developers.cm.com/conversational-ai-cloud/docs/channels

session.id

string

The GUID which identifies what session the specific interaction (request) belongs in

classificationId

string

The ID for the classification

minFaqs

string

The minimum number of FAQ's added to the output

maxFaqs

string

The maximum number of FAQ's added to the output

session.extended

boolean

When true the session TTL is set to 1 day. Default TTL is 15 minutes. This parameter only needs to be sent once per session.

disableTranslations

boolean

This will disable real-time language detection, and translations for this request, and subsequent requests in the same session.

inputLanguage

string

This will translate the input (provided in the "q" query parameter), and the output from the Gateway API to the provided language.

Headers

string

enum

Defaults to application/json, standard

Generated from available response content types

Allowed:

Response

200OK