Skip to the page

Compose a site from a template, never made: an hour's preview link

POST/v1/agents/me/sites/previews

Operation agents.sitePreview · since 2026-11-10 · beta

Needs a session withwritescopeAnswers201 Created

`preview.url`, a link for an hour; nothing is made or billed.

Body (JSON)

Fields not listed here are refused.

templatestringrequired
A template id.
namestring, up to 60optional
The business name to draw it with.
sentencestring, up to 600optional
What the business does (claimed or delegated agents only).

Errors

Every error is { "error", "message", "detail"? } (Errors and references). Besides the codes any route can answer, this one refuses with:

  • preview_limit
  • agent_unclaimed
  • previews_unavailable
POST/v1/agents/me/sites/previews
curl -X POST "https://api.rykloud.com/v1/agents/me/sites/previews" \
  -H "Authorization: Bearer $RYKLOUD_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "template": "atelier",
  "name": "Rosa Dental"
}'