Skip to main content
POST
Generate (asynchronous)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is an access key.

Example: Authorization: Bearer sk-proj-XXXXXXXXX

Body

application/json

Represents a request to enqueue a conversation

userProfileId
string
required

A user profile ID; this will represent the profile that will receive the generated reply.

personaProfileId
string
required

A persona profile ID; this will represent the profile that our operator will impersonate.

language
enum<string>
required

The language used to generate the reply.

Available options:
EN,
EN_GB,
FR,
FR_BE,
RO,
NL,
ES,
DE,
DE_CH,
DE_AT,
IT,
ES_LATAM,
BG,
HE,
JA,
NL_BE,
EN_AU,
PT_PT,
PT_BR,
SV_SE,
DA_DK,
FI_FI,
PL_PL,
LT_LT,
NB_NO,
NN_NO,
SL_SI,
HU,
HU_HU,
CS_CZ,
EL_GR,
EL_GR_LATIN,
EL_GR_GREEK,
HR_HR,
TR_TR,
EN_IE,
AF_ZA,
ZU_ZA,
LV_LV,
SK_SK,
GA_IE,
SR_RS,
ET_EE,
EN_CA,
FR_CA,
RU_RU,
UA_UA
additionalLanguages
enum<string>[]

A list of additional languages that can be used to generate the reply. Currently, we support only one additional language.

Maximum array length: 1
Available options:
EN,
EN_GB,
FR,
FR_BE,
RO,
NL,
ES,
DE,
DE_CH,
DE_AT,
IT,
ES_LATAM,
BG,
HE,
JA,
NL_BE,
EN_AU,
PT_PT,
PT_BR,
SV_SE,
DA_DK,
FI_FI,
PL_PL,
LT_LT,
NB_NO,
NN_NO,
SL_SI,
HU,
HU_HU,
CS_CZ,
EL_GR,
EL_GR_LATIN,
EL_GR_GREEK,
HR_HR,
TR_TR,
EN_IE,
AF_ZA,
ZU_ZA,
LV_LV,
SK_SK,
GA_IE,
SR_RS,
ET_EE,
EN_CA,
FR_CA,
RU_RU,
UA_UA
userProfileVersion
string | null

Specify the current user profile version. If it differs from the stored version, it will trigger a profile data refresh.

personaProfileVersion
string | null

Specify the current persona profile version. If it differs from the stored version, it will trigger a profile data refresh.

tags
object | null

A map of tags to associate with the generated answer. You can use any key-value pair to store additional information along with your request. You can use this to store arbitrary metadata, for events tracking or statistics.

testMode
boolean | null

Specify whether the conversation should be processed in test mode. In test mode, you will receive a dummy answer, which is useful for testing purposes.

You will not be charged when using test mode.

replyParameters
object | null

A set of parameters that allow you to customize the reply you receive from us, enabling greater flexibility and control over the response format, content, and behavior.

Response

204

No Content