HTTP API Reference

Live Content API reference

Reference documentation for the Live HTTP endpoint.

The Live Content API (LCAPI) is the underlying API that powers components like <SanityLive> and other Live by default functionality.

It allows you to subscribe to a stream of sync tags as they become invalid, which you can then match up with the tags returned by the Query API, or in queries made with the Sanity client.

Want to get started?

Live Content API

The Live Content API is perfect for fast-moving events like sports, news, and commerce. Deliver real-time experiences easily and at scale.

Add live content to your application

Learn to use the Live Content API with Next.js or your own integration for real-time content updates in app.

Authentication

  • Authentication is not required for public data.
  • Requests that use the includeAllDocuments option require a viewer token as noted below.

Base API server URL

Sanity API base URL

https://{projectId}.api.sanity.io/{apiVersion}

Variables

  • projectIdstringdefault: "projectId"

    Project ID

  • apiVersionstringdefault: "v2025-02-19"

    API version

Endpoints

Stream sync tag invalidation events

get/data/live/events/{dataset}

Streams sync tags on published documents as they become invalid. This is a live API adhering to the Server Sent Events standard.

Path parameters

  • datasetstringrequired

    The dataset to stream events from

Query parameters

  • includeAllDocumentsbooleandefault: false

    Set to true to include version, draft, and system document changes. Requests made with this parameter must be authenticated with Viewer access rights.

Header parameters

  • last-event-idstring

    An optional start event ID ("position"). If provided, it must be a previously returned event ID. The stream will continue with the next event following this position. If not given, the stream starts at the end. Only new tags are returned. If not usable, the first message emitted will be a restart message, and the stream will start at the end.

Responses

200

Successfully started streaming operation

  • idstring

    The position in the stream

  • eventstring

    The type of SSE message

  • dataobject

    The message payload

Examplestext/event-stream
welcome
{
  "id": "MXxhYVlRejdGZUpPMA",
  "event": "welcome"
}