SiteLift LogoSiteLiftDocs

Content Delivery API

Use the SiteLift Delivery API to fetch your generated content and display it on any platform or custom tech stack.

Note

Base URL: https://api.sitelift.io/v1/delivery

Authentication

Authenticate your requests by including your Delivery API key in the Authorization header as a Bearer token. You can generate an API key in your Project Settings.

bash
curl -X GET "https://api.sitelift.io/v1/delivery/articles" \
  -H "Authorization: Bearer sl_live_your_api_key_here"

Warning

Keep your API key secret! Never expose it in client-side code (like the browser). Always make requests from a secure backend server.

Endpoints

List Articles

GET/api/v1/delivery/articles

Returns a paginated list of published articles. Does not include the full HTML body to save bandwidth.

Query Parameters

ParameterTypeDescription
pagenumberPage number to fetch. Default is 1.
limitnumberItems per page. Default is 20, maximum is 100.
statusstringFilter by status: published, planned, generating, generated, publishing, generation_failed, publish_failed. Default is generated.

Get Article by ID or Slug

GET/api/v1/delivery/articles/:identifier

Returns the full article payload, including the HTML body and SEO metadata. The :identifier can be either the Article UUID or the URL slug.

Query Parameters

ParameterTypeDescription
publishbooleanOptionally mark the article as published when fetching by passing true.
json
{
  "id": "art_123456789",
  "title": "10 Best Dog Training Tips",
  "slug": "best-dog-training-tips",
  "status": "published",
  "publishedAt": "2024-03-15T10:00:00Z",
  "metaDescription": "Discover the 10 best ways to train your puppy...",
  "featuredImage": "https://cdn.sitelift.io/images/...",
  "html": "<p className="leading-loose">Training a dog is rewarding...</p>",
  "schema": {
    "@context": "https://schema.org",
    "@type": "Article",
    "headline": "10 Best Dog Training Tips"
  }
}

Get Sitemap Entries

GET/api/v1/delivery/sitemap

Returns all published article slugs and updated timestamps, perfect for generating your site's sitemap.xml.

json
{
  "entries": [
    {
      "slug": "best-dog-training-tips",
      "updatedAt": "2024-03-15T10:00:00.000Z"
    }
  ]
}

Rate Limits

The Delivery API is limited to 100 requests per minute per project. If you exceed this, you will receive a 429 Too Many Requests response.

For high-traffic sites, we strongly recommend implementing caching on your end (e.g., Next.js ISR, Redis, or a CDN) rather than fetching from the SiteLift API on every user request.

Previous

Next.js Blog

Next

Webhooks