@deepraxis/cli 0.2.1-dev.b623d9c → 0.2.1-dev.b8a4ef3

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 -3
  2. package/dist/praxis.js +563 -58
  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",
@@ -10162,6 +10162,12 @@ Execution errors include error.details.prints containing output printed before f
10162
10162
  type: "integer",
10163
10163
  required: false,
10164
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."
10165
10171
  }
10166
10172
  ]
10167
10173
  }
@@ -10170,7 +10176,7 @@ Execution errors include error.details.prints containing output printed before f
10170
10176
  resource: "cut.projects.frames",
10171
10177
  method: "list",
10172
10178
  summary: "Render preview frames",
10173
- 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. FRAME_UNAVAILABLE warnings on execute mean a source preview could not be fetched and an offline tile was drawn; edits still commit, and this warning alone does not establish that the source media is broken. 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.",
10174
10180
  http: "GET",
10175
10181
  path: "/cut/v1/projects/{project_id}/frames",
10176
10182
  streaming: "no",
@@ -10385,7 +10391,7 @@ Execution errors include error.details.prints containing output printed before f
10385
10391
  resource: "cut.projects",
10386
10392
  method: "execute",
10387
10393
  summary: "Execute editing script",
10388
- 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[];\nInsert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;\nUpdate(id: ClipId, patch: ItemPatchView): void;\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 }, 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>; maxChars?: number }): ClipId[];\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, sourceIn/sourceOut, text 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| 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| 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| 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 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 the catalog defaults. Unknown kinds and unknown or invalid parameters are rejected. Effects: dissolve (no parameters); dip (color black/white, default black); push and wipe (direction left/right/up/down, default left); wipe also has softness 0–1, default 0; iris has centerX/centerY 0–1, both default 0.5; blinds has integer count 2–64, default 8, and orientation vertical/horizontal, default vertical; blur has radius 0–100 pixels at 1080-pixel frame height, default 24. 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, volumeDb, transform, fit, animate, transitionIn, transitionOut |\n| image | media, length | transform, fit, animate, transitionIn, transitionOut |\n| text | text, length | style, transform, reveal, animate, transitionIn, transitionOut |\n| color | color, length | transform, fill, animate, transitionIn, transitionOut |\n| shape | shape, length, width, height, fill | radius, stroke, transform, animate, transitionIn, transitionOut |\n| audio | media | length, sourceIn, volumeDb, fadeIn, fadeOut, transitionIn, transitionOut |\n| caption | text, length | — |\n\nVideo 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, stroke, background, align, maxWidth, position, margin}`. 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}`. Text and captions support position (top/middle/bottom; box centers at 12%/50%/85% of height without margin) and optional margin (0–0.4 of canvas height, box edge distance for top/bottom; middle ignores it). Omitted position preserves the text transform (center by default); explicit position controls vertical placement, so omit it for y animation. Caption style additionally supports highlightColor and maxLines: 2. GetItem and GetTimeline return text style and current caption track style. Caption tracks only accept captions; use AddCaptionsFromTranscript, and place text on video tracks. |\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| 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#### Update fields (ItemPatchView)\n\nAll 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})`.\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',
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, options?: { resplit?: boolean; maxChars?: number }): { replaced: number; added: number; deleted: number };\nImportCaptions(trackId: TrackId, text: string, o?: { format?: "srt" | "vtt"; offset?: number }): ClipId[];\nExportCaptions(trackId: TrackId, o: { format: "srt" | "vtt" }): string;\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| ImportCaptions, ExportCaptions | Import SRT or WebVTT text onto a caption track and export it back. format is inferred from a WEBVTT header when omitted. offset shifts imported cues in seconds. Import rejects more than 100000 bytes, more than 5000 cues, malformed or overlapping file cues with INVALID_CAPTION_FILE; overlap with existing timeline clips uses the normal OVERLAP rejection. Export sorts by timeline start and writes millisecond timecodes. |\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, duck |\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, duck, 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',
10389
10395
  http: "POST",
10390
10396
  path: "/cut/v1/projects/{project_id}:execute",
10391
10397
  streaming: "no",
@@ -11630,7 +11636,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11630
11636
  resource: "file.uploads",
11631
11637
  method: "create",
11632
11638
  summary: "Create an upload",
11633
- description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data, assistants and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.",
11639
+ description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 20 GiB (21474836480 bytes) and only user_data, assistants and vision purposes. Send parts of at most 64000000 bytes; an unfinished upload waits for them for 7 days, so a client can create → send parts → query GET /file/v1/uploads/{upload_id} → resend only the missing parts → complete. Optional part_size fixes every part length and makes each numbered part retryable with identical bytes. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.",
11634
11640
  http: "POST",
11635
11641
  path: "/file/v1/uploads",
11636
11642
  streaming: "no",
@@ -11644,7 +11650,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11644
11650
  name: "bytes",
11645
11651
  type: "integer",
11646
11652
  required: true,
11647
- description: "Exact complete file length in bytes, from 1 through 2147483648 (2 GiB); the sum of completed parts must match."
11653
+ description: "Exact complete file length in bytes, from 1 through 21474836480 (20 GiB); the sum of completed parts must match."
11648
11654
  },
