Designs

Returns designs the caller may see, newest edit first. Version snapshots are never listed, and templates are excluded unless is_template=true — which narrows alongside cat and q rather than replacing them.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Creates an empty design of the given canvas size. To start from something, use POST /designs/{id}/copy or one of the generate endpoints.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Returns the design with its canvas, its metadata and its resolved preview file. The layers on it are read through GET /designs/{id}/layers.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Deactivates the design. It stops being listed and stops being readable through the API; its versions and layers go with it.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Applies the de_-prefixed fields present in the body. This is the canvas and its metadata; the artwork itself is edited through the layer endpoints.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Returns who may read and edit this design. An empty result means unrestricted — everyone in the workspace with the design permissions.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

An empty object clears the restriction, making it visible to the whole workspace.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Returns proposed values for review — it does not apply them. Committing them goes through the same fill endpoint a person uses, so generated copy is held to the same field whitelist and can never alter the layout. Runs a model, so it consumes credits.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Proposes a coherent restyle — per-layer colors and fonts plus a canvas background — rather than mechanically substituting brand colors. Runs a model, so it consumes credits.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

One design per row, each filled from that row's values.

Requires either design:create or design:contribute.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Replaces the design's categories. Categories are the workspace's own taxonomy, defined under /design-categories.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Copies a template into a new design owned by the caller's workspace. The template is unchanged, and the copy keeps its fillable fields.

Requires either design:create or design:contribute.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Copies the design, its layers and its filing into an independent design named " (Copy)" unless a name is given. The original is unchanged.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Renders it to a downloadable file in the requested format and size.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

The same render, filed as a library file rather than returned for download.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Reverse-engineers a flat image into text blocks with their formatting, graphic overlays and picture regions — the way to get an existing artwork into an editable state. Runs a model.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

What a template lets you change without editing its layout.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Files belonging to this design — the assets placed on it and the previews rendered from it.

Requires any one of media:view, document:view, knowledge-base:view, thread:view, design:view, prompt:view or presentation:view.

Writes values into declared fields only. With apply_to_variants, a field key present in several size variants is written to all of them; with apply_to_kit, the same happens across the design's kit — one edit updates the date on the flyer, the post and the email page at once. Either way the set stays consistent, and siblings that lack a key are reported, not failed.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Spawns a design from an approved template and writes its copy from a brief or from source material — the layout, color and imagery stay exactly as the designer approved them and only the words move. This is POST /designs/generate with the layout already decided, and it is the path to prefer whenever a template fits: a brand-approved page beats a generated one. Left unnamed, the design is named from the copy that was written rather than after the template.

filled and unfilled name the fields in display terms. A field in unfilled still shows the template's placeholder text, so ask for those specifics rather than shipping the page as-is; changed counts what the write actually altered, and a changed of 0 means the design reads exactly like the template.

Requires either design:create or design:contribute.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

The sibling designs generated together by POST /designs/generate-kit, in channel order (flyer, social, story, email), the caller's own design included. designs is empty when this design is not part of a kit.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Composes one more piece into this design's kit from the content plan stored at generation time — no model runs when the plan is present, so the new piece cannot drift from the others. output takes the same shapes as generate-kit: a channel role, {platform}, {preset} or an explicit size. A kit made before plans were stored falls back to one writing call from the stored brief.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Soft-deletes every piece of this design's kit in one call.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Renames every piece of this design's kit to the given base name with its channel appended ("Name (Flyer)", "Name (Story)").

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Points a chart at data and pulls the current figures in. Send an empty body to unbind — the last fetched numbers stay behind as ordinary editable values.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Returns every layer on the design in stacking order, lowest first.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Adds a layer to the design. dl_order decides what it sits above; omit it and the layer goes on top.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Returns one layer with its position, its transform and its type-specific content.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Replaces the layer. This is a PUT: fields absent from the body are reset to their defaults, which is what the editor's autosave sends.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Removes the layer from the design.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

A locked design has its layout frozen: only declared fields can change, for everyone including its author. This is what makes an approved template stay approved.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Suggests layers for the design. Proposals are returned, not saved — the editor adds them as drafts you can accept or discard. Runs a model, so it consumes credits.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Fetches current figures for every bound chart and writes them back. No model is involved — a binding records where the numbers come from, so this is a read and an update, and it costs no credits.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Refreshes the thumbnail shown in listings.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Clears every filled field, returning the design to the template's own copy and imagery.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Re-lays the design out at a new size rather than scaling a picture of it.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Copies the design into a template others can start from. The original is unchanged.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Translates the copy while keeping tone and roughly the same length, so the text still fits its boxes. Runs a model, so it consumes credits.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Returns the other sizes this design has been resized into, which are separate designs that remember where they came from.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Returns the design's saved snapshots, newest first, with a preview and a layer count for each.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Takes a snapshot of the design as it stands. Snapshots are what restore restores, and they are not created automatically.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Removes one snapshot. The design itself and its other snapshots are untouched.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Replaces the design's current layers with the snapshot's. Take a version first if the current state is worth keeping — restoring does not snapshot it for you.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

How many designs and how many templates match cat and q, plus the same pair per category with cat left out. This is what a library screen needs to label its tabs and category filters without listing both sides.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Send the region to change as a PNG mask; the model regenerates only what the mask covers. Runs a model, so it consumes credits.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Writes a one-page document from a brief or from source material — a story, a post, an announcement — and lays it out at the requested size. Unlike generate-from-background the subject is the content: a background image is one optional ingredient, and format accepts a paper preset (US Letter, A4), a social platform, or explicit dimensions in any supported unit.

The layout comes from a fixed library of archetypes rather than from the model, so the page is set properly whatever the copy turns out to be. Every text slot is returned as a fill field, which means the result is immediately usable as a template: save it and fill it for the next story through PATCH /designs/{id}/fill or POST /designs/{id}/bulk-fill.

Where an approved template already fits, prefer POST /designs/{id}/generate — same request, but a designer's layout instead of an archetype. For a design built around a photograph rather than around its words, use POST /designs/generate-from-background.

imagery_used reports whether a supplied photo was actually placed: a page too full to hold the band composes without it rather than failing.

Pass plan to lay out a content plan you already have (from generate-plan, edited or not) and the writing step is skipped along with its cost.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.

Builds a design around a photograph: the image becomes a full-bleed background, and a brand overlay, the logo and the on-image copy are placed onto it. Always a social-platform size.

Choose by the subject. A photograph the design is built on belongs here; words the design is built from belong in POST /designs/generate, which takes any canvas size including paper, treats imagery as optional, and returns an editable page rather than a composed picture. Neither substitutes for the other.

Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.