---
title: "Get series"
method: GET
path: "/series/{id}"
---

# Get series

`GET /series/{id}`

## Request

- Base URL: `https://api.shortgenius.com/v1`
- URL: `https://api.shortgenius.com/v1/series/{id}`
- Auth: HTTP bearer

## Path parameters

- `id` string, uuid, required: The unique ID of the video series to retrieve.

## Response `200`

Successful response

- Series: Public series information.
  - `id` string, uuid, required: Unique ID of the series.
  - `created_at` string, required: Date and time (ISO 8601) when the series was created.
  - `updated_at` string, nullable: Date and time (ISO 8601) when the series was last updated.
  - `next_posting_at` string, 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).
  - `schedule` object, nullable, required: The publishing schedule for the video series.
    - `time_zone` 'Pacific/Pago_Pago' | 'America/Adak' | 'Pacific/Honolulu' | 'Pacific/Marquesas' | 'America/Anchorage' | 'America/Tijuana' | 'America/Los_Angeles' | 'America/Phoenix' | 'America/Denver' | 'America/Guatemala' | 'America/Chicago' | 'America/Chihuahua' | 'Pacific/Easter' | 'America/Mexico_City' | 'America/Regina' | 'America/Bogota' | 'America/Cancun' | 'America/New_York' | 'America/Port-au-Prince' | 'America/Havana' | 'America/Fort_Wayne' | 'America/Asuncion' | 'America/Halifax' | 'America/Caracas' | 'America/Cuiaba' | 'America/La_Paz' | 'America/Santiago' | 'America/Grand_Turk' | 'America/St_Johns' | 'America/Araguaina' | 'America/Sao_Paulo' | 'America/Cayenne' | 'America/Argentina/Buenos_Aires' | 'America/Godthab' | 'America/Montevideo' | 'America/Miquelon' | 'America/Bahia' | 'America/Noronha' | 'Atlantic/Azores' | 'Atlantic/Cape_Verde' | 'Europe/London' | 'Africa/Abidjan' | 'Europe/Berlin' | 'Europe/Belgrade' | 'Europe/Brussels' | 'Africa/Lagos' | 'Africa/Casablanca' | 'Africa/Windhoek' | 'Europe/Bucharest' | 'Asia/Beirut' | 'Africa/Cairo' | 'Asia/Damascus' | 'Asia/Gaza' | 'Africa/Maputo' | 'Europe/Kiev' | 'Asia/Jerusalem' | 'Europe/Kaliningrad' | 'Africa/Tripoli' | 'Asia/Amman' | 'Asia/Baghdad' | 'Europe/Istanbul' | 'Asia/Riyadh' | 'Europe/Minsk' | 'Europe/Moscow' | 'Africa/Nairobi' | 'Asia/Tehran' | 'Asia/Dubai' | 'Europe/Volgograd' | 'Asia/Baku' | 'Europe/Samara' | 'Indian/Mauritius' | 'Asia/Tbilisi' | 'Asia/Yerevan' | 'Asia/Kabul' | 'Asia/Tashkent' | 'Asia/Yekaterinburg' | 'Asia/Karachi' | 'Asia/Almaty' | 'Asia/Kolkata' | 'Asia/Colombo' | 'Asia/Kathmandu' | 'Asia/Dhaka' | 'Asia/Rangoon' | 'Asia/Novosibirsk' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Hovd' | 'Asia/Krasnoyarsk' | 'Asia/Tomsk' | 'Asia/Shanghai' | 'Asia/Irkutsk' | 'Asia/Kuala_Lumpur' | 'Australia/Perth' | 'Asia/Taipei' | 'Asia/Ulaanbaatar' | 'Asia/Pyongyang' | 'Australia/Eucla' | 'Asia/Chita' | 'Asia/Tokyo' | 'Asia/Seoul' | 'Asia/Yakutsk' | 'Australia/Adelaide' | 'Australia/Darwin' | 'Australia/Brisbane' | 'Australia/Sydney' | 'Pacific/Port_Moresby' | 'Australia/Hobart' | 'Asia/Vladivostok' | 'Australia/Lord_Howe' | 'Pacific/Bougainville' | 'Asia/Srednekolymsk' | 'Asia/Magadan' | 'Pacific/Norfolk' | 'Asia/Sakhalin' | 'Pacific/Noumea' | 'Asia/Anadyr' | 'Pacific/Auckland' | 'Pacific/Fiji' | 'Pacific/Chatham' | 'Pacific/Tongatapu' | 'Pacific/Apia' | 'Pacific/Kiritimati', required
    - `times` object[], required
      - `day_of_week` number, required
      - `time_of_day` number, required
  - `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.
  - `name` string, 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.
  - `prompt` string, nullable: A custom topic for the series.
  - `tiktok_settings` object, nullable: Settings for the TikTok platform.
    - `disable_duet` boolean, nullable
    - `disable_stitch` boolean, nullable
    - `disable_comment` boolean, nullable
    - `privacy_level` 'PUBLIC_TO_EVERYONE' | 'FOLLOWER_OF_CREATOR' | 'MUTUAL_FOLLOW_FRIENDS' | 'SELF_ONLY' | 'null', nullable
    - `disclose_video_content` boolean, nullable
    - `brand_content_toggle` boolean, nullable
    - `brand_organic_toggle` boolean, nullable
    - `consent_to_use` boolean, nullable
  - `youtube_settings` object, nullable: Settings for the YouTube platform.
    - `privacy_level` 'public' | 'unlisted' | 'private' | 'null', nullable
    - `self_declared_made_for_kids` boolean, nullable
  - `x_settings` object, nullable: Settings for the X/Twitter platform.
    - `post_as_a_thread` boolean, nullable
  - `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.
  - `soundtrack` object, nullable, required: Soundtrack configuration for the series. Null if no soundtrack is configured.
    - `tracks` object[], required: Soundtracks for the series.
      - `id` string: Unique ID of the soundtrack.
      - `url` string, required: URL of the soundtrack.
    - `recommendations` object[], required
      - `id` string: Unique ID of the recommended soundtrack.
      - `url` string, required: URL of the recommended soundtrack.
      - `reason` string, required: Reason for the recommended soundtrack.
    - `playback_rate` number, required: Soundtrack playback rate.
    - `volume` number, required: Soundtrack volume.
  - `thumbnail` object, nullable: Thumbnail for the series.
    - `caption_color` union
      - 'transparent'
      - string
      - string[]
    - `caption_stroke_color` string
    - `caption_stroke_width` number
    - `caption_alignment` 'top-left' | 'top-center' | 'top-right' | 'middle-left' | 'middle-center' | 'middle-right' | 'bottom-left' | 'bottom-center' | 'bottom-right'
    - `caption_font_family` string
    - `caption_font_size` number
    - `caption_text_transform` 'lowercase' | 'none' | 'uppercase'
    - `text` string, nullable, required
    - `theme` 'None' | 'Photo' | 'TikTokTint' | 'TikTokGlitch', required
    - `media` union, required
      - object
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` unknown
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'Image', required
        - `category` 'Stock', required
        - `state` 'completed', required
        - `source` 'Google', required
        - `data` object, required
          - `kind` string, required
          - `title` string, required
          - `html_title` string, required
          - `link` string, required
          - `display_link` string, required
          - `snippet` string, required
          - `html_snippet` string, required
          - `mime` string, required
          - `file_format` string, required
          - `image` object, required
            - `context_link` string, required
            - `height` number, required
            - `width` number, required
            - `byte_size` number, required
            - `thumbnail_link` string, required
            - `thumbnail_height` number, required
            - `thumbnail_width` number, required
      - object
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` unknown
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'Image', required
        - `category` 'Stock', required
        - `state` 'completed', required
        - `source` 'Pexels', required
        - `data` object, required
          - `id` number, required
          - `width` number, required
          - `height` number, required
          - `url` string, required
          - `alt` string, nullable, required
          - `avg_color` string, nullable, required
          - `photographer` string, required
          - `photographer_url` string, required
          - `photographer_id` number, required
          - `liked` boolean, required
          - `src` object, required
            - `original` string, required
            - `large2x` string, required
            - `large` string, required
            - `medium` string, required
            - `small` string, required
            - `portrait` string, required
            - `landscape` string, required
            - `tiny` string, required
      - object
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` unknown
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'Video', required
        - `category` 'Stock', required
        - `state` 'completed', required
        - `source` 'Pexels', required
        - `data` object, required
          - `id` number, required
          - `width` number, required
          - `height` number, required
          - `url` string, required
          - `image` string, required
          - `full_res` string, nullable, required
          - `tags` string[], required
          - `duration` number, required
          - `user` object, required
            - `id` number, required
            - `name` string, required
            - `url` string, required
          - `video_files` object[], required
            - `id` number, required
            - `quality` 'hd' | 'sd' | 'uhd' | 'null', nullable, required
            - `file_type` string, required
            - `width` number, nullable, required
            - `height` number, nullable, required
            - `link` string, required
            - `fps` number, nullable, required
          - `video_pictures` object[], required
            - `id` number, required
            - `picture` string, required
            - `nr` number, required
      - object
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` unknown
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'Image', required
        - `category` 'Stock', required
        - `state` 'completed', required
        - `source` 'Pixabay', required
        - `data` object, required
          - `id` number, required
          - `tags` string
          - `page_u_r_l` string, required
          - `preview_u_r_l` string, required
          - `webformat_u_r_l` string, required
          - `large_image_u_r_l` string, required
          - `views` number, required
          - `downloads` number, required
          - `likes` number, required
          - `comments` number, required
          - `user_id` number, required
          - `user` string, required
          - `user_image_u_r_l` string, required
          - `full_h_d_u_r_l` string
          - `image_u_r_l` string
          - `vector_u_r_l` string
      - object
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` unknown
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'Video', required
        - `category` 'Stock', required
        - `state` 'completed', required
        - `source` 'Pixabay', required
        - `data` object, required
          - `id` number, required
          - `page_u_r_l` string, required
          - `videos` object, required
            - `large` object, required
              - …
            - `medium` object, required
              - …
            - `small` object, required
              - …
            - `tiny` object, required
              - …
          - `tags` string
          - `duration` number
          - `views` number, required
          - `downloads` number, required
          - `likes` number, required
          - `comments` number, required
          - `user_id` number, required
          - `user` string, required
          - `user_image_u_r_l` string, required
      - object
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` unknown
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'Image', required
        - `category` 'Stock', required
        - `state` 'completed', required
        - `source` 'Unsplash', required
        - `data` object, required
          - `id` string, required
          - `created_at` string, required
          - `updated_at` string, required
          - `urls` object, required
            - `full` string, required
            - `raw` string, required
            - `regular` string, required
            - `small` string, required
            - `thumb` string, required
          - `alt_description` string, nullable, required
          - `blur_hash` string, nullable, required
          - `color` string, nullable, required
          - `description` string, nullable, required
          - `height` number, required
          - `likes` number, required
          - `links` object, required
            - `self` string, required
            - `html` string, required
            - `download` string, required
            - `download_location` string, required
          - `promoted_at` string, nullable, required
          - `width` number, required
          - `user` object, required
            - `id` string, required
            - `bio` string, nullable, required
            - `first_name` string, required
            - `instagram_username` string, nullable, required
            - `last_name` string, nullable, required
            - `links` object, required
              - …
            - `location` string, nullable, required
            - `name` string, required
            - `portfolio_url` string, nullable, required
            - `profile_image` object, required
              - …
            - `total_collections` number, required
            - `total_likes` number, required
            - `total_photos` number, required
            - `twitter_username` string, nullable, required
            - `updated_at` string, required
            - `username` string, required
      - object
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` unknown
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'Image', required
        - `category` 'Stock', required
        - `state` 'completed', required
        - `source` 'Wikimedia', required
        - `data` object, required
          - `pageid` number, required
          - `ns` number, required
          - `title` string, required
          - `index` number, required
          - `imagerepository` string, required
          - `imageinfo` object[], required
            - `url` string, uri, required
            - `descriptionurl` string, uri, required
            - `descriptionshorturl` string, uri, required
            - `mime` string
      - object
        - `id` string, uuid, required
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `prompt` string, required
          - `translated_prompt` string, nullable
          - `rephrased_prompt` string, nullable
          - `image_style_preset_id` string, uuid, nullable
          - `image_style_custom_prompt` string, nullable
          - `aspect_ratio` string, nullable
          - `width` number, nullable
          - `height` number, nullable
          - `cloned_media_id` string, uuid, nullable
          - `from_system_media` boolean, nullable
          - `original_image_url` string, nullable
          - `quality` 'low' | 'medium' | 'high' | 'null', nullable
          - `animation_model` string, nullable
          - `animation_prompt` string, nullable
          - `product_id` string, uuid, nullable
          - `model_params` object, nullable
          - `preset_id` string, nullable
          - `variant_id` string, nullable
          - `category_id` string, nullable
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'GeneratedImage' | 'GeneratedImagePreset', required
        - `source` string, nullable, required
        - `category` union, required
          - 'AIGenerated'
          - 'ImageAd'
        - `state` 'pending' | 'generating' | 'completed' | 'error' | 'request_smart_motion' | 'placeholder', required
        - `data` object, nullable, required
          - `path` string, nullable
          - `results` object
          - `result` string, nullable
          - `artifacts` object[]
            - `seed` number
            - `finish_reason` string
          - `result_image_url` string, nullable
          - `watermarked_image_url` string, nullable
          - `has_watermark` boolean, nullable
      - object
        - `id` string, uuid, required
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `source_image_url` string, nullable
          - `source_image_metadata` object, nullable
          - `source_image_data` object, nullable
          - `parent_media_id` string, nullable
          - `animation_prompt` string, nullable
          - `animation_model` string, nullable
          - `image_style_preset_id` string, uuid, nullable
          - `image_style_custom_prompt` string, nullable
          - `mux_playback_id` string, nullable
          - `model_params` object, nullable
          - `duration_in_seconds` number, nullable
          - `preset_id` string, nullable
          - `variant_id` string, nullable
          - `category_id` string, nullable
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'GeneratedVideo' | 'GeneratedVideoPreset' | 'GeneratedVideoFromCloning', required
        - `source` string, nullable, required
        - `category` 'AIGenerated', required
        - `state` 'pending' | 'generating' | 'completed' | 'error' | 'request_smart_motion', required
        - `data` object, nullable, required
          - `path` string, nullable
          - `result` object, nullable
            - `video` object, required
              - …
          - `result_video_url` string, nullable
          - `watermarked_video_url` string, nullable
          - `has_watermark` boolean, nullable
      - object
        - `id` string, uuid, required
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `prompt` string, required
          - `source_image_url` string, nullable
          - `parent_media_id` string, nullable
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'LumaGeneratedVideo', required
        - `source` 'luma-ai' | 'null', nullable, required
        - `category` 'AIGenerated', required
        - `state` 'pending' | 'generating' | 'completed' | 'error', required
        - `data` object, nullable, required
          - `luma_id` string, nullable
      - object
        - `id` string, uuid, required
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `content_type` string, nullable
          - `preset_id` string, nullable
          - `variant_id` string, nullable
          - `category_id` string, nullable
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `source` 'Upload' | 'ImagePicker', required
        - `category` union, required
          - 'UserUploaded'
          - 'UserUploadedAd'
        - `state` 'uploading' | 'error' | 'completed' | 'request_smart_motion', required
        - `type` 'UserImage' | 'UserImagePreset', required
        - `data` object, required
          - `upload_id` string, required
          - `key` string, required
          - `alt` string, nullable, required
          - `uploaded_at` string, nullable, required
      - object
        - `id` string, uuid, required
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `content_type` string, nullable
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `source` 'Upload' | 'ImagePicker', required
        - `category` union, required
          - 'UserUploaded'
          - 'UserUploadedAd'
        - `state` 'uploading' | 'error' | 'completed' | 'request_smart_motion', required
        - `type` 'UserVideo', required
        - `data` object, required
          - `upload_id` string, required
          - `key` string, required
          - `alt` string, nullable, required
          - `uploaded_at` string, nullable, required
      - object
        - `id` string, uuid, required
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `content_type` string, nullable
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `source` 'Upload' | 'ImagePicker', required
        - `category` union, required
          - 'UserUploaded'
          - 'UserUploadedAd'
        - `state` 'uploading' | 'error' | 'completed' | 'request_smart_motion', required
        - `type` 'UserAudio', required
        - `data` object, required
          - `upload_id` string, required
          - `key` string, required
          - `alt` string, nullable, required
          - `uploaded_at` string, nullable, required
          - `name` string, nullable
      - object
        - `id` string, uuid, required
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `content_type` string, nullable
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `source` 'Upload' | 'ImagePicker', required
        - `category` 'UserUploaded', required
        - `type` 'UserImageSegmentation', required
        - `data` object, required
          - `source_media` object, required
            - `id` string, uuid, required
            - `url` string, nullable, required
          - `results` object
            - `image` object, required
              - …
            - `mask_image` object, nullable
              - …
        - `state` 'pending' | 'generating' | 'error' | 'completed', required
      - object
        - `id` string, uuid, required
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `content_type` string, nullable
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `source` 'Upload' | 'ImagePicker', required
        - `category` union, required
          - 'UserUploaded'
          - 'UserUploadedAd'
          - 'Stock'
        - `state` 'uploading' | 'error' | 'completed' | 'request_smart_motion', required
        - `type` 'UserImageFromPicker', required
        - `data` object, required
          - `source_image` unknown
      - object
        - `id` string, uuid, required
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `source_media` unknown
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'Segmentation', required
        - `source` 'GeneratedImage' | 'GeneratedImagePreset' | 'Image' | 'UserImage', required
        - `category` 'AIGenerated' | 'Stock', required
        - `data` object, required
          - `url` string, nullable
          - `path` string, nullable
          - `data` object, nullable
            - `width` number, required
            - `height` number, required
          - `results` object
            - `image` object, required
              - …
            - `mask_image` object, nullable
              - …
        - `state` 'pending' | 'generating' | 'completed' | 'error', required
      - object
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `mux_playback_id` string, nullable, required
          - `start_time` number, nullable, required
          - `end_time` number, nullable, required
          - `duration_till_end` number, nullable, required
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'VideoClip', required
        - `source` 'Gameplay' | 'null', nullable, required
        - `category` 'Gameplay', required
        - `state` 'completed', required
        - `data` object, required
          - `id` string, required
          - `collection_id` string, required
      - object
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` unknown
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'UgcCreator', required
        - `source` 'Ugc' | 'null', nullable, required
        - `category` 'Ugc', required
        - `data` object, required
          - `id` string, required
          - `hook` string, nullable
        - `state` 'completed', required
      - object
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `source_image_url` string, required
          - `mux_playback_id` string, nullable, required
          - `narrating_text` string, nullable
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'UgcVideo', required
        - `source` 'Ugc' | 'null', nullable, required
        - `category` 'Ugc', required
        - `data` object, required
          - `id` string, required
          - `ugc_creator_id` string, required
          - `ugc_preset_id` string, required
          - `created_at` string, required
          - `hook` string, nullable
        - `state` 'pending' | 'generating' | 'completed' | 'error', required
      - object
        - `id` string, uuid, required
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `asset_id` string, required
          - `asset_version_id` string, required
          - `asset_render_id` string, required
          - `aspect_ratio` 'Portrait 9:16' | 'Landscape 16:9' | 'Square 1:1' | 'null', nullable
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'Block', required
        - `source` 'Block', required
        - `category` 'Asset', required
        - `state` 'pending' | 'generating' | 'completed' | 'error', required
        - `data` object, required
          - `thumbnail_url` string, nullable
          - `mux_playback_id` string, nullable
          - `duration` number, nullable
      - object
        - `id` string, uuid, required
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `asset_id` string, required
          - `asset_version_id` string, required
          - `asset_render_id` string, required
          - `aspect_ratio` string, nullable
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'Graphic', required
        - `source` 'Graphic', required
        - `category` 'Asset', required
        - `state` 'pending' | 'generating' | 'completed' | 'error', required
        - `data` object, required
      - object
        - `id` string, uuid, required
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `element_id` string, required
          - `element_category` 'backgrounds' | 'animations' | 'components' | 'text-animations', required
          - `aspect_ratio` 'square' | '9:16' | '16:9', required
          - `props` object, nullable, required
          - `configuration_settings` object, nullable, required
          - `render_dimensions` object, nullable, required
            - `width` number, required
            - `height` number, required
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'Element', required
        - `source` 'Element', required
        - `category` 'Background' | 'Animation' | 'Component' | 'TextAnimation', required
        - `state` 'pending' | 'generating' | 'completed' | 'error', required
        - `data` object, required
          - `thumbnail_url` string, nullable
          - `duration` number, nullable
          - `render_job_id` string, nullable
      - object
        - `id` string, uuid, required
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `content_type` string, nullable
          - `brand_domain` string, required
          - `asset_type` string, required
          - `width` number, nullable
          - `height` number, nullable
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'BrandImage', required
        - `source` 'BrandFetch', required
        - `category` 'Brand', required
        - `state` 'completed' | 'error', required
        - `data` object, required
          - `original_url` string
          - `asset_key` string, required
          - `uploaded_at` string, required
          - `image_format` 'png' | 'jpg' | 'jpeg' | 'webp'
      - object
        - `id` string, uuid, required
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `ad_id` string, required
          - `ad_name` string, nullable
          - `creative_id` string, required
          - `page_id` string, nullable
          - `instagram_user_id` string, nullable
          - `link` string, nullable
          - `image_hash` string, nullable
          - `call_to_action_type` string, nullable
          - `image_url` string, nullable
          - `thumbnail_url` string, nullable
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'MetaAd', required
        - `source` 'Meta', required
        - `category` 'Ad', required
        - `state` 'completed', required
      - object
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `text` string, nullable
          - `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' | 'null', nullable
          - `voice` object, nullable
            - `id` string, required
            - `owner_id` string, nullable
            - `name` string, required
            - `description` string, nullable, required
            - `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' | 'null', nullable, required
            - `avatar` string, nullable
            - `flag` string, nullable
            - `preview_url` string, nullable, required
            - `usage_character_count7d` number, nullable
            - `usage_character_count1y` number, nullable
            - `tags` object, nullable, required
              - …
            - `source` 'Cartesia' | 'CartesiaClonedVoice' | 'ElevenLabs' | 'ElevenLabsShared' | 'FishAudio' | 'FishAudioClonedVoice' | 'OpenAI', required
          - `voice_id` string, nullable
          - `owner_id` string, nullable
          - `prompt` string, nullable
          - `duration_ms` number, nullable
          - `composition_plan` unknown
          - `generation_type` 'prompt' | 'compositionPlan' | 'null', nullable
          - `asset_id` string, uuid, nullable
          - `song_metadata` object, nullable
            - `title` string, nullable
            - `description` string, nullable
            - `genres` string[], nullable
            - `languages` string[], nullable
            - `is_explicit` boolean, nullable
          - `background_image_url` string, nullable
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'GeneratedAudio', required
        - `source` 'Cartesia' | 'CartesiaClonedVoice' | 'ElevenLabs' | 'ElevenLabsShared' | 'FishAudio' | 'FishAudioClonedVoice' | 'OpenAI', required
        - `category` 'AIGeneratedAudio' | 'AIGeneratedAudioForVideo' | 'AIGeneratedMusic', required
        - `state` 'pending' | 'generating' | 'completed' | 'error', required
        - `transcript` object, nullable
          - `words` object[], required
            - `text` string, required
            - `start` number, required
            - `end` number, required
            - `confidence` number
        - `data` object, nullable, required
          - `path` string, nullable
          - `transcript_state` 'pending' | 'generating' | 'completed' | 'error' | 'null', nullable
          - `duration` number, nullable
          - `lufs` number, nullable
          - `lufs_output` string, nullable
      - object
        - `id` string, uuid, required
        - `url` string, nullable, required
        - `deleted_at` string, nullable
        - `metadata` object, required
          - `element_id` string, required
          - `element_category` 'backgrounds' | 'animations' | 'components' | 'text-animations', required
          - `aspect_ratio` 'square' | '9:16' | '16:9', required
          - `props` object, nullable, required
          - `configuration_settings` object, nullable, required
          - `render_dimensions` object, nullable, required
            - `width` number, required
            - `height` number, required
        - `last_error` string, nullable
        - `associated_product_id` string, nullable
        - `type` 'Element', required
        - `source` 'Element', required
        - `category` 'Background' | 'Animation' | 'Component' | 'TextAnimation', required
        - `state` 'pending' | 'generating' | 'completed' | 'error', required
        - `data` object, required
          - `thumbnail_url` string, nullable
          - `duration` number, nullable
          - `render_job_id` string, nullable
  - `styles` object, nullable, required: Styles for the series videos.
    - `caption_active_word_background_color` union
      - 'transparent'
      - string
      - string[]
    - `caption_active_word_color` union
      - 'transparent'
      - string
      - string[]
    - `caption_active_word_stroke_width` number
    - `caption_active_word_stroke_color` string
    - `caption_alignment` 'top-left' | 'top-center' | 'top-right' | 'middle-left' | 'middle-center' | 'middle-right' | 'bottom-left' | 'bottom-center' | 'bottom-right'
    - `caption_animation` 'ZoomIn'
    - `caption_background_color` union
      - 'transparent'
      - string
      - string[]
    - `caption_background_disabled` boolean
    - `caption_color` union
      - 'transparent'
      - string
      - string[]
    - `caption_display` 'karaoke' | 'phrase' | 'word' | 'none'
    - `caption_font_family` string
    - `caption_font_size` number
    - `caption_keyword_color` union
      - 'transparent'
      - string
      - string[]
    - `caption_rotate_occasionally` boolean
    - `caption_stroke_width` number
    - `caption_stroke_color` string
    - `caption_text_transform` 'lowercase' | 'none' | 'uppercase'
  - `image_style` object, nullable, required: Image style for series. Null if no image style is configured.
    - `id` string, uuid: Unique ID of the current image style.
    - `recommendations` object[]
      - `id` string, uuid, required: Unique ID of the recommended image style.
      - `reason` string, required: Reason for the recommended image style.
  - `voice` object, nullable, required: Voice configuration for the series. Null if no voice is configured.
    - `voices` Voice[], required: Voices for the series.
      - `id` string, required: Unique ID of the voice.
      - `name` string, required: Name of the voice.
      - `description` string, nullable, required: Description of the voice.
      - `avatar_url` string, nullable: Avatar url of the voice.
      - `flag_url` string, nullable: Flag url of the voice.
      - `tags` object, nullable, required: Tags of the voice. Describe the characteristics of the voice.
        - `language` string, nullable
        - `accent` string, nullable
        - `age` string, nullable
        - `category` string, nullable
        - `gender` string, nullable
        - `tone` string, nullable
        - `useCase` string, nullable
      - `preview_url` string, nullable, required: URL of the preview audio of the voice.
      - `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' | 'null', nullable, required: Locale of the voice.
      - `source` 'Cartesia' | 'CartesiaClonedVoice' | 'ElevenLabs' | 'ElevenLabsShared' | 'FishAudio' | 'FishAudioClonedVoice' | 'OpenAI', required: Source of the voice.
    - `playback_rate` number, required: Voice playback rate.
    - `volume` number, required: Voice volume.
  - `custom_watermark` object, nullable: Custom watermark for the series (paid plans only).
    - `caption_color` union
      - 'transparent'
      - string
      - string[]
    - `caption_stroke_color` string
    - `caption_stroke_width` number
    - `caption_alignment` 'top-left' | 'top-center' | 'top-right' | 'middle-left' | 'middle-center' | 'middle-right' | 'bottom-left' | 'bottom-center' | 'bottom-right'
    - `caption_font_family` string
    - `caption_font_size` number
    - `caption_text_transform` 'lowercase' | 'none' | 'uppercase'
    - `text` string, required
  - `connections` Connection[], required: Publishing connections for the series.
    - `id` string, uuid, required: Unique ID for the connection.
    - `type` 'Email' | 'TikTok' | 'YouTube' | 'X' | 'Facebook' | 'Instagram', required: The publishing destination.
    - `name` string, nullable: User-friendly name for the connection.
  - `hashtags` string, nullable: List of custom hashtags for the series.

## Other responses

- `400`: Invalid request

---

[API](https://skmtc.dev/shortgenius/apis/shortgenius-api.md) · [All operations](https://skmtc.dev/shortgenius/apis/shortgenius-api/llms.txt) · [OpenAPI document](https://skmtc.dev/shortgenius/apis/shortgenius-api/revisions/532abda8ff32?raw)