Skip to main content
POST
Create or recover a durable shared preview link to a site route in the API key owner's agent workspace. Start an agent session in the project before sharing. Page availability is checked when the link is opened, not when it is created.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Replo-Api-Version
enum<string>
required

The public API version to use for this request.

Available options:
2026-10-05

Body

application/json
projectId
string<uuid>
required
siteId
string<uuid>
required
route
string
required

The site route to preview, e.g. "/" or "/about". Must be an absolute path without a query string or fragment.

Required string length: 1 - 2048
locale
string

BCP 47 language tag to render the page in, e.g. "en-US". Omit to use the site's default locale.

Required string length: 1 - 255

Response

Create or recover a durable shared preview link to a site route in the API key owner's agent workspace. Start an agent session in the project before sharing. Page availability is checked when the link is opened, not when it is created.

object
enum<string>
required
Available options:
shared_preview
id
string<uuid>
required
url
string<uri>
required

Durable link to the requested site route. Page availability is checked when someone opens it; deleting the preview disables the link.