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.

GET/v1/headless/layouts

Parameter metadata is unavailable for this endpoint, but request examples are still shown.

Examples

cURL request

curl --request GET \
  --url "https://api.coassemble.com/api/v1/headless/layouts" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Create 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.

POST/v1/headless/screen

Parameter metadata is unavailable for this endpoint, but request examples are still shown.

Examples

cURL request

curl --request POST \
  --url "https://api.coassemble.com/api/v1/headless/screen" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"