POST

Generate Heading Structure Suggestions


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Suggests corrected heading levels for a page's headings.

Pass the page's headings in document order, each with its raw HTML and your own reference IDs. The AI checks the heading hierarchy (one H1, no skipped levels, headings that match their content) and returns a suggested tag per heading that should change, echoing your reference IDs back so you can locate each element.

The heading nodes are the request's content, so this method works for any page, including headless projects.

This method must be called with a Wix user identity, for example an app acting on behalf of a signed-in site owner. Calls made with an API key fail, because the page's title is read through the site's accessibility analysis, which runs as the user.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
View SEO Settings
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/seo/suggestions/v1/tag-suggestions/heading-structure

Errors
429Resource Exhausted

There is 1 error with this status code.

500Internal

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?