@golpoai/sdk 0.1.9 → 1.0.0

package/dist/index.d.cts

@@ -1,36 +1,57 @@
+interface CreateVideoRecordOptions {
+    topic: string;
+    userEmail?: string;
+    context?: string;
+    scenes?: number;
+    pipeline?: string;
+    shareDocuments?: boolean;
+    logoPlacement?: string;
+    audioClipUrl?: string;
+    requestPayload?: any;
+    videoId?: string;
+}
 interface CreatePodcastOptions {
     uploads?: string | Iterable<string>;
-    addMusic?: boolean;
     voiceInstructions?: string;
-    personality1?: string;
-    personality2?: string;
-    doResearch?: boolean;
-    ttsModel?: 'accurate' | 'fast';
     language?: string;
-    style?: 'conversational' | 'solo-male' | 'solo-female';
-    bgMusic?: 'jazz' | 'lofi' | 'dramatic' | null;
-    outputVolume?: number;
+    style?: 'solo-male-4' | 'solo-female-4' | 'solo-male-3' | 'solo-female-3';
+    bgMusic?: 'jazz' | 'lofi' | 'dramatic' | 'whimsical' | 'engaging' | 'hyper' | 'inspirational' | 'documentary' | null;
     pollIntervalMs?: number;
-    concurrency?: number;
-    no_voice_chunking?: boolean;
+    newScript?: string;
+    timing?: 0.25 | 0.5 | 1 | 2 | 4 | 8 | 10;
 }
 interface CreateVideoOptions {
     uploads?: string | Iterable<string>;
     voiceInstructions?: string;
-    personality1?: string;
-    doResearch?: boolean;
-    ttsModel?: 'accurate' | 'fast';
     language?: string;
-    style?: 'solo-male' | 'solo-female';
-    bgMusic?: 'engaging' | 'lofi' | null;
-    bgVolume?: number;
-    outputVolume?: number;
+    style?: 'solo-male-3' | 'solo-female-3' | 'solo-male-4' | 'solo-female-4';
+    bgMusic?: 'jazz' | 'lofi' | 'dramatic' | 'whimsical' | 'engaging' | 'hyper' | 'inspirational' | 'documentary' | null;
     videoType?: 'short' | 'long';
     includeWatermark?: boolean;
     logo?: string;
-    timing?: '1' | '2';
+    timing?: 0.25 | 0.5 | 1 | 2 | 4 | 8 | 10;
     pollIntervalMs?: number;
-    concurrency?: number;
+    useColor?: boolean;
+    newScript?: string;
+    logoPlacement?: string;
+    videoInstructions?: string;
+    useLineart2Style?: string;
+    audioClip?: string | string[];
+    isPublic?: boolean;
+    useAsIs?: string | boolean[];
+    skipAnimation?: string | boolean[];
+    userImages?: string | string[];
+    userImagesDescriptions?: string | string[];
+    userVideos?: string | string[];
+    userVideosDescription?: string | string[];
+    userAudioInVideo?: string;
+    use2Style?: boolean;
+    imageStyle?: 'neon' | 'whiteboard' | 'modern_minimal' | 'playful' | 'technical' | 'editorial';
+    inputImages?: string | string[];
+    penStyle?: 'stylus' | 'marker' | 'pen';
+    showPencilCursor?: boolean;
+    pacing?: 'normal' | 'fast';
+    justReturnScript?: boolean;
 }
 interface EditVideoOptions {
     frameIds: string[];
@@ -41,11 +62,35 @@ interface EditVideoOptions {
     pollIntervalMs?: number;
     autoCombine?: boolean;
 }
+interface FrameAnimations {
+    [frameId: string]: string;
+}
 interface CombineVideosOptions {
     mp4Urls: string[];
     videoUrl?: string;
     pollIntervalMs?: number;
 }
+/**
+ * Result of createPodcast or createVideo (generated content URL, script, and job ID).
+ */
+interface GenerationResult {
+    url: string;
+    script: string;
+    videoId: string;
+}
+/**
+ * Result of editVideo (edited or combined video URL and job ID).
+ */
+interface VideoEditResult {
+    videoUrl: string;
+    jobId: string;
+}
+/**
+ * Result of combineVideos (URL of the combined video).
+ */
+interface CombinedVideoResult {
+    url: string;
+}
 declare class Golpo {
     private readonly http;
     constructor(apiKey: string, baseUrl?: string);
@@ -57,23 +102,20 @@ declare class Golpo {
         podcastUrl: string;
         podcastScript: string;
     }>;
-    createPodcast(prompt: string, opts?: CreatePodcastOptions): Promise<{
-        podcastUrl: string;
-        podcastScript: string;
-    }>;
-    createVideo(prompt: string, opts?: CreateVideoOptions): Promise<{
-        videoUrl: string;
-        videoScript: string;
-    }>;
+    createPodcast(prompt: string, opts?: CreatePodcastOptions): Promise<GenerationResult>;
+    createVideo(prompt: string, opts?: CreateVideoOptions): Promise<GenerationResult>;
+    /**
+     * Private helper: Get user email from API key
+     * Backend resolves: api_key -> user_id -> user_credits.email
+     */
+    private getUserEmailFromApiKey;
+    private createVideoRecord;
     /**
      * Edit specific frames of a video and regenerate the video.
      * This method polls until completion and returns the final edited video URL.
      * If autoCombine is true, it will also combine all frames into a final video.
      */
-    editVideo(videoId: string, opts: EditVideoOptions): Promise<{
-        videoUrl: string;
-        jobId: string;
-    }>;
+    editVideo(videoId: string, opts: EditVideoOptions): Promise<VideoEditResult>;
     /**
      * Combines edited frames into a final video with audio.
      * This is a helper method used by editVideo when autoCombine is enabled.
@@ -99,7 +141,7 @@ declare class Golpo {
      * Returns a dictionary mapping frame indices to animation URLs.
      * This is a convenience method that extracts frame_animations from getFrameVersions.
      */
-    private getFrameAnimations;
+    getFrameAnimations(videoId: string): Promise<FrameAnimations>;
     /**
      * Get frame versions and animations for a video.
      * Returns both the current frame_animations and available frame_animation_versions.
@@ -114,10 +156,15 @@ declare class Golpo {
      * Combine multiple MP4 videos into a single video.
      * This is used to combine frame animations into a final video.
      */
-    combineVideos(opts: CombineVideosOptions): Promise<string>;
+    combineVideos(opts: CombineVideosOptions): Promise<CombinedVideoResult>;
     private pollUntilComplete;
     private pollEditStatus;
+    /**
+     * Upload a file using /upload-url endpoint and return the final URL.
+     * Replicates the _presign_and_upload_one logic from the backend.
+     */
+    private uploadFileAndGetUrl;
     private createFormData;
 }
 
-export { type CombineVideosOptions, type CreatePodcastOptions, type CreateVideoOptions, type EditVideoOptions, Golpo, Golpo as default };
+export { type CombineVideosOptions, type CombinedVideoResult, type CreatePodcastOptions, type CreateVideoOptions, type CreateVideoRecordOptions, type EditVideoOptions, type GenerationResult, Golpo, type VideoEditResult, Golpo as default };

package/dist/index.d.ts

@@ -1,36 +1,57 @@
+interface CreateVideoRecordOptions {
+    topic: string;
+    userEmail?: string;
+    context?: string;
+    scenes?: number;
+    pipeline?: string;
+    shareDocuments?: boolean;
+    logoPlacement?: string;
+    audioClipUrl?: string;
+    requestPayload?: any;
+    videoId?: string;
+}
 interface CreatePodcastOptions {
     uploads?: string | Iterable<string>;
-    addMusic?: boolean;
     voiceInstructions?: string;
-    personality1?: string;
-    personality2?: string;
-    doResearch?: boolean;
-    ttsModel?: 'accurate' | 'fast';
     language?: string;
-    style?: 'conversational' | 'solo-male' | 'solo-female';
-    bgMusic?: 'jazz' | 'lofi' | 'dramatic' | null;
-    outputVolume?: number;
+    style?: 'solo-male-4' | 'solo-female-4' | 'solo-male-3' | 'solo-female-3';
+    bgMusic?: 'jazz' | 'lofi' | 'dramatic' | 'whimsical' | 'engaging' | 'hyper' | 'inspirational' | 'documentary' | null;
     pollIntervalMs?: number;
-    concurrency?: number;
-    no_voice_chunking?: boolean;
+    newScript?: string;
+    timing?: 0.25 | 0.5 | 1 | 2 | 4 | 8 | 10;
 }
 interface CreateVideoOptions {
     uploads?: string | Iterable<string>;
     voiceInstructions?: string;
-    personality1?: string;
-    doResearch?: boolean;
-    ttsModel?: 'accurate' | 'fast';
     language?: string;
-    style?: 'solo-male' | 'solo-female';
-    bgMusic?: 'engaging' | 'lofi' | null;
-    bgVolume?: number;
-    outputVolume?: number;
+    style?: 'solo-male-3' | 'solo-female-3' | 'solo-male-4' | 'solo-female-4';
+    bgMusic?: 'jazz' | 'lofi' | 'dramatic' | 'whimsical' | 'engaging' | 'hyper' | 'inspirational' | 'documentary' | null;
     videoType?: 'short' | 'long';
     includeWatermark?: boolean;
     logo?: string;
-    timing?: '1' | '2';
+    timing?: 0.25 | 0.5 | 1 | 2 | 4 | 8 | 10;
     pollIntervalMs?: number;
-    concurrency?: number;
+    useColor?: boolean;
+    newScript?: string;
+    logoPlacement?: string;
+    videoInstructions?: string;
+    useLineart2Style?: string;
+    audioClip?: string | string[];
+    isPublic?: boolean;
+    useAsIs?: string | boolean[];
+    skipAnimation?: string | boolean[];
+    userImages?: string | string[];
+    userImagesDescriptions?: string | string[];
+    userVideos?: string | string[];
+    userVideosDescription?: string | string[];
+    userAudioInVideo?: string;
+    use2Style?: boolean;
+    imageStyle?: 'neon' | 'whiteboard' | 'modern_minimal' | 'playful' | 'technical' | 'editorial';
+    inputImages?: string | string[];
+    penStyle?: 'stylus' | 'marker' | 'pen';
+    showPencilCursor?: boolean;
+    pacing?: 'normal' | 'fast';
+    justReturnScript?: boolean;
 }
 interface EditVideoOptions {
     frameIds: string[];
@@ -41,11 +62,35 @@ interface EditVideoOptions {
     pollIntervalMs?: number;
     autoCombine?: boolean;
 }
+interface FrameAnimations {
+    [frameId: string]: string;
+}
 interface CombineVideosOptions {
     mp4Urls: string[];
     videoUrl?: string;
     pollIntervalMs?: number;
 }
+/**
+ * Result of createPodcast or createVideo (generated content URL, script, and job ID).
+ */
+interface GenerationResult {
+    url: string;
+    script: string;
+    videoId: string;
+}
+/**
+ * Result of editVideo (edited or combined video URL and job ID).
+ */
+interface VideoEditResult {
+    videoUrl: string;
+    jobId: string;
+}
+/**
+ * Result of combineVideos (URL of the combined video).
+ */
+interface CombinedVideoResult {
+    url: string;
+}
 declare class Golpo {
     private readonly http;
     constructor(apiKey: string, baseUrl?: string);
@@ -57,23 +102,20 @@ declare class Golpo {
         podcastUrl: string;
         podcastScript: string;
     }>;
-    createPodcast(prompt: string, opts?: CreatePodcastOptions): Promise<{
-        podcastUrl: string;
-        podcastScript: string;
-    }>;
-    createVideo(prompt: string, opts?: CreateVideoOptions): Promise<{
-        videoUrl: string;
-        videoScript: string;
-    }>;
+    createPodcast(prompt: string, opts?: CreatePodcastOptions): Promise<GenerationResult>;
+    createVideo(prompt: string, opts?: CreateVideoOptions): Promise<GenerationResult>;
+    /**
+     * Private helper: Get user email from API key
+     * Backend resolves: api_key -> user_id -> user_credits.email
+     */
+    private getUserEmailFromApiKey;
+    private createVideoRecord;
     /**
      * Edit specific frames of a video and regenerate the video.
      * This method polls until completion and returns the final edited video URL.
      * If autoCombine is true, it will also combine all frames into a final video.
      */
-    editVideo(videoId: string, opts: EditVideoOptions): Promise<{
-        videoUrl: string;
-        jobId: string;
-    }>;
+    editVideo(videoId: string, opts: EditVideoOptions): Promise<VideoEditResult>;
     /**
      * Combines edited frames into a final video with audio.
      * This is a helper method used by editVideo when autoCombine is enabled.
@@ -99,7 +141,7 @@ declare class Golpo {
      * Returns a dictionary mapping frame indices to animation URLs.
      * This is a convenience method that extracts frame_animations from getFrameVersions.
      */
-    private getFrameAnimations;
+    getFrameAnimations(videoId: string): Promise<FrameAnimations>;
     /**
      * Get frame versions and animations for a video.
      * Returns both the current frame_animations and available frame_animation_versions.
@@ -114,10 +156,15 @@ declare class Golpo {
      * Combine multiple MP4 videos into a single video.
      * This is used to combine frame animations into a final video.
      */
-    combineVideos(opts: CombineVideosOptions): Promise<string>;
+    combineVideos(opts: CombineVideosOptions): Promise<CombinedVideoResult>;
     private pollUntilComplete;
     private pollEditStatus;
+    /**
+     * Upload a file using /upload-url endpoint and return the final URL.
+     * Replicates the _presign_and_upload_one logic from the backend.
+     */
+    private uploadFileAndGetUrl;
     private createFormData;
 }
 
-export { type CombineVideosOptions, type CreatePodcastOptions, type CreateVideoOptions, type EditVideoOptions, Golpo, Golpo as default };
+export { type CombineVideosOptions, type CombinedVideoResult, type CreatePodcastOptions, type CreateVideoOptions, type CreateVideoRecordOptions, type EditVideoOptions, type GenerationResult, Golpo, type VideoEditResult, Golpo as default };