@deepraxis/cli 0.2.1-dev.ea9c801 → 0.2.1-dev.fcdebee

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/COMMANDS.md +12 -4
  2. package/dist/praxis.js +541 -133
  3. package/package.json +1 -1
package/dist/praxis.js CHANGED
@@ -143,7 +143,7 @@ across all toolsets allowed.`
143
143
  type: "array",
144
144
  itemType: "object",
145
145
  required: false,
146
- description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time."
146
+ description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time."
147
147
  },
148
148
  {
149
149
  name: "kind",
@@ -9962,7 +9962,7 @@ Execution errors include error.details.prints containing output printed before f
9962
9962
  resource: "cut.projects.analysis",
9963
9963
  method: "create",
9964
9964
  summary: "Analyze project media",
9965
- description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible.",
9965
+ description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible. Silence measures transcript-based speech pauses, not music or loudness. A completed transcript without words returns ready with empty segments and reason no_speech; no completed transcript returns unsupported with reason no_transcript. A failed transcription remains failed.",
9966
9966
  http: "POST",
9967
9967
  path: "/cut/v1/projects/{project_id}/analysis",
9968
9968
  streaming: "no",
@@ -10133,6 +10133,18 @@ Execution errors include error.details.prints containing output printed before f
10133
10133
  body: {
10134
10134
  required: true,
10135
10135
  fields: [
10136
+ {
10137
+ name: "folder",
10138
+ type: "string",
10139
+ required: false,
10140
+ description: "Optional destination path within the bound media library; omitted uses its default folder."
10141
+ },
10142
+ {
10143
+ name: "name",
10144
+ type: "string",
10145
+ required: false,
10146
+ description: "Nonempty display name, frozen with the export. Path separators and control characters become hyphens; limited to 200 characters. Omitted uses project name and timestamp."
10147
+ },
10136
10148
  {
10137
10149
  name: "output",
10138
10150
  type: "object",
@@ -10150,6 +10162,12 @@ Execution errors include error.details.prints containing output printed before f
10150
10162
  type: "integer",
10151
10163
  required: false,
10152
10164
  description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write."
10165
+ },
10166
+ {
10167
+ name: "loudness",
10168
+ type: "object",
10169
+ required: false,
10170
+ description: "Optional loudness normalization target; normalization adds analysis and rendering work."
10153
10171
  }
10154
10172
  ]
10155
10173
  }
@@ -10158,7 +10176,7 @@ Execution errors include error.details.prints containing output printed before f
10158
10176
  resource: "cut.projects.frames",
10159
10177
  method: "list",
10160
10178
  summary: "Render preview frames",
10161
- description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. Decode its base64 payload to save the image. Codemode returns at most four images per call, so request at most four times when reviewing there.",
10179
+ description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution. The response always includes warnings; FRAME_UNAVAILABLE means a source preview could not be obtained and an offline tile was drawn. Its message identifies a timeout, delivery capacity limit, or unavailable source and contains no source URL. Decode each image's base64 payload to save it. Codemode returns at most four images per call, so request at most four times when reviewing there.",
10162
10180
  http: "GET",
10163
10181
  path: "/cut/v1/projects/{project_id}/frames",
10164
10182
  streaming: "no",
@@ -10181,7 +10199,7 @@ Execution errors include error.details.prints containing output printed before f
10181
10199
  name: "scale",
10182
10200
  type: "number",
10183
10201
  required: false,
10184
- description: "Positive image size multiplier; 0.5 renders at half the project dimensions."
10202
+ description: "Image size multiplier, default 0.25, greater than zero and at most 0.5. Larger values return INVALID_PARAMS; pixel-area limits may reduce actual dimensions, reported as width and height."
10185
10203
  },
10186
10204
  {
10187
10205
  name: "revision",
@@ -10373,88 +10391,7 @@ Execution errors include error.details.prints containing output printed before f
10373
10391
  resource: "cut.projects",
10374
10392
  method: "execute",
10375
10393
  summary: "Execute editing script",
10376
- description: `Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: \`const t = AddTrack("video"); Insert(t, {type: "color", color: "#123456", start: 0, length: 3}); Print(t);\`
10377
-
10378
- ### Script function reference
10379
-
10380
- Functions are synchronous globals; do not import them. \`project\` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. Reads see earlier writes in the same script.
10381
-
10382
- \`\`\`ts
10383
- GetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;
10384
- GetItem(id: ClipId): ItemView;
10385
- FindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];
10386
- GetMedia(ref: MediaRef): MediaInfo;
10387
- GetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];
10388
- GetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];
10389
- Insert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;
10390
- Update(id: ClipId, patch: ItemPatchView): void;
10391
- Delete(id: ClipId, o?: { ripple?: boolean }): void;
10392
- Split(id: ClipId, at: number): ClipId;
10393
- Trim(id: ClipId, edge: "in" | "out", delta: number, o?: { ripple?: boolean }): void;
10394
- Move(id: ClipId, start: number, track?: TrackId): void;
10395
- RippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;
10396
- AddTrack(kind: "video" | "audio" | "caption", init?: { name?: string }, index?: number): TrackId;
10397
- UpdateTrack(id: TrackId, patch: TrackPatch): void;
10398
- DeleteTrack(id: TrackId): void;
10399
- SetSettings(patch: Partial<ProjectSettingsView>): void;
10400
- AddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle>; maxChars?: number }): ClipId[];
10401
- SetMarker(at: number, label: string): string;
10402
- Print(...values: unknown[]): void;
10403
- Preview(at: number[]): void;
10404
- \`\`\`
10405
-
10406
- | Functions | Behavior and arguments |
10407
- | --- | --- |
10408
- | GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, sourceIn/sourceOut, text and offline reason. GetTimeline returns duration and tracks (id, kind, name, index, locked, items); from/to and tracks narrow the read. |
10409
- | FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |
10410
- | GetMedia | Read metadata for \`{libraryId, assetId}\` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |
10411
- | GetTranscript, GetAnalysis | Read available transcript words or silence/filler/scenes segments. Transcript filter from/to is seconds; returned word and segment from/to values are source microseconds (divide by 1,000,000 for editing). Words contain text and optional speaker/filler; segments may include label/confidence. Request analysis first if unavailable. |
10412
- | Insert, Update, Delete | Insert returns the new clip ID; Update changes supplied fields; Delete removes the clip. Optional ripple on Insert/Delete closes or opens space on the track. |
10413
- | Split, Trim, Move | Split at a timeline position and return the new right-hand clip ID. Trim changes the in or out edge by delta seconds. Move sets the timeline start and optionally a new track. |
10414
- | RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |
10415
- | AddTrack, UpdateTrack, DeleteTrack | Add video/audio/caption tracks; index selects layer order (0 is top). TrackPatch supports name, locked, hidden, muted, gainDb and style as appropriate to track kind. |
10416
- | SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |
10417
- | AddCaptionsFromTranscript | Create captions from an audio/video clip's kept words. Optional maxChars is 1–1000, default 16; style updates the caption track. Returns caption IDs. |
10418
- | SetMarker | Add a label at a timeline time and return its ID. |
10419
- | Print, Preview | Print appends text to prints. Preview requests up to eight times total per execute and puts images in the result's frames. Each url is an inline PNG data URL, not an HTTP image link. Decode the base64 payload to save an image. Codemode returns at most four images per call; request at most four times there. |
10420
-
10421
- #### Insert fields (ItemInit)
10422
-
10423
- Every item requires \`type\` and \`start\`. Times used for editing are seconds and snap to the project frame rate: start, length, sourceIn, fadeIn/fadeOut, transition length, keyframe at, reveal delay/stagger/duration. Keyframe and reveal times are relative to the clip start. Video/audio may omit length to use the remaining source duration; other types require length.
10424
-
10425
- | type | Required fields beyond type/start | Optional fields |
10426
- | --- | --- | --- |
10427
- | video | media | length, sourceIn, volumeDb, transform, fit, animate, transitionIn, transitionOut |
10428
- | image | media, length | transform, fit, animate, transitionIn, transitionOut |
10429
- | text | text, length | style, transform, reveal, animate, transitionIn, transitionOut |
10430
- | color | color, length | transform, fill, animate, transitionIn, transitionOut |
10431
- | shape | shape, length, width, height, fill | radius, stroke, transform, animate, transitionIn, transitionOut |
10432
- | audio | media | length, sourceIn, volumeDb, fadeIn, fadeOut, transitionIn, transitionOut |
10433
- | caption | text, length | — |
10434
-
10435
- Video tracks accept video/image/text/color/shape; audio and caption tracks accept their corresponding type. Media is \`{libraryId: string, assetId: string}\` from a bound library. sourceIn defaults to 0, volumeDb to 0 dB, audio fades to 0 seconds. fit defaults to contain: contain fits the whole image, cover fills and crops, fill stretches, none keeps native dimensions.
10436
-
10437
- | Field | Value |
10438
- | --- | --- |
10439
- | transform | Partial \`{x, y, scale, rotation, opacity, crop, blur}\`. x/y are normalized canvas center coordinates (default 0.5); scale 1 is fitted size; rotation is degrees (default 0); opacity is 0–1 (default 1). crop is \`{top,right,bottom,left}\`. blur is 0–100 pixels at 1080-pixel frame height. |
10440
- | style | Partial \`{fontFamily, fontSize, fontWeight, color, stroke, background, align, maxWidth}\`. fontFamily: Geist or Noto Sans SC (default); fontSize defaults to 48; fontWeight: 400 (default), 500 or 700; color defaults to #FFFFFF; align: left, center (default), right; maxWidth is a fraction of canvas width (default 0.9). stroke is \`{color,width}\`. Caption style additionally supports position (top/middle/bottom), margin (0–0.4 of canvas height), highlightColor and maxLines: 2. |
10441
- | animate | An object keyed by x, y, scale, rotation, opacity or blur. Each value is an array of \`{at: number, value: number, ease?: Ease}\` sorted by at with distinct frame-snapped times. Values hold before the first and after the last keyframe, overriding the static transform. |
10442
- | Ease | linear, in, out, inOut, \`{bezier: [x1,y1,x2,y2]}\` or \`{spring: {stiffness, damping, mass?}}\`. Easing shapes the segment arriving at that keyframe; springs may overshoot. |
10443
- | reveal | \`{by, delay?: number, stagger: number, duration: number, from: {y?, opacity?, scale?, blur?}, ease?: Ease}\`. by selects char, word or line. Unit k starts at delay + k * stagger and takes duration seconds to reach its resting state; from.y is a fraction of font size. |
10444
- | fill | A color string (#RRGGBB or #RRGGBBAA), \`{linear: {angle, stops: [{at,color}, ...]}}\` or \`{radial: {stops: [{at,color}, ...]}}\`. Stop positions are 0–1; angle is degrees, 0 left to right. On color clips, fill replaces color when supplied. |
10445
- | shape, width, height, radius, stroke | shape is rect or ellipse. width/height are fractions of canvas width/height before scaling. radius rounds rect corners in pixels at 1080-pixel frame height. stroke is \`{color: string, width: number}\`. |
10446
- | transitionIn, transitionOut | \`{kind, length: number}\` at the clip's beginning/end. length is seconds. fade changes opacity; dissolve blends; push_left/push_right move horizontally; wipe_left reveals horizontally. |
10447
-
10448
- #### Update fields (ItemPatchView)
10449
-
10450
- All fields are optional; use only fields relevant to the item's type. Supported fields: start, length, sourceIn, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, animate, reveal, fill, stroke, shape, width, height, radius, transitionIn, transitionOut. Values and units match Insert. Set animate, reveal, fill, stroke, transitionIn or transitionOut to null to remove that effect; omitting a field preserves it. For example: \`Update(id, {volumeDb: -12})\` or \`Update(id, {transitionIn: null})\`.
10451
-
10452
- #### Script names versus HTTP response names
10453
-
10454
- Use camelCase inside scripts, including nested objects. HTTP request/response JSON outside script source uses snake_case. Map media.library_id → media.libraryId, media.asset_id → media.assetId, source_in → sourceIn, volume_db → volumeDb, fade_in/fade_out → fadeIn/fadeOut, transition_in/transition_out → transitionIn/transitionOut, font_family/font_size/font_weight/max_width → fontFamily/fontSize/fontWeight/maxWidth, gain_db → gainDb, highlight_color/max_lines → highlightColor/maxLines. Fields such as animate, reveal, fill, stroke, at and length retain their spelling. GetTimeline/GetItem already return camelCase compact views; the expanded retrieveTimeline HTTP response is not an Insert object.
10455
-
10456
- Unrecognized script fields fail with OPS_REJECTED and rejection code UNKNOWN_FIELD; snake_case mistakes suggest the corresponding camelCase name. The error message lists each rejection's #opIndex, code and reason. Correct the named fields and retry the saved edit; do not assume an ignored field applied an effect.
10457
- `,
10394
+ description: 'Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: `const t = AddTrack("video"); Insert(t, {type: "color", color: "#123456", start: 0, length: 3}); Print(t);`\n\n### Script function reference\n\nFunctions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. JoinId is the string returned by Join or read from GetTimeline().joins. Reads see earlier writes in the same script.\n\n```ts\nGetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;\nGetItem(id: ClipId): ItemView;\nFindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];\nGetMedia(ref: MediaRef): MediaInfo;\nGetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];\nGetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];\nListTransitions(): TransitionInfo[];\nListEffects(): EffectInfo[];\nListTextStyles(): TextStylePreset[];\nListTextTemplates(): TextTemplate[];\nListAnimations(): { id: string; version: number; phase: "in" | "out" | "loop"; target: "any" | "text"; name: string; description: string; defaultDuration: number; params: { name: string; type: string; values?: string[]; default?: string | number; min?: number; max?: number; description: string }[] }[];\nListFonts(): { family: string; weights: number[]; scripts: ("latin"|"cjk")[]; source: "bundled"|"catalog" }[];\nInsert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;\nUpdate(id: ClipId, patch: ItemPatchView): void;\nSetSpeed(id: ClipId, rate: number | { curve: { at: number; rate: number; ease?: Ease }[]; audio?: "mute" | "resample" }, o: { keep: "source" | "duration"; ripple?: boolean }): { length: number; sourceOut: number };\nDelete(id: ClipId, o?: { ripple?: boolean }): void;\nJoin(left: ClipId, right: ClipId, o: { length?: number; effect: TransitionInput }): JoinId;\nUpdateJoin(id: JoinId, patch: { length?: number; effect?: TransitionInput }): void;\nDeleteJoin(id: JoinId): void;\nSplit(id: ClipId, at: number): ClipId;\nTrim(id: ClipId, edge: "in" | "out", delta: number, o?: { ripple?: boolean }): void;\nMove(id: ClipId, start: number, track?: TrackId): void;\nRippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;\nAddTrack(kind: "video" | "audio" | "caption", init?: { name?: string; role?: "voice" | "music" | "sfx" }, index?: number): TrackId;\nUpdateTrack(id: TrackId, patch: TrackPatch): void;\nDeleteTrack(id: TrackId): void;\nSetSettings(patch: Partial<ProjectSettingsView>): void;\nAddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle> & { preset?: string }; maxChars?: number }): ClipId[];\nInsertTemplate(track: TrackId, o: { template: string; start: number; slots?: Record<string, string> }): ClipId[];\nAlignCaptions(trackId: TrackId, script: string): { replaced: number; added: number; deleted: number };\nSetMarker(at: number, label: string): string;\nPrint(...values: unknown[]): void;\nPreview(at: number[]): void;\n```\n\n| Functions | Behavior and arguments |\n| --- | --- |\n| GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, playback, sourceIn/sourceOut, text, effects, blend and offline reason. GetTimeline returns duration, tracks (id, kind, name, index, locked, items), and joins (id, track, left, right, length in seconds, normalized effect). from/to and tracks narrow the items and joins; joins are selected by their overlap window. |\n| ListEffects | Discover the shared visual-effect catalog with parameter types, ranges, defaults, cost and bounds. Effects are supported only on visual clips. |\n| ListTransitions | Discover the shared validation catalog: each entry contains kind (effect ID), name, description and params. Each parameter has name, type (enum/number/integer), default, description, enum values or numeric min/max. Use the returned kind and parameter names inside effect. |\n| ListAnimations | Discover animation presets. Each entry has id, version, phase (`in`, `out`, `loop`), target (`any`, `text`), name, description, defaultDuration (seconds), and params (name, type, values/default/min/max/description as applicable). A slot use is `{preset, duration?, ...params}`; duration is seconds. |\n| FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |\n| GetMedia | Read metadata for `{libraryId, assetId}` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |\n| GetTranscript, GetAnalysis | Read available transcript words or silence/filler/scenes segments. Transcript filter from/to is seconds; returned word and segment from/to values are source microseconds (divide by 1,000,000 for editing). Words contain text and optional speaker/filler; segments may include label/confidence. Request analysis first if unavailable. |\n| Insert, Update, Delete | Insert returns the new clip ID; Update changes supplied fields; Delete removes the clip. Optional ripple on Insert/Delete closes or opens space on the track. |\n| SetSpeed | Change video/audio rate in 0.25–4; keep is required. A `{curve: [{at, rate, ease?}, ...], audio?: "mute" | "resample"}` rate is forward-only and holds output duration fixed; pitch preservation is unavailable. Scalar rates: source preserves consumed source and changes length; duration preserves output length. Returns actual length and sourceOut in seconds. Optional ripple explicitly shifts same-track followers when keeping source; otherwise overlaps are rejected. |\n| Join, UpdateJoin, DeleteJoin | Join creates an overlap between two butt-adjacent visual clips on the same track and returns its ID. length defaults to 0.5 seconds; effect is required. The right clip and all same-track followers move left by length, shortening that track and potentially the project. UpdateJoin moves those followers by the difference in length; omitted fields are preserved. DeleteJoin moves them right to restore the butt cut. Other tracks stay in place. |\n| Split, Trim, Move | Split at a timeline position and return the new right-hand clip ID. Trim changes the in or out edge by delta seconds. Move sets the timeline start and optionally a new track. |\n| RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |\n| AddTrack, UpdateTrack, DeleteTrack | Add video/audio/caption tracks; index selects layer order (0 is top). TrackPatch supports name, locked, hidden, muted, gainDb, audio role (`voice`, `music`, `sfx`) and style as appropriate to track kind. |\n| SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |\n| AddCaptionsFromTranscript | Create captions from an audio/video clip\'s kept words. Optional maxChars is 1–1000, default 16; style updates the caption track. Returns caption IDs. |\n| SetMarker | Add a label at a timeline time and return its ID. |\n| Print, Preview | Print appends text to prints. Preview requests up to eight times total per execute and puts images in the result\'s frames. Each url is an inline PNG data URL, not an HTTP image link. Decode the base64 payload to save an image. Codemode returns at most four images per call; request at most four times there. |\n\n#### Joins between clips\n\nEndpoints may be video, image, text, color or shape; audio and caption are rejected. Require 0 < length < each endpoint\'s length. Each clip allows at most one incoming and one outgoing join; their summed lengths cannot exceed its length. Three-input overlaps, nonadjacent endpoints and cross-track joins are rejected with OPS_REJECTED. Read the rejection\'s code and message, shorten or remove conflicting joins, and retry the saved edit.\n\nTransitionInput is an object with kind plus the parameters returned by ListTransitions; omitted parameters use catalog defaults. Unknown kinds and invalid parameters return INVALID_TRANSITION_PARAM with available parameters. Effects: dissolve; dip color black/white default black; push and wipe direction left/right/up/down default left; wipe softness 0–1 default 0; iris centerX/centerY 0–1 default 0.5; blinds integer count 2–64 default 8 and orientation vertical/horizontal default vertical; blur radius 0–100 pixels at 1080-pixel frame height default 24; zoom direction in/out default in, amount 0.1–3 default 1, blur 0–1 default 0.5; clock direction clockwise/counterclockwise default clockwise, startAngle 0–360 degrees default 0 (twelve o\'clock), softness 0–1 default 0; flash color white/black default white, intensity 0–1 default 1. Zoom blur uses up to eight radial samples per shot and is slower on server rendering. Join options and UpdateJoin patches accept only length and effect. Effect updates replace the effect object and apply defaults for omitted parameters.\n\nMinimal example on an existing visual track with adjacent clips left and right: `Print(ListTransitions()); const j = Join(left, right, {length: 0.5, effect: {kind: "dissolve"}}); Print(GetTimeline().joins); Preview([GetItem(right).start + 0.25]);` Use `UpdateJoin(j, {length: 0.8})` to adjust it in a later edit or `DeleteJoin(j)` to restore the cut. Preview uses server-rendered frames and includes joins. Per-clip transitionIn/transitionOut remain separate entrance/exit effects.\n\n#### Insert fields (ItemInit)\n\nEvery item requires `type` and `start`. Times used for editing are seconds and snap to the project frame rate: start, length, sourceIn, fadeIn/fadeOut, transition length, keyframe at, reveal delay/stagger/duration. Keyframe and reveal times are relative to the clip start. Video/audio may omit length to use the remaining source duration; other types require length.\n\n| type | Required fields beyond type/start | Optional fields |\n| --- | --- | --- |\n| video | media | length, sourceIn, playback, volumeDb, transform, fit, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| image | media, length | transform, fit, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| text | text, length | style, transform, blend, reveal, animate, animation, effects, mask, transitionIn, transitionOut |\n| color | color, length | transform, fill, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| shape | shape, length, width, height, fill | radius, stroke, transform, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| audio | media | length, sourceIn, playback, volumeDb, gain, fadeIn, fadeOut |\n| caption | text, length | — |\n\nVisual Insert/Update also accepts `blend`: `normal` (default), `screen`, `multiply`, `overlay`, or `add`; set it to null in Update to clear it. During a Join overlap, both inputs render with normal blending. Video tracks accept video/image/text/color/shape; audio and caption tracks accept their corresponding type. Media is `{libraryId: string, assetId: string}` from a bound library. sourceIn defaults to 0, volumeDb to 0 dB, audio fades to 0 seconds. fit defaults to contain: contain fits the whole image, cover fills and crops, fill stretches, none keeps native dimensions.\n\n| Field | Value |\n| --- | --- |\n| transform | Partial `{x, y, scale, rotation, opacity, crop, blur}`. x/y are normalized canvas center coordinates (default 0.5); scale 1 is fitted size; rotation is degrees (default 0); opacity is 0–1 (default 1). crop is `{top,right,bottom,left}`. blur is 0–100 pixels at 1080-pixel frame height. |\n| style | Partial `{fontFamily, fontSize, fontWeight, color, fill, stroke, strokes, shadows, glow, background, align, maxWidth, position, margin}`. fill accepts a color or linear/radial gradient across the entire text bounding box. strokes draw outside to inside; at most 4, width 0–40. shadows accepts at most 4 `{color,x,y,blur}` entries; blur is 0–100. glow is `{color,radius,strength}` with radius 0–100 and strength 0–1. All dimensions use pixels at 1080 frame height and scale with the text. Glow and large shadow blur increase render time. Invalid colors or ranges return actionable INVALID_STYLE errors. `ListFonts()` discovers family, available weights, scripts and bundled/catalog source. Text and captions share the style fields; caption style additionally supports highlightColor and maxLines: 2. |\n| animate | An object keyed by x, y, scale, rotation, opacity or blur. Each value is an array of `{at: number, value: number, ease?: Ease}` sorted by at with distinct frame-snapped times. Values hold before the first and after the last keyframe, overriding the static transform. |\n| animation | `{in?: AnimationUse, out?: AnimationUse, loop?: AnimationUse}` on visual clips. Each use is `{preset: string, duration?: number, ...params}`; duration and parameter units follow `ListAnimations()`. Presets replace existing animate and reveal when applied. Update accepts `animation: null` to clear the preset and its generated effects. |\n| Ease | linear, in, out, inOut, `{bezier: [x1,y1,x2,y2]}` or `{spring: {stiffness, damping, mass?}}`. Easing shapes the segment arriving at that keyframe; springs may overshoot. |\n| reveal | `{by, delay?: number, stagger: number, duration: number, from: {y?, opacity?, scale?, blur?}, ease?: Ease}`. by selects char, word or line. Unit k starts at delay + k * stagger and takes duration seconds to reach its resting state; from.y is a fraction of font size. |\n| fill | A color string (#RRGGBB or #RRGGBBAA), `{linear: {angle, stops: [{at,color}, ...]}}` or `{radial: {stops: [{at,color}, ...]}}`. Stop positions are 0–1; angle is degrees, 0 left to right. On color clips, fill replaces color when supplied. |\n| shape, width, height, radius, stroke | shape is rect or ellipse. width/height are fractions of canvas width/height before scaling. radius rounds rect corners in pixels at 1080-pixel frame height. stroke is `{color: string, width: number}`. |\n| transitionIn, transitionOut | `{kind, length: number}` at the clip\'s beginning/end. length is seconds. fade changes opacity; dissolve blends; push_left/push_right move horizontally; wipe_left reveals horizontally. |\n\n#### Visual effects\n\n`effects` is an ordered stack of at most 8 catalog entries. Call `ListEffects()` to discover the catalog; unknown kinds return `UNKNOWN_EFFECT`, invalid names/values/keyframes return `INVALID_EFFECT_PARAM`, and stacks over 8 return `TOO_MANY_EFFECTS`. Entries include blur, color adjustment, vignette, film grain, chromatic aberration, pixelate, glitch, shake, flash, light leak and built-in `lut` looks; user `.cube` LUTs are not supported. `speed` is cycles per second. Effects run on CPU during export and increase render time. Parameters are discovered with ListEffects(). Catalog entries expose their own parameters through ListEffects(), including `blur` (`radius` 0–100, default 24) and `color_adjust`: `brightness`, `contrast`, `temperature`, and `tint` each range -1–1 (default 0), while `saturation` ranges 0–2 (default 1). Disabled entries are skipped. `color_adjust` uses an SDR-only Rec.709 adjustment matrix with no color management.\n\nNumeric and integer effect parameters accept `keyframes: {parameter: [{at, value, ease?}, ...]}`; times are seconds relative to the clip, snap to frames like `animate`, must be strictly increasing and within clip duration, and values follow that parameter\'s catalog range. Omitted parameters use catalog defaults. Trim and Split preserve effect keyframes with the same clip-local behavior as `animate`. There are no custom shaders.\n\n`blend` applies to the completed visual layer after its content, effects and `transform.blur`; `add` maps to Skia Plus. The default `normal` path adds no blend layer. During Join overlaps, blending is forced to normal because each input is composed on transparency.\n\n#### Update fields (ItemPatchView)\n\nAll fields are optional; use only fields relevant to the item\'s type. Supported fields: start, length, sourceIn, playback, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, animate, reveal, animation, fill, stroke, shape, width, height, radius, transitionIn, transitionOut, effects, blend, mask, gain. Values and units match Insert; set effects or blend to null to clear them. Set animation to null to clear the preset; set animate or reveal to null to remove that effect. Applying a preset replaces existing animate/reveal. Do not set animation together with animate or reveal in one Insert/Update call. Omit a field to preserve it.\n\n#### Animation presets\n\nDiscover the catalog with `ListAnimations()`. Its entries contain id, version, phase (`in`, `out`, `loop`), target (`any` or `text`), name, description, defaultDuration in seconds, and params. Slots may combine one in, one out and one loop preset. A loop runs only in the interval between in and out; if the same property is animated by multiple slots, loop occupies only that middle interval. Text-target presets are entrances. Their duration controls the rhythm per character/word/line, not the total reveal time. Out and loop presets apply to the whole clip, not per text unit.\n\nPresets replace the clip\'s existing animate and reveal when applied. The source preset is retained, so changing clip length or transform automatically regenerates its keyframes/reveal. If a clip becomes shorter, in/out durations shrink proportionally; when it grows, the requested durations are restored. Split keeps in on the left, out on the right, and loop on both. Writing animate or reveal directly detaches the preset; setting animation to null clears both source and generated effects. Insert/Update reject a call that supplies animation together with animate or reveal.\n\nErrors: UNKNOWN_ANIMATION (unknown preset), INVALID_ANIMATION_PARAM (invalid slot/parameter or frame/keyframe limit), ANIMATION_TOO_LONG (in+out exceed clip length), ANIMATION_TARGET_MISMATCH (text-only preset on a non-text or preset on non-visual clip), ANIMATION_PHASE_MISMATCH (preset in the wrong slot). Each animated property is limited to 600 keyframes; loop duration must be at least 4 frames. `ANIMATION_TOO_LONG` is avoided during later length changes by proportional fitting.\n\n#### Speed, reverse and freeze\n\nVideo/audio Insert and Update accept playback as `{kind: "rate", rate: number, direction: "forward" | "reverse", audio: "preservePitch" | "resample" | "mute"}` or `{kind: "freeze"}`. Rate is finite and inclusive 0.25–4. Omitted playback defaults to 1× forward with preservePitch; supply the complete rate object when changing playback. preservePitch keeps pitch, resample changes pitch with speed, mute removes audio. Reverse requires explicit audio: "mute"; preservePitch/resample are rejected with UNSUPPORTED_PLAYBACK rather than silently muted. Freeze holds sourceIn and is silent. GetItem/GetTimeline echo playback and the source interval in seconds; sourceOut is exclusive even for reverse and equals sourceIn for freeze.\n\nUpdate of playback keeps output length unless length is also supplied. SetSpeed preserves direction/audio, rejects frozen and non-video/audio clips, and requires keep: "source" or "duration". keep: "source" computes round(consumed source / new rate × fps) frames, falling back to floor if rounding would exceed the source end; the returned length/sourceOut are actual frame-rounded seconds. keep: "duration" keeps output length and changes source consumption. Length conflicts fail with OVERLAP; move/shorten the conflicting clip, keep duration, or explicitly use ripple: true to shift following clips on the same track. Source overflow fails with OUT_OF_SOURCE; rate limits fail with RATE_OUT_OF_RANGE. Unknown playback fields and SetSpeed options are rejected with UNKNOWN_FIELD; options only accept keep and boolean ripple.\n\nExample for an existing four-second video/audio clip id: `Print(SetSpeed(id, 0.5, {keep: "source"})); Print(SetSpeed(id, 2, {keep: "source"}));` returns lengths 8 then 2, keeping the same source interval. Reverse: `Update(id, {playback: {kind: "rate", rate: 1, direction: "reverse", audio: "mute"}})`. Freeze: `Update(id, {playback: {kind: "freeze"}})`. Ensure enough source remains for the chosen length/rate. Browser reverse playback currently displays a placeholder; server-rendered Preview/frames and exports support reverse normally. Speed-adjusted audio is generated asynchronously after the edit transaction commits; exports wait for that audio before rendering.\n\n#### Script names versus HTTP response names\n\nUse camelCase inside scripts, including nested objects. HTTP request/response JSON outside script source uses snake_case. Map media.library_id → media.libraryId, media.asset_id → media.assetId, source_in → sourceIn, volume_db → volumeDb, fade_in/fade_out → fadeIn/fadeOut, transition_in/transition_out → transitionIn/transitionOut, font_family/font_size/font_weight/max_width → fontFamily/fontSize/fontWeight/maxWidth, gain_db → gainDb, highlight_color/max_lines → highlightColor/maxLines. Fields such as animate, reveal, fill, stroke, at and length retain their spelling. GetTimeline/GetItem already return camelCase compact views; the expanded retrieveTimeline HTTP response is not an Insert object.\n\nUnrecognized script fields fail with OPS_REJECTED and rejection code UNKNOWN_FIELD; snake_case mistakes suggest the corresponding camelCase name. The error message lists each rejection\'s #opIndex, code and reason. Correct the named fields and retry the saved edit; do not assume an ignored field applied an effect.\n',
10458
10395
  http: "POST",
