auto_write

Has the designer compose a new design from a written brief, in the store's brand, optionally built on images from the st

Has the designer compose a new design from a written brief, in the store's brand, optionally built on images from the store's studio library or on products from its catalogue. The designer reads the business's own records (its profile, its products or plans at today's prices, its running and planned promotions) and is told to state only the prices, offers and claims found there or in the brief. Works for any kind of business: a product launch, a sale, an event, a menu, an opening, a hiring post, a testimonial. A duration above 0 makes it a motion design with animated layers. Queued: returns a request id whose state shows when the design exists. Uses credits.

post/api/v1/tools/compose_design

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/tools/compose_design
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: creative:write)

Request body

briefstring required

What the design is for and what it should say.

placementsstring[]

Layouts: square 1:1, portrait 4:5, story 9:16, landscape 1.91:1, wide 16:9. Default square, portrait and story.

duration_secondsnumber

0 for a still image (default); up to 60 for a video.

musicboolean

Videos only: lay an instrumental track made for its length under it (default true). False exports a silent video.

music_moodstring

Videos only: the mood of that track. Left out, the brand kit's music mood.

media_idsstring[]

Images from the store's studio library to build on.

product_idsstring[]

Products from the store's catalogue to feature: the designer gets their names and prices, and their pictures where the studio can show them.

job'spotlight' | 'offer' | 'new' | 'proof' | 'how_it_works' | 'before_after' | 'why_us' | 'tip' | 'event' | 'availability' | 'hours' | 'milestone' | 'team' | 'hiring' | 'seasonal'

What the design is for; the designer follows that job's structure. One of: spotlight (spotlight a product or plan), offer (announce an offer), new (something new), proof (customer proof), how_it_works (how it works), before_after (before and after), why_us (why choose us), tip (a tip or an answer), event (an event or a date), availability (in stock or available), hours (opening hours or a closure), milestone (a milestone), team (meet the team), hiring (we're hiring), seasonal (a season or a holiday). Leave it out to let the brief decide.

builds_onstring

A design of this store to make the next design after. The designer is shown its words and how it did once posted, keeps what it leads with and says it in new words; the new design joins its test group. A design that repeats its words is refused.

Response

Tool result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.