@deepraxis/cli 0.2.1-dev.6dcf6a1 → 0.2.1-dev.71b291b

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/COMMANDS.md +14 -5
  2. package/dist/praxis.js +595 -61
  3. package/package.json +1 -1
package/dist/praxis.js CHANGED
@@ -9962,7 +9962,7 @@ Execution errors include error.details.prints containing output printed before f
9962
9962
  resource: "cut.projects.analysis",
9963
9963
  method: "create",
9964
9964
  summary: "Analyze project media",
9965
- description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible.",
9965
+ description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible. Silence measures transcript-based speech pauses, not music or loudness. A completed transcript without words returns ready with empty segments and reason no_speech; no completed transcript returns unsupported with reason no_transcript. A failed transcription remains failed.",
9966
9966
  http: "POST",
9967
9967
  path: "/cut/v1/projects/{project_id}/analysis",
9968
9968
  streaming: "no",
@@ -10133,6 +10133,18 @@ Execution errors include error.details.prints containing output printed before f
10133
10133
  body: {
10134
10134
  required: true,
10135
10135
  fields: [
10136
+ {
10137
+ name: "folder",
10138
+ type: "string",
10139
+ required: false,
10140
+ description: "Optional destination path within the bound media library; omitted uses its default folder."
10141
+ },
10142
+ {
10143
+ name: "name",
10144
+ type: "string",
10145
+ required: false,
10146
+ description: "Nonempty display name, frozen with the export. Path separators and control characters become hyphens; limited to 200 characters. Omitted uses project name and timestamp."
10147
+ },
10136
10148
  {
10137
10149
  name: "output",
10138
10150
  type: "object",
@@ -10158,7 +10170,7 @@ Execution errors include error.details.prints containing output printed before f
10158
10170
  resource: "cut.projects.frames",
10159
10171
  method: "list",
10160
10172
  summary: "Render preview frames",
10161
- description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Fetch the returned image URLs before expires_at; render again when they expire.",
10173
+ description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution. The response always includes warnings; FRAME_UNAVAILABLE means a source preview could not be obtained and an offline tile was drawn. Its message identifies a timeout, delivery capacity limit, or unavailable source and contains no source URL. Decode each image's base64 payload to save it. Codemode returns at most four images per call, so request at most four times when reviewing there.",
10162
10174
  http: "GET",
10163
10175
  path: "/cut/v1/projects/{project_id}/frames",
10164
10176
  streaming: "no",
@@ -10181,7 +10193,7 @@ Execution errors include error.details.prints containing output printed before f
10181
10193
  name: "scale",
10182
10194
  type: "number",
10183
10195
  required: false,
10184
- description: "Positive image size multiplier; 0.5 renders at half the project dimensions."
10196
+ description: "Image size multiplier, default 0.25, greater than zero and at most 0.5. Larger values return INVALID_PARAMS; pixel-area limits may reduce actual dimensions, reported as width and height."
10185
10197
  },
10186
10198
  {
10187
10199
  name: "revision",
@@ -10373,7 +10385,7 @@ Execution errors include error.details.prints containing output printed before f
10373
10385
  resource: "cut.projects",
10374
10386
  method: "execute",
10375
10387
  summary: "Execute editing script",
10376
- description: 'Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Use AddTrack, Insert, Update, Delete, Split, Trim, Move, RippleDeleteRange, UpdateTrack, DeleteTrack, SetSettings, AddCaptionsFromTranscript and SetMarker for writes; GetTimeline, GetItem, FindItems, GetMedia, GetTranscript and GetAnalysis read editing context; Print emits text and Preview requests frame previews. All script times are seconds; script object fields use camelCase, for example `media: {libraryId, assetId}`. 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:\n\n```js\nconst t = AddTrack("video");\nInsert(t, {type: "color", color: "#123456", start: 0, length: 3});\nPrint(t);\n```',
10388
+ description: 'Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: `const t = AddTrack("video"); Insert(t, {type: "color", color: "#123456", start: 0, length: 3}); Print(t);`\n\n### Script function reference\n\nFunctions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. JoinId is the string returned by Join or read from GetTimeline().joins. Reads see earlier writes in the same script.\n\n```ts\nGetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;\nGetItem(id: ClipId): ItemView;\nFindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];\nGetMedia(ref: MediaRef): MediaInfo;\nGetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];\nGetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];\nListTransitions(): TransitionInfo[];\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, 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 }, 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, playback, sourceIn/sourceOut, text and offline reason. GetTimeline returns duration, tracks (id, kind, name, index, locked, items), and joins (id, track, left, right, length in seconds, normalized effect). from/to and tracks narrow the items and joins; joins are selected by their overlap window. |\n| ListTransitions | Discover the shared validation catalog: each entry contains kind (effect ID), name, description and params. Each parameter has name, type (enum/number/integer), default, description, enum values or numeric min/max. Use the returned kind and parameter names inside effect. |\n| 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. 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 and style as appropriate to track kind. |\n| SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |\n| AddCaptionsFromTranscript | Create captions from an audio/video clip\'s kept words. Optional maxChars is 1–1000, default 16; style updates the caption track. Returns caption IDs. |\n| SetMarker | Add a label at a timeline time and return its ID. |\n| Print, Preview | Print appends text to prints. Preview requests up to eight times total per execute and puts images in the result\'s frames. Each url is an inline PNG data URL, not an HTTP image link. Decode the base64 payload to save an image. Codemode returns at most four images per call; request at most four times there. |\n\n#### Joins between clips\n\nEndpoints may be video, image, text, color or shape; audio and caption are rejected. Require 0 < length < each endpoint\'s length. Each clip allows at most one incoming and one outgoing join; their summed lengths cannot exceed its length. Three-input overlaps, nonadjacent endpoints and cross-track joins are rejected with OPS_REJECTED. Read the rejection\'s code and message, shorten or remove conflicting joins, and retry the saved edit.\n\nTransitionInput is an object with kind plus the parameters returned by ListTransitions; omitted parameters use catalog defaults. Unknown kinds and invalid parameters return INVALID_TRANSITION_PARAM with available parameters. Effects: dissolve; dip color black/white default black; push and wipe direction left/right/up/down default left; wipe softness 0–1 default 0; iris centerX/centerY 0–1 default 0.5; blinds integer count 2–64 default 8 and orientation vertical/horizontal default vertical; blur radius 0–100 pixels at 1080-pixel frame height default 24; zoom direction in/out default in, amount 0.1–3 default 1, blur 0–1 default 0.5; clock direction clockwise/counterclockwise default clockwise, startAngle 0–360 degrees default 0 (twelve o\'clock), softness 0–1 default 0; flash color white/black default white, intensity 0–1 default 1. Zoom blur uses up to eight radial samples per shot and is slower on server rendering. Join options and UpdateJoin patches accept only length and effect. Effect updates replace the effect object and apply defaults for omitted parameters.\n\nMinimal example on an existing visual track with adjacent clips left and right: `Print(ListTransitions()); const j = Join(left, right, {length: 0.5, effect: {kind: "dissolve"}}); Print(GetTimeline().joins); Preview([GetItem(right).start + 0.25]);` Use `UpdateJoin(j, {length: 0.8})` to adjust it in a later edit or `DeleteJoin(j)` to restore the cut. Preview uses server-rendered frames and includes joins. Per-clip transitionIn/transitionOut remain separate entrance/exit effects.\n\n#### Insert fields (ItemInit)\n\nEvery item requires `type` and `start`. Times used for editing are seconds and snap to the project frame rate: start, length, sourceIn, fadeIn/fadeOut, transition length, keyframe at, reveal delay/stagger/duration. Keyframe and reveal times are relative to the clip start. Video/audio may omit length to use the remaining source duration; other types require length.\n\n| type | Required fields beyond type/start | Optional fields |\n| --- | --- | --- |\n| video | media | length, sourceIn, playback, volumeDb, transform, fit, animate, animation, transitionIn, transitionOut |\n| image | media, length | transform, fit, animate, animation, transitionIn, transitionOut |\n| text | text, length | style, transform, reveal, animate, animation, transitionIn, transitionOut |\n| color | color, length | transform, fill, animate, animation, transitionIn, transitionOut |\n| shape | shape, length, width, height, fill | radius, stroke, transform, animate, animation, transitionIn, transitionOut |\n| audio | media | length, sourceIn, playback, volumeDb, fadeIn, fadeOut |\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, 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#### Update fields (ItemPatchView)\n\nAll fields are optional; use only fields relevant to the item\'s type. Supported fields: start, length, sourceIn, playback, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, animate, reveal, animation, fill, stroke, shape, width, height, radius, transitionIn, transitionOut. Values and units match Insert. 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',
10377
10389
  http: "POST",
10378
10390
  path: "/cut/v1/projects/{project_id}:execute",
10379
10391
  streaming: "no",
@@ -11465,7 +11477,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11465
11477
  resource: "file.files",
11466
11478
  method: "create",
11467
11479
  summary: "Upload file",
11468
- 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.',
11480
+ 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.',
11469
11481
  http: "POST",
11470
11482
  path: "/file/v1/files",
11471
11483
  streaming: "no",
@@ -11487,10 +11499,11 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11487
11499
  type: "string",
11488
11500
  enum: [
11489
11501
  "user_data",
11502
+ "assistants",
11490
11503
  "vision"
11491
11504
  ],
11492
11505
  required: true,
11493
- 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."
11506
+ 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."
11494
11507
  },
11495
11508
  {
11496
11509
  name: "expires_after",
@@ -11559,7 +11572,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11559
11572
  resource: "file.files.contentLinks",
11560
11573
  method: "revoke",
11561
11574
  summary: "Revoke a file content link",
11562
- 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/>"}.',
11575
+ 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/>"}.',
11563
11576
  http: "POST",
11564
11577
  path: "/file/v1/files/{file_id}/content_links:revoke",
11565
11578
  streaming: "no",
@@ -11588,7 +11601,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11588
11601
  resource: "file.files.contentUrl",
11589
11602
  method: "create",
11590
11603
  summary: "Create a download URL",
11591
- 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}.`,
11604
+ 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}.`,
11592
11605
  http: "POST",
11593
11606
  path: "/file/v1/files/{file_id}/content_url",
11594
11607
  streaming: "no",
@@ -11608,7 +11621,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11608
11621
  name: "ttl_seconds",
11609
11622
  type: "integer",
11610
11623
  required: false,
11611
- description: "Download link lifetime in seconds, from 1 through 604800; omitted means 3600. This does not change the file's own expiry."
11624
+ description: "Download link lifetime in seconds, from 1 through 604800; omitted means 900. This does not change the file's own expiry."
11612
11625
  }
11613
11626
  ]