11649
11655
  {
11650
11656
  name: "filename",
@@ -11688,7 +11694,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11688
11694
  resource: "file.uploads",
11689
11695
  method: "createSigned",
11690
11696
  summary: "Create a one-time upload URL",
11691
- description: "Upload a local file of up to 2 GiB from a coding agent without sending bytes through the model. Provide basename, exact byte count and MIME type. Up to 104857600 bytes, PUT the file to url with curl -T photo.png -H 'Content-Type: image/png' '<url>'; success returns 201 with the file object, and reuse returns 410 CAPABILITY_USED. Above that threshold, split the file into part_size chunks (default 64000000 bytes), PUT each chunk to its numbered parts[].url in any order, then POST complete_url without a body. Part PUTs return 200; completion returns 201 with the file object, including its state, or 400 if a part is missing. A processing file can be polled with files.retrieve until active. Identical part bytes may be retried; changed bytes at the same number return 400. Completion reuse returns 410 CAPABILITY_USED. Each PUT requires the exact signed Content-Length; single-PUT Content-Type must match content_type or be omitted. Expired, revoked, invalid, wrong-action or cross-organization URLs return 404. URL lifetime defaults to 900 seconds for single PUT or 3600 for multipart, at most 604800; all multipart URLs share an expiry. Multipart creation reserves storage quota. Issuance requires the same unscoped credential as direct file creation. Each issuance creates a new upload and is not idempotent. Example body: {\"filename\":\"photo.png\",\"bytes\":2048,\"content_type\":\"image/png\"}.",
11697
+ description: "Upload a local file of up to 20 GiB from a coding agent without sending bytes through the model. Provide basename, exact byte count and MIME type. Up to 104857600 bytes, PUT the file to url with curl -T photo.png -H 'Content-Type: image/png' '<url>'; success returns 201 with the file object, and reuse returns 410 CAPABILITY_USED. Above that threshold, split the file into part_size chunks (default 64000000 bytes) and PUT each chunk to its numbered parts[].url in any order; an interrupted client GETs status_url to see the received parts and resends only what is missing, then POSTs complete_url without a body. Part PUTs return 200; completion returns 201 with the file object, including its state, or 400 if a part is missing. A processing file can be polled with files.retrieve until active. Identical part bytes may be retried; changed bytes at the same number return 400. Completion reuse returns 410 CAPABILITY_USED. Each PUT requires the exact signed Content-Length; single-PUT Content-Type must match content_type or be omitted. Expired, revoked, invalid, wrong-action or cross-organization URLs return 404. URL lifetime defaults to 900 seconds for single PUT or 604800 (7 days) for multipart, at most 604800; all multipart URLs, including status_url, share an expiry. Multipart creation reserves storage quota. Issuance requires the same unscoped credential as direct file creation. Each issuance creates a new upload and is not idempotent. Example body: {\"filename\":\"photo.png\",\"bytes\":2048,\"content_type\":\"image/png\"}.",
11692
11698
  http: "POST",
11693
11699
  path: "/file/v1/uploads/signed",
11694
11700
  streaming: "no",
@@ -11708,7 +11714,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11708
11714
  name: "bytes",
11709
11715
  type: "integer",
11710
11716
  required: true,
11711
- description: "Exact local file size in bytes, from 1 through 2147483648 (2 GiB). Up to 104857600 bytes returns one PUT URL; larger files return numbered part URLs and a completion URL. Every PUT requires its exact signed Content-Length."
11717
+ description: "Exact local file size in bytes, from 1 through 21474836480 (20 GiB). Up to 104857600 bytes returns one PUT URL; larger files return numbered part URLs, a completion URL and a status URL. Every PUT requires its exact signed Content-Length."
11712
11718
  },
11713
11719
  {
11714
11720
  name: "content_type",
@@ -11731,7 +11737,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11731
11737
  name: "expires_in",
11732
11738
  type: "integer",
11733
11739
  required: false,
11734
- description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or 3600 for multipart. All part URLs and the completion URL share one expiry. This does not set the resulting file's lifetime."
11740
+ description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or 604800 (7 days) for multipart. All part URLs, the status URL and the completion URL share one expiry. This does not set the resulting file's lifetime."
11735
11741
  },
11736
11742
  {
11737
11743
  name: "part_size",
@@ -11742,6 +11748,24 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11742
11748
  ]
11743
11749
  }
11744
11750
  },
11751
+ {
11752
+ resource: "file.uploads",
11753
+ method: "retrieve",
11754
+ summary: "Retrieve an upload",
11755
+ description: "Read the state of an unfinished upload — its status, declared bytes, fixed part_size and the parts it already holds (received_parts, each with part_number, bytes and sha256). After a break or a failed part, call it to resend only the missing numbers, then complete. A cancelled or expired upload is refused; a completed one returns its file. A missing or other-organization upload returns 404.",
11756
+ http: "GET",
11757
+ path: "/file/v1/uploads/{upload_id}",
11758
+ streaming: "no",
11759
+ pagination: false,
11760
+ pathParams: [
11761
+ {
11762
+ name: "upload_id",
11763
+ sdkName: "upload_id",
11764
+ description: "Upload identifier returned by create; the upload must belong to your organization."
11765
+ }
11766
+ ],
11767
+ query: []
11768
+ },
11745
11769
  {
11746
11770
  resource: "file.uploads",
11747
11771
  method: "cancel",
@@ -11764,7 +11788,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11764
11788
  resource: "file.uploads",
11765
11789
  method: "complete",
11766
11790
  summary: "Complete an upload",
11767
- description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.",
11791
+ description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. When parts were lost, query GET /file/v1/uploads/{upload_id} and resend them before completing. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.",
11768
11792
  http: "POST",
11769
11793
  path: "/file/v1/uploads/{upload_id}/complete",
11770
11794
  streaming: "no",
@@ -11800,7 +11824,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11800
11824
  resource: "file.uploads.parts",
11801
11825
  method: "create",
11802
11826
  summary: "Add an upload part",
11803
- description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.",
11827
+ description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID, and query GET /file/v1/uploads/{upload_id} to see which numbers already arrived. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.",
11804
11828
  http: "POST",
11805
11829
  path: "/file/v1/uploads/{upload_id}/parts",
11806
11830
  streaming: "no",
@@ -11888,7 +11912,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11888
11912
  resource: "knowledge.vectorStores",
11889
11913
  method: "create",
11890
11914
  summary: "Create knowledge base",
11891
- 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"}.',
11915
+ 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"}.',
11892
11916
  http: "POST",
11893
11917
  path: "/knowledge/v1/vector_stores",
11894
11918
  streaming: "no",
@@ -11927,7 +11951,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11927
11951
  name: "chunking_strategy",
11928
11952
  type: "object",
11929
11953
  required: false,
11930
- 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."
11954
+ 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."
11931
11955
  },