10459
10396
  path: "/cut/v1/projects/{project_id}:execute",
10460
10397
  streaming: "no",
@@ -11957,7 +11894,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11957
11894
  resource: "knowledge.vectorStores",
11958
11895
  method: "create",
11959
11896
  summary: "Create knowledge base",
11960
- description: 'Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. Each file accepts up to 52428800 bytes and 5000000 estimated tokens; each account holds up to 100 active/nondeleted stores. Minimal body: {"name":"Refund policies"}.',
11897
+ description: 'Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; each account holds up to 100 active/nondeleted stores. Minimal body: {"name":"Refund policies"}.',
11961
11898
  http: "POST",
11962
11899
  path: "/knowledge/v1/vector_stores",
11963
11900
  streaming: "no",
@@ -11996,7 +11933,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11996
11933
  name: "chunking_strategy",
11997
11934
  type: "object",
11998
11935
  required: false,
11999
- description: "auto resolves to static with 800 estimated tokens and 400 overlap tokens. Unlike OpenAI vector stores, token counts are estimates; each Han character counts as one, and other whitespace-delimited words count as their UTF-16 length divided by four, rounded up."
11936
+ description: "Native attachment strategy. auto uses static chunks of 800 estimated tokens with 400 overlap; static supplies explicit chunk sizes; hierarchical indexes child chunks and supplies bounded parent context. Existing attachments are reused unchanged; remove and reattach a file to change its strategy."
12000
11937
  },