11614
11627
  }
@@ -11617,7 +11630,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11617
11630
  resource: "file.uploads",
11618
11631
  method: "create",
11619
11632
  summary: "Create an upload",
11620
- 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.",
11633
+ description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data, assistants and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.",
11621
11634
  http: "POST",
11622
11635
  path: "/file/v1/uploads",
11623
11636
  streaming: "no",
@@ -11650,10 +11663,11 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11650
11663
  type: "string",
11651
11664
  enum: [
11652
11665
  "user_data",
11666
+ "assistants",
11653
11667
  "vision"
11654
11668
  ],
11655
11669
  required: true,
11656
- description: "Use user_data for conversation attachments, or vision for PNG, JPEG, GIF and WebP images."
11670
+ description: "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images."
11657
11671
  },
11658
11672
  {
11659
11673
  name: "expires_after",
@@ -11707,10 +11721,11 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11707
11721
  type: "string",
11708
11722
  enum: [
11709
11723
  "user_data",
11724
+ "assistants",
11710
11725
  "vision"
11711
11726
  ],
11712
11727
  required: false,
11713
- description: "user_data stores ordinary files and conversation images; vision accepts PNG, JPEG, GIF or WebP images only. Omitted means user_data."
11728
+ 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."
11714
11729
  },
11715
11730
  {
11716
11731
  name: "expires_in",
@@ -11873,7 +11888,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11873
11888
  resource: "knowledge.vectorStores",
11874
11889
  method: "create",
11875
11890
  summary: "Create knowledge base",
11876
- 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"}.',
11891
+ description: 'Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. 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"}.',
11877
11892
  http: "POST",
11878
11893
  path: "/knowledge/v1/vector_stores",
11879
11894
  streaming: "no",
@@ -11912,7 +11927,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11912
11927
  name: "chunking_strategy",
11913
11928
  type: "object",
11914
11929
  required: false,
11915
- 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."
11930
+ 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."
11916
11931
  },