11932
11956
  {
11933
11957
  name: "description",
@@ -12274,7 +12298,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12274
12298
  resource: "knowledge.vectorStores.files",
12275
12299
  method: "create",
12276
12300
  summary: "Add file",
12277
- 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.",
12301
+ 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.",
12278
12302
  http: "POST",
12279
12303
  path: "/knowledge/v1/vector_stores/{vector_store_id}/files",
12280
12304
  streaming: "no",
@@ -12306,7 +12330,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12306
12330
  name: "chunking_strategy",
12307
12331
  type: "object",
12308
12332
  required: false,
12309
- 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."
12333
+ 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."
12310
12334
  }
12311
12335
  ]
12312
12336
  }
@@ -12613,11 +12637,23 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12613
12637
  ],
12614
12638
  query: []
12615
12639
  },
12640
+ {
12641
+ resource: "media.generation.capabilities",
12642
+ method: "list",
12643
+ summary: "Get generation capabilities",
12644
+ 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.",
12645
+ http: "GET",
12646
+ path: "/media/v1/generation/capabilities",
12647
+ streaming: "no",
12648
+ pagination: false,
12649
+ pathParams: [],
12650
+ query: []
12651
+ },
12616
12652
  {
12617
12653
  resource: "media.libraries",
12618
12654
  method: "list",
12619
12655
  summary: "List libraries",
12620
- 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.",
12656
+ 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.",
12621
12657
  http: "GET",
12622
12658
  path: "/media/v1/libraries",
12623
12659
  streaming: "no",
@@ -12699,7 +12735,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12699
12735
  resource: "media.libraries",
12700
12736
  method: "delete",
12701
12737
  summary: "Delete library",
12702
- 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.",
12738
+ 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.",
12703
12739
  http: "DELETE",
12704
12740
  path: "/media/v1/libraries/{library_id}",
12705
12741
  streaming: "no",
@@ -12717,7 +12753,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12717
12753
  resource: "media.libraries",
12718
12754
  method: "retrieve",
12719
12755
  summary: "Get library",
12720
- 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.",
12756
+ 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.",
12721
12757
  http: "GET",
12722
12758
  path: "/media/v1/libraries/{library_id}",
12723
12759
  streaming: "no",
@@ -12735,7 +12771,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12735
12771
  resource: "media.libraries",
12736
12772
  method: "update",
12737
12773
  summary: "Update library",
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.",
12774
+ 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.",
12739
12775
  http: "PATCH",
12740
12776
  path: "/media/v1/libraries/{library_id}",
12741
12777
  streaming: "no",
@@ -12789,7 +12825,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12789
12825
  resource: "media.libraries.assets",
12790
12826
  method: "list",
12791
12827
  summary: "List assets",
12792
- 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.",
12828
+ 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.",
12793
12829
  http: "GET",
12794
12830
  path: "/media/v1/libraries/{library_id}/assets",
12795
12831
  streaming: "no",
@@ -12837,7 +12873,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12837
12873
  resource: "media.libraries.assets",
12838
12874
  method: "create",
12839
12875
  summary: "Upload asset",
12840
- 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.",
12876
+ 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.",
12841
12877
  http: "POST",
12842
12878
  path: "/media/v1/libraries/{library_id}/assets",
12843
12879
  streaming: "no",
@@ -12882,7 +12918,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12882
12918
  name: "asset_folder",
12883
12919
  type: "string",
12884
12920
  required: false,
12885
- description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
12921
+ 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."
12886
12922
  },
12887
12923
  {
12888
12924
  name: "use_filename",
@@ -12961,7 +12997,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12961
12997
  resource: "media.libraries.assets.import",
12962
12998
  method: "create",
12963
12999
  summary: "Import file",
12964
- 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.",
13000
+ 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.",
12965
13001
  http: "POST",
12966
13002
  path: "/media/v1/libraries/{library_id}/assets/import",
12967
13003
  streaming: "no",
@@ -12981,7 +13017,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12981
13017
  name: "file_id",
12982
13018
  type: "string",
12983
13019
  required: true,
12984
- 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."
13020
+ 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."
12985
13021
  },
12986
13022
  {
12987
13023
  name: "public_id",
@@ -13005,7 +13041,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13005
13041
  name: "asset_folder",
13006
13042
  type: "string",
13007
13043
  required: false,
13008
- description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
13044
+ 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."
13009
13045
  },
13010
13046
  {
13011
13047
  name: "use_filename",
@@ -13084,7 +13120,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13084
13120
  resource: "media.libraries.assets",
13085
13121
  method: "delete",
13086
13122
  summary: "Delete asset",
13087
- 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.",
13123
+ 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.",
13088
13124
  http: "DELETE",
13089
13125
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
13090
13126
  streaming: "no",
@@ -13107,7 +13143,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13107
13143
  resource: "media.libraries.assets",
13108
13144
  method: "retrieve",
13109
13145
  summary: "Get asset",
13110
- 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.",
13146
+ 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.",
13111
13147
  http: "GET",
13112
13148
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
13113
13149
  streaming: "no",
@@ -13130,7 +13166,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13130
13166
  resource: "media.libraries.assets",
13131
13167
  method: "update",
13132
13168
  summary: "Update asset",
13133
- 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.",
13169
+ 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.",
13134
13170
  http: "PATCH",
13135
13171
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
13136
13172
  streaming: "no",
@@ -13161,7 +13197,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13161
13197
  name: "asset_folder",
13162
13198
  type: "string",
13163
13199
  required: false,
13164
- description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
13200
+ 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."
13165
13201
  },
