Generate a quality control report

POST

/api/v1/ai/quality/control/report

Start a run that asks the account’s AI every control question and grades each answer against the expected one. Returns immediately with the reportId; the grading happens asynchronously.

Notes

• Every control question costs one AI call, so this is only available on the Enterprise, Flex, Fixed and Plus plans. Other plans get 403
• Answers 400 when the website has no control questions yet
• Poll GET /api/v1/ai/quality/control/report for progress. The report is absent from the list until its first question has been scored

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

Report generation was started.

object

message

string

reportId

Poll the report list for this id.

string

Example

{
  "message": "Report generation initiated",
  "reportId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

400

Bad request - missing websiteId, or the website has no control questions.

401

Unauthorized - invalid API key.

403

The account’s plan does not include quality control reports.