11917
11932
  {
11918
11933
  name: "description",
@@ -12259,7 +12274,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12259
12274
  resource: "knowledge.vectorStores.files",
12260
12275
  method: "create",
12261
12276
  summary: "Add file",
12262
- 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.",
12277
+ 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.",
12263
12278
  http: "POST",
12264
12279
  path: "/knowledge/v1/vector_stores/{vector_store_id}/files",
12265
12280
  streaming: "no",
@@ -12291,7 +12306,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12291
12306
  name: "chunking_strategy",
12292
12307
  type: "object",
12293
12308
  required: false,
12294
- 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."
12309
+ 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."
12295
12310
  }
12296
12311
  ]
12297
12312
  }
@@ -12598,11 +12613,23 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12598
12613
  ],
12599
12614
  query: []
12600
12615
  },
12616
+ {
12617
+ resource: "media.generation.capabilities",
12618
+ method: "list",
12619
+ summary: "Get generation capabilities",
12620
+ 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.",
12621
+ http: "GET",
12622
+ path: "/media/v1/generation/capabilities",
12623
+ streaming: "no",
12624
+ pagination: false,
12625
+ pathParams: [],
12626
+ query: []
12627
+ },
12601
12628
  {
12602
12629
  resource: "media.libraries",
12603
12630
  method: "list",
12604
12631
  summary: "List libraries",
12605
- 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.",
12632
+ 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.",
12606
12633
  http: "GET",
12607
12634
  path: "/media/v1/libraries",
12608
12635
  streaming: "no",
@@ -12684,7 +12711,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12684
12711
  resource: "media.libraries",
12685
12712
  method: "delete",
12686
12713
  summary: "Delete library",
12687
- 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.",
12714
+ 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.",
12688
12715
  http: "DELETE",
12689
12716
  path: "/media/v1/libraries/{library_id}",
12690
12717
  streaming: "no",
@@ -12702,7 +12729,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12702
12729
  resource: "media.libraries",
12703
12730
  method: "retrieve",
12704
12731
  summary: "Get library",
12705
- 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.",
12732
+ 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.",
12706
12733
  http: "GET",
12707
12734
  path: "/media/v1/libraries/{library_id}",
12708
12735
  streaming: "no",
@@ -12720,7 +12747,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12720
12747
  resource: "media.libraries",
12721
12748
  method: "update",
12722
12749
  summary: "Update library",
12723
- 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.",
12750
+ 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.",
12724
12751
  http: "PATCH",
12725
12752
  path: "/media/v1/libraries/{library_id}",
12726
12753
  streaming: "no",
@@ -12736,6 +12763,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12736
12763
  body: {
12737
12764
  required: true,
12738
12765
  fields: [
12766
+ {
12767
+ name: "hotwords",
12768
+ type: "array",
12769
+ itemType: "string",
12770
+ required: false,
12771
+ 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."
12772
+ },
12739
12773
  {
12740
12774
  name: "models",
12741
12775
  type: "object",
@@ -12767,7 +12801,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12767
12801
  resource: "media.libraries.assets",
12768
12802
  method: "list",
12769
12803
  summary: "List assets",
12770
- 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.",
12804
+ 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.",
12771
12805
  http: "GET",
12772
12806
  path: "/media/v1/libraries/{library_id}/assets",
12773
12807
  streaming: "no",
@@ -12815,7 +12849,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12815
12849
  resource: "media.libraries.assets",
12816
12850
  method: "create",
12817
12851
  summary: "Upload asset",
12818
- 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.",
12852
+ 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.",
12819
12853
  http: "POST",
12820
12854
  path: "/media/v1/libraries/{library_id}/assets",
12821
12855
  streaming: "no",
@@ -12860,7 +12894,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12860
12894
  name: "asset_folder",
12861
12895
  type: "string",
12862
12896
  required: false,
12863
- description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
12897
+ 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."
12864
12898
  },
12865
12899
  {
12866
12900
  name: "use_filename",
@@ -12939,7 +12973,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12939
12973
  resource: "media.libraries.assets.import",
12940
12974
  method: "create",
12941
12975
  summary: "Import file",
12942
- 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.",
12976
+ 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.",
12943
12977
  http: "POST",
12944
12978
  path: "/media/v1/libraries/{library_id}/assets/import",
12945
12979
  streaming: "no",
@@ -12959,7 +12993,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12959
12993
  name: "file_id",
12960
12994
  type: "string",
12961
12995
  required: true,
12962
- 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."
12996
+ 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."
12963
12997
  },
12964
12998
  {
12965
12999
  name: "public_id",
@@ -12983,7 +13017,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12983
13017
  name: "asset_folder",
12984
13018
  type: "string",
12985
13019
  required: false,
12986
- description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
13020
+ 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."
12987
13021
  },
12988
13022
  {
12989
13023
  name: "use_filename",
@@ -13062,7 +13096,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13062
13096
  resource: "media.libraries.assets",
13063
13097
  method: "delete",
13064
13098
  summary: "Delete asset",
13065
- 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.",
13099
+ 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.",
13066
13100
  http: "DELETE",
13067
13101
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
13068
13102
  streaming: "no",
@@ -13085,7 +13119,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13085
13119
  resource: "media.libraries.assets",
13086
13120
  method: "retrieve",
13087
13121
  summary: "Get asset",
13088
- 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.",
13122
+ 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.",
13089
13123
  http: "GET",
13090
13124
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
13091
13125
  streaming: "no",
@@ -13108,7 +13142,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13108
13142
  resource: "media.libraries.assets",
13109
13143
  method: "update",
13110
13144
  summary: "Update asset",
13111
- 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.",
13145
+ 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.",
13112
13146
  http: "PATCH",
13113
13147
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
13114
13148
  streaming: "no",
@@ -13139,7 +13173,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13139
13173
  name: "asset_folder",
13140
13174
  type: "string",
13141
13175
  required: false,
13142
- description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
13176
+ 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."
13143
13177
  },
13144
13178
  {
13145
13179
  name: "tags",
@@ -13157,11 +13191,57 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13157
13191
  ]
13158
13192
  }
13159
13193
  },
13194
+ {
13195
+ resource: "media.libraries.assets.frames",
13196
+ method: "create",
13197
+ summary: "Create frame URLs",
13198
+ 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.',
13199
+ http: "POST",
13200
+ path: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames",
13201
+ streaming: "no",
13202
+ pagination: false,
13203
+ pathParams: [
13204
+ {
13205
+ name: "library_id",
13206
+ sdkName: "library_id",
13207
+ description: "Library identifier returned by library creation or listing; must be accessible to the current credential."
13208
+ },
13209
+ {
13210
+ name: "asset_id",
13211
+ sdkName: "asset_id",
13212
+ description: "Video asset identifier returned by asset upload or listing in this library; read its duration before choosing timestamps."
13213
+ }
13214
+ ],
13215
+ query: [],
13216
+ body: {
13217
+ required: true,
13218
+ fields: [
13219
+ {
13220
+ name: "at_micros",
13221
+ type: "array",
13222
+ itemType: "integer",
13223
+ required: true,
13224
+ 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."
13225
+ },
13226
+ {
13227
+ name: "width",
13228
+ type: "integer",
13229
+ enum: [
13230
+ 160,
13231
+ 320,
13232
+ 640
13233
+ ],
13234
+ required: false,
13235
+ 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."
13236
+ }
13237
+ ]
13238
+ }
13239
+ },
13160
13240
  {
13161
13241
  resource: "media.libraries.assets.reprocess",
13162
13242
  method: "create",
13163
13243
  summary: "Reprocess asset",
13164
- 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.",
13244
+ 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.",
13165
13245
  http: "POST",
13166
13246
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess",
13167
13247
  streaming: "no",
@@ -13193,7 +13273,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13193
13273
  "embedding"
13194
13274
  ],
13195
13275
  required: false,
13196
- 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."
13276
+ 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."
13197
13277
  }