13166
13202
  {
13167
13203
  name: "tags",
@@ -13179,11 +13215,57 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13179
13215
  ]
13180
13216
  }
13181
13217
  },
13218
+ {
13219
+ resource: "media.libraries.assets.frames",
13220
+ method: "create",
13221
+ summary: "Create frame URLs",
13222
+ 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.',
13223
+ http: "POST",
13224
+ path: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames",
13225
+ streaming: "no",
13226
+ pagination: false,
13227
+ pathParams: [
13228
+ {
13229
+ name: "library_id",
13230
+ sdkName: "library_id",
13231
+ description: "Library identifier returned by library creation or listing; must be accessible to the current credential."
13232
+ },
13233
+ {
13234
+ name: "asset_id",
13235
+ sdkName: "asset_id",
13236
+ description: "Video asset identifier returned by asset upload or listing in this library; read its duration before choosing timestamps."
13237
+ }
13238
+ ],
13239
+ query: [],
13240
+ body: {
13241
+ required: true,
13242
+ fields: [
13243
+ {
13244
+ name: "at_micros",
13245
+ type: "array",
13246
+ itemType: "integer",
13247
+ required: true,
13248
+ 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."
13249
+ },
13250
+ {
13251
+ name: "width",
13252
+ type: "integer",
13253
+ enum: [
13254
+ 160,
13255
+ 320,
13256
+ 640
13257
+ ],
13258
+ required: false,
13259
+ 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."
13260
+ }
13261
+ ]
13262
+ }
13263
+ },
13182
13264
  {
13183
13265
  resource: "media.libraries.assets.reprocess",
13184
13266
  method: "create",
13185
13267
  summary: "Reprocess asset",
13186
- 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.",
13268
+ 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.",
13187
13269
  http: "POST",
13188
13270
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess",
13189
13271
  streaming: "no",
@@ -13215,7 +13297,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13215
13297
  "embedding"
13216
13298
  ],
13217
13299
  required: false,
13218
- 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."
13300
+ 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."
13219
13301
  }
13220
13302
  ]
13221
13303
  }
@@ -13224,7 +13306,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13224
13306
  resource: "media.libraries.assets.understandings",
13225
13307
  method: "list",
13226
13308
  summary: "List understandings",
13227
- 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.",
13309
+ 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.",
13228
13310
  http: "GET",
13229
13311
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}/understandings",
13230
13312
  streaming: "no",
@@ -13256,10 +13338,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13256
13338
  "tags",
13257
13339
  "ocr",
13258
13340
  "transcript",
13259
- "frame"
13341
+ "frame",
13342
+ "overview",
13343
+ "audio",
13344
+ "embedding"
13260
13345
  ],
13261
13346
  required: false,
13262
- 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."
13347
+ 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."
13263
13348
  },
13264
13349
  {
13265
13350
  name: "cursor",
@@ -13279,7 +13364,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13279
13364
  resource: "media.libraries.assets",
13280
13365
  method: "batch",
13281
13366
  summary: "Batch assets alias",
13282
- 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.",
13367
+ 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.',
13283
13368
  http: "POST",
13284
13369
  path: "/media/v1/libraries/{library_id}/assets:batch",
13285
13370
  streaming: "no",
@@ -13300,6 +13385,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13300
13385
  type: "object",
13301
13386
  required: true,
13302
13387
  description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
13388
+ },
13389
+ {
13390
+ name: "reason",
13391
+ type: "string",
13392
+ required: false,
13393
+ description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
13303
13394
  }
13304
13395
  ]
13305
13396
  }
@@ -13308,7 +13399,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13308
13399
  resource: "media.libraries.batches",
13309
13400
  method: "create",
13310
13401
  summary: "Create batch",
13311
- 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.",
13402
+ 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.',
13312
13403
  http: "POST",
13313
13404
  path: "/media/v1/libraries/{library_id}/batches",
13314
13405
  streaming: "no",
@@ -13329,6 +13420,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13329
13420
  type: "object",
13330
13421
  required: true,
13331
13422
  description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
13423
+ },
13424
+ {
13425
+ name: "reason",
13426
+ type: "string",
13427
+ required: false,
13428
+ description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
13332
13429
  }
13333
13430
  ]
13334
13431
  }
@@ -13337,7 +13434,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13337
13434
  resource: "media.libraries.batches",
13338
13435
  method: "retrieve",
13339
13436
  summary: "Get batch",
13340
- 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.",
13437
+ 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.",
13341
13438
  http: "GET",
13342
13439
  path: "/media/v1/libraries/{library_id}/batches/{job_id}",
13343
13440
  streaming: "no",
@@ -13395,7 +13492,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13395
13492
  resource: "media.libraries.events",
13396
13493
  method: "list",
13397
13494
  summary: "List events",
13398
- 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.",
13495
+ 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.",
13399
13496
  http: "GET",
13400
13497
  path: "/media/v1/libraries/{library_id}/events",
13401
13498
  streaming: "no",
@@ -13442,7 +13539,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13442
13539
  resource: "media.libraries.folders",
13443
13540
  method: "list",
13444
13541
  summary: "List folders",
13445
- 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.",
13542
+ description: "undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.",
13446
13543
  http: "GET",
