---
title: "Preview Surface"
method: POST
path: "/api/v1/admin/surfaces/{surface}/preview"
tags: ["admin"]
---

# Preview Surface

`POST /api/v1/admin/surfaces/{surface}/preview`

## Request

- Base URL: `https://api.peil.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.peil.app/api/v1/admin/surfaces/{surface}/preview`
- Auth: OAuth 2 (password, token URL `/api/v1/auth/jwt/login`)

Render posted (unsaved) HTML with sample variables — for the editor.

## Path parameters

- `surface` string, required

## Request body

- SurfacePreviewRequest
  - `html_source` string, required

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/peil/apis/peil-api.md) · [All operations](https://skmtc.dev/peil/apis/peil-api/llms.txt) · [OpenAPI document](https://skmtc.dev/peil/apis/peil-api/revisions/ee3ca1246dde?raw)