Audit
Create fixes or a rewrite for one audited page
Creates the requested fixes among those estimateAuditFixes lists as
applicable and debits their price from the site’s AI credits (402
insufficient_credits with details.required and details.balance when
the balance is too low). Returns HTTP 202: the fixes are generated
asynchronously, follow them with listAuditFixes. A generated targeted fix
is written to the CMS with applyAuditFix; a rewrite produces an article
(article_id) to push live with updatePublishedArticle. Replaying the
same idempotency key returns the same fixes without a second debit.
POST
/
profiles
/
{profile_id}
/
audit
/
pages
/
{id}
/
fixes
Error
A valid request URL is required to generate request examples{
"data": {
"audit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fixes": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"page_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fix_type": "<string>",
"status": "pending",
"mode": "manual",
"units": 1,
"credits": 1,
"free_regeneration_available": true,
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"article_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"restorable": true,
"snapshot_expires_at": "2023-11-07T05:31:56Z",
"recheck_pending": true,
"applied_at": "2023-11-07T05:31:56Z",
"restored_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"failure_code": "<string>"
}
],
"credits": 1,
"receipt": {
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "accepted",
"resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"meta": {
"request_id": "<string>",
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}Authorizations
OAuth2PersonalAPIKey
Scopes
Headers
Path Parameters
Body
application/json
Fixes to create for the page, among those estimateAuditFixes lists as applicable. rewrite replaces the article by a full rewrite and is requested alone.
Required array length:
1 - 20 elementsAvailable options:
rewrite, meta_title, meta_description, image_alt, h1, add_links, cover_image, broken_links, image_compression, json_ld, canonical, noindex ⌘I
Error
A valid request URL is required to generate request examples{
"data": {
"audit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fixes": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"page_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fix_type": "<string>",
"status": "pending",
"mode": "manual",
"units": 1,
"credits": 1,
"free_regeneration_available": true,
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"article_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"restorable": true,
"snapshot_expires_at": "2023-11-07T05:31:56Z",
"recheck_pending": true,
"applied_at": "2023-11-07T05:31:56Z",
"restored_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"failure_code": "<string>"
}
],
"credits": 1,
"receipt": {
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "accepted",
"resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"meta": {
"request_id": "<string>",
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}