13447
13544
  path: "/media/v1/libraries/{library_id}/folders",
13448
13545
  streaming: "no",
@@ -13463,11 +13560,155 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13463
13560
  }
13464
13561
  ]
13465
13562
  },
13563
+ {
13564
+ resource: "media.libraries.generations",
13565
+ method: "create",
13566
+ summary: "Create video generation",
13567
+ 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.",
13568
+ http: "POST",
13569
+ path: "/media/v1/libraries/{library_id}/generations",
13570
+ streaming: "no",
13571
+ pagination: false,
13572
+ pathParams: [
13573
+ {
13574
+ name: "library_id",
13575
+ sdkName: "library_id",
13576
+ description: "Library ID returned by creation."
13577
+ }
13578
+ ],
13579
+ query: [],
13580
+ body: {
13581
+ required: true,
13582
+ fields: [
13583
+ {
13584
+ name: "intent",
13585
+ type: "string",
13586
+ required: true,
13587
+ description: "Generation operation; v1 accepts only video.generate text-to-video requests."
13588
+ },
13589
+ {
13590
+ name: "prompt",
13591
+ type: "string",
13592
+ required: true,
13593
+ description: "Text prompt describing the video to generate."
13594
+ },
13595
+ {
13596
+ name: "count",
13597
+ type: "integer",
13598
+ required: false,
13599
+ description: "Number of videos to generate; defaults to 1 and must be from 1 to 4."
13600
+ },
13601
+ {
13602
+ name: "duration_seconds",
13603
+ type: "integer",
13604
+ required: false,
13605
+ description: "Requested video duration in seconds; Router validates the model-specific supported durations."
13606
+ },
13607
+ {
13608
+ name: "aspect_ratio",
13609
+ type: "string",
13610
+ required: false,
13611
+ description: "Requested output aspect ratio; defaults to 16:9 and Router validates model support."
13612
+ },
13613
+ {
13614
+ name: "model",
13615
+ type: "string",
13616
+ required: false,
13617
+ description: "Router model with video_generation capability; defaults to wan2.7-t2v."
13618
+ },
13619
+ {
13620
+ name: "save",
13621
+ type: "string",
13622
+ enum: [
13623
+ "candidate",
13624
+ "library"
13625
+ ],
13626
+ required: false,
13627
+ description: "candidate keeps outputs temporary for explicit save calls; library saves successful outputs automatically."
13628
+ },
13629
+ {
13630
+ name: "asset_folder",
13631
+ type: "string",
13632
+ required: false,
13633
+ 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."
13634
+ },
13635
+ {
13636
+ name: "tags",
13637
+ type: "array",
13638
+ itemType: "string",
13639
+ required: false,
13640
+ description: "Tags applied when an output becomes a library asset."
13641
+ },
13642
+ {
13643
+ name: "understanding",
13644
+ type: "string",
13645
+ enum: [
13646
+ "auto",
13647
+ "skip"
13648
+ ],
13649
+ required: false,
13650
+ description: "Understanding behavior when a candidate is saved as an asset; defaults to auto."
13651
+ },
13652
+ {
13653
+ name: "references",
13654
+ type: "array",
13655
+ itemType: "object",
13656
+ required: false,
13657
+ description: "Not supported in v1; omit this field. Only text-to-video is currently available."
13658
+ }
13659
+ ]
13660
+ }
13661
+ },
13662
+ {
13663
+ resource: "media.libraries.jobs",
13664
+ method: "list",
13665
+ summary: "List jobs",
13666
+ 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.",
13667
+ http: "GET",
13668
+ path: "/media/v1/libraries/{library_id}/jobs",
13669
+ streaming: "no",
13670
+ pagination: true,
13671
+ pathParams: [
13672
+ {
13673
+ name: "library_id",
13674
+ sdkName: "library_id",
13675
+ description: "Library ID returned by creation."
13676
+ }
13677
+ ],
13678
+ query: [
13679
+ {
13680
+ name: "status",
13681
+ type: "string",
13682
+ enum: [
13683
+ "queued",
13684
+ "running",
13685
+ "completed",
13686
+ "completed_with_errors",
13687
+ "failed",
13688
+ "cancelled"
13689
+ ],
13690
+ required: false,
13691
+ description: "Filter jobs by their current status."
13692
+ },
13693
+ {
13694
+ name: "limit",
13695
+ type: "integer",
13696
+ required: false,
13697
+ description: "Maximum entries in this page, from 1 through 100; defaults to 100."
13698
+ },
13699
+ {
13700
+ name: "cursor",
13701
+ type: "string",
13702
+ required: false,
13703
+ description: "Job id from the previous page’s next_cursor; omit for the first page."
13704
+ }
13705
+ ]
13706
+ },
13466
13707
  {
13467
13708
  resource: "media.libraries.jobs",
13468
13709
  method: "retrieve",
13469
- summary: "Get job alias",
13470
- description: "Alias of batch retrieval. Read the job returned by a batch request, including terminal status, successful and failed counts, and individual failure codes.",
13710
+ summary: "Get job",
13711
+ 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.",
13471
13712
  http: "GET",
13472
13713
  path: "/media/v1/libraries/{library_id}/jobs/{job_id}",
13473
13714
  streaming: "no",
@@ -13481,16 +13722,101 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13481
13722
  {
13482
13723
  name: "job_id",
13483
13724
  sdkName: "job_id",
13484
- description: "Batch identifier returned by createBatch or batchAssets; resolved within this library."
13725
+ description: "Job identifier returned by batch creation, video-generation creation or job listing; resolved within this library."
13485
13726
  }
13486
13727
  ],
13487
13728
  query: []
13488
13729
  },