12001
11938
  {
12002
11939
  name: "description",
@@ -12343,7 +12280,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12343
12280
  resource: "knowledge.vectorStores.files",
12344
12281
  method: "create",
12345
12282
  summary: "Add file",
12346
- description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching. Each file accepts up to 52428800 bytes and 5000000 estimated tokens; chunk sizes use estimated tokens rather than a model tokenizer. Text, Markdown, CSV, JSON, HTML, PDF, DOCX, PPTX, XLSX and PNG/JPEG/GIF/WebP images can be extracted; audio and video uploads are not knowledge documents. Images may yield generated descriptions rather than verbatim OCR. auto chunking resolves to static 800/400; explicit sizes are 100–4096 with overlap at most half the size. Each store holds at most 10000 attached files. Reattaching the same file returns its existing record without applying new attributes or chunking; inspect last_error after failure.",
12283
+ description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; chunk sizes use estimated tokens rather than a model tokenizer. Text, Markdown, CSV, JSON, HTML, PDF, DOCX, PPTX, XLSX and PNG/JPEG/GIF/WebP images can be extracted; audio and video uploads are not knowledge documents. Images may yield generated descriptions rather than verbatim OCR. auto chunking resolves to static 800/400; explicit sizes are 100–4096 with overlap at most half the size. Each store holds at most 10000 attached files. Reattaching the same file returns its existing record without applying new attributes or chunking; inspect last_error after failure.",
12347
12284
  http: "POST",
12348
12285
  path: "/knowledge/v1/vector_stores/{vector_store_id}/files",
12349
12286
  streaming: "no",
@@ -12375,7 +12312,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12375
12312
  name: "chunking_strategy",
12376
12313
  type: "object",
12377
12314
  required: false,
12378
- description: "auto resolves to static with 800 estimated tokens and 400 overlap tokens. Unlike OpenAI vector stores, token counts are estimates; each Han character counts as one, and other whitespace-delimited words count as their UTF-16 length divided by four, rounded up."
12315
+ description: "Native attachment strategy. auto uses static chunks of 800 estimated tokens with 400 overlap; static supplies explicit chunk sizes; hierarchical indexes child chunks and supplies bounded parent context. Existing attachments are reused unchanged; remove and reattach a file to change its strategy."
12379
12316
  }
