Create a mockup project
create_projectCreates a new still-image or film mockup project in one call: devices arranged by a composition, reference shot or template, screenshots from URLs placed on their screens, a background palette derived from the screenshots, optional texts and extra edit_scene ops. Use it to start any image, App Store set or animated film; use create_launch_video for a music-synced launch video, duplicate_project for a variant of an existing project, and edit_scene to change a project that already exists. The result is reviewed before it is saved: if it has errors, nothing is created and you get the findings with fixes. Screenshots that are files on disk: create the project first, then run the returned curl commands. Returns project_id, editor_url, the media, the scene, the review and a preview sketch.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ops | No | Extra edit_scene ops applied at the end, in the same format as the `ops` of edit_scene. | |
| kind | No | Still image or animated film. Fixed after creation. export_image renders a film as a still (its preview moment); the video of a film is exported by the user in the editor — there is no video export here. For a video made with you, use create_launch_video. | image |
| name | Yes | What the user finds the project by in their overview: "<app or product> · <what it shows>", in the user's language, e.g. "Tempo · App Store set, 5 images" or "Wetter · Das Wetter auf einen Blick". Never "Mockup", "Untitled" or "Test". Rename it later with edit_scene {op:"rename"} when the content changes. | |
| texts | No | Up to three texts, laid out automatically, e.g. a headline and a subline. In a store set add titles with the add_text op and its `image` instead. | |
| folder | No | Only when the user names a folder: the folder in their Showoff projects to put this in, e.g. "Launch videos" or a subfolder "Showoff/Trailer" (two levels at most). Folders are found by name and created when missing. "" moves it back to the top level. | |
| format | No | Preset (quer, klassisch, quadrat, feed, hoch, appstore, banner, vierdrei, hochkant) or {width,height}. | quer |
| devices | No | The devices on stage, in order, at most 6. Leave it out when starting from a template to keep its devices. | |
| palette | No | Palette id; default: the best-rated suggestion for the screenshots. | |
| reference | No | Measured reference shot id (list_compositions) — copies its camera, format and device placement exactly. Overrides composition and format. | |
| composition | No | Composition id; default is chosen from the devices. | |
| screenshots | No | Screenshots by public URL (or tiny base64), each shown on the device at `device_index`. Files on disk: leave this out and run the curl commands the result returns. | |
| template_id | No | Start from a template (list_templates) instead of an empty stage. Its devices, camera, background and motion come along; without `devices`, `device_index` of a screenshot counts the template's devices in order. |