Screens
Standalone library screens for the Screen Builder and Screen Player embeddables. Two ways to create a screen with a layout: omit screenId on POST /embed/screen (action: edit) so our picker opens — or list layouts here and POST /screen with a layoutId, then embed the returned id. See Screen Builder for the tradeoff.
List layouts Build and above
Returns picker-visible catalog layouts: id, name, category, and screenType only — there are no thumbnails. Use id as layoutId on POST /screen.
/v1/headless/layoutsCreate screen Build and above
Creates a library screen. Pass layoutId to apply catalog structure, geometry, and English placeholder copy (quiz layouts create a cover + question + results group). A host wanting prompts in their own voice can overwrite the seeded heading and paragraph after mint. Without a layout, pass type (for example blocks or blocksQuiz). Then open the builder with POST /embed/screen, action: edit, and the returned id.
/v1/headless/screenBody parameters
| Field | Type | Required | Desc | Options |
|---|---|---|---|---|
layoutId | string | No | Catalog layout id from GET /layouts | — |
type | string | No | Screen type name (e.g. blocks, blocksQuiz) when layoutId is omitted | — |
typeId | number | No | Screen type id when layoutId is omitted | — |
title | string | null | No | Screen title | — |
identifier | string | No | Your stable user identifier | — |
clientIdentifier | string | No | The client this user belongs to | — |