13730
+ {
13731
+ resource: "media.libraries.jobs",
13732
+ method: "cancel",
13733
+ summary: "Cancel job",
13734
+ 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.",
13735
+ http: "POST",
13736
+ path: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
13737
+ streaming: "no",
13738
+ pagination: false,
13739
+ pathParams: [
13740
+ {
13741
+ name: "library_id",
13742
+ sdkName: "library_id",
13743
+ description: "Library ID returned by creation."
13744
+ },
13745
+ {
13746
+ name: "job_id",
13747
+ sdkName: "job_id",
13748
+ description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
13749
+ }
13750
+ ],
13751
+ query: []
13752
+ },
13753
+ {
13754
+ resource: "media.libraries.jobs.outputs.save",
13755
+ method: "create",
13756
+ summary: "Save generation output",
13757
+ 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.",
13758
+ http: "POST",
13759
+ path: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
13760
+ streaming: "no",
13761
+ pagination: false,
13762
+ pathParams: [
13763
+ {
13764
+ name: "library_id",
13765
+ sdkName: "library_id",
13766
+ description: "Library ID returned by creation."
13767
+ },
13768
+ {
13769
+ name: "job_id",
13770
+ sdkName: "job_id",
13771
+ description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
13772
+ },
13773
+ {
13774
+ name: "index",
13775
+ sdkName: "index",
13776
+ description: "Zero-based position of the candidate in the Job outputs array."
13777
+ }
13778
+ ],
13779
+ query: [],
13780
+ body: {
13781
+ required: false,
13782
+ fields: [
13783
+ {
13784
+ name: "public_id",
13785
+ type: "string",
13786
+ required: false,
13787
+ description: "Delivery identifier for the saved asset; defaults to gen_<job_id>_<index> and is idempotent."
13788
+ },
13789
+ {
13790
+ name: "asset_folder",
13791
+ type: "string",
13792
+ required: false,
13793
+ 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."
13794
+ },
13795
+ {
13796
+ name: "tags",
13797
+ type: "array",
13798
+ itemType: "string",
13799
+ required: false,
13800
+ description: "Tags to apply to the saved asset."
13801
+ },
13802
+ {
13803
+ name: "understanding",
13804
+ type: "string",
13805
+ enum: [
13806
+ "auto",
13807
+ "skip"
13808
+ ],
13809
+ required: false,
13810
+ description: "Understanding behavior for the saved asset; defaults to auto."
13811
+ }
13812
+ ]
13813
+ }
13814
+ },
13489
13815
  {
13490
13816
  resource: "media.libraries.purge",
13491
13817
  method: "create",
13492
13818
  summary: "Purge library",
13493
- 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.",
13819
+ 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.",
13494
13820
  http: "POST",
13495
13821
  path: "/media/v1/libraries/{library_id}/purge",
13496
13822
  streaming: "no",
@@ -13508,7 +13834,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13508
13834
  resource: "media.libraries",
13509
13835
  method: "restore",
13510
13836
  summary: "Restore library",
13511
- 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.",
13837
+ 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.",
13512
13838
  http: "POST",
13513
13839
  path: "/media/v1/libraries/{library_id}/restore",
13514
13840
  streaming: "no",
@@ -13526,7 +13852,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13526
13852
  resource: "media.libraries.search",
13527
13853
  method: "create",
13528
13854
  summary: "Semantic search alias",
13529
- 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.",
13855
+ 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.",
13530
13856
  http: "POST",
13531
13857
  path: "/media/v1/libraries/{library_id}/search",
13532
13858
  streaming: "no",
@@ -13577,7 +13903,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13577
13903
  resource: "media.libraries.search.expression",
13578
13904
  method: "create",
13579
13905
  summary: "Expression search",
13580
- 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.",
13906
+ 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.",
13581
13907
  http: "POST",
13582
13908
  path: "/media/v1/libraries/{library_id}/search/expression",
13583
13909
  streaming: "no",
@@ -13597,7 +13923,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13597
13923
  name: "expression",
13598
13924
  type: "string",
13599
13925
  required: false,
13600
- 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.'
13926
+ 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.'
13601
13927
  },
13602
13928
  {
13603
13929
  name: "sort_by",
@@ -13649,7 +13975,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13649
13975
  resource: "media.libraries.search.semantic",
13650
13976
  method: "create",
13651
13977
  summary: "Semantic search",
13652
- 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.",
13978
+ 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.",
13653
13979
  http: "POST",
13654
13980
  path: "/media/v1/libraries/{library_id}/search/semantic",
13655
13981
  streaming: "no",
@@ -13700,7 +14026,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13700
14026
  resource: "media.libraries.search.visual",
13701
14027
  method: "create",
13702
14028
  summary: "Visual search",
13703
- 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.",
14029
+ 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.",
13704
14030
  http: "POST",
13705
14031
  path: "/media/v1/libraries/{library_id}/search/visual",
13706
14032
  streaming: "no",
@@ -13743,6 +14069,67 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13743
14069
  ]
13744
14070
  }
13745
14071
  },
