Create series

Create series

post

/series

Authorizations

Body

content_typestring · enum · default: Custom

Options: Custom, News, Quiz, History, Scary, Motivational, Bedtime, FunFacts, LifeTips, ELI5, Philosophy

localestring · enum · default: auto

Locale for the generated video.

Options: 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

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.

connection_idsstring · uuid[]required

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

aspect_ratiostring · enum · default: 9:16

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

Options: 9:16, 16:9, 1:1

voice_playback_ratenumber · min: 50 · max: 200 · default: 100

Voice playback speed percentage.

voice_volumenumber · max: 100 · default: 100

Voice volume percentage.

soundtrack_playback_ratenumber · min: 50 · max: 200 · default: 100

Soundtrack playback speed percentage.

soundtrack_volumenumber · max: 100 · default: 100

Soundtrack volume percentage.

scheduleobject

Publishing schedule for the video (optional).

durationnumber · max: 900

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

topicsobject[]

Array of series topics.

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 · uuid[]

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.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://shortgenius.com/api/v1/series' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "content_type": "Custom",
    "locale": "auto",
    "image_style_id": "123e4567-e89b-12d3-a456-426614174000",
    "connection_ids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "aspect_ratio": "9:16",
    "voice_playback_rate": 100,
    "voice_volume": 100,
    "soundtrack_playback_rate": 100,
    "soundtrack_volume": 100,
    "schedule": {
      "timeZone": "Pacific/Pago_Pago",
      "times": [
        {
          "dayOfWeek": 1,
          "timeOfDay": 1
        }
      ]
    },
    "duration": 1,
    "topics": [
      {
        "topic": "text"
      }
    ],
    "parent_topic": "text",
    "voice_ids": [
      "text"
    ],
    "soundtrack_ids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

200

400

401

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "text",
  "updated_at": null,
  "next_posting_at": null,
  "type": "SingleVideo",
  "schedule": {
    "time_zone": "Pacific/Pago_Pago",
    "times": [
      {
        "day_of_week": 1,
        "time_of_day": 1
      }
    ]
  },
  "content_type": "Custom",
  "name": null,
  "aspect_ratio": "9:16",
  "soundtrack_behavior": "MutedAfter60s",
  "prompt": null,
  "tiktok_settings": {
    "disable_duet": null,
    "disable_stitch": null,
    "disable_comment": null,
    "privacy_level": "PUBLIC_TO_EVERYONE",
    "disclose_video_content": null,
    "brand_content_toggle": null,
    "brand_organic_toggle": null,
    "consent_to_use": null
  },
  "youtube_settings": {
    "privacy_level": "public",
    "self_declared_made_for_kids": null
  },
  "x_settings": {
    "post_as_a_thread": null
  },
  "locale": "af-ZA",
  "soundtrack": {
    "tracks": [
      {
        "id": "text",
        "url": "text"
      }
    ],
    "recommendations": [
      {
        "id": "text",
        "url": "text",
        "reason": "text"
      }
    ],
    "playback_rate": 1,
    "volume": 1
  },
  "thumbnail": {
    "caption_color": "text",
    "caption_stroke_color": "text",
    "caption_alignment": "top-left",
    "caption_font_family": "text",
    "caption_font_size": 1,
    "caption_text_transform": "lowercase",
    "text": null,
    "theme": "None",
    "media": {
      "url": null,
      "deleted_at": null,
      "metadata": null,
      "last_error": null,
      "type": "text",
      "category": "Stock",
      "state": "text",
      "source": "text",
      "data": {
        "kind": "text",
        "title": "text",
        "html_title": "text",
        "link": "text",
        "display_link": "text",
        "snippet": "text",
        "html_snippet": "text",
        "mime": "text",
        "file_format": "text",
        "image": {
          "context_link": "text",
          "height": 1,
          "width": 1,
          "byte_size": 1,
          "thumbnail_link": "text",
          "thumbnail_height": 1,
          "thumbnail_width": 1
        }
      }
    }
  },
  "styles": {
    "caption_active_word_background_color": "text",
    "caption_active_word_color": "text",
    "caption_active_word_stroke_width": 1,
    "caption_active_word_stroke_color": "text",
    "caption_alignment": "top-left",
    "caption_animation": "ZoomIn",
    "caption_background_color": "text",
    "caption_color": "text",
    "caption_display": "karaoke",
    "caption_font_family": "text",
    "caption_font_size": 1,
    "caption_keyword_color": "text",
    "caption_rotate_occasionally": true,
    "caption_stroke_width": 1,
    "caption_stroke_color": "text",
    "caption_text_transform": "lowercase"
  },
  "image_style": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "recommendations": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "reason": "text"
      }
    ]
  },
  "voice": {
    "voices": [
      {
        "id": "text",
        "name": "text",
        "description": null,
        "avatar_url": null,
        "flag_url": null,
        "tags": {
          "language": null,
          "accent": null,
          "age": null,
          "category": null,
          "gender": null,
          "tone": null,
          "useCase": null
        },
        "preview_url": null,
        "locale": "af-ZA",
        "source": "Cartesia"
      }
    ],
    "playback_rate": 1,
    "volume": 1
  },
  "custom_watermark": {
    "caption_color": "text",
    "caption_stroke_color": "text",
    "caption_alignment": "top-left",
    "caption_font_family": "text",
    "caption_font_size": 1,
    "caption_text_transform": "lowercase",
    "text": ""
  },
  "connections": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "Email",
      "name": null
    }
  ],
  "hashtags": null
}

Successful response