13198
13278
  ]
13199
13279
  }
@@ -13202,7 +13282,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13202
13282
  resource: "media.libraries.assets.understandings",
13203
13283
  method: "list",
13204
13284
  summary: "List understandings",
13205
- 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.",
13285
+ 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.",
13206
13286
  http: "GET",
13207
13287
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}/understandings",
13208
13288
  streaming: "no",
@@ -13234,10 +13314,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13234
13314
  "tags",
13235
13315
  "ocr",
13236
13316
  "transcript",
13237
- "frame"
13317
+ "frame",
13318
+ "overview",
13319
+ "audio",
13320
+ "embedding"
13238
13321
  ],
13239
13322
  required: false,
13240
- 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."
13323
+ 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."
13241
13324
  },
13242
13325
  {
13243
13326
  name: "cursor",
@@ -13257,7 +13340,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13257
13340
  resource: "media.libraries.assets",
13258
13341
  method: "batch",
13259
13342
  summary: "Batch assets alias",
13260
- 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.",
13343
+ 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.',
13261
13344
  http: "POST",
13262
13345
  path: "/media/v1/libraries/{library_id}/assets:batch",
13263
13346
  streaming: "no",
@@ -13278,6 +13361,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13278
13361
  type: "object",
13279
13362
  required: true,
13280
13363
  description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
13364
+ },
13365
+ {
13366
+ name: "reason",
13367
+ type: "string",
13368
+ required: false,
13369
+ description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
13281
13370
  }
13282
13371
  ]
13283
13372
  }
@@ -13286,7 +13375,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13286
13375
  resource: "media.libraries.batches",
13287
13376
  method: "create",
13288
13377
  summary: "Create batch",
13289
- 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.",
13378
+ 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.',
13290
13379
  http: "POST",
13291
13380
  path: "/media/v1/libraries/{library_id}/batches",
13292
13381
  streaming: "no",
@@ -13307,6 +13396,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13307
13396
  type: "object",
13308
13397
  required: true,
13309
13398
  description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
13399
+ },
13400
+ {
13401
+ name: "reason",
13402
+ type: "string",
13403
+ required: false,
13404
+ description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
13310
13405
  }
13311
13406
  ]
13312
13407
  }
@@ -13315,7 +13410,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13315
13410
  resource: "media.libraries.batches",
13316
13411
  method: "retrieve",
13317
13412
  summary: "Get batch",
13318
- 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.",
13413
+ 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.",
13319
13414
  http: "GET",
13320
13415
  path: "/media/v1/libraries/{library_id}/batches/{job_id}",
13321
13416
  streaming: "no",
@@ -13338,7 +13433,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13338
13433
  resource: "media.libraries.deliveryTokens",
13339
13434
  method: "create",
13340
13435
  summary: "Create delivery token",
13341
- 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.",
13436
+ 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.",
13342
13437
  http: "POST",
13343
13438
  path: "/media/v1/libraries/{library_id}/delivery_tokens",
13344
13439
  streaming: "no",
@@ -13364,7 +13459,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13364
13459
  name: "expires_in",
13365
13460
  type: "integer",
13366
13461
  required: false,
13367
- description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 3600."
13462
+ description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 900."
13368
13463
  }
13369
13464
  ]
13370
13465
  }
@@ -13373,7 +13468,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13373
13468
  resource: "media.libraries.events",
13374
13469
  method: "list",
13375
13470
  summary: "List events",
13376
- 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.",
13471
+ 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.",
13377
13472
  http: "GET",
13378
13473
  path: "/media/v1/libraries/{library_id}/events",
13379
13474
  streaming: "no",
@@ -13420,7 +13515,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13420
13515
  resource: "media.libraries.folders",