12380
12317
  ]
12381
12318
  }
@@ -12682,11 +12619,23 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12682
12619
  ],
12683
12620
  query: []
12684
12621
  },
12622
+ {
12623
+ resource: "media.generation.capabilities",
12624
+ method: "list",
12625
+ summary: "Get generation capabilities",
12626
+ description: "Read supported text-to-video intent, default model, duration and aspect-ratio limits, per-library concurrency and candidate retention. Generation is charged per second; unsaved candidates expire after 7 days.",
12627
+ http: "GET",
12628
+ path: "/media/v1/generation/capabilities",
12629
+ streaming: "no",
12630
+ pagination: false,
12631
+ pathParams: [],
12632
+ query: []
12633
+ },
12685
12634
  {
12686
12635
  resource: "media.libraries",
12687
12636
  method: "list",
12688
12637
  summary: "List libraries",
12689
- description: "List libraries owned by the caller, newest first. By default, deleting and deleted libraries are excluded; use status=deleting to find libraries awaiting purge. All supplied label pairs must match.",
12638
+ description: "Read a caller-owned library’s current settings, usage and lifecycle status. A deleting library remains readable; missing, foreign or purged libraries return LIBRARY_NOT_FOUND.",
12690
12639
  http: "GET",
12691
12640
  path: "/media/v1/libraries",
12692
12641
  streaming: "no",
@@ -12768,7 +12717,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12768
12717
  resource: "media.libraries",
12769
12718
  method: "delete",
12770
12719
  summary: "Delete library",
12771
- description: "Soft-delete an active library, returning its deleting status and purge_at deadline. Asset operations and delivery become unavailable; the library can be restored before purge_at. Repeated deletion while deleting returns the current library.",
12720
+ description: "Restore a deleting library before its purge_at deadline. The library becomes active again and deleted_at and purge_at are cleared; expired or non-deleting libraries cannot be restored.",
12772
12721
  http: "DELETE",
12773
12722
  path: "/media/v1/libraries/{library_id}",
12774
12723
  streaming: "no",
@@ -12786,7 +12735,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12786
12735
  resource: "media.libraries",
12787
12736
  method: "retrieve",
12788
12737
  summary: "Get library",
12789
- description: "Read a caller-owned library’s current settings, usage and lifecycle status. A deleting library remains readable; missing, foreign or purged libraries return LIBRARY_NOT_FOUND.",
12738
+ description: "Update an active library’s supplied settings. Labels replace the complete map; understanding settings and model roles merge with current values. Changing the embedding model is rejected while assets exist.",
12790
12739
  http: "GET",
12791
12740
  path: "/media/v1/libraries/{library_id}",
12792
12741
  streaming: "no",
@@ -12804,7 +12753,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12804
12753
  resource: "media.libraries",
12805
12754
  method: "update",
12806
12755
  summary: "Update library",
12807
- description: "Update an active library’s supplied settings. Labels replace the complete map; understanding settings and model roles merge with current values. Changing the embedding model is rejected while assets exist.",
12756
+ description: "Update an active library. Set hotwords for spelling evidence in subsequent transcripts; [] disables inferred vocabulary. Transcript understanding calls the timestamped ASR, optional reference ASR and correction model through the existing metered model path. Reprocess assets to apply new settings to existing transcripts.",
12808
12757
  http: "PATCH",
12809
12758
  path: "/media/v1/libraries/{library_id}",
12810
12759
  streaming: "no",
@@ -12858,7 +12807,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12858
12807
  resource: "media.libraries.assets",
12859
12808
  method: "list",
12860
12809
  summary: "List assets",
12861
- description: "List assets in an active library, newest first, optionally filtering by exact folder and stored resource type. Continue using next_cursor; video includes audio-only assets.",
12810
+ description: "Upload content into an active library and return a Cloudinary-compatible resource. Use file for a multipart file, data URI, public HTTPS URL or same-owner file identifier. Reusing public_id overwrites by default; overwrite=false returns the existing resource. Chunk uploads require both chunk headers.",
12862
12811
  http: "GET",
12863
12812
  path: "/media/v1/libraries/{library_id}/assets",
12864
12813
  streaming: "no",
@@ -12906,7 +12855,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12906
12855
  resource: "media.libraries.assets",
12907
12856
  method: "create",
12908
12857
  summary: "Upload asset",
12909
- description: "Upload content into an active library and return a Cloudinary-compatible resource. Use file for a multipart file, data URI, public HTTPS URL or same-owner file identifier. Reusing public_id overwrites by default; overwrite=false returns the existing resource. Chunk uploads require both chunk headers.",
12858
+ description: " For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.",
12910
12859
  http: "POST",
12911
12860
  path: "/media/v1/libraries/{library_id}/assets",
12912
12861
  streaming: "no",
@@ -12951,7 +12900,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12951
12900
  name: "asset_folder",
12952
12901
  type: "string",
12953
12902
  required: false,
12954
- description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
12903
+ description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
12955
12904
  },
