Skip to main content
POST
Chat with the service

Authorizations

Authorization
string
header
required

Body

application/json

Chat request payload.

Request payload for chat.

prompt
string
required

The chat prompt.

chat_id
string

The chat session ID (assigned at 1st prompt).

Example:

""

dataset_code
string

Root dataset code used to scope the chat. Ignored when dataset_codes is provided.

Example:

"ds-core"

dataset_codes
string[]

Dataset codes that must belong to the same dataset tree (root + children). Takes precedence over dataset_code when both are provided.

Example:
docked_audiences
string[]

The audiences ids (UUIDs) to dock and produce insights for. These audiences are created via GWI platform and need to be shared within the organization. The list can be found using /v2/saved/audiences.

Example:
limit
integer
default:10

Optional. Maximum number of insights to return per query (1-20). Fewer insights may be returned when data cannot support more.

Required range: 1 <= x <= 20
Example:

8

Response

Successful response

Response payload for chat.

message
string
required

The chat response message.

insights
object[]
required

Insights related to the chat.

chat_id
string
required

The chat session ID.

sources
object
required

Metadata about the sources used for insights.