14072
+ {
14073
+ resource: "media.libraries.understandings",
14074
+ method: "list",
14075
+ summary: "List understanding results across a library",
14076
+ 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.",
14077
+ http: "GET",
14078
+ path: "/media/v1/libraries/{library_id}/understandings",
14079
+ streaming: "no",
14080
+ pagination: true,
14081
+ pathParams: [
14082
+ {
14083
+ name: "library_id",
14084
+ sdkName: "library_id",
14085
+ description: "Library ID returned by creation."
14086
+ }
14087
+ ],
14088
+ query: [
14089
+ {
14090
+ name: "folder",
14091
+ type: "string",
14092
+ required: false,
14093
+ description: "Folder path including all descendants; omitted or empty selects the entire library."
14094
+ },
14095
+ {
14096
+ name: "kinds",
14097
+ type: "string",
14098
+ required: false,
14099
+ description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind."
14100
+ },
14101
+ {
14102
+ name: "cursor",
14103
+ type: "string",
14104
+ required: false,
14105
+ description: "Cursor from the previous next_cursor."
14106
+ },
14107
+ {
14108
+ name: "limit",
14109
+ type: "integer",
14110
+ required: false,
14111
+ description: "Maximum entries in this page, from 1 through 100; defaults to 100."
14112
+ }
14113
+ ]
14114
+ },
14115
+ {
14116
+ resource: "media.libraries.understandings",
14117
+ method: "retrieveFailureSummary",
14118
+ summary: "Summarize understanding failures",
14119
+ 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.",
14120
+ http: "GET",
14121
+ path: "/media/v1/libraries/{library_id}/understandings/failure_summary",
14122
+ streaming: "no",
14123
+ pagination: false,
14124
+ pathParams: [
14125
+ {
14126
+ name: "library_id",
14127
+ sdkName: "library_id",
14128
+ description: "Library ID returned by creation."
14129
+ }
14130
+ ],
14131
+ query: []
14132
+ },
13746
14133
  {
13747
14134
  resource: "meta.docs",
13748
14135
  method: "search",
@@ -14030,25 +14417,25 @@ services (model, agent, automation…); call the operation you need and read its
14030
14417
  name: "model",
14031
14418
  type: "string",
14032
14419
  required: true,
14033
- 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."
14420
+ description: "Model catalog identifier declaring openai.audio.transcriptions; use it unchanged, including any creator prefix."
14034
14421
  },
14035
14422
  {
14036
14423
  name: "file",
14037
14424
  type: "string",
14038
14425
  required: true,
14039
- description: "Audio file to transcribe, uploaded as multipart/form-data. Router support (supported): Verified to take effect."
14426
+ description: "Audio bytes uploaded as a multipart file; supported formats and input limits depend on the selected model."
14040
14427
  },
14041
14428
  {
14042
14429
  name: "language",
14043
14430
  type: "string",
14044
14431
  required: false,
14045
- 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."
14432
+ description: "Source language code when known; omit to let the model detect the language."
14046
14433
  },
14047
14434
  {
14048
14435
  name: "prompt",
14049
14436
  type: "string",
14050
14437
  required: false,
14051
- 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."
14438
+ description: "Optional vocabulary or contextual guidance for recognizing the audio; support depends on the selected model."
14052
14439
  },
14053
14440
  {
14054
14441
  name: "response_format",
@@ -14056,20 +14443,22 @@ services (model, agent, automation…); call the operation you need and read its
14056
14443
  enum: [
14057
14444
  "json",
14058
14445
  "text",
14059
- "verbose_json"
14446
+ "verbose_json",
14447
+ "diarized_json"
14060
14448
  ],
14061
14449
  required: false,
14062
- 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."
14450
+ 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."
14063
14451
  },
14064
14452
  {
14065
14453
  name: "timestamp_granularities[]",
14066
14454
  type: "array",
14067
14455
  itemType: "string",
14068
14456
  enum: [
14457
+ "word",
14069
14458
  "segment"
14070
14459
  ],
14071
14460
  required: false,
14072
- 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."
14461
+ 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."
14073
14462
  },
