Shorts

Create a short

post/v1/shorts

Request

  • Base URL: https://api.jellypod.com
  • URL: https://api.jellypod.com/v1/shorts
  • Auth: HTTP bearer

Headers

idempotency-keystring

Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request.

Request body

host_idstring

Narrator Host ID. Required unless host_ids is given. Do not combine with host_ids.

language'en' | 'es' | 'fr' | 'hi' | 'pt' | 'zh' | 'de' | 'ja' | 'ar' | 'ru' | 'ko' | 'id' | 'it' | 'nl' | 'tr' | 'pl' | 'sv' | 'fil' | 'ms' | 'ro' | 'uk' | 'el' | 'cs' | 'da' | 'fi' | 'no' | 'bg' | 'hr' | 'sk' | 'ta' | 'ace' | 'af' | 'ak' | 'sq' | 'am' | 'hy' | 'as' | 'awa' | 'az' | 'ban' | 'bjn' | 'ba' | 'eu' | 'be' | 'bem' | 'bn' | 'bho' | 'bs' | 'bug' | 'my' | 'yue' | 'ca' | 'ckb' | 'hne' | 'ny' | 'crh' | 'dyu' | 'dz' | 'et' | 'gl' | 'lg' | 'ka' | 'gn' | 'gu' | 'ht' | 'ha' | 'he' | 'hu' | 'is' | 'ig' | 'ga' | 'jv' | 'kab' | 'kam' | 'kn' | 'ks' | 'kk' | 'km' | 'ki' | 'rw' | 'kg' | 'ky' | 'lo' | 'ltg' | 'lv' | 'lt' | 'lb' | 'mk' | 'mag' | 'mai' | 'ml' | 'mt' | 'mni' | 'mr' | 'min' | 'lus' | 'mn' | 'ne' | 'nso' | 'or' | 'pag' | 'ps' | 'fa' | 'pa' | 'sat' | 'sr' | 'sd' | 'si' | 'sl' | 'so' | 'sw' | 'ss' | 'tg' | 'te' | 'th' | 'ti' | 'ur' | 'ug' | 'uz' | 'vi' | 'cy'

Narration language code. Defaults to en.

orientation'AUTO' | 'PORTRAIT' | 'LANDSCAPE' | 'SQUARE'

Output orientation. Omit for AUTO, which follows the product policy.

promptstring

Instructions for writing new narration: describe the story, audience, and desired result. To preserve finished narration word for word, use script instead.

scriptstring

Finished plain-text narration. Put [Character Name] on its own line before each turn. Speaker labels resolve to saved Characters unless speaker_characters assigns their IDs, and may resolve to at most 4 distinct Characters.

source_idsstring[]

Sources owned by your organization. Generation waits for processing Sources; missing or failed Sources are rejected.

style_id'almanac' | 'atomic-age' | 'blueprint' | 'chalkboard' | 'claymation' | 'crayon' | 'flat' | 'gouache' | 'paper-mache' | 'pixel-art' | 'retro-comics' | 'sketch' | 'stickman' | 'toy-bricks' | 'watercolor' | 'whiteboard-explainer'

Visual style ID. Omit to use the product's default style.

background_musicboolean

Include background music. Defaults to on.

host_idsstring[]

Ordered Short Host IDs. Supports up to four. Do not combine with host_id.

Response

Generation accepted. Check the status URL until generation finishes.

Changes

No recorded changes to this operation across all 1 revision of this API.