13421
13516
  method: "list",
13422
13517
  summary: "List folders",
13423
- 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.",
13518
+ description: "undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.",
13424
13519
  http: "GET",
13425
13520
  path: "/media/v1/libraries/{library_id}/folders",
13426
13521
  streaming: "no",
@@ -13441,11 +13536,155 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13441
13536
  }
13442
13537
  ]
13443
13538
  },
13539
+ {
13540
+ resource: "media.libraries.generations",
13541
+ method: "create",
13542
+ summary: "Create video generation",
13543
+ 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.",
13544
+ http: "POST",
13545
+ path: "/media/v1/libraries/{library_id}/generations",
13546
+ streaming: "no",
13547
+ pagination: false,
13548
+ pathParams: [
13549
+ {
13550
+ name: "library_id",
13551
+ sdkName: "library_id",
13552
+ description: "Library ID returned by creation."
13553
+ }
13554
+ ],
13555
+ query: [],
13556
+ body: {
13557
+ required: true,
13558
+ fields: [
13559
+ {
13560
+ name: "intent",
13561
+ type: "string",
13562
+ required: true,
13563
+ description: "Generation operation; v1 accepts only video.generate text-to-video requests."
13564
+ },
13565
+ {
13566
+ name: "prompt",
13567
+ type: "string",
13568
+ required: true,
13569
+ description: "Text prompt describing the video to generate."
13570
+ },
13571
+ {
13572
+ name: "count",
13573
+ type: "integer",
13574
+ required: false,
13575
+ description: "Number of videos to generate; defaults to 1 and must be from 1 to 4."
13576
+ },
13577
+ {
13578
+ name: "duration_seconds",
13579
+ type: "integer",
13580
+ required: false,
13581
+ description: "Requested video duration in seconds; Router validates the model-specific supported durations."
13582
+ },
13583
+ {
13584
+ name: "aspect_ratio",
13585
+ type: "string",
13586
+ required: false,
13587
+ description: "Requested output aspect ratio; defaults to 16:9 and Router validates model support."
13588
+ },
13589
+ {
13590
+ name: "model",
13591
+ type: "string",
13592
+ required: false,
13593
+ description: "Router model with video_generation capability; defaults to wan2.7-t2v."
13594
+ },
13595
+ {
13596
+ name: "save",
13597
+ type: "string",
13598
+ enum: [
13599
+ "candidate",
13600
+ "library"
13601
+ ],
13602
+ required: false,
13603
+ description: "candidate keeps outputs temporary for explicit save calls; library saves successful outputs automatically."
13604
+ },
13605
+ {
13606
+ name: "asset_folder",
13607
+ type: "string",
13608
+ required: false,
13609
+ 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."
13610
+ },
13611
+ {
13612
+ name: "tags",
13613
+ type: "array",
13614
+ itemType: "string",
13615
+ required: false,
13616
+ description: "Tags applied when an output becomes a library asset."
13617
+ },
13618
+ {
13619
+ name: "understanding",
13620
+ type: "string",
13621
+ enum: [
13622
+ "auto",
13623
+ "skip"
13624
+ ],
13625
+ required: false,
13626
+ description: "Understanding behavior when a candidate is saved as an asset; defaults to auto."
13627
+ },
13628
+ {
13629
+ name: "references",
13630
+ type: "array",
13631
+ itemType: "object",
13632
+ required: false,
13633
+ description: "Not supported in v1; omit this field. Only text-to-video is currently available."
13634
+ }
13635
+ ]
13636
+ }
13637
+ },
13638
+ {
13639
+ resource: "media.libraries.jobs",
13640
+ method: "list",
13641
+ summary: "List jobs",
13642
+ 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.",
13643
+ http: "GET",
13644
+ path: "/media/v1/libraries/{library_id}/jobs",
13645
+ streaming: "no",
13646
+ pagination: true,
13647
+ pathParams: [
13648
+ {
13649
+ name: "library_id",
13650
+ sdkName: "library_id",
13651
+ description: "Library ID returned by creation."
13652
+ }
13653
+ ],
13654
+ query: [
13655
+ {
13656
+ name: "status",
13657
+ type: "string",
13658
+ enum: [
13659
+ "queued",
13660
+ "running",
13661
+ "completed",
13662
+ "completed_with_errors",
13663
+ "failed",
13664
+ "cancelled"
13665
+ ],
13666
+ required: false,
13667
+ description: "Filter jobs by their current status."
13668
+ },
13669
+ {
13670
+ name: "limit",
13671
+ type: "integer",
13672
+ required: false,
13673
+ description: "Maximum entries in this page, from 1 through 100; defaults to 100."
13674
+ },
13675
+ {
13676
+ name: "cursor",
13677
+ type: "string",
13678
+ required: false,
13679
+ description: "Job id from the previous page’s next_cursor; omit for the first page."
13680
+ }
13681
+ ]
13682
+ },
13444
13683
  {
13445
13684
  resource: "media.libraries.jobs",
13446
13685
  method: "retrieve",
13447
- summary: "Get job alias",
13448
- description: "Alias of batch retrieval. Read the job returned by a batch request, including terminal status, successful and failed counts, and individual failure codes.",
13686
+ summary: "Get job",
13687
+ 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.",
13449
13688
  http: "GET",
13450
13689
  path: "/media/v1/libraries/{library_id}/jobs/{job_id}",
13451
13690
  streaming: "no",
@@ -13459,16 +13698,101 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13459
13698
  {
13460
13699
  name: "job_id",
13461
13700
  sdkName: "job_id",
13462
- description: "Batch identifier returned by createBatch or batchAssets; resolved within this library."
13701
+ description: "Job identifier returned by batch creation, video-generation creation or job listing; resolved within this library."
13463
13702
  }
13464
13703
  ],
13465
13704
  query: []
13466
13705
  },
