@deepraxis/sdk 0.1.1-dev.eb022f5 → 0.1.1-dev.ec2a9a1

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.
@@ -107,7 +107,7 @@ export declare const operations: readonly [{
107
107
  readonly type: "array";
108
108
  readonly itemType: "object";
109
109
  readonly required: false;
110
- readonly 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.";
110
+ readonly 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.";
111
111
  }, {
112
112
  readonly name: "kind";
113
113
  readonly type: "string";
@@ -7935,7 +7935,7 @@ export declare const operations: readonly [{
7935
7935
  readonly resource: "cut.projects.analysis";
7936
7936
  readonly method: "create";
7937
7937
  readonly summary: "Analyze project media";
7938
- readonly description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible.";
7938
+ readonly description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible. Silence measures transcript-based speech pauses, not music or loudness. A completed transcript without words returns ready with empty segments and reason no_speech; no completed transcript returns unsupported with reason no_transcript. A failed transcription remains failed.";
7939
7939
  readonly http: "POST";
7940
7940
  readonly path: "/cut/v1/projects/{project_id}/analysis";
7941
7941
  readonly streaming: "no";
@@ -8074,6 +8074,16 @@ export declare const operations: readonly [{
8074
8074
  readonly body: {
8075
8075
  readonly required: true;
8076
8076
  readonly fields: readonly [{
8077
+ readonly name: "folder";
8078
+ readonly type: "string";
8079
+ readonly required: false;
8080
+ readonly description: "Optional destination path within the bound media library; omitted uses its default folder.";
8081
+ }, {
8082
+ readonly name: "name";
8083
+ readonly type: "string";
8084
+ readonly required: false;
8085
+ readonly description: "Nonempty display name, frozen with the export. Path separators and control characters become hyphens; limited to 200 characters. Omitted uses project name and timestamp.";
8086
+ }, {
8077
8087
  readonly name: "output";
8078
8088
  readonly type: "object";
8079
8089
  readonly required: false;
@@ -8088,13 +8098,18 @@ export declare const operations: readonly [{
8088
8098
  readonly type: "integer";
8089
8099
  readonly required: false;
8090
8100
  readonly description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write.";
8101
+ }, {
8102
+ readonly name: "loudness";
8103
+ readonly type: "object";
8104
+ readonly required: false;
8105
+ readonly description: "Optional loudness normalization target; normalization adds analysis and rendering work.";
8091
8106
  }];
8092
8107
  };
8093
8108
  }, {
8094
8109
  readonly resource: "cut.projects.frames";
8095
8110
  readonly method: "list";
8096
8111
  readonly summary: "Render preview frames";
8097
- readonly description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. Decode its base64 payload to save the image. Codemode returns at most four images per call, so request at most four times when reviewing there.";
8112
+ readonly 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.";
8098
8113
  readonly http: "GET";
8099
8114
  readonly path: "/cut/v1/projects/{project_id}/frames";
8100
8115
  readonly streaming: "no";
@@ -8113,7 +8128,7 @@ export declare const operations: readonly [{
8113
8128
  readonly name: "scale";
8114
8129
  readonly type: "number";
8115
8130
  readonly required: false;
8116
- readonly description: "Positive image size multiplier; 0.5 renders at half the project dimensions.";
8131
+ readonly description: "Image size multiplier, default 0.25, greater than zero and at most 0.5. Larger values return INVALID_PARAMS; pixel-area limits may reduce actual dimensions, reported as width and height.";
8117
8132
  }, {
8118
8133
  readonly name: "revision";
8119
8134
  readonly type: "integer";
@@ -8268,7 +8283,7 @@ export declare const operations: readonly [{
8268
8283
  readonly resource: "cut.projects";
8269
8284
  readonly method: "execute";
8270
8285
  readonly summary: "Execute editing script";
8271
- readonly 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. 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[];\nInsert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;\nUpdate(id: ClipId, patch: ItemPatchView): void;\nDelete(id: ClipId, o?: { ripple?: boolean }): 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 and tracks (id, kind, name, index, locked, items); from/to and tracks narrow the read. |\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| 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#### 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}`. fontFamily: Geist or Noto Sans SC (default); fontSize defaults to 48; fontWeight: 400 (default), 500 or 700; color defaults to #FFFFFF; align: left, center (default), right; maxWidth is a fraction of canvas width (default 0.9). stroke is `{color,width}`. Caption style additionally supports position (top/middle/bottom), margin (0–0.4 of canvas height), highlightColor and maxLines: 2. |\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";
8286
+ readonly description: "Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: `const t = AddTrack(\"video\"); Insert(t, {type: \"color\", color: \"#123456\", start: 0, length: 3}); Print(t);`\n\n### Script function reference\n\nFunctions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. JoinId is the string returned by Join or read from GetTimeline().joins. Reads see earlier writes in the same script.\n\n```ts\nGetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;\nGetItem(id: ClipId): ItemView;\nFindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];\nGetMedia(ref: MediaRef): MediaInfo;\nGetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];\nGetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];\nListTransitions(): TransitionInfo[];\nListEffects(): EffectInfo[];\nListTextStyles(): TextStylePreset[];\nListTextTemplates(): TextTemplate[];\nListAnimations(): { id: string; version: number; phase: \"in\" | \"out\" | \"loop\"; target: \"any\" | \"text\"; name: string; description: string; defaultDuration: number; params: { name: string; type: string; values?: string[]; default?: string | number; min?: number; max?: number; description: string }[] }[];\nListFonts(): { family: string; weights: number[]; scripts: (\"latin\"|\"cjk\")[]; source: \"bundled\"|\"catalog\" }[];\nInsert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;\nUpdate(id: ClipId, patch: ItemPatchView): void;\nSetSpeed(id: ClipId, rate: number | { curve: { at: number; rate: number; ease?: Ease }[]; audio?: \"mute\" | \"resample\" }, o: { keep: \"source\" | \"duration\"; ripple?: boolean }): { length: number; sourceOut: number };\nDelete(id: ClipId, o?: { ripple?: boolean }): void;\nJoin(left: ClipId, right: ClipId, o: { length?: number; effect: TransitionInput }): JoinId;\nUpdateJoin(id: JoinId, patch: { length?: number; effect?: TransitionInput }): void;\nDeleteJoin(id: JoinId): void;\nSplit(id: ClipId, at: number): ClipId;\nTrim(id: ClipId, edge: \"in\" | \"out\", delta: number, o?: { ripple?: boolean }): void;\nMove(id: ClipId, start: number, track?: TrackId): void;\nRippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;\nAddTrack(kind: \"video\" | \"audio\" | \"caption\", init?: { name?: string; role?: \"voice\" | \"music\" | \"sfx\" }, index?: number): TrackId;\nUpdateTrack(id: TrackId, patch: TrackPatch): void;\nDeleteTrack(id: TrackId): void;\nSetSettings(patch: Partial<ProjectSettingsView>): void;\nAddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle> & { preset?: string }; maxChars?: number }): ClipId[];\nInsertTemplate(track: TrackId, o: { template: string; start: number; slots?: Record<string, string> }): ClipId[];\nAlignCaptions(trackId: TrackId, script: string): { replaced: number; added: number; deleted: number };\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";
8272
8287
  readonly http: "POST";
8273
8288
  readonly path: "/cut/v1/projects/{project_id}:execute";
8274
8289
  readonly streaming: "no";
@@ -9164,7 +9179,7 @@ export declare const operations: readonly [{
9164
9179
  readonly resource: "file.files";
9165
9180
  readonly method: "create";
9166
9181
  readonly summary: "Upload file";
9167
- readonly description: "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.";
9182
+ readonly description: "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.";
9168
9183
  readonly http: "POST";
9169
9184
  readonly path: "/file/v1/files";
9170
9185
  readonly streaming: "no";
@@ -9182,9 +9197,9 @@ export declare const operations: readonly [{
9182
9197
  }, {
9183
9198
  readonly name: "purpose";
9184
9199
  readonly type: "string";
9185
- readonly enum: readonly ["user_data", "vision"];
9200
+ readonly enum: readonly ["user_data", "assistants", "vision"];
9186
9201
  readonly required: true;
9187
- readonly description: "Purpose label stored with the file: user_data or vision. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data.";
9202
+ readonly description: "Purpose label stored with the file: user_data, assistants or vision. The label is stored and returned unchanged; assistants follows the same rules as user_data. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data.";
9188
9203
  }, {
9189
9204
  readonly name: "expires_after";
9190
9205
  readonly type: "object";
@@ -9241,7 +9256,7 @@ export declare const operations: readonly [{
9241
9256
  readonly resource: "file.files.contentLinks";
9242
9257
  readonly method: "revoke";
9243
9258
  readonly summary: "Revoke a file content link";
9244
- readonly description: "Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within 30 seconds; the file and other links remain available. Only current IAM capability tokens can be revoked; legacy content links expire at the migration deadline. Example body: {\"token\":\"<token from /c/>\"}.";
9259
+ readonly description: "Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within 15 minutes; the file and other links remain available. Only current IAM capability tokens can be revoked; legacy content links expire at the migration deadline. Example body: {\"token\":\"<token from /c/>\"}.";
9245
9260
  readonly http: "POST";
9246
9261
  readonly path: "/file/v1/files/{file_id}/content_links:revoke";
9247
9262
  readonly streaming: "no";
@@ -9265,7 +9280,7 @@ export declare const operations: readonly [{
9265
9280
  readonly resource: "file.files.contentUrl";
9266
9281
  readonly method: "create";
9267
9282
  readonly summary: "Create a download URL";
9268
- readonly description: "Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to 3600 seconds and is at most 604800 seconds. Issuance requires the same credential and file-read access as files.retrieveContent; a processing file returns 409 FILE_NOT_READY, so poll files.retrieve until active before retrying. A missing, expired or other-organization file returns 404. Each issuance creates a new link. OpenAI Files has no signed download URL; this follows S3 presigned GET semantics. Example body: {\"ttl_seconds\":3600}.";
9283
+ readonly description: "Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to 900 seconds and is at most 604800 seconds. Issuance requires the same credential and file-read access as files.retrieveContent; a processing file returns 409 FILE_NOT_READY, so poll files.retrieve until active before retrying. A missing, expired or other-organization file returns 404. Each issuance creates a new link. OpenAI Files has no signed download URL; this follows S3 presigned GET semantics. Example body: {\"ttl_seconds\":3600}.";
9269
9284
  readonly http: "POST";
9270
9285
  readonly path: "/file/v1/files/{file_id}/content_url";
9271
9286
  readonly streaming: "no";
@@ -9282,14 +9297,14 @@ export declare const operations: readonly [{
9282
9297
  readonly name: "ttl_seconds";
9283
9298
  readonly type: "integer";
9284
9299
  readonly required: false;
9285
- readonly description: "Download link lifetime in seconds, from 1 through 604800; omitted means 3600. This does not change the file's own expiry.";
9300
+ readonly description: "Download link lifetime in seconds, from 1 through 604800; omitted means 900. This does not change the file's own expiry.";
9286
9301
  }];
9287
9302
  };
9288
9303
  }, {
9289
9304
  readonly resource: "file.uploads";
9290
9305
  readonly method: "create";
9291
9306
  readonly summary: "Create an upload";
9292
- readonly 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 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.";
9307
+ readonly 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.";
9293
9308
  readonly http: "POST";
9294
9309
  readonly path: "/file/v1/uploads";
9295
9310
  readonly streaming: "no";
@@ -9316,9 +9331,9 @@ export declare const operations: readonly [{
9316
9331
  }, {
9317
9332
  readonly name: "purpose";
9318
9333
  readonly type: "string";
9319
- readonly enum: readonly ["user_data", "vision"];
9334
+ readonly enum: readonly ["user_data", "assistants", "vision"];
9320
9335
  readonly required: true;
9321
- readonly description: "Use user_data for conversation attachments, or vision for PNG, JPEG, GIF and WebP images.";
9336
+ readonly description: "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images.";
9322
9337
  }, {
9323
9338
  readonly name: "expires_after";
9324
9339
  readonly type: "object";
@@ -9362,9 +9377,9 @@ export declare const operations: readonly [{
9362
9377
  }, {
9363
9378
  readonly name: "purpose";
9364
9379
  readonly type: "string";
9365
- readonly enum: readonly ["user_data", "vision"];
9380
+ readonly enum: readonly ["user_data", "assistants", "vision"];
9366
9381
  readonly required: false;
9367
- readonly description: "user_data stores ordinary files and conversation images; vision accepts PNG, JPEG, GIF or WebP images only. Omitted means user_data.";
9382
+ readonly description: "user_data and assistants store ordinary files and conversation images with their original purpose label; vision accepts PNG, JPEG, GIF or WebP images only. Omitted means user_data.";
9368
9383
  }, {
9369
9384
  readonly name: "expires_in";
9370
9385
  readonly type: "integer";
@@ -9494,7 +9509,7 @@ export declare const operations: readonly [{
9494
9509
  readonly resource: "knowledge.vectorStores";
9495
9510
  readonly method: "create";
9496
9511
  readonly summary: "Create knowledge base";
9497
- readonly 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\"}.";
9512
+ readonly 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\"}.";
9498
9513
  readonly http: "POST";
9499
9514
  readonly path: "/knowledge/v1/vector_stores";
9500
9515
  readonly streaming: "no";
@@ -9528,7 +9543,7 @@ export declare const operations: readonly [{
9528
9543
  readonly name: "chunking_strategy";
9529
9544
  readonly type: "object";
9530
9545
  readonly required: false;
9531
- readonly 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.";
9546
+ readonly 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.";
9532
9547
  }, {
9533
9548
  readonly name: "description";
9534
9549
  readonly type: "string";
@@ -9798,7 +9813,7 @@ export declare const operations: readonly [{
9798
9813
  readonly resource: "knowledge.vectorStores.files";
9799
9814
  readonly method: "create";
9800
9815
  readonly summary: "Add file";
9801
- readonly 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.";
9816
+ readonly 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.";
9802
9817
  readonly http: "POST";
9803
9818
  readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files";
9804
9819
  readonly streaming: "no";
@@ -9825,7 +9840,7 @@ export declare const operations: readonly [{
9825
9840
  readonly name: "chunking_strategy";
9826
9841
  readonly type: "object";
9827
9842
  readonly required: false;
9828
- readonly 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.";
9843
+ readonly 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.";
9829
9844
  }];
9830
9845
  };
9831
9846
  }, {
@@ -10075,11 +10090,22 @@ export declare const operations: readonly [{
10075
10090
  readonly description: "Chunk ID returned by segment listing or native search content.";
10076
10091
  }];
10077
10092
  readonly query: readonly [];
10093
+ }, {
10094
+ readonly resource: "media.generation.capabilities";
10095
+ readonly method: "list";
10096
+ readonly summary: "Get generation capabilities";
10097
+ readonly 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.";
10098
+ readonly http: "GET";
10099
+ readonly path: "/media/v1/generation/capabilities";
10100
+ readonly streaming: "no";
10101
+ readonly pagination: false;
10102
+ readonly pathParams: readonly [];
10103
+ readonly query: readonly [];
10078
10104
  }, {
10079
10105
  readonly resource: "media.libraries";
10080
10106
  readonly method: "list";
10081
10107
  readonly summary: "List libraries";
10082
- readonly 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.";
10108
+ readonly 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.";
10083
10109
  readonly http: "GET";
10084
10110
  readonly path: "/media/v1/libraries";
10085
10111
  readonly streaming: "no";
@@ -10146,7 +10172,7 @@ export declare const operations: readonly [{
10146
10172
  readonly resource: "media.libraries";
10147
10173
  readonly method: "delete";
10148
10174
  readonly summary: "Delete library";
10149
- readonly 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.";
10175
+ readonly 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.";
10150
10176
  readonly http: "DELETE";
10151
10177
  readonly path: "/media/v1/libraries/{library_id}";
10152
10178
  readonly streaming: "no";
@@ -10161,7 +10187,7 @@ export declare const operations: readonly [{
10161
10187
  readonly resource: "media.libraries";
10162
10188
  readonly method: "retrieve";
10163
10189
  readonly summary: "Get library";
10164
- readonly 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.";
10190
+ readonly 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.";
10165
10191
  readonly http: "GET";
10166
10192
  readonly path: "/media/v1/libraries/{library_id}";
10167
10193
  readonly streaming: "no";
@@ -10176,7 +10202,7 @@ export declare const operations: readonly [{
10176
10202
  readonly resource: "media.libraries";
10177
10203
  readonly method: "update";
10178
10204
  readonly summary: "Update library";
10179
- readonly 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.";
10205
+ readonly 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.";
10180
10206
  readonly http: "PATCH";
10181
10207
  readonly path: "/media/v1/libraries/{library_id}";
10182
10208
  readonly streaming: "no";
@@ -10190,6 +10216,12 @@ export declare const operations: readonly [{
10190
10216
  readonly body: {
10191
10217
  readonly required: true;
10192
10218
  readonly fields: readonly [{
10219
+ readonly name: "hotwords";
10220
+ readonly type: "array";
10221
+ readonly itemType: "string";
10222
+ readonly required: false;
10223
+ readonly description: "Correction vocabulary, at most 200 nonblank terms of at most 32 Unicode characters each. Omitted on an unconfigured library: correction derives up to 200 distinct names from the library name and every folder level, excluding generic names such as 原始素材 and 混剪成品. An explicit empty array disables this vocabulary. Updating affects subsequent understanding and explicit reprocessing, not existing results.";
10224
+ }, {
10193
10225
  readonly name: "models";
10194
10226
  readonly type: "object";
10195
10227
  readonly required: false;
@@ -10215,7 +10247,7 @@ export declare const operations: readonly [{
10215
10247
  readonly resource: "media.libraries.assets";
10216
10248
  readonly method: "list";
10217
10249
  readonly summary: "List assets";
10218
- readonly 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.";
10250
+ readonly 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.";
10219
10251
  readonly http: "GET";
10220
10252
  readonly path: "/media/v1/libraries/{library_id}/assets";
10221
10253
  readonly streaming: "no";
@@ -10251,7 +10283,7 @@ export declare const operations: readonly [{
10251
10283
  readonly resource: "media.libraries.assets";
10252
10284
  readonly method: "create";
10253
10285
  readonly summary: "Upload asset";
10254
- readonly 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.";
10286
+ readonly 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.";
10255
10287
  readonly http: "POST";
10256
10288
  readonly path: "/media/v1/libraries/{library_id}/assets";
10257
10289
  readonly streaming: "no";
@@ -10289,7 +10321,7 @@ export declare const operations: readonly [{
10289
10321
  readonly name: "asset_folder";
10290
10322
  readonly type: "string";
10291
10323
  readonly required: false;
10292
- readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected.";
10324
+ readonly 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.";
10293
10325
  }, {
10294
10326
  readonly name: "use_filename";
10295
10327
  readonly type: "boolean";
@@ -10348,7 +10380,7 @@ export declare const operations: readonly [{
10348
10380
  readonly resource: "media.libraries.assets.import";
10349
10381
  readonly method: "create";
10350
10382
  readonly summary: "Import file";
10351
- readonly 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.";
10383
+ readonly 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.";
10352
10384
  readonly http: "POST";
10353
10385
  readonly path: "/media/v1/libraries/{library_id}/assets/import";
10354
10386
  readonly streaming: "no";
@@ -10365,7 +10397,7 @@ export declare const operations: readonly [{
10365
10397
  readonly name: "file_id";
10366
10398
  readonly type: "string";
10367
10399
  readonly required: true;
10368
- readonly 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.";
10400
+ readonly 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.";
10369
10401
  }, {
10370
10402
  readonly name: "public_id";
10371
10403
  readonly type: "string";
@@ -10385,7 +10417,7 @@ export declare const operations: readonly [{
10385
10417
  readonly name: "asset_folder";
10386
10418
  readonly type: "string";
10387
10419
  readonly required: false;
10388
- readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected.";
10420
+ readonly 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.";
10389
10421
  }, {
10390
10422
  readonly name: "use_filename";
10391
10423
  readonly type: "boolean";
@@ -10444,7 +10476,7 @@ export declare const operations: readonly [{
10444
10476
  readonly resource: "media.libraries.assets";
10445
10477
  readonly method: "delete";
10446
10478
  readonly summary: "Delete asset";
10447
- readonly 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.";
10479
+ readonly 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.";
10448
10480
  readonly http: "DELETE";
10449
10481
  readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}";
10450
10482
  readonly streaming: "no";
@@ -10463,7 +10495,7 @@ export declare const operations: readonly [{
10463
10495
  readonly resource: "media.libraries.assets";
10464
10496
  readonly method: "retrieve";
10465
10497
  readonly summary: "Get asset";
10466
- readonly 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.";
10498
+ readonly 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.";
10467
10499
  readonly http: "GET";
10468
10500
  readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}";
10469
10501
  readonly streaming: "no";
@@ -10482,7 +10514,7 @@ export declare const operations: readonly [{
10482
10514
  readonly resource: "media.libraries.assets";
10483
10515
  readonly method: "update";
10484
10516
  readonly summary: "Update asset";
10485
- readonly 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.";
10517
+ readonly 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.";
10486
10518
  readonly http: "PATCH";
10487
10519
  readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}";
10488
10520
  readonly streaming: "no";
@@ -10508,7 +10540,7 @@ export declare const operations: readonly [{
10508
10540
  readonly name: "asset_folder";
10509
10541
  readonly type: "string";
10510
10542
  readonly required: false;
10511
- readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected.";
10543
+ readonly 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.";
10512
10544
  }, {
10513
10545
  readonly name: "tags";
10514
10546
  readonly type: "array";
@@ -10522,11 +10554,46 @@ export declare const operations: readonly [{
10522
10554
  readonly description: "Replacement custom string-metadata map. Nonempty keys are required and serialized JSON must fit within 1024 UTF-8 bytes; an empty object clears the metadata.";
10523
10555
  }];
10524
10556
  };
10557
+ }, {
10558
+ readonly resource: "media.libraries.assets.frames";
10559
+ readonly method: "create";
10560
+ readonly summary: "Create frame URLs";
10561
+ readonly 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.";
10562
+ readonly http: "POST";
10563
+ readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames";
10564
+ readonly streaming: "no";
10565
+ readonly pagination: false;
10566
+ readonly pathParams: readonly [{
10567
+ readonly name: "library_id";
10568
+ readonly sdkName: "library_id";
10569
+ readonly description: "Library identifier returned by library creation or listing; must be accessible to the current credential.";
10570
+ }, {
10571
+ readonly name: "asset_id";
10572
+ readonly sdkName: "asset_id";
10573
+ readonly description: "Video asset identifier returned by asset upload or listing in this library; read its duration before choosing timestamps.";
10574
+ }];
10575
+ readonly query: readonly [];
10576
+ readonly body: {
10577
+ readonly required: true;
10578
+ readonly fields: readonly [{
10579
+ readonly name: "at_micros";
10580
+ readonly type: "array";
10581
+ readonly itemType: "integer";
10582
+ readonly required: true;
10583
+ readonly 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.";
10584
+ }, {
10585
+ readonly name: "width";
10586
+ readonly type: "integer";
10587
+ readonly enum: readonly [160, 320, 640];
10588
+ readonly required: false;
10589
+ readonly 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.";
10590
+ }];
10591
+ };
10525
10592
  }, {
10526
10593
  readonly resource: "media.libraries.assets.reprocess";
10527
10594
  readonly method: "create";
10528
10595
  readonly summary: "Reprocess asset";
10529
- readonly 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.";
10596
+ readonly 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.";
10530
10597
  readonly http: "POST";
10531
10598
  readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess";
10532
10599
  readonly streaming: "no";
@@ -10549,14 +10616,14 @@ export declare const operations: readonly [{
10549
10616
  readonly itemType: "string";
10550
10617
  readonly enum: readonly ["visual", "frames", "transcript", "embedding"];
10551
10618
  readonly required: false;
10552
- readonly 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.";
10619
+ readonly 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.";
10553
10620
  }];
10554
10621
  };
10555
10622
  }, {
10556
10623
  readonly resource: "media.libraries.assets.understandings";
10557
10624
  readonly method: "list";
10558
10625
  readonly summary: "List understandings";
10559
- readonly 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.";
10626
+ readonly 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.";
10560
10627
  readonly http: "GET";
10561
10628
  readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/understandings";
10562
10629
  readonly streaming: "no";
@@ -10578,9 +10645,9 @@ export declare const operations: readonly [{
10578
10645
  }, {
10579
10646
  readonly name: "kind";
10580
10647
  readonly type: "string";
10581
- readonly enum: readonly ["caption", "tags", "ocr", "transcript", "frame"];
10648
+ readonly enum: readonly ["caption", "tags", "ocr", "transcript", "frame", "overview", "audio", "embedding"];
10582
10649
  readonly required: false;
10583
- readonly 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.";
10650
+ readonly 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.";
10584
10651
  }, {
10585
10652
  readonly name: "cursor";
10586
10653
  readonly type: "string";
@@ -10596,7 +10663,7 @@ export declare const operations: readonly [{
10596
10663
  readonly resource: "media.libraries.assets";
10597
10664
  readonly method: "batch";
10598
10665
  readonly summary: "Batch assets alias";
10599
- readonly 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.";
10666
+ readonly 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.";
10600
10667
  readonly http: "POST";
10601
10668
  readonly path: "/media/v1/libraries/{library_id}/assets:batch";
10602
10669
  readonly streaming: "no";
@@ -10614,13 +10681,18 @@ export declare const operations: readonly [{
10614
10681
  readonly type: "object";
10615
10682
  readonly required: true;
10616
10683
  readonly description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created.";
10684
+ }, {
10685
+ readonly name: "reason";
10686
+ readonly type: "string";
10687
+ readonly required: false;
10688
+ readonly description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters.";
10617
10689
  }];
10618
10690
  };
10619
10691
  }, {
10620
10692
  readonly resource: "media.libraries.batches";
10621
10693
  readonly method: "create";
10622
10694
  readonly summary: "Create batch";
10623
- readonly 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.";
10695
+ readonly 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.";
10624
10696
  readonly http: "POST";
10625
10697
  readonly path: "/media/v1/libraries/{library_id}/batches";
10626
10698
  readonly streaming: "no";
@@ -10638,13 +10710,18 @@ export declare const operations: readonly [{
10638
10710
  readonly type: "object";
10639
10711
  readonly required: true;
10640
10712
  readonly description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created.";
10713
+ }, {
10714
+ readonly name: "reason";
10715
+ readonly type: "string";
10716
+ readonly required: false;
10717
+ readonly description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters.";
10641
10718
  }];
10642
10719
  };
10643
10720
  }, {
10644
10721
  readonly resource: "media.libraries.batches";
10645
10722
  readonly method: "retrieve";
10646
10723
  readonly summary: "Get batch";
10647
- readonly 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.";
10724
+ readonly 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.";
10648
10725
  readonly http: "GET";
10649
10726
  readonly path: "/media/v1/libraries/{library_id}/batches/{job_id}";
10650
10727
  readonly streaming: "no";
@@ -10663,7 +10740,7 @@ export declare const operations: readonly [{
10663
10740
  readonly resource: "media.libraries.deliveryTokens";
10664
10741
  readonly method: "create";
10665
10742
  readonly summary: "Create delivery token";
10666
- readonly description: "Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is 3600 seconds; narrow acl and expires_in before sharing. Anyone holding the token can read matching paths until expires_at.";
10743
+ readonly description: "Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is 900 seconds; narrow acl and expires_in before sharing. Anyone holding the token can read matching paths until expires_at.";
10667
10744
  readonly http: "POST";
10668
10745
  readonly path: "/media/v1/libraries/{library_id}/delivery_tokens";
10669
10746
  readonly streaming: "no";
@@ -10685,14 +10762,14 @@ export declare const operations: readonly [{
10685
10762
  readonly name: "expires_in";
10686
10763
  readonly type: "integer";
10687
10764
  readonly required: false;
10688
- readonly description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 3600.";
10765
+ readonly description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 900.";
10689
10766
  }];
10690
10767
  };
10691
10768
  }, {
10692
10769
  readonly resource: "media.libraries.events";
10693
10770
  readonly method: "list";
10694
10771
  readonly summary: "List events";
10695
- readonly 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.";
10772
+ readonly 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.";
10696
10773
  readonly http: "GET";
10697
10774
  readonly path: "/media/v1/libraries/{library_id}/events";
10698
10775
  readonly streaming: "no";
@@ -10728,7 +10805,7 @@ export declare const operations: readonly [{
10728
10805
  readonly resource: "media.libraries.folders";
10729
10806
  readonly method: "list";
10730
10807
  readonly summary: "List folders";
10731
- readonly 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.";
10808
+ readonly description: "undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.";
10732
10809
  readonly http: "GET";
10733
10810
  readonly path: "/media/v1/libraries/{library_id}/folders";
10734
10811
  readonly streaming: "no";
@@ -10744,11 +10821,120 @@ export declare const operations: readonly [{
10744
10821
  readonly required: false;
10745
10822
  readonly description: "Folder whose immediate children are returned. Omit or use an empty string for the library root; invalid folder paths are rejected.";
10746
10823
  }];
10824
+ }, {
10825
+ readonly resource: "media.libraries.generations";
10826
+ readonly method: "create";
10827
+ readonly summary: "Create video generation";
10828
+ readonly 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.";
10829
+ readonly http: "POST";
10830
+ readonly path: "/media/v1/libraries/{library_id}/generations";
10831
+ readonly streaming: "no";
10832
+ readonly pagination: false;
10833
+ readonly pathParams: readonly [{
10834
+ readonly name: "library_id";
10835
+ readonly sdkName: "library_id";
10836
+ readonly description: "Library ID returned by creation.";
10837
+ }];
10838
+ readonly query: readonly [];
10839
+ readonly body: {
10840
+ readonly required: true;
10841
+ readonly fields: readonly [{
10842
+ readonly name: "intent";
10843
+ readonly type: "string";
10844
+ readonly required: true;
10845
+ readonly description: "Generation operation; v1 accepts only video.generate text-to-video requests.";
10846
+ }, {
10847
+ readonly name: "prompt";
10848
+ readonly type: "string";
10849
+ readonly required: true;
10850
+ readonly description: "Text prompt describing the video to generate.";
10851
+ }, {
10852
+ readonly name: "count";
10853
+ readonly type: "integer";
10854
+ readonly required: false;
10855
+ readonly description: "Number of videos to generate; defaults to 1 and must be from 1 to 4.";
10856
+ }, {
10857
+ readonly name: "duration_seconds";
10858
+ readonly type: "integer";
10859
+ readonly required: false;
10860
+ readonly description: "Requested video duration in seconds; Router validates the model-specific supported durations.";
10861
+ }, {
10862
+ readonly name: "aspect_ratio";
10863
+ readonly type: "string";
10864
+ readonly required: false;
10865
+ readonly description: "Requested output aspect ratio; defaults to 16:9 and Router validates model support.";
10866
+ }, {
10867
+ readonly name: "model";
10868
+ readonly type: "string";
10869
+ readonly required: false;
10870
+ readonly description: "Router model with video_generation capability; defaults to wan2.7-t2v.";
10871
+ }, {
10872
+ readonly name: "save";
10873
+ readonly type: "string";
10874
+ readonly enum: readonly ["candidate", "library"];
10875
+ readonly required: false;
10876
+ readonly description: "candidate keeps outputs temporary for explicit save calls; library saves successful outputs automatically.";
10877
+ }, {
10878
+ readonly name: "asset_folder";
10879
+ readonly type: "string";
10880
+ readonly required: false;
10881
+ readonly 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.";
10882
+ }, {
10883
+ readonly name: "tags";
10884
+ readonly type: "array";
10885
+ readonly itemType: "string";
10886
+ readonly required: false;
10887
+ readonly description: "Tags applied when an output becomes a library asset.";
10888
+ }, {
10889
+ readonly name: "understanding";
10890
+ readonly type: "string";
10891
+ readonly enum: readonly ["auto", "skip"];
10892
+ readonly required: false;
10893
+ readonly description: "Understanding behavior when a candidate is saved as an asset; defaults to auto.";
10894
+ }, {
10895
+ readonly name: "references";
10896
+ readonly type: "array";
10897
+ readonly itemType: "object";
10898
+ readonly required: false;
10899
+ readonly description: "Not supported in v1; omit this field. Only text-to-video is currently available.";
10900
+ }];
10901
+ };
10902
+ }, {
10903
+ readonly resource: "media.libraries.jobs";
10904
+ readonly method: "list";
10905
+ readonly summary: "List jobs";
10906
+ readonly 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.";
10907
+ readonly http: "GET";
10908
+ readonly path: "/media/v1/libraries/{library_id}/jobs";
10909
+ readonly streaming: "no";
10910
+ readonly pagination: true;
10911
+ readonly pathParams: readonly [{
10912
+ readonly name: "library_id";
10913
+ readonly sdkName: "library_id";
10914
+ readonly description: "Library ID returned by creation.";
10915
+ }];
10916
+ readonly query: readonly [{
10917
+ readonly name: "status";
10918
+ readonly type: "string";
10919
+ readonly enum: readonly ["queued", "running", "completed", "completed_with_errors", "failed", "cancelled"];
10920
+ readonly required: false;
10921
+ readonly description: "Filter jobs by their current status.";
10922
+ }, {
10923
+ readonly name: "limit";
10924
+ readonly type: "integer";
10925
+ readonly required: false;
10926
+ readonly description: "Maximum entries in this page, from 1 through 100; defaults to 100.";
10927
+ }, {
10928
+ readonly name: "cursor";
10929
+ readonly type: "string";
10930
+ readonly required: false;
10931
+ readonly description: "Job id from the previous page’s next_cursor; omit for the first page.";
10932
+ }];
10747
10933
  }, {
10748
10934
  readonly resource: "media.libraries.jobs";
10749
10935
  readonly method: "retrieve";
10750
- readonly summary: "Get job alias";
10751
- readonly description: "Alias of batch retrieval. Read the job returned by a batch request, including terminal status, successful and failed counts, and individual failure codes.";
10936
+ readonly summary: "Get job";
10937
+ readonly 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.";
10752
10938
  readonly http: "GET";
10753
10939
  readonly path: "/media/v1/libraries/{library_id}/jobs/{job_id}";
10754
10940
  readonly streaming: "no";
@@ -10760,14 +10946,82 @@ export declare const operations: readonly [{
10760
10946
  }, {
10761
10947
  readonly name: "job_id";
10762
10948
  readonly sdkName: "job_id";
10763
- readonly description: "Batch identifier returned by createBatch or batchAssets; resolved within this library.";
10949
+ readonly description: "Job identifier returned by batch creation, video-generation creation or job listing; resolved within this library.";
10950
+ }];
10951
+ readonly query: readonly [];
10952
+ }, {
10953
+ readonly resource: "media.libraries.jobs";
10954
+ readonly method: "cancel";
10955
+ readonly summary: "Cancel job";
10956
+ readonly 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.";
10957
+ readonly http: "POST";
10958
+ readonly path: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel";
10959
+ readonly streaming: "no";
10960
+ readonly pagination: false;
10961
+ readonly pathParams: readonly [{
10962
+ readonly name: "library_id";
10963
+ readonly sdkName: "library_id";
10964
+ readonly description: "Library ID returned by creation.";
10965
+ }, {
10966
+ readonly name: "job_id";
10967
+ readonly sdkName: "job_id";
10968
+ readonly description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library.";
10764
10969
  }];
10765
10970
  readonly query: readonly [];
10971
+ }, {
10972
+ readonly resource: "media.libraries.jobs.outputs.save";
10973
+ readonly method: "create";
10974
+ readonly summary: "Save generation output";
10975
+ readonly 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.";
10976
+ readonly http: "POST";
10977
+ readonly path: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save";
10978
+ readonly streaming: "no";
10979
+ readonly pagination: false;
10980
+ readonly pathParams: readonly [{
10981
+ readonly name: "library_id";
10982
+ readonly sdkName: "library_id";
10983
+ readonly description: "Library ID returned by creation.";
10984
+ }, {
10985
+ readonly name: "job_id";
10986
+ readonly sdkName: "job_id";
10987
+ readonly description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library.";
10988
+ }, {
10989
+ readonly name: "index";
10990
+ readonly sdkName: "index";
10991
+ readonly description: "Zero-based position of the candidate in the Job outputs array.";
10992
+ }];
10993
+ readonly query: readonly [];
10994
+ readonly body: {
10995
+ readonly required: false;
10996
+ readonly fields: readonly [{
10997
+ readonly name: "public_id";
10998
+ readonly type: "string";
10999
+ readonly required: false;
11000
+ readonly description: "Delivery identifier for the saved asset; defaults to gen_<job_id>_<index> and is idempotent.";
11001
+ }, {
11002
+ readonly name: "asset_folder";
11003
+ readonly type: "string";
11004
+ readonly required: false;
11005
+ readonly 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.";
11006
+ }, {
11007
+ readonly name: "tags";
11008
+ readonly type: "array";
11009
+ readonly itemType: "string";
11010
+ readonly required: false;
11011
+ readonly description: "Tags to apply to the saved asset.";
11012
+ }, {
11013
+ readonly name: "understanding";
11014
+ readonly type: "string";
11015
+ readonly enum: readonly ["auto", "skip"];
11016
+ readonly required: false;
11017
+ readonly description: "Understanding behavior for the saved asset; defaults to auto.";
11018
+ }];
11019
+ };
10766
11020
  }, {
10767
11021
  readonly resource: "media.libraries.purge";
10768
11022
  readonly method: "create";
10769
11023
  readonly summary: "Purge library";
10770
- readonly 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.";
11024
+ readonly 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.";
10771
11025
  readonly http: "POST";
10772
11026
  readonly path: "/media/v1/libraries/{library_id}/purge";
10773
11027
  readonly streaming: "no";
@@ -10782,7 +11036,7 @@ export declare const operations: readonly [{
10782
11036
  readonly resource: "media.libraries";
10783
11037
  readonly method: "restore";
10784
11038
  readonly summary: "Restore library";
10785
- readonly 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.";
11039
+ readonly 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.";
10786
11040
  readonly http: "POST";
10787
11041
  readonly path: "/media/v1/libraries/{library_id}/restore";
10788
11042
  readonly streaming: "no";
@@ -10797,7 +11051,7 @@ export declare const operations: readonly [{
10797
11051
  readonly resource: "media.libraries.search";
10798
11052
  readonly method: "create";
10799
11053
  readonly summary: "Semantic search alias";
10800
- readonly 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.";
11054
+ readonly 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.";
10801
11055
  readonly http: "POST";
10802
11056
  readonly path: "/media/v1/libraries/{library_id}/search";
10803
11057
  readonly streaming: "no";
@@ -10837,7 +11091,7 @@ export declare const operations: readonly [{
10837
11091
  readonly resource: "media.libraries.search.expression";
10838
11092
  readonly method: "create";
10839
11093
  readonly summary: "Expression search";
10840
- readonly 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.";
11094
+ readonly 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.";
10841
11095
  readonly http: "POST";
10842
11096
  readonly path: "/media/v1/libraries/{library_id}/search/expression";
10843
11097
  readonly streaming: "no";
@@ -10854,7 +11108,7 @@ export declare const operations: readonly [{
10854
11108
  readonly name: "expression";
10855
11109
  readonly type: "string";
10856
11110
  readonly required: false;
10857
- readonly 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.";
11111
+ readonly 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.";
10858
11112
  }, {
10859
11113
  readonly name: "sort_by";
10860
11114
  readonly type: "array";
@@ -10891,7 +11145,7 @@ export declare const operations: readonly [{
10891
11145
  readonly resource: "media.libraries.search.semantic";
10892
11146
  readonly method: "create";
10893
11147
  readonly summary: "Semantic search";
10894
- readonly 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.";
11148
+ readonly 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.";
10895
11149
  readonly http: "POST";
10896
11150
  readonly path: "/media/v1/libraries/{library_id}/search/semantic";
10897
11151
  readonly streaming: "no";
@@ -10931,7 +11185,7 @@ export declare const operations: readonly [{
10931
11185
  readonly resource: "media.libraries.search.visual";
10932
11186
  readonly method: "create";
10933
11187
  readonly summary: "Visual search";
10934
- readonly 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.";
11188
+ readonly 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.";
10935
11189
  readonly http: "POST";
10936
11190
  readonly path: "/media/v1/libraries/{library_id}/search/visual";
10937
11191
  readonly streaming: "no";
@@ -10966,6 +11220,56 @@ export declare const operations: readonly [{
10966
11220
  readonly description: "Expression filter restricting eligible result assets.";
10967
11221
  }];
10968
11222
  };
11223
+ }, {
11224
+ readonly resource: "media.libraries.understandings";
11225
+ readonly method: "list";
11226
+ readonly summary: "List understanding results across a library";
11227
+ readonly 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.";
11228
+ readonly http: "GET";
11229
+ readonly path: "/media/v1/libraries/{library_id}/understandings";
11230
+ readonly streaming: "no";
11231
+ readonly pagination: true;
11232
+ readonly pathParams: readonly [{
11233
+ readonly name: "library_id";
11234
+ readonly sdkName: "library_id";
11235
+ readonly description: "Library ID returned by creation.";
11236
+ }];
11237
+ readonly query: readonly [{
11238
+ readonly name: "folder";
11239
+ readonly type: "string";
11240
+ readonly required: false;
11241
+ readonly description: "Folder path including all descendants; omitted or empty selects the entire library.";
11242
+ }, {
11243
+ readonly name: "kinds";
11244
+ readonly type: "string";
11245
+ readonly required: false;
11246
+ readonly description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind.";
11247
+ }, {
11248
+ readonly name: "cursor";
11249
+ readonly type: "string";
11250
+ readonly required: false;
11251
+ readonly description: "Cursor from the previous next_cursor.";
11252
+ }, {
11253
+ readonly name: "limit";
11254
+ readonly type: "integer";
11255
+ readonly required: false;
11256
+ readonly description: "Maximum entries in this page, from 1 through 100; defaults to 100.";
11257
+ }];
11258
+ }, {
11259
+ readonly resource: "media.libraries.understandings";
11260
+ readonly method: "retrieveFailureSummary";
11261
+ readonly summary: "Summarize understanding failures";
11262
+ readonly 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.";
11263
+ readonly http: "GET";
11264
+ readonly path: "/media/v1/libraries/{library_id}/understandings/failure_summary";
11265
+ readonly streaming: "no";
11266
+ readonly pagination: false;
11267
+ readonly pathParams: readonly [{
11268
+ readonly name: "library_id";
11269
+ readonly sdkName: "library_id";
11270
+ readonly description: "Library ID returned by creation.";
11271
+ }];
11272
+ readonly query: readonly [];
10969
11273
  }, {
10970
11274
  readonly resource: "meta.docs";
10971
11275
  readonly method: "search";
@@ -11179,35 +11483,35 @@ export declare const operations: readonly [{
11179
11483
  readonly name: "model";
11180
11484
  readonly type: "string";
11181
11485
  readonly required: true;
11182
- readonly 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.";
11486
+ readonly description: "Model catalog identifier declaring openai.audio.transcriptions; use it unchanged, including any creator prefix.";
11183
11487
  }, {
11184
11488
  readonly name: "file";
11185
11489
  readonly type: "string";
11186
11490
  readonly required: true;
11187
- readonly description: "Audio file to transcribe, uploaded as multipart/form-data. Router support (supported): Verified to take effect.";
11491
+ readonly description: "Audio bytes uploaded as a multipart file; supported formats and input limits depend on the selected model.";
11188
11492
  }, {
11189
11493
  readonly name: "language";
11190
11494
  readonly type: "string";
11191
11495
  readonly required: false;
11192
- readonly 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.";
11496
+ readonly description: "Source language code when known; omit to let the model detect the language.";
11193
11497
  }, {
11194
11498
  readonly name: "prompt";
11195
11499
  readonly type: "string";
11196
11500
  readonly required: false;
11197
- readonly 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.";
11501
+ readonly description: "Optional vocabulary or contextual guidance for recognizing the audio; support depends on the selected model.";
11198
11502
  }, {
11199
11503
  readonly name: "response_format";
11200
11504
  readonly type: "string";
11201
- readonly enum: readonly ["json", "text", "verbose_json"];
11505
+ readonly enum: readonly ["json", "text", "verbose_json", "diarized_json"];
11202
11506
  readonly required: false;
11203
- readonly 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.";
11507
+ readonly 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.";
11204
11508
  }, {
11205
11509
  readonly name: "timestamp_granularities[]";
11206
11510
  readonly type: "array";
11207
11511
  readonly itemType: "string";
11208
- readonly enum: readonly ["segment"];
11512
+ readonly enum: readonly ["word", "segment"];
11209
11513
  readonly required: false;
11210
- readonly 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.";
11514
+ readonly 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.";
11211
11515
  }, {
11212
11516
  readonly name: "temperature";
11213
11517
  readonly type: "number";
@@ -15119,7 +15423,7 @@ export declare const operations: readonly [{
15119
15423
  readonly name: "filter";
15120
15424
  readonly type: "string";
15121
15425
  readonly required: false;
15122
- readonly 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.";
15426
+ readonly 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.";
15123
15427
  }];
15124
15428
  }, {
15125
15429
  readonly resource: "ticket.tickets";