samsar-js 0.48.21 → 0.48.23

package/README.md

@@ -161,9 +161,17 @@ const noSubtitles = await samsar.removeSubtitles(
   { webhookUrl: 'https://example.com/webhook' },
 );
 
+// Clone a session and add subtitle/transcript text overlays
+const withSubtitles = await samsar.addSubtitles(
+  {
+    videoSessionId: noSubtitles.data.session_id ?? noSubtitles.data.request_id!,
+  },
+  { webhookUrl: 'https://example.com/webhook' },
+);
+
 // Cancel an in-progress render
 const cancelled = await samsar.cancelRender({
-  videoSessionId: noSubtitles.data.session_id ?? noSubtitles.data.request_id!,
+  videoSessionId: withSubtitles.data.session_id ?? withSubtitles.data.request_id!,
 });
 console.log(cancelled.data.status, cancelled.data.cancelled);
 
@@ -331,15 +339,18 @@ const rollup = await samsar.enhanceAndGenerateRollupBanner({
 
 // Check status by request_id (defaults to /v1/status)
 const status = await samsar.getStatus(video.data.request_id);
+if (status.data.status === 'COMPLETED') {
+  console.log(status.data.result_url, status.data.has_subtitles, status.data.result_language);
+}
 
 // Fetch the latest render URL for a session (when available)
 const latest = await samsar.fetchLatestVideoVersion(video.data.session_id ?? video.data.request_id);
-console.log(latest.data.result_url ?? latest.data.status);
+console.log(latest.data.result_url ?? latest.data.status, latest.data.has_subtitles, latest.data.result_language);
 
 // List completed video sessions for this API key
 const completedSessions = await samsar.listCompletedVideoSessions();
 completedSessions.data.forEach((session) => {
-  console.log(session.session_id, session.langauge, session.result_url);
+  console.log(session.session_id, session.result_language ?? session.langauge, session.has_subtitles, session.result_url);
 });
 
 // Publish, edit, or revoke a completed session in the public publication feed (free endpoints)
@@ -505,7 +516,8 @@ Video model support notes:
 - `createVideoFromImageList` accepts either a provided outro (`outro_image_url`) or server-generated QR outro (`generate_outro_image: true` with `cta_url`). Do not combine the two modes in a single request.
 - `createVideoFromImageList` can render per-scene footer QR cards by setting `add_footer_animation: true` and providing one `footer_metadata` item per image scene.
 - `updateVideoOutroImage` accepts either a replacement outro image URL (`outro_image_url`, `outroImageUrl`, `new_outro_image_url`) or a generated QR CTA outro (`generate_outro_image: true` with `cta_url`, or just `cta_url` when no outro image URL is supplied). Generated outro updates reuse the existing session image layers for tiling and only queue frame/video regeneration.
-- Main video methods and external-user methods accept the same generated outro and footer parameters. The API can resolve either internal session ids or external `extreq_...` ids on repeated video routes, so client code can keep using `translateVideo`, `joinVideos`, `addVideoOutroImage`, and `updateVideoOutroImage`; the explicit external variants are available when you want to call `/external_users/*` directly. Do not strip the `extreq_` prefix.
+- Main video methods and external-user methods accept the same generated outro and footer parameters. The API can resolve either internal session ids or external `extreq_...` ids on repeated video routes, so client code can keep using `translateVideo`, `joinVideos`, `addSubtitles`, `removeSubtitles`, `addVideoOutroImage`, and `updateVideoOutroImage`; the explicit external variants are available when you want to call `/external_users/*` directly. Do not strip the `extreq_` prefix.
+- Completed video status, latest-version, and completed-session list responses expose `has_subtitles` and `result_language` when the session metadata is available.
 - `publishPublication`, `editPublication`, and `revokePublication` manage public feed publications for completed sessions through free `/publications/*` endpoints. They work with account API keys, customer sub-account API keys, and client auth tokens when the session belongs to the authenticated actor.
 - Image-list video pricing is per rendered second: `VEO3.1I2V` and `SEEDANCEI2V` are 75 credits/sec, `KLING3.0` is 50 credits/sec, and `RUNWAYML` is 25 credits/sec.
 

package/dist/index.d.ts

@@ -51,6 +51,8 @@ export interface CreateVideoFromTextInput {
     languageString?: string | null;
     enable_subtitles?: boolean;
     enableSubtitles?: boolean;
+    add_subtitles?: boolean;
+    addSubtitles?: boolean;
     session_id?: string;
     sessionId?: string;
     sessionID?: string;
@@ -141,6 +143,8 @@ export interface CreateVideoFromImageListInput {
     font?: FontOptions;
     enable_subtitles?: boolean;
     enableSubtitles?: boolean;
+    add_subtitles?: boolean;
+    addSubtitles?: boolean;
     session_id?: string;
     sessionId?: string;
     sessionID?: string;
@@ -339,6 +343,10 @@ export interface RemoveSubtitlesResponse {
     remainingCredits?: number | null;
     [key: string]: unknown;
 }
+export interface AddSubtitlesInput extends RemoveSubtitlesInput {
+}
+export interface AddSubtitlesResponse extends RemoveSubtitlesResponse {
+}
 export interface CancelRenderInput {
     videoSessionId?: string;
     video_session_id?: string;
@@ -362,6 +370,8 @@ export interface CancelRenderResponse {
 export interface FetchLatestVideoVersionResponse {
     session_id: string;
     result_url?: string;
+    has_subtitles?: boolean | null;
+    result_language?: string | null;
     status?: string;
     message?: string;
     [key: string]: unknown;
@@ -370,6 +380,8 @@ export interface CompletedVideoSession {
     session_id: string;
     langauge: string;
     language?: string;
+    result_language?: string;
+    has_subtitles?: boolean | null;
     result_url: string;
     [key: string]: unknown;
 }
@@ -1103,6 +1115,8 @@ export interface GlobalStatusResponse {
     type?: 'image' | 'video' | string;
     provider?: string | null;
     result_url?: string | null;
+    has_subtitles?: boolean | null;
+    result_language?: string | null;
     thumbnail_url?: string | null;
     result_urls?: string[];
     videoLink?: string | null;
@@ -1758,6 +1772,13 @@ export declare class SamsarClient {
     removeSubtitles(input: RemoveSubtitlesInput, options?: {
         webhookUrl?: string;
     } & SamsarRequestOptions): Promise<SamsarResult<RemoveSubtitlesResponse>>;
+    /**
+     * Add subtitle/transcript text overlays by cloning an existing session and re-running
+     * transcription + frame + video generation on the new session.
+     */
+    addSubtitles(input: AddSubtitlesInput, options?: {
+        webhookUrl?: string;
+    } & SamsarRequestOptions): Promise<SamsarResult<AddSubtitlesResponse>>;
     /**
      * Cancel an in-progress render for an existing video session.
      */
@@ -1791,11 +1812,13 @@ export declare class SamsarClient {
     } & SamsarRequestOptions): Promise<SamsarResult<ExternalRequestResponse>>;
     /**
      * Fetch the latest available render URL for a given video session id.
+     * Completed responses include result_url, has_subtitles, and result_language.
      * Maps to GET /video/fetch_latest_version?session_id={sessionId}.
      */
     fetchLatestVideoVersion(sessionId: string, options?: SamsarRequestOptions): Promise<SamsarResult<FetchLatestVideoVersionResponse>>;
     /**
      * List completed video sessions for the authenticated API key.
+     * Each item includes result_url plus session metadata such as has_subtitles and result_language.
      * Maps to GET /video/list_completed_video_sessions.
      */
     listCompletedVideoSessions(options?: SamsarRequestOptions & {
@@ -2001,6 +2024,7 @@ export declare class SamsarClient {
      * Retrieve the status of an asynchronous request by request_id.
      * Defaults to GET /status?request_id={requestId}, but the path can be overridden.
      * Normalizes the response to expose status/result_url for both image and video flows.
+     * Completed video responses can also include has_subtitles and result_language.
      */
     getStatus(requestId: string, options?: SamsarRequestOptions & {
         path?: string;

package/dist/index.js

@@ -791,6 +791,51 @@ export class SamsarClient {
         }
         return response;
     }
+    /**
+     * Add subtitle/transcript text overlays by cloning an existing session and re-running
+     * transcription + frame + video generation on the new session.
+     */
+    async addSubtitles(input, options) {
+        const raw = input;
+        const videoSessionId = raw.videoSessionId ??
+            raw.video_session_id ??
+            raw.videoSessionID ??
+            raw.session_id ??
+            raw.sessionId ??
+            raw.sessionID ??
+            raw.request_id ??
+            raw.requestId;
+        if (!videoSessionId) {
+            throw new Error('videoSessionId is required for addSubtitles');
+        }
+        const body = {
+            input: {
+                ...input,
+                videoSessionId: String(videoSessionId),
+            },
+            webhookUrl: options?.webhookUrl,
+        };
+        const response = await this.post('video/add_subtitles', body, options);
+        const data = response.data;
+        if (data && typeof data === 'object') {
+            const sessionId = typeof data.sessionID === 'string'
+                ? data.sessionID
+                : typeof data.session_id === 'string'
+                    ? data.session_id
+                    : typeof data.request_id === 'string'
+                        ? data.request_id
+                        : undefined;
+            const normalizedSessionId = sessionId ? String(sessionId) : undefined;
+            const normalizedData = {
+                ...data,
+                sessionID: data.sessionID ?? normalizedSessionId ?? '',
+                session_id: data.session_id ?? normalizedSessionId,
+                request_id: data.request_id ?? normalizedSessionId,
+            };
+            return { ...response, data: normalizedData };
+        }
+        return response;
+    }
     /**
      * Cancel an in-progress render for an existing video session.
      */
@@ -1033,6 +1078,7 @@ export class SamsarClient {
     }
     /**
      * Fetch the latest available render URL for a given video session id.
+     * Completed responses include result_url, has_subtitles, and result_language.
      * Maps to GET /video/fetch_latest_version?session_id={sessionId}.
      */
     async fetchLatestVideoVersion(sessionId, options) {
@@ -1050,6 +1096,7 @@ export class SamsarClient {
     }
     /**
      * List completed video sessions for the authenticated API key.
+     * Each item includes result_url plus session metadata such as has_subtitles and result_language.
      * Maps to GET /video/list_completed_video_sessions.
      */
     async listCompletedVideoSessions(options) {
@@ -1581,6 +1628,7 @@ export class SamsarClient {
      * Retrieve the status of an asynchronous request by request_id.
      * Defaults to GET /status?request_id={requestId}, but the path can be overridden.
      * Normalizes the response to expose status/result_url for both image and video flows.
+     * Completed video responses can also include has_subtitles and result_language.
      */
     async getStatus(requestId, options) {
         if (!requestId) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "samsar-js",
-  "version": "0.48.21",
+  "version": "0.48.23",
   "description": "TypeScript client for the Samsar Processor API routes.",
   "type": "module",
   "main": "dist/index.js",