12956
12905
  {
12957
12906
  name: "use_filename",
@@ -13030,7 +12979,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13030
12979
  resource: "media.libraries.assets.import",
13031
12980
  method: "create",
13032
12981
  summary: "Import file",
13033
- description: "Copy source content into an active library using upload options and return the full native Asset. The imported asset is independent of the source after copying. Reusing public_id follows overwrite semantics.",
12982
+ description: "Copy a File into an independent Media asset. New assets default to organization-private delivery (type=authenticated); explicitly set type=upload for public originals and derivatives. Omitting type on overwrite preserves the current type. Deleting the source File does not delete this copy. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.",
13034
12983
  http: "POST",
13035
12984
  path: "/media/v1/libraries/{library_id}/assets/import",
13036
12985
  streaming: "no",
@@ -13050,7 +12999,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13050
12999
  name: "file_id",
13051
13000
  type: "string",
13052
13001
  required: true,
13053
- description: "File ID to copy into this library instead of file bytes. This independent copy defaults to public delivery; set type=authenticated for private delivery. Deleting the source File does not delete this asset."
13002
+ description: "File ID to copy into this library instead of file bytes. This independent copy defaults to organization-private delivery (type=authenticated); explicitly set type=upload for public delivery. Deleting the source File does not delete this asset."
13054
13003
  },
13055
13004
  {
13056
13005
  name: "public_id",
@@ -13074,7 +13023,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13074
13023
  name: "asset_folder",
13075
13024
  type: "string",
13076
13025
  required: false,
13077
- description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
13026
+ description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
13078
13027
  },
13079
13028
  {
13080
13029
  name: "use_filename",
@@ -13153,7 +13102,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13153
13102
  resource: "media.libraries.assets",
13154
13103
  method: "delete",
13155
13104
  summary: "Delete asset",
13156
- description: "Delete an asset from the library so it is no longer readable, searchable or deliverable. This removes the asset rather than placing it in the library’s restoration window; a missing asset returns ASSET_NOT_FOUND.",
13105
+ description: "Queue reprocessing of the asset’s current version and return its updated state immediately. Omit kinds to retry failed tasks and legacy source-size unsupported tasks; explicit kinds rerun applicable completed tasks and recoverable source-size unsupported tasks. Other unsupported causes remain unchanged. Replaced understandings become superseded, and processing finishes asynchronously.",
13157
13106
  http: "DELETE",
13158
13107
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
13159
13108
  streaming: "no",
@@ -13176,7 +13125,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13176
13125
  resource: "media.libraries.assets",
13177
13126
  method: "retrieve",
13178
13127
  summary: "Get asset",
13179
- description: "Read a non-deleted asset by its asset_id in an active library, including content hashes, processing progress and available previews. Missing or deleted assets return ASSET_NOT_FOUND.",
13128
+ description: "Update an asset’s supplied metadata fields. Tags and context replace their current collections; an empty collection clears them. Moving asset_folder or changing display_name preserves public_id and delivery URLs.",
13180
13129
  http: "GET",
13181
13130
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
13182
13131
  streaming: "no",
@@ -13199,7 +13148,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13199
13148
  resource: "media.libraries.assets",
13200
13149
  method: "update",
13201
13150
  summary: "Update asset",
13202
- description: "Update an asset’s supplied metadata fields. Tags and context replace their current collections; an empty collection clears them. Moving asset_folder or changing display_name preserves public_id and delivery URLs.",
13151
+ description: "Delete an asset from the library so it is no longer readable, searchable or deliverable. This removes the asset rather than placing it in the library’s restoration window; a missing asset returns ASSET_NOT_FOUND.",
13203
13152
  http: "PATCH",
13204
13153
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
13205
13154
  streaming: "no",
@@ -13230,7 +13179,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13230
13179
  name: "asset_folder",
13231
13180
  type: "string",
13232
13181
  required: false,
13233
- description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
13182
+ description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
13234
13183
  },
13235
13184
  {
13236
13185
  name: "tags",
@@ -13248,11 +13197,57 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13248
13197
  ]
13249
13198
  }
13250
13199
  },
13200
+ {
13201
+ resource: "media.libraries.assets.frames",
13202
+ method: "create",
13203
+ summary: "Create frame URLs",
13204
+ description: 'Media creates JPEG frame URLs for inspecting one or more moments in a video without downloading the original. Obtain library_id from libraries and asset_id plus duration from assets. Send 1–20 integer microsecond timestamps strictly below duration, for example {"at_micros":[0,1000000],"width":640}. Only video assets are supported; audio and images return INVALID_PARAMS. Width defaults to 640 and accepts 160, 320 or 640. This read operation does not store a new asset or rerun understanding. Fetch each returned URL to obtain the frame; delivery usage follows media pricing. Authenticated links expire after 300 seconds; upload links remain public and permanent. Reissue expired links. Foreign libraries and assets return 404 without revealing their existence.',
13205
+ http: "POST",
13206
+ path: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames",
13207
+ streaming: "no",
13208
+ pagination: false,
13209
+ pathParams: [
13210
+ {
13211
+ name: "library_id",
13212
+ sdkName: "library_id",
13213
+ description: "Library identifier returned by library creation or listing; must be accessible to the current credential."
13214
+ },
13215
+ {
13216
+ name: "asset_id",
13217
+ sdkName: "asset_id",
13218
+ description: "Video asset identifier returned by asset upload or listing in this library; read its duration before choosing timestamps."
13219
+ }
13220
+ ],
13221
+ query: [],
13222
+ body: {
13223
+ required: true,
13224
+ fields: [
13225
+ {
13226
+ name: "at_micros",
13227
+ type: "array",
13228
+ itemType: "integer",
13229
+ required: true,
13230
+ description: "One to twenty timestamps in microseconds from the start of the video. Each must be a nonnegative safe integer strictly below the video duration; order and duplicates are preserved."
13231
+ },
13232
+ {
13233
+ name: "width",
13234
+ type: "integer",
13235
+ enum: [
13236
+ 160,
13237
+ 320,
13238
+ 640
13239
+ ],
13240
+ required: false,
13241
+ description: "Maximum JPEG width in pixels: 160 is a small thumbnail, 320 a preview and 640 a larger preview. Defaults to 640; larger widths are unavailable."
13242
+ }
13243
+ ]
13244
+ }
13245
+ },
13251
13246
  {
13252
13247
  resource: "media.libraries.assets.reprocess",
13253
13248
  method: "create",
13254
13249
  summary: "Reprocess asset",
13255
- description: "Queue reprocessing of the asset’s current version and return its updated state immediately. Omit kinds to retry failed tasks; explicit kinds rerun applicable completed tasks. Replaced understandings become superseded, and processing finishes asynchronously.",
13250
+ description: " For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.",
13256
13251
  http: "POST",
13257
13252
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess",
13258
13253
  streaming: "no",
@@ -13284,7 +13279,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13284
13279
  "embedding"
13285
13280
  ],
13286
13281
  required: false,
13287
- description: "Processing tasks to rerun. Omit to retry failed tasks only; explicit kinds rerun applicable ready, failed or unsupported tasks. Pending and running tasks are unchanged; an empty array does nothing."
13282
+ description: "Processing tasks to rerun. Omit to retry failed tasks and legacy source-size unsupported tasks; explicit kinds rerun applicable ready or failed tasks and recoverable source-size unsupported tasks. Other unsupported causes remain unchanged. Pending and running tasks are unchanged; an empty array does nothing."
13288
13283
  }
13289
13284
  ]
13290
13285
  }
@@ -13293,7 +13288,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13293
13288
  resource: "media.libraries.assets.understandings",
13294
13289
  method: "list",
13295
13290
  summary: "List understandings",
13296
- description: "List an asset’s understanding results in creation order. By default only current, non-superseded results are returned; use include_superseded=true for history or kind to select an output type.",
13291
+ description: "List understanding results for an asset, ordered by creation time. Use the cursor to continue; include_superseded also returns replaced records. The optional shots array contains current-version shot boundaries and per-shot captions, scene, location guesses, visible text and confidence flags; it is absent on legacy records. Location guesses and folder mismatch are unverified hints. Correction-enabled transcripts expose text_original, corrected text and a correction audit. Their timed data array remains suitable for subtitles. Reference failure is marked missing; correction failure returns the original verbatim. Model inference uses the existing metered model path.",
13297
13292
  http: "GET",
13298
13293
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}/understandings",
13299
13294
  streaming: "no",
@@ -13325,10 +13320,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13325
13320
  "tags",
13326
13321
  "ocr",
13327
13322
  "transcript",
13328
- "frame"
13323
+ "frame",
13324
+ "overview",
13325
+ "audio",
13326
+ "embedding"
13329
13327
  ],
13330
13328
  required: false,
13331
- description: "Filter result kind: caption is a visual description, tags are recognized labels, ocr is recognized image text, transcript is speech text, and frame describes a video segment."
13329
+ description: "Return one output kind: caption is a visual description, tags are generated labels, ocr is visible text, transcript is speech, frame is a video shot, overview is a video summary, audio is sampled audio understanding, and embedding reports a failed embedding step."
13332
13330
  },
13333
13331
  {
13334
13332
  name: "cursor",
@@ -13348,7 +13346,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13348
13346
  resource: "media.libraries.assets",
13349
13347
  method: "batch",
13350
13348
  summary: "Batch assets alias",
13351
- description: "Alias of batch creation. Apply one metadata or deletion action to ids or a frozen expression selection asynchronously; poll the returned job id to inspect completion and item failures.",
13349
+ description: 'Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.',
13352
13350
  http: "POST",
13353
13351
  path: "/media/v1/libraries/{library_id}/assets:batch",
13354
13352
  streaming: "no",
@@ -13369,6 +13367,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13369
13367
  type: "object",
13370
13368
  required: true,
13371
13369
  description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
13370
+ },
13371
+ {
13372
+ name: "reason",
13373
+ type: "string",
13374
+ required: false,
13375
+ description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
13372
13376
  }