13706
+ {
13707
+ resource: "media.libraries.jobs",
13708
+ method: "cancel",
13709
+ summary: "Cancel job",
13710
+ 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.",
13711
+ http: "POST",
13712
+ path: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
13713
+ streaming: "no",
13714
+ pagination: false,
13715
+ pathParams: [
13716
+ {
13717
+ name: "library_id",
13718
+ sdkName: "library_id",
13719
+ description: "Library ID returned by creation."
13720
+ },
13721
+ {
13722
+ name: "job_id",
13723
+ sdkName: "job_id",
13724
+ description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
13725
+ }
13726
+ ],
13727
+ query: []
13728
+ },
13729
+ {
13730
+ resource: "media.libraries.jobs.outputs.save",
13731
+ method: "create",
13732
+ summary: "Save generation output",
13733
+ 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.",
13734
+ http: "POST",
13735
+ path: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
13736
+ streaming: "no",
13737
+ pagination: false,
13738
+ pathParams: [
13739
+ {
13740
+ name: "library_id",
13741
+ sdkName: "library_id",
13742
+ description: "Library ID returned by creation."
13743
+ },
13744
+ {
13745
+ name: "job_id",
13746
+ sdkName: "job_id",
13747
+ description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
13748
+ },
13749
+ {
13750
+ name: "index",
13751
+ sdkName: "index",
13752
+ description: "Zero-based position of the candidate in the Job outputs array."
13753
+ }
13754
+ ],
13755
+ query: [],
13756
+ body: {
13757
+ required: false,
13758
+ fields: [
13759
+ {
13760
+ name: "public_id",
13761
+ type: "string",
13762
+ required: false,
13763
+ description: "Delivery identifier for the saved asset; defaults to gen_<job_id>_<index> and is idempotent."
13764
+ },
13765
+ {
13766
+ name: "asset_folder",
13767
+ type: "string",
13768
+ required: false,
13769
+ 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."
13770
+ },
13771
+ {
13772
+ name: "tags",
13773
+ type: "array",
13774
+ itemType: "string",
13775
+ required: false,
13776
+ description: "Tags to apply to the saved asset."
13777
+ },
13778
+ {
13779
+ name: "understanding",
13780
+ type: "string",
13781
+ enum: [
13782
+ "auto",
13783
+ "skip"
13784
+ ],
13785
+ required: false,
13786
+ description: "Understanding behavior for the saved asset; defaults to auto."
13787
+ }
13788
+ ]
13789
+ }
13790
+ },
13467
13791
  {
13468
13792
  resource: "media.libraries.purge",
13469
13793
  method: "create",
13470
13794
  summary: "Purge library",
13471
- 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.",
13795
+ 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.",
13472
13796
  http: "POST",
13473
13797
  path: "/media/v1/libraries/{library_id}/purge",
13474
13798
  streaming: "no",
@@ -13486,7 +13810,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13486
13810
  resource: "media.libraries",
13487
13811
  method: "restore",
13488
13812
  summary: "Restore library",
13489
- 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.",
13813
+ 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.",
13490
13814
  http: "POST",
13491
13815
  path: "/media/v1/libraries/{library_id}/restore",
13492
13816
  streaming: "no",
@@ -13504,7 +13828,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13504
13828
  resource: "media.libraries.search",
13505
13829
  method: "create",
13506
13830
  summary: "Semantic search alias",
13507
- 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.",
13831
+ 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.",
13508
13832
  http: "POST",
13509
13833
  path: "/media/v1/libraries/{library_id}/search",
13510
13834
  streaming: "no",
@@ -13555,7 +13879,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13555
13879
  resource: "media.libraries.search.expression",
13556
13880
  method: "create",
13557
13881
  summary: "Expression search",
13558
- 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.",
13882
+ 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.",
13559
13883
  http: "POST",
13560
13884
  path: "/media/v1/libraries/{library_id}/search/expression",
13561
13885
  streaming: "no",
@@ -13575,7 +13899,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13575
13899
  name: "expression",
13576
13900
  type: "string",
13577
13901
  required: false,
13578
- 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.'
13902
+ 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.'
13579
13903
  },
13580
13904
  {
13581
13905
  name: "sort_by",
@@ -13627,7 +13951,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13627
13951
  resource: "media.libraries.search.semantic",
13628
13952
  method: "create",
13629
13953
  summary: "Semantic search",
13630
- 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.",
13954
+ 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.",
13631
13955
  http: "POST",
13632
13956
  path: "/media/v1/libraries/{library_id}/search/semantic",
13633
13957
  streaming: "no",
@@ -13678,7 +14002,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13678
14002
  resource: "media.libraries.search.visual",
13679
14003
  method: "create",
13680
14004
  summary: "Visual search",
13681
- 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.",
14005
+ 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.",
13682
14006
  http: "POST",
13683
14007
  path: "/media/v1/libraries/{library_id}/search/visual",
13684
14008
  streaming: "no",
@@ -13721,6 +14045,67 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13721
14045
  ]
13722
14046
  }
13723
14047
  },
14048
+ {
14049
+ resource: "media.libraries.understandings",
14050
+ method: "list",
14051
+ summary: "List understanding results across a library",
14052
+ 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.",
14053
+ http: "GET",
14054
+ path: "/media/v1/libraries/{library_id}/understandings",
14055
+ streaming: "no",
14056
+ pagination: true,
14057
+ pathParams: [
14058
+ {
14059
+ name: "library_id",
14060
+ sdkName: "library_id",
14061
+ description: "Library ID returned by creation."
14062
+ }
14063
+ ],
14064
+ query: [
14065
+ {
14066
+ name: "folder",
14067
+ type: "string",
14068
+ required: false,
14069
+ description: "Folder path including all descendants; omitted or empty selects the entire library."
14070
+ },
14071
+ {
14072
+ name: "kinds",
14073
+ type: "string",
14074
+ required: false,
14075
+ description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind."
14076
+ },
14077
+ {
14078
+ name: "cursor",
14079
+ type: "string",
14080
+ required: false,
14081
+ description: "Cursor from the previous next_cursor."
14082
+ },
14083
+ {
14084
+ name: "limit",
14085
+ type: "integer",
14086
+ required: false,
14087
+ description: "Maximum entries in this page, from 1 through 100; defaults to 100."
14088
+ }
14089
+ ]
14090
+ },
14091
+ {
14092
+ resource: "media.libraries.understandings",
14093
+ method: "retrieveFailureSummary",
14094
+ summary: "Summarize understanding failures",
14095
+ 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.",
14096
+ http: "GET",
14097
+ path: "/media/v1/libraries/{library_id}/understandings/failure_summary",
14098
+ streaming: "no",
14099
+ pagination: false,
14100
+ pathParams: [
14101
+ {
14102
+ name: "library_id",
14103
+ sdkName: "library_id",
14104
+ description: "Library ID returned by creation."
14105
+ }
14106
+ ],
14107
+ query: []
14108
+ },
13724
14109
  {
13725
14110
  resource: "meta.docs",
13726
14111
  method: "search",
@@ -14008,25 +14393,25 @@ services (model, agent, automation…); call the operation you need and read its
14008
14393
  name: "model",
14009
14394
  type: "string",
14010
14395
  required: true,
14011
- 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."
14396
+ description: "Model catalog identifier declaring openai.audio.transcriptions; use it unchanged, including any creator prefix."
14012
14397
  },
