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

idstring uuid required

The unique ID of the video series to retrieve.

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.