13373
13377
  ]
13374
13378
  }
@@ -13377,7 +13381,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13377
13381
  resource: "media.libraries.batches",
13378
13382
  method: "create",
13379
13383
  summary: "Create batch",
13380
- description: "Create an asynchronous batch for tagging, untagging, replacing context, moving or deleting assets. Select ids or an expression; selection is frozen at creation. Poll the returned job id for completion and per-item failures.",
13384
+ description: 'Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.',
13381
13385
  http: "POST",
13382
13386
  path: "/media/v1/libraries/{library_id}/batches",
13383
13387
  streaming: "no",
@@ -13398,6 +13402,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13398
13402
  type: "object",
13399
13403
  required: true,
13400
13404
  description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
13405
+ },
13406
+ {
13407
+ name: "reason",
13408
+ type: "string",
13409
+ required: false,
13410
+ description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
13401
13411
  }
13402
13412
  ]
13403
13413
  }
@@ -13406,7 +13416,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13406
13416
  resource: "media.libraries.batches",
13407
13417
  method: "retrieve",
13408
13418
  summary: "Get batch",
13409
- description: "Read a batch job’s status, successful and failed item counts, and a bounded list of failed items. Use the id returned by batch creation; a job outside this library is not found.",
13419
+ description: "Alias of batch creation. Apply one metadata or deletion action to ids or a frozen expression selection asynchronously; poll the returned job id to inspect completion and item failures.",
13410
13420
  http: "GET",
13411
13421
  path: "/media/v1/libraries/{library_id}/batches/{job_id}",
13412
13422
  streaming: "no",
@@ -13464,7 +13474,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13464
13474
  resource: "media.libraries.events",
13465
13475
  method: "list",
13466
13476
  summary: "List events",
13467
- description: "Read library events in sequence order, including while the library is deleting. Page forward with asc and after_seq, or backward with desc and before_seq; never combine the two sequence cursors.",
13477
+ description: "Read library events in sequence order for observing asset writes and understanding progress. Obtain library_id from creation or listing; continue with after_seq for asc or before_seq for desc, without combining both. Use next_cursor when supplied. Reads do not start or retry understanding.",
13468
13478
  http: "GET",
13469
13479
  path: "/media/v1/libraries/{library_id}/events",
13470
13480
  streaming: "no",
@@ -13511,7 +13521,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13511
13521
  resource: "media.libraries.folders",
13512
13522
  method: "list",
13513
13523
  summary: "List folders",
13514
- description: "List all immediate child folders under parent, or under the root when parent is omitted. Counts include descendant assets. The result is unpaginated; limit and cursor are rejected.",
13524
+ description: "undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.",
13515
13525
  http: "GET",
13516
13526
  path: "/media/v1/libraries/{library_id}/folders",
13517
13527
  streaming: "no",
@@ -13532,11 +13542,155 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13532
13542
  }
13533
13543
  ]
13534
13544
  },
13545
+ {
13546
+ resource: "media.libraries.generations",
13547
+ method: "create",
13548
+ summary: "Create video generation",
13549
+ description: "Create a video.generate job. Generation is charged per second. The response is 202 with a queued Job; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until terminal, then save successful outputs. Unsaved candidate Files expire after 7 days.",
13550
+ http: "POST",
13551
+ path: "/media/v1/libraries/{library_id}/generations",
13552
+ streaming: "no",
13553
+ pagination: false,
13554
+ pathParams: [
13555
+ {
13556
+ name: "library_id",
13557
+ sdkName: "library_id",
13558
+ description: "Library ID returned by creation."
13559
+ }
13560
+ ],
13561
+ query: [],
13562
+ body: {
13563
+ required: true,
13564
+ fields: [
13565
+ {
13566
+ name: "intent",
13567
+ type: "string",
13568
+ required: true,
13569
+ description: "Generation operation; v1 accepts only video.generate text-to-video requests."
13570
+ },
13571
+ {
13572
+ name: "prompt",
13573
+ type: "string",
13574
+ required: true,
13575
+ description: "Text prompt describing the video to generate."
13576
+ },
13577
+ {
13578
+ name: "count",
13579
+ type: "integer",
13580
+ required: false,
13581
+ description: "Number of videos to generate; defaults to 1 and must be from 1 to 4."
13582
+ },
13583
+ {
13584
+ name: "duration_seconds",
13585
+ type: "integer",
13586
+ required: false,
13587
+ description: "Requested video duration in seconds; Router validates the model-specific supported durations."
13588
+ },
13589
+ {
13590
+ name: "aspect_ratio",
13591
+ type: "string",
13592
+ required: false,
13593
+ description: "Requested output aspect ratio; defaults to 16:9 and Router validates model support."
13594
+ },
13595
+ {
13596
+ name: "model",
13597
+ type: "string",
13598
+ required: false,
13599
+ description: "Router model with video_generation capability; defaults to wan2.7-t2v."
13600
+ },
13601
+ {
13602
+ name: "save",
13603
+ type: "string",
13604
+ enum: [
13605
+ "candidate",
13606
+ "library"
13607
+ ],
13608
+ required: false,
13609
+ description: "candidate keeps outputs temporary for explicit save calls; library saves successful outputs automatically."
13610
+ },
13611
+ {
13612
+ name: "asset_folder",
13613
+ type: "string",
13614
+ required: false,
13615
+ description: "Folder for assets saved automatically or by later save calls; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
13616
+ },
13617
+ {
13618
+ name: "tags",
13619
+ type: "array",
13620
+ itemType: "string",
13621
+ required: false,
13622
+ description: "Tags applied when an output becomes a library asset."
13623
+ },
13624
+ {
13625
+ name: "understanding",
13626
+ type: "string",
13627
+ enum: [
13628
+ "auto",
13629
+ "skip"
13630
+ ],
13631
+ required: false,
13632
+ description: "Understanding behavior when a candidate is saved as an asset; defaults to auto."
13633
+ },
13634
+ {
13635
+ name: "references",
13636
+ type: "array",
13637
+ itemType: "object",
13638
+ required: false,
13639
+ description: "Not supported in v1; omit this field. Only text-to-video is currently available."
13640
+ }
13641
+ ]
13642
+ }
13643
+ },
13644
+ {
13645
+ resource: "media.libraries.jobs",
13646
+ method: "list",
13647
+ summary: "List jobs",
13648
+ description: "List batch and video-generation jobs in a library. Filter by status and continue with next_cursor. Poll a generation Job until terminal, then save successful candidate outputs before they expire after 7 days.",
13649
+ http: "GET",
13650
+ path: "/media/v1/libraries/{library_id}/jobs",
13651
+ streaming: "no",
13652
+ pagination: true,
13653
+ pathParams: [
13654
+ {
13655
+ name: "library_id",
13656
+ sdkName: "library_id",
13657
+ description: "Library ID returned by creation."
13658
+ }
13659
+ ],
13660
+ query: [
13661
+ {
13662
+ name: "status",
13663
+ type: "string",
13664
+ enum: [
13665
+ "queued",
13666
+ "running",
13667
+ "completed",
13668
+ "completed_with_errors",
13669
+ "failed",
13670
+ "cancelled"
13671
+ ],
13672
+ required: false,
13673
+ description: "Filter jobs by their current status."
13674
+ },
13675
+ {
13676
+ name: "limit",
13677
+ type: "integer",
13678
+ required: false,
13679
+ description: "Maximum entries in this page, from 1 through 100; defaults to 100."
13680
+ },
13681
+ {
13682
+ name: "cursor",
13683
+ type: "string",
13684
+ required: false,
13685
+ description: "Job id from the previous page’s next_cursor; omit for the first page."
13686
+ }
13687
+ ]
13688
+ },
13535
13689
  {
13536
13690
  resource: "media.libraries.jobs",
13537
13691
  method: "retrieve",
13538
- summary: "Get job alias",
13539
- description: "Alias of batch retrieval. Read the job returned by a batch request, including terminal status, successful and failed counts, and individual failure codes.",
13692
+ summary: "Get job",
13693
+ description: "Read the current batch or video-generation Job status and progress. For generation, inspect outputs and failures, then save successful candidates before their preview and save window expires after 7 days.",
13540
13694
  http: "GET",
13541
13695
  path: "/media/v1/libraries/{library_id}/jobs/{job_id}",
13542
13696
  streaming: "no",
@@ -13550,16 +13704,101 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13550
13704
  {
13551
13705
  name: "job_id",
13552
13706
  sdkName: "job_id",
13553
- description: "Batch identifier returned by createBatch or batchAssets; resolved within this library."
13707
+ description: "Job identifier returned by batch creation, video-generation creation or job listing; resolved within this library."
13708
+ }
13709
+ ],
13710
+ query: []
13711
+ },
13712
+ {
13713
+ resource: "media.libraries.jobs",
13714
+ method: "cancel",
13715
+ summary: "Cancel job",
13716
+ description: "Cancel a queued or running generation job. Already completed outputs remain available to save; poll or read the returned Job to confirm its status.",
13717
+ http: "POST",
13718
+ path: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
13719
+ streaming: "no",
13720
+ pagination: false,
13721
+ pathParams: [
13722
+ {
13723
+ name: "library_id",
13724
+ sdkName: "library_id",
13725
+ description: "Library ID returned by creation."
13726
+ },
13727
+ {
13728
+ name: "job_id",
13729
+ sdkName: "job_id",
13730
+ description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
13554
13731
  }
13555
13732
  ],
13556
13733
  query: []
13557
13734
  },