14013
14398
  {
14014
14399
  name: "file",
14015
14400
  type: "string",
14016
14401
  required: true,
14017
- description: "Audio file to transcribe, uploaded as multipart/form-data. Router support (supported): Verified to take effect."
14402
+ description: "Audio bytes uploaded as a multipart file; supported formats and input limits depend on the selected model."
14018
14403
  },
14019
14404
  {
14020
14405
  name: "language",
14021
14406
  type: "string",
14022
14407
  required: false,
14023
- 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."
14408
+ description: "Source language code when known; omit to let the model detect the language."
14024
14409
  },
14025
14410
  {
14026
14411
  name: "prompt",
14027
14412
  type: "string",
14028
14413
  required: false,
14029
- 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."
14414
+ description: "Optional vocabulary or contextual guidance for recognizing the audio; support depends on the selected model."
14030
14415
  },
14031
14416
  {
14032
14417
  name: "response_format",
@@ -14034,20 +14419,22 @@ services (model, agent, automation…); call the operation you need and read its
14034
14419
  enum: [
14035
14420
  "json",
14036
14421
  "text",
14037
- "verbose_json"
14422
+ "verbose_json",
14423
+ "diarized_json"
14038
14424
  ],
14039
14425
  required: false,
14040
- 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."
14426
+ 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."
14041
14427
  },
14042
14428
  {
14043
14429
  name: "timestamp_granularities[]",
14044
14430
  type: "array",
14045
14431
  itemType: "string",
14046
14432
  enum: [
14433
+ "word",
14047
14434
  "segment"
14048
14435
  ],
14049
14436
  required: false,
14050
- 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."
14437
+ 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."
14051
14438
  },
14052
14439
  {
14053
14440
  name: "temperature",
@@ -16569,6 +16956,31 @@ for more details.`
16569
16956
  ]
16570
16957
  }
16571
16958
  },
16959
+ {
16960
+ resource: "organization.members",
16961
+ method: "list",
16962
+ summary: "List organization members",
16963
+ description: "Concepts follow GitHub org members: find a person's user id, for example to assign an approver to an approval task. Lists only members of the organization behind your API key or runtime token, ordered by joined_at ascending (membership id breaks ties). Ask the user who should approve, then use that member's id. Emails are visible only within this organization. The request cannot select another organization. Pass next_page unchanged as page; null means the end. Read-only; no usage charge. Example: GET /organization/v1/members?limit=20.",
16964
+ http: "GET",
16965
+ path: "/organization/v1/members",
16966
+ streaming: "no",
16967
+ pagination: false,
16968
+ pathParams: [],
16969
+ query: [
16970
+ {
16971
+ name: "limit",
16972
+ type: "integer",
16973
+ required: false,
16974
+ description: "Maximum members per page, from 1 to 100; defaults to 20."
16975
+ },
16976
+ {
16977
+ name: "page",
16978
+ type: "string",
16979
+ required: false,
16980
+ description: "Opaque next_page cursor returned by the previous response; omit for the first page."
16981
+ }
16982
+ ]
16983
+ },
16572
16984
  {
16573
16985
  resource: "organization.usage",
16574
16986
  method: "list",
@@ -19262,7 +19674,7 @@ for more details.`
19262
19674
  name: "filter",
19263
19675
  type: "string",
19264
19676
  required: false,
19265
- 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."
19677
+ 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."
19266
19678
  }
19267
19679
  ]
19268
19680
  },
@@ -23355,6 +23767,19 @@ var countResponseInputTokens = (options) => (options.client ?? client).post({
23355
23767
  ...options.headers
23356
23768
  }
23357
23769
  });