14074
14463
  {
14075
14464
  name: "temperature",
@@ -19309,7 +19698,7 @@ for more details.`
19309
19698
  name: "filter",
19310
19699
  type: "string",
19311
19700
  required: false,
19312
- 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."
19701
+ 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."
19313
19702
  }
19314
19703
  ]
19315
19704
  },
@@ -22875,6 +23264,15 @@ var fileCancelUpload = (options) => (options.client ?? client).post({
22875
23264
  url: "/file/v1/uploads/{upload_id}/cancel",
22876
23265
  ...options
22877
23266
  });
23267
+ var fileRetrieveUpload = (options) => (options.client ?? client).get({
23268
+ security: [{
23269
+ key: "BearerAuth",
23270
+ scheme: "bearer",
23271
+ type: "http"
23272
+ }],
23273
+ url: "/file/v1/uploads/{upload_id}",
23274
+ ...options
23275
+ });
22878
23276
  var fileCreateSignedUpload = (options) => (options.client ?? client).post({
22879
23277
  security: [{
22880
23278
  key: "BearerAuth",
@@ -27285,6 +27683,19 @@ var mediaCreateLibrary = (options) => (options.client ?? client).post({
27285
27683
  ...options.headers
27286
27684
  }
27287
27685
  });
27686
+ var mediaCreateFrameUrls = (options) => (options.client ?? client).post({
27687
+ security: [{
27688
+ key: "media-BearerAuth",
27689
+ scheme: "bearer",
27690
+ type: "http"
27691
+ }],
27692
+ url: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames",
27693
+ ...options,
27694
+ headers: {
27695
+ "Content-Type": "application/json",
27696
+ ...options.headers
27697
+ }
27698
+ });
27288
27699
  var mediaDeleteLibrary = (options) => (options.client ?? client).delete({
27289
27700
  security: [{
27290
27701
  key: "media-BearerAuth",
@@ -27549,6 +27960,77 @@ var mediaCreateDeliveryToken = (options) => (options.client ?? client).post({
27549
27960
  ...options.headers
27550
27961
  }
27551
27962
  });
27963
+ var mediaUnderstandingFailureSummary = (options) => (options.client ?? client).get({
27964
+ security: [{
27965
+ key: "media-BearerAuth",
27966
+ scheme: "bearer",
27967
+ type: "http"
27968
+ }],
27969
+ url: "/media/v1/libraries/{library_id}/understandings/failure_summary",
27970
+ ...options
27971
+ });
27972
+ var mediaListUnderstandingsByLibrary = (options) => (options.client ?? client).get({
27973
+ security: [{
27974
+ key: "media-BearerAuth",
27975
+ scheme: "bearer",
27976
+ type: "http"
27977
+ }],
27978
+ url: "/media/v1/libraries/{library_id}/understandings",
27979
+ ...options
27980
+ });
27981
+ var mediaCreateGeneration = (options) => (options.client ?? client).post({
27982
+ security: [{
27983
+ key: "media-BearerAuth",
27984
+ scheme: "bearer",
27985
+ type: "http"
27986
+ }],
27987
+ url: "/media/v1/libraries/{library_id}/generations",
27988
+ ...options,
27989
+ headers: {
27990
+ "Content-Type": "application/json",
27991
+ ...options.headers
27992
+ }
27993
+ });
27994
+ var mediaListJobs = (options) => (options.client ?? client).get({
27995
+ security: [{
27996
+ key: "media-BearerAuth",
27997
+ scheme: "bearer",
27998
+ type: "http"
27999
+ }],
28000
+ url: "/media/v1/libraries/{library_id}/jobs",
28001
+ ...options
28002
+ });
28003
+ var mediaCancelJob = (options) => (options.client ?? client).post({
28004
+ security: [{
28005
+ key: "media-BearerAuth",
28006
+ scheme: "bearer",
28007
+ type: "http"
28008
+ }],
28009
+ url: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
28010
+ ...options
28011
+ });
28012
+ var mediaSaveGenerationOutput = (options) => (options.client ?? client).post({
28013
+ security: [{
28014
+ key: "media-BearerAuth",
28015
+ scheme: "bearer",
28016
+ type: "http"
28017
+ }],
28018
+ url: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
28019
+ ...options,
28020
+ headers: {
28021
+ "Content-Type": "application/json",
28022
+ ...options.headers
28023
+ }
28024
+ });
28025
+ var mediaGetGenerationCapabilities = (options) => (options?.client ?? client).get({
28026
+ security: [{
28027
+ key: "media-BearerAuth",
28028
+ scheme: "bearer",
28029
+ type: "http"
28030
+ }],
28031
+ url: "/media/v1/generation/capabilities",
28032
+ ...options
28033
+ });
27552
28034
  var getSandboxV1Sandboxes = (options) => (options?.client ?? client).get({
27553
28035
  querySerializer: { parameters: { state: { array: { explode: false } } } },
27554
28036
  security: [
@@ -29947,7 +30429,8 @@ function createFile(transport) {
29947
30429
  createSigned: bind(transport, fileCreateSignedUpload),
29948
30430
  parts: {
29949
30431
  create: bind(transport, (options) => fileAddUploadPart({ ...options, bodySerializer: multipartBodySerializer, headers: { "Content-Type": null, ...options.headers } }))
29950
- }
30432
+ },
30433
+ retrieve: bind(transport, fileRetrieveUpload)
29951
30434
  }
29952
30435
  };
29953
30436
  }
@@ -29999,11 +30482,19 @@ function createKnowledge(transport) {
29999
30482
  }
30000
30483
  function createMedia(transport) {
30001
30484
  return {
30485
+ generation: {
30486
+ capabilities: {
30487
+ list: bind(transport, mediaGetGenerationCapabilities)
30488
+ }
30489
+ },
30002
30490
  libraries: {
30003
30491
  assets: {
30004
30492
  batch: bind(transport, mediaBatchAssets),
30005
30493
  create: bind(transport, (options) => mediaUploadAsset({ ...options, bodySerializer: multipartBodySerializer, headers: { "Content-Type": null, ...options.headers } })),
30006
30494
  delete: bind(transport, mediaDeleteAsset),
30495
+ frames: {
30496
+ create: bind(transport, mediaCreateFrameUrls)
30497
+ },
30007
30498
  import: {
30008
30499
  create: bind(transport, mediaImportAsset)
30009
30500
  },
@@ -30032,7 +30523,17 @@ function createMedia(transport) {
30032
30523
  folders: {
30033
30524
  list: bind(transport, mediaListFolders)
30034
30525
  },
30526
+ generations: {
30527
+ create: bind(transport, mediaCreateGeneration)
30528
+ },
30035
30529
  jobs: {
30530
+ cancel: bind(transport, mediaCancelJob),
30531
+ list: bindPage(transport, mediaListJobs),
30532
+ outputs: {
30533
+ save: {
30534
+ create: bind(transport, mediaSaveGenerationOutput)
30535
+ }
30536
+ },
30036
30537
  retrieve: bind(transport, mediaGetJob)
30037
30538
  },
30038
30539
  list: bindPage(transport, mediaListLibraries),
@@ -30053,6 +30554,10 @@ function createMedia(transport) {
30053
30554
  create: bind(transport, mediaVisualSearch)
30054
30555
  }
30055
30556
  },
30557
+ understandings: {
30558
+ list: bindPage(transport, mediaListUnderstandingsByLibrary),
30559
+ retrieveFailureSummary: bind(transport, mediaUnderstandingFailureSummary)
30560
+ },
30056
30561
  update: bind(transport, mediaUpdateLibrary)
30057
30562
  }
30058
30563
  };
@@ -33432,7 +33937,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
33432
33937
  }
33433
33938
 
33434
33939
  // src/main.ts
33435
- var version = "0.2.1-dev.b623d9c";
33940
+ var version = "0.2.1-dev.b8a4ef3";
33436
33941
  var commands = commandTree(operations);
33437
33942
  var manual = [...workflows.map((w) => w.words), [API_WORD]];
33438
33943
  function route(argv) {