@transcodely/sdk 0.3.9 → 0.3.11

package/CHANGELOG.md

@@ -4,6 +4,20 @@ All notable changes to the Transcodely JavaScript / TypeScript SDK will be docum
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Breaking changes are allowed on minor bumps until 1.0.0.
 
+## [0.3.11](https://github.com/transcodely/transcodely-js/compare/v0.3.10...v0.3.11) (2026-10-25)
+
+
+### Features
+
+* transcripts & insights surface (proto sync) ([#77](https://github.com/transcodely/transcodely-js/issues/77)) ([554a81f](https://github.com/transcodely/transcodely-js/commit/554a81f80d0360d81c7e5670c45b6c49ea57f2e1))
+
+## [0.3.10](https://github.com/transcodely/transcodely-js/compare/v0.3.9...v0.3.10) (2026-09-22)
+
+
+### Features
+
+* **proto:** per-title search curve — seed_crf, met_target, probes (api 5.23.0) ([#74](https://github.com/transcodely/transcodely-js/issues/74)) ([62deaf2](https://github.com/transcodely/transcodely-js/commit/62deaf2d94fd01af0982a93f5de8d85da04a87a3))
+
 ## [0.3.9](https://github.com/transcodely/transcodely-js/compare/v0.3.8...v0.3.9) (2026-09-15)
 
 

package/README.md

@@ -175,6 +175,19 @@ on its samples, and the CRF it chose. It describes the SEARCH, not the delivered
 file — `vmafAchieved` scores short samples taken before the real encode, which is
 never scored itself. It is `undefined` on every ordinary output.
 
+It also carries the whole curve the search measured: `seedCrf` (the CRF the
+rung would have used without per-title — compare it with `crfChosen` to see
+what changed), `metTarget` (whether the search reached `vmafTarget`; `false`
+means `crfChosen` is only the best-scoring point it measured), and `probes[]`
+(`OutputReportContentAwareProbe[]`, one entry per sample the search measured,
+in order — each with `crf`, `vmaf`, and `bitrateKbps`). Two probes' bitrates
+compare directly since every sample is the same cut of the source, so the
+ratio between the `seedCrf` probe and the `crfChosen` probe is the honest
+per-title saving on that sample. `bitrateKbps` is the sample's VIDEO-ONLY
+bitrate — the search's cuts drop audio, subtitles and data — so don't compare
+it to a delivered output's muxed `averageBitrateKbps`. All three fields are
+`undefined`/empty on reports from workers older than 1.29.0.
+
 ## AI captions
 
 Add auto-generated captions to any output with a `generate` subtitle track.
@@ -214,6 +227,56 @@ for (const fee of job.fees) {
 }
 ```
 
+## Transcripts and insights
+
+Every `generate` track also writes the transcript as `json`, `txt` and `md`.
+Ask for the opt-in insights pass (summary, key points, chapters, questions,
+terms, highlights) on the same track:
+
+```ts
+import { SubtitleOperation, TranscriptStyle, TranscriptFormat, InsightsStatus } from "@transcodely/sdk";
+
+await client.jobs.create({
+  inputVideoId: "vid_a1b2c3d4e5f6g7",
+  outputs: [{
+    subtitleTracks: [{
+      operation: SubtitleOperation.GENERATE,
+      transcript: { style: TranscriptStyle.CLEAN }, // default; LITERAL keeps fillers
+      insights: { enabled: true, hint: "conference talk for developers" },
+    }],
+  }],
+});
+
+// On a hosted video each rendition carries a short-lived signedUrl, re-issued
+// on every read, so fetch the video right before downloading.
+const video = await client.videos.get("vid_a1b2c3d4e5f6g7");
+const txt = video.textTracks
+  .flatMap((t) => t.transcriptRenditions)
+  .find((r) => r.format === TranscriptFormat.TXT);
+if (txt?.signedUrl) {
+  const transcript = await (await fetch(txt.signedUrl)).text();
+  console.log(transcript);
+}
+
+for (const ins of video.insights) {
+  if (ins.status === InsightsStatus.READY) {
+    console.log(ins.summary, ins.keyPoints);
+    for (const ch of ins.chapters) console.log(ch.startSeconds, ch.title);
+  }
+}
+
+// Ready-to-paste JSON-LD, video-sitemap entry and HTML fragment for your own page.
+const kit = await client.videos.getSeoMarkup({
+  videoId: "vid_a1b2c3d4e5f6g7",
+  watchUrl: "https://example.com/watch/42",
+});
+console.log(kit.jsonLd, kit.sitemapEntry, kit.htmlFragment);
+```
+
+Jobs carry the same data on `job.subtitleResults[i].transcriptRenditions` and
+`job.insights`. The `job.insights.ready` and `job.insights.failed` webhook events
+tell you when an insights pass finishes.
+
 ## Authentication
 
 Pass your API key in the constructor:
@@ -227,7 +290,7 @@ const client = new Transcodely({ apiKey: process.env.TRANSCODELY_API_KEY! });
 ```ts
 client.jobs            // create / get / list / cancel / confirm / watch
 client.uploads         // putFile — the whole create / PUT / complete upload, for a path, Blob or stream
-client.videos          // upload RPCs, multipart, createFromUrl, get / list / update / delete / watch / getStats / listTopVideos
+client.videos          // upload RPCs, multipart, createFromUrl, get / list / update / delete / watch / getStats / listTopVideos / getSeoMarkup
 client.presets         // create / get / getBySlug / list / update / duplicate / archive
 client.origins         // create / get / list / update / validate / archive
 client.ingestRules     // create / get / list / update / delete / listEvents / test / replayEvent