Regenerate a help center FAQ answer

POST

/api/v1/help-center/faqs/retry

Ask the AI to write an FAQ’s answer again, for instance after the training data changed.

Notes

• An FAQ already at answerStatus: pending is returned unchanged rather than queued twice, so a repeated call is safe
• Answers 404 when the faqId does not exist

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.

Request Body ^required

object

faqId

required

string

Example

{
  "faqId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Responses

200

The FAQ, with answerStatus set to pending.

400

Bad request - missing websiteId or faqId.

401

Unauthorized - invalid API key.

404

No FAQ with that id.