Nuvelics documentation
CLICommand reference

nuvelics output-template

Usage, options and details of the nuvelics output-template commands.

nuvelics output-template create

Create an output template

--type selects the template shape; the flags each type accepts differ:

web_article: --min-words, --max-words, --include-byline, --byline-default, --featured-image / --no-featured-image, --inline-images / --no-inline-images

x_post / instagram_post / tiktok_post / facebook_post / linkedin_post: --max-characters, --max-hashtags

short_form_video: --formats (repeatable), --min-seconds, --max-seconds, --caption-style

--newsdesk-id is required: pass an id, or "" to offer the template on

every desk.

  • --type <type> — Template type: web_article, x_post, instagram_post, tiktok_post, facebook_post, linkedin_post, or short_form_video
  • --name <name> — Template display name
  • --newsdesk-id <id> — Desk this template is scoped to, or "" to offer it on every desk
  • --tone <text> — Free-text description of the intended voice
  • --style-notes <text> — Free-text house style notes
  • --min-words <n> — Minimum article length in words (web_article)
  • --max-words <n> — Maximum article length in words (web_article)
  • --include-byline <true|false> — Whether generated articles carry a byline (web_article)
  • --byline-default <text> — Default byline text; required when --include-byline is true (web_article)
  • --featured-image — Generation picks a featured image; default on, --no-featured-image turns it off (web_article)
  • --inline-images — Generation may place images in the body; default on, --no-inline-images turns it off (web_article)
  • --max-characters <n> — Maximum characters (x_post, instagram_post, tiktok_post, facebook_post, linkedin_post)
  • --max-hashtags <n> — Maximum hashtags (x_post, instagram_post, tiktok_post, facebook_post, linkedin_post)
  • --formats <9:16|1:1|4:5> — Crop shapes, repeatable: "9:16", "1:1", or "4:5" (short_form_video)
  • --min-seconds <n> — Minimum video length in seconds (short_form_video)
  • --max-seconds <n> — Maximum video length in seconds (short_form_video)
  • --caption-style <cards> — Caption rendering: "cards" (short_form_video)

nuvelics output-template delete [id]

Delete an output template (irreversible)

Pass --yes to confirm. This action is irreversible.

  • --yes — Confirm irreversible deletion

nuvelics output-template get [id]

Get an output template by ID

nuvelics output-template list

List output templates

  • --type <type> — Filter by type: web_article, x_post, instagram_post, tiktok_post, facebook_post, linkedin_post, or short_form_video
  • --is-active <true|false> — Filter by active state
  • --newsdesk-id <id> — Filter by newsdesk id

nuvelics output-template update [id]

Update an output template

The current version is fetched automatically. If modified concurrently, a 412 is returned — retry. --newsdesk-id "" clears the scoping (offers the template on every desk).

  • --name <name> — New display name
  • --newsdesk-id <id> — New desk to scope to, or "" to offer it on every desk
  • --tone <text> — New intended-voice description
  • --style-notes <text> — New house style notes
  • --is-active <true|false> — New active state
  • --min-words <n> — New minimum article length in words (web_article)
  • --max-words <n> — New maximum article length in words (web_article)
  • --include-byline <true|false> — New byline setting (web_article)
  • --byline-default <text> — New default byline text (web_article)
  • --featured-image — Turn the featured image on, or off with --no-featured-image (web_article)
  • --inline-images — Turn body images on, or off with --no-inline-images (web_article)
  • --max-characters <n> — New maximum characters (x_post, instagram_post, tiktok_post, facebook_post, linkedin_post)
  • --max-hashtags <n> — New maximum hashtags (x_post, instagram_post, tiktok_post, facebook_post, linkedin_post)
  • --formats <9:16|1:1|4:5> — New crop shapes, repeatable (short_form_video)
  • --min-seconds <n> — New minimum video length in seconds (short_form_video)
  • --max-seconds <n> — New maximum video length in seconds (short_form_video)
  • --caption-style <cards> — New caption rendering style (short_form_video)

Report a problem with this page

On this page