23770
+ var listOrganizationMembers = (options) => (options?.client ?? client).get({
23771
+ security: [{
23772
+ key: "BearerAuth",
23773
+ scheme: "bearer",
23774
+ type: "http"
23775
+ }, {
23776
+ key: "ApiKeyAuth",
23777
+ name: "X-API-Key",
23778
+ type: "apiKey"
23779
+ }],
23780
+ url: "/organization/v1/members",
23781
+ ...options
23782
+ });
23358
23783
  var listOrganizationFeedback = (options) => (options?.client ?? client).get({
23359
23784
  security: [{
23360
23785
  key: "BearerAuth",
@@ -27225,6 +27650,19 @@ var mediaCreateLibrary = (options) => (options.client ?? client).post({
27225
27650
  ...options.headers
27226
27651
  }
27227
27652
  });
27653
+ var mediaCreateFrameUrls = (options) => (options.client ?? client).post({
27654
+ security: [{
27655
+ key: "media-BearerAuth",
27656
+ scheme: "bearer",
27657
+ type: "http"
27658
+ }],
27659
+ url: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames",
27660
+ ...options,
27661
+ headers: {
27662
+ "Content-Type": "application/json",
27663
+ ...options.headers
27664
+ }
27665
+ });
27228
27666
  var mediaDeleteLibrary = (options) => (options.client ?? client).delete({
27229
27667
  security: [{
27230
27668
  key: "media-BearerAuth",
@@ -27489,6 +27927,77 @@ var mediaCreateDeliveryToken = (options) => (options.client ?? client).post({
27489
27927
  ...options.headers
27490
27928
  }
27491
27929
  });
27930
+ var mediaUnderstandingFailureSummary = (options) => (options.client ?? client).get({
27931
+ security: [{
27932
+ key: "media-BearerAuth",
27933
+ scheme: "bearer",
27934
+ type: "http"
27935
+ }],
27936
+ url: "/media/v1/libraries/{library_id}/understandings/failure_summary",
27937
+ ...options
27938
+ });
27939
+ var mediaListUnderstandingsByLibrary = (options) => (options.client ?? client).get({
27940
+ security: [{
27941
+ key: "media-BearerAuth",
27942
+ scheme: "bearer",
27943
+ type: "http"
27944
+ }],
27945
+ url: "/media/v1/libraries/{library_id}/understandings",
27946
+ ...options
27947
+ });
27948
+ var mediaCreateGeneration = (options) => (options.client ?? client).post({
27949
+ security: [{
27950
+ key: "media-BearerAuth",
27951
+ scheme: "bearer",
27952
+ type: "http"
27953
+ }],
27954
+ url: "/media/v1/libraries/{library_id}/generations",
27955
+ ...options,
27956
+ headers: {
27957
+ "Content-Type": "application/json",
27958
+ ...options.headers
27959
+ }
27960
+ });
27961
+ var mediaListJobs = (options) => (options.client ?? client).get({
27962
+ security: [{
27963
+ key: "media-BearerAuth",
27964
+ scheme: "bearer",
27965
+ type: "http"
27966
+ }],
27967
+ url: "/media/v1/libraries/{library_id}/jobs",
27968
+ ...options
27969
+ });
27970
+ var mediaCancelJob = (options) => (options.client ?? client).post({
27971
+ security: [{
27972
+ key: "media-BearerAuth",
27973
+ scheme: "bearer",
27974
+ type: "http"
27975
+ }],
27976
+ url: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
27977
+ ...options
27978
+ });
27979
+ var mediaSaveGenerationOutput = (options) => (options.client ?? client).post({
27980
+ security: [{
27981
+ key: "media-BearerAuth",
27982
+ scheme: "bearer",
27983
+ type: "http"
27984
+ }],
27985
+ url: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
27986
+ ...options,
27987
+ headers: {
27988
+ "Content-Type": "application/json",
27989
+ ...options.headers
27990
+ }
27991
+ });
27992
+ var mediaGetGenerationCapabilities = (options) => (options?.client ?? client).get({
27993
+ security: [{
27994
+ key: "media-BearerAuth",
27995
+ scheme: "bearer",
27996
+ type: "http"
27997
+ }],
27998
+ url: "/media/v1/generation/capabilities",
27999
+ ...options
28000
+ });
27492
28001
  var getSandboxV1Sandboxes = (options) => (options?.client ?? client).get({
27493
28002
  querySerializer: { parameters: { state: { array: { explode: false } } } },
27494
28003
  security: [
@@ -29939,11 +30448,19 @@ function createKnowledge(transport) {
29939
30448
  }
29940
30449
  function createMedia(transport) {
29941
30450
  return {
30451
+ generation: {
30452
+ capabilities: {
30453
+ list: bind(transport, mediaGetGenerationCapabilities)
30454
+ }
30455
+ },
29942
30456
  libraries: {
29943
30457
  assets: {
29944
30458
  batch: bind(transport, mediaBatchAssets),
29945
30459
  create: bind(transport, (options) => mediaUploadAsset({ ...options, bodySerializer: multipartBodySerializer, headers: { "Content-Type": null, ...options.headers } })),
29946
30460
  delete: bind(transport, mediaDeleteAsset),
30461
+ frames: {
30462
+ create: bind(transport, mediaCreateFrameUrls)
30463
+ },
29947
30464
  import: {
29948
30465
  create: bind(transport, mediaImportAsset)
29949
30466
  },
@@ -29972,7 +30489,17 @@ function createMedia(transport) {
29972
30489
  folders: {
29973
30490
  list: bind(transport, mediaListFolders)
29974
30491
  },
30492
+ generations: {
30493
+ create: bind(transport, mediaCreateGeneration)
30494
+ },
29975
30495
  jobs: {
30496
+ cancel: bind(transport, mediaCancelJob),
30497
+ list: bindPage(transport, mediaListJobs),
30498
+ outputs: {
30499
+ save: {
30500
+ create: bind(transport, mediaSaveGenerationOutput)
30501
+ }
30502
+ },
29976
30503
  retrieve: bind(transport, mediaGetJob)
29977
30504
  },
29978
30505
  list: bindPage(transport, mediaListLibraries),
@@ -29993,6 +30520,10 @@ function createMedia(transport) {
29993
30520
  create: bind(transport, mediaVisualSearch)
29994
30521
  }
29995
30522
  },
30523
+ understandings: {
30524
+ list: bindPage(transport, mediaListUnderstandingsByLibrary),
30525
+ retrieveFailureSummary: bind(transport, mediaUnderstandingFailureSummary)
30526
+ },
29996
30527
  update: bind(transport, mediaUpdateLibrary)
29997
30528
  }
29998
30529
  };
@@ -30117,6 +30648,9 @@ function createOrganization(transport) {
30117
30648
  },
30118
30649
  retrieve: bind(transport, getOrganizationFeedback)
30119
30650
  },
30651
+ members: {
30652
+ list: bind(transport, listOrganizationMembers)
30653
+ },
30120
30654
  usage: {
30121
30655
  list: bind(transport, listOrganizationUsage)
30122
30656
  }
@@ -33369,7 +33903,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
33369
33903
  }
33370
33904
 
33371
33905
  // src/main.ts
33372
- var version = "0.2.1-dev.6dcf6a1";
33906
+ var version = "0.2.1-dev.71b291b";
33373
33907
  var commands = commandTree(operations);
33374
33908
  var manual = [...workflows.map((w) => w.words), [API_WORD]];
33375
33909
  function route(argv) {