13735
+ {
13736
+ resource: "media.libraries.jobs.outputs.save",
13737
+ method: "create",
13738
+ summary: "Save generation output",
13739
+ description: "Save a successful candidate as a library asset. Candidate outputs expire after 7 days; save before expiry. Generation is charged per second when the job runs, not when an output is saved.",
13740
+ http: "POST",
13741
+ path: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
13742
+ streaming: "no",
13743
+ pagination: false,
13744
+ pathParams: [
13745
+ {
13746
+ name: "library_id",
13747
+ sdkName: "library_id",
13748
+ description: "Library ID returned by creation."
13749
+ },
13750
+ {
13751
+ name: "job_id",
13752
+ sdkName: "job_id",
13753
+ description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
13754
+ },
13755
+ {
13756
+ name: "index",
13757
+ sdkName: "index",
13758
+ description: "Zero-based position of the candidate in the Job outputs array."
13759
+ }
13760
+ ],
13761
+ query: [],
13762
+ body: {
13763
+ required: false,
13764
+ fields: [
13765
+ {
13766
+ name: "public_id",
13767
+ type: "string",
13768
+ required: false,
13769
+ description: "Delivery identifier for the saved asset; defaults to gen_<job_id>_<index> and is idempotent."
13770
+ },
13771
+ {
13772
+ name: "asset_folder",
13773
+ type: "string",
13774
+ required: false,
13775
+ description: "Destination folder for the saved asset; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
13776
+ },
13777
+ {
13778
+ name: "tags",
13779
+ type: "array",
13780
+ itemType: "string",
13781
+ required: false,
13782
+ description: "Tags to apply to the saved asset."
13783
+ },
13784
+ {
13785
+ name: "understanding",
13786
+ type: "string",
13787
+ enum: [
13788
+ "auto",
13789
+ "skip"
13790
+ ],
13791
+ required: false,
13792
+ description: "Understanding behavior for the saved asset; defaults to auto."
13793
+ }
13794
+ ]
13795
+ }
13796
+ },
13558
13797
  {
13559
13798
  resource: "media.libraries.purge",
13560
13799
  method: "create",
13561
13800
  summary: "Purge library",
13562
- description: "Permanently remove a library that is already deleting, without waiting for purge_at. Its assets and related resources are removed and cannot be restored; first soft-delete an active library.",
13801
+ description: "List assets in an active library, newest first, optionally filtering by exact folder and stored resource type. Continue using next_cursor; video includes audio-only assets.",
13563
13802
  http: "POST",
13564
13803
  path: "/media/v1/libraries/{library_id}/purge",
13565
13804
  streaming: "no",
@@ -13577,7 +13816,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13577
13816
  resource: "media.libraries",
13578
13817
  method: "restore",
13579
13818
  summary: "Restore library",
13580
- description: "Restore a deleting library before its purge_at deadline. The library becomes active again and deleted_at and purge_at are cleared; expired or non-deleting libraries cannot be restored.",
13819
+ description: "Permanently remove a library that is already deleting, without waiting for purge_at. Its assets and related resources are removed and cannot be restored; first soft-delete an active library.",
13581
13820
  http: "POST",
13582
13821
  path: "/media/v1/libraries/{library_id}/restore",
13583
13822
  streaming: "no",
@@ -13595,7 +13834,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13595
13834
  resource: "media.libraries.search",
13596
13835
  method: "create",
13597
13836
  summary: "Semantic search alias",
13598
- description: "Alias of semantic search. Search assets with a nonblank text query, optional expression filter and top_k; hybrid combines semantic and keyword matches, while semantic uses vector similarity only.",
13837
+ description: "List all immediate child folders under parent, or under the root when parent is omitted. Counts include descendant assets. The result is unpaginated; limit and cursor are rejected.",
13599
13838
  http: "POST",
13600
13839
  path: "/media/v1/libraries/{library_id}/search",
13601
13840
  streaming: "no",
@@ -13646,7 +13885,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13646
13885
  resource: "media.libraries.search.expression",
13647
13886
  method: "create",
13648
13887
  summary: "Expression search",
13649
- description: "Search active assets using the supported filter-expression syntax, sorting and cursor pagination. Empty expression matches all assets. Tags and context require with_field; inspect the exactness flags before treating counts as complete.",
13888
+ description: "Find visually similar assets using exactly one of asset_id or an inline base64 image. The library must support image search; an asset query needs a current image embedding and excludes that source asset from results.",
13650
13889
  http: "POST",
13651
13890
  path: "/media/v1/libraries/{library_id}/search/expression",
13652
13891
  streaming: "no",
@@ -13666,7 +13905,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13666
13905
  name: "expression",
13667
13906
  type: "string",
13668
13907
  required: false,
13669
- description: 'Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets. For business metadata use context.sku=KETTLE-RED AND context.revision=2; request with_field: ["context"] to include context. Quality filters: flags:watermark matches any current shot with a watermark; flags.watermark:false requires an assessed video with no positive watermark judgment. The same syntax supports slideshow, hand_frame, text_sticker and low_quality. folder_mismatch:true selects lexical folder/location hints. Geometry filters support width, height, resolution:1920x1080, numeric aspect_ratio (width/height), and orientation:landscape, portrait or square. Missing geometry or unassessed legacy flags do not match positive filters.'
13908
+ description: 'Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets. For business metadata use context.sku=KETTLE-RED AND context.revision=2; request with_field: ["context"] to include context. Quality filters: flags:watermark matches any current shot with a watermark; flags.watermark:false requires an assessed video with no positive watermark judgment. The same syntax supports slideshow, hand_frame, text_sticker and low_quality. folder_mismatch:true selects lexical folder/location hints. Geometry filters support width, height, resolution:1920x1080, numeric aspect_ratio (width/height), and orientation:landscape, portrait or square. Missing geometry or unassessed legacy flags do not match positive filters. has_music:true AND audio_genre:jazz AND audio_mood:calm selects current-version audio profiles with music and matching model labels; has_music:false applies only to sampled ranges, not the entire source. failure_code=UPSTREAM_FAILED selects assets with a current failed understanding carrying that code; combine with processing_state=failed or processing_state=partial.'
13670
13909
  },
13671
13910
  {
13672
13911
  name: "sort_by",
@@ -13718,7 +13957,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13718
13957
  resource: "media.libraries.search.semantic",
13719
13958
  method: "create",
13720
13959
  summary: "Semantic search",
13721
- description: "Search assets with a nonblank text query and optional expression filter. Hybrid mode combines semantic and keyword matches; semantic mode uses vector similarity only. Results are ranked and limited by top_k.",
13960
+ description: "Alias of semantic search. Search assets with a nonblank text query, optional expression filter and top_k; hybrid combines semantic and keyword matches, while semantic uses vector similarity only.",
13722
13961
  http: "POST",
13723
13962
  path: "/media/v1/libraries/{library_id}/search/semantic",
13724
13963
  streaming: "no",
@@ -13769,7 +14008,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13769
14008
  resource: "media.libraries.search.visual",
13770
14009
  method: "create",
13771
14010
  summary: "Visual search",
13772
- description: "Find visually similar assets using exactly one of asset_id or an inline base64 image. The library must support image search; an asset query needs a current image embedding and excludes that source asset from results.",
14011
+ description: "Search assets with a nonblank text query and optional expression filter. Hybrid mode combines semantic and keyword matches; semantic mode uses vector similarity only. Results are ranked and limited by top_k.",
13773
14012
  http: "POST",
13774
14013
  path: "/media/v1/libraries/{library_id}/search/visual",
13775
14014
  streaming: "no",
@@ -13812,6 +14051,67 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13812
14051
  ]
13813
14052
  }
13814
14053
  },
14054
+ {
14055
+ resource: "media.libraries.understandings",
14056
+ method: "list",
14057
+ summary: "List understanding results across a library",
14058
+ description: "Read current understanding entries across one library without fetching every asset separately. Use library_id from creation or listing. folder includes descendants; kinds is a comma-separated list of output kinds. Entries are ordered by asset_id and then understanding id. Continue with next_cursor and the same folder and kinds; limit defaults to 100 and cannot exceed 100. Superseded, deleted and old-version entries are excluded. During historical backfill, this method returns 503 CAPACITY rather than incomplete pages; poll failureSummary until counts_complete is true, then start pagination. Example: GET /media/v1/libraries/lib_example/understandings?folder=travel&kinds=caption,transcript&limit=100.",
14059
+ http: "GET",
14060
+ path: "/media/v1/libraries/{library_id}/understandings",
14061
+ streaming: "no",
14062
+ pagination: true,
14063
+ pathParams: [
14064
+ {
14065
+ name: "library_id",
14066
+ sdkName: "library_id",
14067
+ description: "Library ID returned by creation."
14068
+ }
14069
+ ],
14070
+ query: [
14071
+ {
14072
+ name: "folder",
14073
+ type: "string",
14074
+ required: false,
14075
+ description: "Folder path including all descendants; omitted or empty selects the entire library."
14076
+ },
14077
+ {
14078
+ name: "kinds",
14079
+ type: "string",
14080
+ required: false,
14081
+ description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind."
14082
+ },
14083
+ {
14084
+ name: "cursor",
14085
+ type: "string",
14086
+ required: false,
14087
+ description: "Cursor from the previous next_cursor."
14088
+ },
14089
+ {
14090
+ name: "limit",
14091
+ type: "integer",
14092
+ required: false,
14093
+ description: "Maximum entries in this page, from 1 through 100; defaults to 100."
14094
+ }
14095
+ ]
14096
+ },
14097
+ {
14098
+ resource: "media.libraries.understandings",
14099
+ method: "retrieveFailureSummary",
14100
+ summary: "Summarize understanding failures",
14101
+ description: "Inspect current understanding failures before retrying. Use library_id from library creation or listing. Groups include code, output kind, actual producer model, retryability and up to five sample asset IDs. At most 1024 detailed groups plus two overflow groups are returned; overflow groups separate retryable and unrecoverable entries and mark overflow=true. Unknown failure codes remain retryable. Historical counts are provisional while counts_complete is false. Example: GET /media/v1/libraries/lib_example/understandings/failure_summary.",
14102
+ http: "GET",
14103
+ path: "/media/v1/libraries/{library_id}/understandings/failure_summary",
14104
+ streaming: "no",
14105
+ pagination: false,
14106
+ pathParams: [
14107
+ {
14108
+ name: "library_id",
14109
+ sdkName: "library_id",
14110
+ description: "Library ID returned by creation."
14111
+ }
14112
+ ],
14113
+ query: []
14114
+ },
13815
14115
  {
13816
14116
  resource: "meta.docs",
13817
14117
  method: "search",
@@ -14099,25 +14399,25 @@ services (model, agent, automation…); call the operation you need and read its
14099
14399
  name: "model",
14100
14400
  type: "string",
14101
14401
  required: true,
14102
- description: "Transcription model id, for example `whisper-large-v3-turbo` or `qwen3-asr-flash`; list candidates with listModels?type=transcription. Router support (supported): Verified to take effect."
14402
+ description: "Model catalog identifier declaring openai.audio.transcriptions; use it unchanged, including any creator prefix."
14103
14403
  },
