$ cli-blog docs
API ReferenceAPI Reference

Sitemap

Resource overviewGenerated XML for published, indexable posts.
AuthenticationPublic or private key
Common workflowRequest the organization sitemap, then proxy or serve the XML from your product domain.
Read the action guide

Generate sitemap XML

Key type: Public or private key

Generate a sitemap XML document for published, indexable posts. Customer sites should proxy this endpoint onto /sitemap.xml on their own domain so crawlers receive first-party URLs.

Authorization

ApiKeyAuth
x-api-key<token>

Organization API key. Each key selects exactly one organization; do not send an organization ID separately. Public keys use the cli_blog_pk_ prefix and are intended for published-content delivery reads. Private keys use the cli_blog_sk_ prefix, belong only in trusted environments, and are required for write, publish, delete, and editorial-state workflows when their scopes allow it.

In: header

Query Parameters

locale?string

Optional BCP 47 locale filter. Omit it to include every published, indexable localized post URL.

limit?|

Maximum URLs to include. Sitemaps are capped at 50,000 URLs by the sitemap protocol.

Response Body

text/plain

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/sitemap"
"string"
{  "error": {    "code": "invalid_request",    "message": "string",    "param": "string"  }}
{  "error": {    "code": "invalid_request",    "message": "string",    "param": "string"  }}
{  "error": {    "code": "invalid_request",    "message": "string",    "param": "string"  }}
{  "error": {    "code": "invalid_request",    "message": "string",    "param": "string"  }}