Projects and demos

A project is the long-lived container for one product, website, docs set, or demo environment. A demo is one recorded clip inside that project.

Projects

Projects store the default target URL, viewport, refresh settings, webhook secret, and generated demos.

Create one project per product surface unless the surfaces have very different URLs or release cycles.

bash
littledemo projects create \ --name "Acme App" \ --url https://app.acme.com \ --viewport desktop

Demos

A demo stores the prompt, status, generated plan, recording metadata, media keys, and presentation settings.

Common statuses:

StatusMeaning
pendingThe request has been accepted.
planningLittleDemo is analyzing the page and building a script.
recordingThe browser recording is running.
renderingVideo assets are being prepared.
readyThe demo can be shared and embedded.
failedGeneration stopped before a usable demo was produced.

Jobs and versions

Refreshing or restyling a demo creates a new job. When the job succeeds, the demo version increments and embeds point at the latest ready version.

That means you can use the same iframe forever:

html
<iframe src="https://littledemo.com/embed/demo_abc123"></iframe>

The embed does not need to change when the video refreshes.

Viewports

Projects can default to desktop or mobile. The API also accepts tablet for project creation.

Use mobile when the product has a real mobile layout. Do not use it just to make a smaller video. For small embeds, keep the recording desktop and control player size in the embed container.

Ask a question... ⌘I