14104
14404
  {
14105
14405
  name: "file",
14106
14406
  type: "string",
14107
14407
  required: true,
14108
- description: "Audio file to transcribe, uploaded as multipart/form-data. Router support (supported): Verified to take effect."
14408
+ description: "Audio bytes uploaded as a multipart file; supported formats and input limits depend on the selected model."
14109
14409
  },
14110
14410
  {
14111
14411
  name: "language",
14112
14412
  type: "string",
14113
14413
  required: false,
14114
- description: "Language of the audio as an ISO-639-1 code such as `en` or `zh`. Router support (partial): Both models accept ISO language codes. qwen3-asr-flash may translate output to that language; whisper-large-v3-turbo treats it as an input hint. Non-ISO names may return 502."
14414
+ description: "Source language code when known; omit to let the model detect the language."
14115
14415
  },
14116
14416
  {
14117
14417
  name: "prompt",
14118
14418
  type: "string",
14119
14419
  required: false,
14120
- description: "Text that primes the model with vocabulary or context. Router support (partial): Vocabulary hints work on whisper-large-v3-turbo only; qwen3-asr-flash returns 400."
14420
+ description: "Optional vocabulary or contextual guidance for recognizing the audio; support depends on the selected model."
14121
14421
  },
14122
14422
  {
14123
14423
  name: "response_format",
@@ -14125,20 +14425,22 @@ services (model, agent, automation…); call the operation you need and read its
14125
14425
  enum: [
14126
14426
  "json",
14127
14427
  "text",
14128
- "verbose_json"
14428
+ "verbose_json",
14429
+ "diarized_json"
14129
14430
  ],
14130
14431
  required: false,
14131
- description: "Format of the response body. `json` and `text` are the commonly supported formats. Router support (partial): json/text work on both; verbose_json works only on whisper-large-v3-turbo. srt/vtt return 400."
14432
+ description: "Output format: json returns text in JSON; text returns plain text; verbose_json includes requested timestamps; diarized_json includes speaker-labelled segments when supported. Defaults to json."
14132
14433
  },
14133
14434
  {
14134
14435
  name: "timestamp_granularities[]",
14135
14436
  type: "array",
14136
14437
  itemType: "string",
14137
14438
  enum: [
14439
+ "word",
14138
14440
  "segment"
14139
14441
  ],
14140
14442
  required: false,
14141
- description: "Timestamp levels to include with `verbose_json`; only `segment` exists in this schema. Router support (partial): Only whisper-large-v3-turbo supports segment with verbose_json. word returns 400; qwen3-asr-flash does not support timestamps."
14443
+ description: "Timestamp levels to request as repeated multipart fields: word returns per-word times; segment returns segment times. Omit for the model default. Use verbose_json, or diarized_json on supporting models."
14142
14444
  },
14143
14445
  {
14144
14446
  name: "temperature",
@@ -19378,7 +19680,7 @@ for more details.`
19378
19680
  name: "filter",
19379
19681
  type: "string",
19380
19682
  required: false,
19381
- description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort; unknown qualifiers return INVALID_PARAMS. Passed unchanged to the service."
19683
+ description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort; write each qualifier as field:value (for example, is:open milestone:5), never field=value. Unknown qualifiers return INVALID_PARAMS. Passed unchanged to the service."
19382
19684
  }
19383
19685
  ]
19384
19686
  },
@@ -27354,6 +27656,19 @@ var mediaCreateLibrary = (options) => (options.client ?? client).post({
27354
27656
  ...options.headers
27355
27657
  }
27356
27658
  });
27659
+ var mediaCreateFrameUrls = (options) => (options.client ?? client).post({
27660
+ security: [{
27661
+ key: "media-BearerAuth",
27662
+ scheme: "bearer",
27663
+ type: "http"
27664
+ }],
27665
+ url: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames",
27666
+ ...options,
27667
+ headers: {
27668
+ "Content-Type": "application/json",
27669
+ ...options.headers
27670
+ }
27671
+ });
27357
27672
  var mediaDeleteLibrary = (options) => (options.client ?? client).delete({
27358
27673
  security: [{
27359
27674
  key: "media-BearerAuth",
@@ -27618,6 +27933,77 @@ var mediaCreateDeliveryToken = (options) => (options.client ?? client).post({
27618
27933
  ...options.headers
27619
27934
  }
27620
27935
  });
27936
+ var mediaUnderstandingFailureSummary = (options) => (options.client ?? client).get({
27937
+ security: [{
27938
+ key: "media-BearerAuth",
27939
+ scheme: "bearer",
27940
+ type: "http"
27941
+ }],
27942
+ url: "/media/v1/libraries/{library_id}/understandings/failure_summary",
27943
+ ...options
27944
+ });
27945
+ var mediaListUnderstandingsByLibrary = (options) => (options.client ?? client).get({
27946
+ security: [{
27947
+ key: "media-BearerAuth",
27948
+ scheme: "bearer",
27949
+ type: "http"
27950
+ }],
27951
+ url: "/media/v1/libraries/{library_id}/understandings",
27952
+ ...options
27953
+ });
27954
+ var mediaCreateGeneration = (options) => (options.client ?? client).post({
27955
+ security: [{
27956
+ key: "media-BearerAuth",
27957
+ scheme: "bearer",
27958
+ type: "http"
27959
+ }],
27960
+ url: "/media/v1/libraries/{library_id}/generations",
27961
+ ...options,
27962
+ headers: {
27963
+ "Content-Type": "application/json",
27964
+ ...options.headers
27965
+ }
27966
+ });
27967
+ var mediaListJobs = (options) => (options.client ?? client).get({
27968
+ security: [{
27969
+ key: "media-BearerAuth",
27970
+ scheme: "bearer",
27971
+ type: "http"
27972
+ }],
27973
+ url: "/media/v1/libraries/{library_id}/jobs",
27974
+ ...options
27975
+ });
27976
+ var mediaCancelJob = (options) => (options.client ?? client).post({
27977
+ security: [{
27978
+ key: "media-BearerAuth",
27979
+ scheme: "bearer",
27980
+ type: "http"
27981
+ }],
27982
+ url: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
27983
+ ...options
27984
+ });
27985
+ var mediaSaveGenerationOutput = (options) => (options.client ?? client).post({
27986
+ security: [{
27987
+ key: "media-BearerAuth",
27988
+ scheme: "bearer",
27989
+ type: "http"
27990
+ }],
27991
+ url: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
27992
+ ...options,
27993
+ headers: {
27994
+ "Content-Type": "application/json",
27995
+ ...options.headers
27996
+ }
27997
+ });
27998
+ var mediaGetGenerationCapabilities = (options) => (options?.client ?? client).get({
27999
+ security: [{
28000
+ key: "media-BearerAuth",
28001
+ scheme: "bearer",
28002
+ type: "http"
28003
+ }],
28004
+ url: "/media/v1/generation/capabilities",
28005
+ ...options
28006
+ });
27621
28007
  var getSandboxV1Sandboxes = (options) => (options?.client ?? client).get({
27622
28008
  querySerializer: { parameters: { state: { array: { explode: false } } } },
27623
28009
  security: [
@@ -30068,11 +30454,19 @@ function createKnowledge(transport) {
30068
30454
  }
30069
30455
  function createMedia(transport) {
30070
30456
  return {
30457
+ generation: {
30458
+ capabilities: {
30459
+ list: bind(transport, mediaGetGenerationCapabilities)
30460
+ }
30461
+ },
30071
30462
  libraries: {
30072
30463
  assets: {
30073
30464
  batch: bind(transport, mediaBatchAssets),
30074
30465
  create: bind(transport, (options) => mediaUploadAsset({ ...options, bodySerializer: multipartBodySerializer, headers: { "Content-Type": null, ...options.headers } })),
30075
30466
  delete: bind(transport, mediaDeleteAsset),
30467
+ frames: {
30468
+ create: bind(transport, mediaCreateFrameUrls)
30469
+ },
30076
30470
  import: {
30077
30471
  create: bind(transport, mediaImportAsset)
30078
30472
  },
@@ -30101,7 +30495,17 @@ function createMedia(transport) {
30101
30495
  folders: {
30102
30496
  list: bind(transport, mediaListFolders)
30103
30497
  },
30498
+ generations: {
30499
+ create: bind(transport, mediaCreateGeneration)
30500
+ },
30104
30501
  jobs: {
30502
+ cancel: bind(transport, mediaCancelJob),
30503
+ list: bindPage(transport, mediaListJobs),
30504
+ outputs: {
30505
+ save: {
30506
+ create: bind(transport, mediaSaveGenerationOutput)
30507
+ }
30508
+ },
30105
30509
  retrieve: bind(transport, mediaGetJob)
30106
30510
  },
30107
30511
  list: bindPage(transport, mediaListLibraries),
@@ -30122,6 +30526,10 @@ function createMedia(transport) {
30122
30526
  create: bind(transport, mediaVisualSearch)
30123
30527
  }
30124
30528
  },
30529
+ understandings: {
30530
+ list: bindPage(transport, mediaListUnderstandingsByLibrary),
30531
+ retrieveFailureSummary: bind(transport, mediaUnderstandingFailureSummary)
30532
+ },
30125
30533
  update: bind(transport, mediaUpdateLibrary)
30126
30534
  }
30127
30535
  };
@@ -33501,7 +33909,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
33501
33909
  }
33502
33910
 
33503
33911
  // src/main.ts
33504
- var version = "0.2.1-dev.ea9c801";
33912
+ var version = "0.2.1-dev.fcdebee";
33505
33913
  var commands = commandTree(operations);
33506
33914
  var manual = [...workflows.map((w) => w.words), [API_WORD]];
33507
33915
  function route(argv) {