API reference
Seo
Content Delivery API: GET /seo/llms.txt, GET /seo/llms-full.txt, GET /seo/sitemap.xml, …
AI / LLM site index (llms.txt) using externalStorefrontUrl as the base URL
/seo/llms.txtParameters
localestring · queryLocale of the file: page and post titles and summaries from that locale's published translations, URLs with the locale's URL prefix, and a Languages section linking the other locales' files at /{prefix}/llms.txt. One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. A custom llms.txt applies to the primary locale only. Rewrite /{prefix}/llms.txt on your front end to this endpoint with locale={prefix}.
Errors
UNSUPPORTED_LOCALE400
curl -X GET "https://{site}/api/v1/seo/llms.txt"Full site Markdown content (llms-full.txt) using externalStorefrontUrl as the base URL
/seo/llms-full.txtParameters
localestring · queryLocale of the file: page sections and post bodies from that locale's published translations, URLs with the locale's URL prefix, and links to the other locales' files. One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. A custom llms-full.txt applies to the primary locale only.
Errors
UNSUPPORTED_LOCALE400
curl -X GET "https://{site}/api/v1/seo/llms-full.txt"curl -X GET "https://{site}/api/v1/seo/sitemap.xml"robots.txt including AI crawler block rules and Sitemap pointing to externalStorefrontUrl
/seo/robots.txtcurl -X GET "https://{site}/api/v1/seo/robots.txt"curl -X GET "https://{site}/api/v1/seo/indexnow-key.txt"Parameters
pathstring · queryRelative page path starting with / (e.g. /, /about, /blog, /blog/my-post)
localestring · queryLocale of the structured data: inLanguage, page and post names and descriptions from that locale's published translations, and page URLs with the locale's URL prefix. Pass path in the primary locale's path space (strip the locale prefix). One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE.
Errors
INVALID_QUERY400PAGE_NOT_FOUND404UNSUPPORTED_LOCALE400
curl -X GET "https://{site}/api/v1/seo/jsonld"