Create series

post/series

Request

  • Base URL: https://api.shortgenius.com/v1
  • URL: https://api.shortgenius.com/v1/series
  • Auth: HTTP bearer

Request body

content_type'Custom' | 'News' | 'Quiz' | 'History' | 'Scary' | 'Motivational' | 'Bedtime' | 'FunFacts' | 'LifeTips' | 'ELI5' | 'Philosophy' | 'Blog' | 'Ad'
locale'af-ZA' | 'id-ID' | 'ms-MY' | 'ca-ES' | 'cs-CZ' | 'da-DK' | 'de-DE' | 'en-US' | 'es-ES' | 'es-419' | 'fr-CA' | 'fr-FR' | 'hr-HR' | 'it-IT' | 'hu-HU' | 'nl-NL' | 'no-NO' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'ro-RO' | 'sk-SK' | 'fi-FI' | 'sv-SE' | 'vi-VN' | 'tr-TR' | 'el-GR' | 'ru-RU' | 'sr-SP' | 'uk-UA' | 'hy-AM' | 'he-IL' | 'ur-PK' | 'ar-SA' | 'hi-IN' | 'th-TH' | 'ko-KR' | 'ja-JP' | 'zh-CN' | 'zh-TW' | 'auto'

Locale for the generated video.

image_style_idstring uuid

The ID of the image style to use. Use the List image styles endpoint to get a list of available image styles. If left empty, the AI chooses.

image_model'OpenAI' | 'Flux Ultra/Max' | 'Flux Pro' | 'Flux 2 Pro'

Image model for the generated video.

image_quality'low' | 'medium' | 'high'

Image quality for the generated video.

image_style_raw_modeboolean

Whether to use the raw image style mode. If true, the image style will be ignored.

image_style_custom_promptstring

Custom prompt for the image style. If you provide a custom prompt, the image style will be ignored.

animation_model'None' | 'Seedance' | 'Kling' | 'Hailuo02Standard' | 'Hailuo02Pro' | 'Veo3' | 'SeedanceTTV'

Default animation model for scene images when not specified individually.

animation_model_preset'fully_animated' | 'first_scene_only' | 'first_image_each_scene'

Default animation preset for scene images when not specified individually.

connection_idsstring[] required

List of publishing connection ids. Use the List connections endpoint to get a list of available connections

aspect_ratio'9:16' | '16:9' | '1:1'

Aspect ratio of the video. Not required for News videos.

voice_playback_ratenumber

Voice playback speed percentage.

voice_volumenumber

Voice volume percentage.

soundtrack_playback_ratenumber

Soundtrack playback speed percentage.

soundtrack_volumenumber

Soundtrack volume percentage.

durationnumber

The desired video duration in seconds. Must be <= 900. Not required for news.

parent_topicstring

Base idea or theme for generating custom topics. Required for Custom and Quiz series

voice_idsstring[]

List of voice IDs to use. See the List voices endpoint. If left empty, the AI chooses.

soundtrack_idsstring[]

List of soundtrack IDs to use for background music. See the List music endpoint for available genres, and the List music tracks endpoint for available soundtracks. If left empty, the AI chooses.

Response

Successful response

idstring uuid required

Unique ID of the series.

created_atstring required

Date and time (ISO 8601) when the series was created.

updated_atstring nullable

Date and time (ISO 8601) when the series was last updated.

next_posting_atstring nullable required

Date and time (ISO 8601) when the next video will be posted.

type'SingleVideo' | 'Series' required

Type of the series (e.g., automatically generated).

content_type'Custom' | 'News' | 'Quiz' | 'History' | 'Scary' | 'Motivational' | 'Bedtime' | 'FunFacts' | 'LifeTips' | 'ELI5' | 'Philosophy' | 'Blog' | 'Ad' | 'null' nullable

Indicates the type of content in this series.

namestring nullable

User-friendly name for the series.

aspect_ratio'9:16' | '16:9' | '1:1' required

Aspect ratio of the series videos.

soundtrack_behavior'MutedAfter60s' | 'FullMusic' | 'NoMusic' required

Behavior of the soundtrack.

promptstring nullable

A custom topic for the series.

locale'af-ZA' | 'id-ID' | 'ms-MY' | 'ca-ES' | 'cs-CZ' | 'da-DK' | 'de-DE' | 'en-US' | 'es-ES' | 'es-419' | 'fr-CA' | 'fr-FR' | 'hr-HR' | 'it-IT' | 'hu-HU' | 'nl-NL' | 'no-NO' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'ro-RO' | 'sk-SK' | 'fi-FI' | 'sv-SE' | 'vi-VN' | 'tr-TR' | 'el-GR' | 'ru-RU' | 'sr-SP' | 'uk-UA' | 'hy-AM' | 'he-IL' | 'ur-PK' | 'ar-SA' | 'hi-IN' | 'th-TH' | 'ko-KR' | 'ja-JP' | 'zh-CN' | 'zh-TW' required

Locale of the video series.

hashtagsstring nullable

List of custom hashtags for the series.

Changes

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