Create series

Create series

post

Authorizations

bearerAuth

AuthorizationstringRequired

Your ShortGenius API token

Body

application/json

content_typestring · enumOptionalDefault: CustomPossible values:

localestring · enumOptional

Locale for the generated video.

Default: autoPossible values:

image_style_idstring · uuidOptional

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_modelstring · enumOptional

Image model for the generated video.

Possible values:

image_qualitystring · enumOptional

Image quality for the generated video.

Possible values:

image_style_raw_modebooleanOptional

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

image_style_custom_promptstringOptional

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

animation_modelstring · enumOptional

Default animation model for scene images when not specified individually.

Possible values:

animation_model_presetstring · enumOptional

Default animation preset for scene images when not specified individually.

Possible values:

connection_idsstring · uuid[]Required

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

aspect_ratiostring · enumOptional

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

Default: 9:16Possible values:

voice_playback_ratenumber · min: 50 · max: 200Optional

Voice playback speed percentage.

Default: 100

voice_volumenumber · max: 100Optional

Voice volume percentage.

Default: 100

soundtrack_playback_ratenumber · min: 50 · max: 200Optional

Soundtrack playback speed percentage.

Default: 100

soundtrack_volumenumber · max: 100Optional

Soundtrack volume percentage.

Default: 100

durationnumber · max: 900Optional

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

parent_topicstringOptional

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

voice_idsstring[]Optional

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

soundtrack_idsstring · uuid[]Optional

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

200

Successful response

application/json

400

Invalid request

application/json

401

Unauthorized request

application/json

post

/series

HTTPcURLJavaScriptPython

POST /api/v1/series HTTP/1.1
Host: shortgenius.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1010

{
  "content_type": "Custom",
  "locale": "auto",
  "image_style_id": "123e4567-e89b-12d3-a456-426614174000",
  "image_model": "OpenAI",
  "image_quality": "low",
  "image_style_raw_mode": true,
  "image_style_custom_prompt": "text",
  "animation_model": "None",
  "animation_model_preset": "fully_animated",
  "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"
    }
  ],
  "ad": {
    "product_id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "JustTheHook",
    "ugc_media": [
      {
        "url": null,
        "deletedAt": null,
        "metadata": null,
        "lastError": null,
        "associatedProductId": null,
        "type": "text",
        "source": "Ugc",
        "category": "text",
        "data": {
          "id": "text",
          "hook": null
        },
        "state": "text"
      }
    ],
    "media_ids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  },
  "parent_topic": "text",
  "voice_ids": [
    "text"
  ],
  "soundtrack_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "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_stroke_width": 1,
    "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,
      "associated_product_id": 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_background_disabled": true,
    "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_stroke_width": 1,
    "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
}