Get AI configuration

GET

/api/v1/ai/configuration

Retrieve the AI configuration for a website: the main language, response length, product name, custom rules and other settings that control how the AI answers questions.

Use cases

• Account investigation: Inspect how the AI is configured before diagnosing answer quality or behaviour
• Verification: Confirm settings such as the main language or custom rules after making changes in the dashboard

Notes

• The configuration is returned as a flat object
• When a website has no configuration yet, a default configuration is created and returned

Parameters

Header Parameters

x-api-key

required

string

Your API key from account settings.

x-user-email

required

string

The email address of your user.

x-account-id

required

string

The ID of your account. You can find this in the account settings.

x-website-id

required

string

The ID of the workspace you want to use.

Responses

200

The AI configuration for the website.

object

accountId

string

websiteId

string

mainLanguage

Two-letter code of the main conversation language.

string

productName

The product name the AI refers to.

string

customRules

Free-form instructions that steer the AI’s answers.

string

responseLength

Preferred answer length.

string

suggestReplies

Whether the AI suggests follow-up replies.

boolean

componentFilterPII

Whether personally identifiable information is filtered.

boolean

negativeFeedbackReply

Reply shown after negative feedback.

string

positiveFeedbackReply

Reply shown after positive feedback.

string

Example

{
  "accountId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "websiteId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "mainLanguage": "en",
  "productName": "Unless",
  "customRules": "Always answer in a friendly tone.",
  "responseLength": "long",
  "suggestReplies": true,
  "componentFilterPII": true,
  "negativeFeedbackReply": "I'm sorry to hear that.",
  "positiveFeedbackReply": "Thank you for your feedback."
}

400

Bad request - missing required parameters.

401

Unauthorized - invalid API key.