@deepraxis/cli 0.2.1-dev.5c83a98 → 0.2.1-dev.5ce75d1

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 +28 -5
  2. package/dist/praxis.js +1314 -147
  3. package/package.json +1 -1
package/dist/praxis.js CHANGED
@@ -143,7 +143,7 @@ across all toolsets allowed.`
143
143
  type: "array",
144
144
  itemType: "object",
145
145
  required: false,
146
- description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time."
146
+ description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time."
147
147
  },
148
148
  {
149
149
  name: "kind",
@@ -9962,7 +9962,7 @@ Execution errors include error.details.prints containing output printed before f
9962
9962
  resource: "cut.projects.analysis",
9963
9963
  method: "create",
9964
9964
  summary: "Analyze project media",
9965
- description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible.",
9965
+ description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible. Silence measures transcript-based speech pauses, not music or loudness. A completed transcript without words returns ready with empty segments and reason no_speech; no completed transcript returns unsupported with reason no_transcript. A failed transcription remains failed.",
9966
9966
  http: "POST",
9967
9967
  path: "/cut/v1/projects/{project_id}/analysis",
9968
9968
  streaming: "no",
@@ -10133,6 +10133,18 @@ Execution errors include error.details.prints containing output printed before f
10133
10133
  body: {
10134
10134
  required: true,
10135
10135
  fields: [
10136
+ {
10137
+ name: "folder",
10138
+ type: "string",
10139
+ required: false,
10140
+ description: "Optional destination path within the bound media library; omitted uses its default folder."
10141
+ },
10142
+ {
10143
+ name: "name",
10144
+ type: "string",
10145
+ required: false,
10146
+ description: "Nonempty display name, frozen with the export. Path separators and control characters become hyphens; limited to 200 characters. Omitted uses project name and timestamp."
10147
+ },
10136
10148
  {
10137
10149
  name: "output",
10138
10150
  type: "object",
@@ -10150,6 +10162,12 @@ Execution errors include error.details.prints containing output printed before f
10150
10162
  type: "integer",
10151
10163
  required: false,
10152
10164
  description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write."
10165
+ },
10166
+ {
10167
+ name: "loudness",
10168
+ type: "object",
10169
+ required: false,
10170
+ description: "Optional loudness normalization target; normalization adds analysis and rendering work."
10153
10171
  }
10154
10172
  ]
10155
10173
  }
@@ -10158,7 +10176,7 @@ Execution errors include error.details.prints containing output printed before f
10158
10176
  resource: "cut.projects.frames",
10159
10177
  method: "list",
10160
10178
  summary: "Render preview frames",
10161
- description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. Decode its base64 payload to save the image. Codemode returns at most four images per call, so request at most four times when reviewing there.",
10179
+ description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution. The response always includes warnings; FRAME_UNAVAILABLE means a source preview could not be obtained and an offline tile was drawn. Its message identifies a timeout, delivery capacity limit, or unavailable source and contains no source URL. Decode each image's base64 payload to save it. Codemode returns at most four images per call, so request at most four times when reviewing there.",
10162
10180
  http: "GET",
10163
10181
  path: "/cut/v1/projects/{project_id}/frames",
10164
10182
  streaming: "no",
@@ -10181,7 +10199,7 @@ Execution errors include error.details.prints containing output printed before f
10181
10199
  name: "scale",
10182
10200
  type: "number",
10183
10201
  required: false,
10184
- description: "Positive image size multiplier; 0.5 renders at half the project dimensions."
10202
+ description: "Image size multiplier, default 0.25, greater than zero and at most 0.5. Larger values return INVALID_PARAMS; pixel-area limits may reduce actual dimensions, reported as width and height."
10185
10203
  },
10186
10204
  {
10187
10205
  name: "revision",
@@ -10373,88 +10391,7 @@ Execution errors include error.details.prints containing output printed before f
10373
10391
  resource: "cut.projects",
10374
10392
  method: "execute",
10375
10393
  summary: "Execute editing script",
10376
- description: `Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: \`const t = AddTrack("video"); Insert(t, {type: "color", color: "#123456", start: 0, length: 3}); Print(t);\`
10377
-
10378
- ### Script function reference
10379
-
10380
- Functions are synchronous globals; do not import them. \`project\` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. Reads see earlier writes in the same script.
10381
-
10382
- \`\`\`ts
10383
- GetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;
10384
- GetItem(id: ClipId): ItemView;
10385
- FindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];
10386
- GetMedia(ref: MediaRef): MediaInfo;
10387
- GetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];
10388
- GetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];
10389
- Insert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;
10390
- Update(id: ClipId, patch: ItemPatchView): void;
10391
- Delete(id: ClipId, o?: { ripple?: boolean }): void;
10392
- Split(id: ClipId, at: number): ClipId;
10393
- Trim(id: ClipId, edge: "in" | "out", delta: number, o?: { ripple?: boolean }): void;
10394
- Move(id: ClipId, start: number, track?: TrackId): void;
10395
- RippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;
10396
- AddTrack(kind: "video" | "audio" | "caption", init?: { name?: string }, index?: number): TrackId;
10397
- UpdateTrack(id: TrackId, patch: TrackPatch): void;
10398
- DeleteTrack(id: TrackId): void;
10399
- SetSettings(patch: Partial<ProjectSettingsView>): void;
10400
- AddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle>; maxChars?: number }): ClipId[];
10401
- SetMarker(at: number, label: string): string;
10402
- Print(...values: unknown[]): void;
10403
- Preview(at: number[]): void;
10404
- \`\`\`
10405
-
10406
- | Functions | Behavior and arguments |
10407
- | --- | --- |
10408
- | GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, sourceIn/sourceOut, text and offline reason. GetTimeline returns duration and tracks (id, kind, name, index, locked, items); from/to and tracks narrow the read. |
10409
- | FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |
10410
- | GetMedia | Read metadata for \`{libraryId, assetId}\` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |
10411
- | GetTranscript, GetAnalysis | Read available transcript words or silence/filler/scenes segments. Transcript filter from/to is seconds; returned word and segment from/to values are source microseconds (divide by 1,000,000 for editing). Words contain text and optional speaker/filler; segments may include label/confidence. Request analysis first if unavailable. |
10412
- | Insert, Update, Delete | Insert returns the new clip ID; Update changes supplied fields; Delete removes the clip. Optional ripple on Insert/Delete closes or opens space on the track. |
10413
- | Split, Trim, Move | Split at a timeline position and return the new right-hand clip ID. Trim changes the in or out edge by delta seconds. Move sets the timeline start and optionally a new track. |
10414
- | RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |
10415
- | AddTrack, UpdateTrack, DeleteTrack | Add video/audio/caption tracks; index selects layer order (0 is top). TrackPatch supports name, locked, hidden, muted, gainDb and style as appropriate to track kind. |
10416
- | SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |
10417
- | AddCaptionsFromTranscript | Create captions from an audio/video clip's kept words. Optional maxChars is 1–1000, default 16; style updates the caption track. Returns caption IDs. |
10418
- | SetMarker | Add a label at a timeline time and return its ID. |
10419
- | Print, Preview | Print appends text to prints. Preview requests up to eight times total per execute and puts images in the result's frames. Each url is an inline PNG data URL, not an HTTP image link. Decode the base64 payload to save an image. Codemode returns at most four images per call; request at most four times there. |
10420
-
10421
- #### Insert fields (ItemInit)
10422
-
10423
- Every item requires \`type\` and \`start\`. Times used for editing are seconds and snap to the project frame rate: start, length, sourceIn, fadeIn/fadeOut, transition length, keyframe at, reveal delay/stagger/duration. Keyframe and reveal times are relative to the clip start. Video/audio may omit length to use the remaining source duration; other types require length.
10424
-
10425
- | type | Required fields beyond type/start | Optional fields |
10426
- | --- | --- | --- |
10427
- | video | media | length, sourceIn, volumeDb, transform, fit, animate, transitionIn, transitionOut |
10428
- | image | media, length | transform, fit, animate, transitionIn, transitionOut |
10429
- | text | text, length | style, transform, reveal, animate, transitionIn, transitionOut |
10430
- | color | color, length | transform, fill, animate, transitionIn, transitionOut |
10431
- | shape | shape, length, width, height, fill | radius, stroke, transform, animate, transitionIn, transitionOut |
10432
- | audio | media | length, sourceIn, volumeDb, fadeIn, fadeOut, transitionIn, transitionOut |
10433
- | caption | text, length | — |
10434
-
10435
- Video tracks accept video/image/text/color/shape; audio and caption tracks accept their corresponding type. Media is \`{libraryId: string, assetId: string}\` from a bound library. sourceIn defaults to 0, volumeDb to 0 dB, audio fades to 0 seconds. fit defaults to contain: contain fits the whole image, cover fills and crops, fill stretches, none keeps native dimensions.
10436
-
10437
- | Field | Value |
10438
- | --- | --- |
10439
- | transform | Partial \`{x, y, scale, rotation, opacity, crop, blur}\`. x/y are normalized canvas center coordinates (default 0.5); scale 1 is fitted size; rotation is degrees (default 0); opacity is 0–1 (default 1). crop is \`{top,right,bottom,left}\`. blur is 0–100 pixels at 1080-pixel frame height. |
10440
- | style | Partial \`{fontFamily, fontSize, fontWeight, color, stroke, background, align, maxWidth}\`. fontFamily: Geist or Noto Sans SC (default); fontSize defaults to 48; fontWeight: 400 (default), 500 or 700; color defaults to #FFFFFF; align: left, center (default), right; maxWidth is a fraction of canvas width (default 0.9). stroke is \`{color,width}\`. Caption style additionally supports position (top/middle/bottom), margin (0–0.4 of canvas height), highlightColor and maxLines: 2. |
10441
- | animate | An object keyed by x, y, scale, rotation, opacity or blur. Each value is an array of \`{at: number, value: number, ease?: Ease}\` sorted by at with distinct frame-snapped times. Values hold before the first and after the last keyframe, overriding the static transform. |
10442
- | Ease | linear, in, out, inOut, \`{bezier: [x1,y1,x2,y2]}\` or \`{spring: {stiffness, damping, mass?}}\`. Easing shapes the segment arriving at that keyframe; springs may overshoot. |
10443
- | reveal | \`{by, delay?: number, stagger: number, duration: number, from: {y?, opacity?, scale?, blur?}, ease?: Ease}\`. by selects char, word or line. Unit k starts at delay + k * stagger and takes duration seconds to reach its resting state; from.y is a fraction of font size. |
10444
- | fill | A color string (#RRGGBB or #RRGGBBAA), \`{linear: {angle, stops: [{at,color}, ...]}}\` or \`{radial: {stops: [{at,color}, ...]}}\`. Stop positions are 0–1; angle is degrees, 0 left to right. On color clips, fill replaces color when supplied. |
10445
- | shape, width, height, radius, stroke | shape is rect or ellipse. width/height are fractions of canvas width/height before scaling. radius rounds rect corners in pixels at 1080-pixel frame height. stroke is \`{color: string, width: number}\`. |
10446
- | transitionIn, transitionOut | \`{kind, length: number}\` at the clip's beginning/end. length is seconds. fade changes opacity; dissolve blends; push_left/push_right move horizontally; wipe_left reveals horizontally. |
10447
-
10448
- #### Update fields (ItemPatchView)
10449
-
10450
- All fields are optional; use only fields relevant to the item's type. Supported fields: start, length, sourceIn, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, animate, reveal, fill, stroke, shape, width, height, radius, transitionIn, transitionOut. Values and units match Insert. Set animate, reveal, fill, stroke, transitionIn or transitionOut to null to remove that effect; omitting a field preserves it. For example: \`Update(id, {volumeDb: -12})\` or \`Update(id, {transitionIn: null})\`.
10451
-
10452
- #### Script names versus HTTP response names
10453
-
10454
- Use camelCase inside scripts, including nested objects. HTTP request/response JSON outside script source uses snake_case. Map media.library_id → media.libraryId, media.asset_id → media.assetId, source_in → sourceIn, volume_db → volumeDb, fade_in/fade_out → fadeIn/fadeOut, transition_in/transition_out → transitionIn/transitionOut, font_family/font_size/font_weight/max_width → fontFamily/fontSize/fontWeight/maxWidth, gain_db → gainDb, highlight_color/max_lines → highlightColor/maxLines. Fields such as animate, reveal, fill, stroke, at and length retain their spelling. GetTimeline/GetItem already return camelCase compact views; the expanded retrieveTimeline HTTP response is not an Insert object.
10455
-
10456
- Unrecognized script fields fail with OPS_REJECTED and rejection code UNKNOWN_FIELD; snake_case mistakes suggest the corresponding camelCase name. The error message lists each rejection's #opIndex, code and reason. Correct the named fields and retry the saved edit; do not assume an ignored field applied an effect.
10457
- `,
10394
+ description: 'Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: `const t = AddTrack("video"); Insert(t, {type: "color", color: "#123456", start: 0, length: 3}); Print(t);`\n\n### Script function reference\n\nFunctions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. JoinId is the string returned by Join or read from GetTimeline().joins. Reads see earlier writes in the same script.\n\n```ts\nGetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;\nGetItem(id: ClipId): ItemView;\nFindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];\nGetMedia(ref: MediaRef): MediaInfo;\nGetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];\nGetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];\nListTransitions(): TransitionInfo[];\nListEffects(): EffectInfo[];\nListTextStyles(): TextStylePreset[];\nListTextTemplates(): TextTemplate[];\nListAnimations(): { id: string; version: number; phase: "in" | "out" | "loop"; target: "any" | "text"; name: string; description: string; defaultDuration: number; params: { name: string; type: string; values?: string[]; default?: string | number; min?: number; max?: number; description: string }[] }[];\nListFonts(): { family: string; weights: number[]; scripts: ("latin"|"cjk")[]; source: "bundled"|"catalog" }[];\nInsert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;\nUpdate(id: ClipId, patch: ItemPatchView): void;\nSetSpeed(id: ClipId, rate: number | { curve: { at: number; rate: number; ease?: Ease }[]; audio?: "mute" | "resample" }, o: { keep: "source" | "duration"; ripple?: boolean }): { length: number; sourceOut: number };\nDelete(id: ClipId, o?: { ripple?: boolean }): void;\nJoin(left: ClipId, right: ClipId, o: { length?: number; effect: TransitionInput }): JoinId;\nUpdateJoin(id: JoinId, patch: { length?: number; effect?: TransitionInput }): void;\nDeleteJoin(id: JoinId): void;\nSplit(id: ClipId, at: number): ClipId;\nTrim(id: ClipId, edge: "in" | "out", delta: number, o?: { ripple?: boolean }): void;\nMove(id: ClipId, start: number, track?: TrackId): void;\nRippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;\nAddTrack(kind: "video" | "audio" | "caption", init?: { name?: string; role?: "voice" | "music" | "sfx" }, index?: number): TrackId;\nUpdateTrack(id: TrackId, patch: TrackPatch): void;\nDeleteTrack(id: TrackId): void;\nSetSettings(patch: Partial<ProjectSettingsView>): void;\nAddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle> & { preset?: string }; maxChars?: number }): ClipId[];\nInsertTemplate(track: TrackId, o: { template: string; start: number; slots?: Record<string, string> }): ClipId[];\nAlignCaptions(trackId: TrackId, script: string, options?: { resplit?: boolean; maxChars?: number }): { replaced: number; added: number; deleted: number };\nImportCaptions(trackId: TrackId, text: string, o?: { format?: "srt" | "vtt"; offset?: number }): ClipId[];\nExportCaptions(trackId: TrackId, o: { format: "srt" | "vtt" }): string;\nSetMarker(at: number, label: string): string;\nPrint(...values: unknown[]): void;\nPreview(at: number[]): void;\n```\n\n| Functions | Behavior and arguments |\n| --- | --- |\n| GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, playback, sourceIn/sourceOut, text, effects, blend and offline reason. GetTimeline returns duration, tracks (id, kind, name, index, locked, items), and joins (id, track, left, right, length in seconds, normalized effect). from/to and tracks narrow the items and joins; joins are selected by their overlap window. |\n| ListEffects | Discover the shared visual-effect catalog with parameter types, ranges, defaults, cost and bounds. Effects are supported only on visual clips. |\n| ListTransitions | Discover the shared validation catalog: each entry contains kind (effect ID), name, description and params. Each parameter has name, type (enum/number/integer), default, description, enum values or numeric min/max. Use the returned kind and parameter names inside effect. |\n| ListAnimations | Discover animation presets. Each entry has id, version, phase (`in`, `out`, `loop`), target (`any`, `text`), name, description, defaultDuration (seconds), and params (name, type, values/default/min/max/description as applicable). A slot use is `{preset, duration?, ...params}`; duration is seconds. |\n| FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |\n| GetMedia | Read metadata for `{libraryId, assetId}` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |\n| GetTranscript, GetAnalysis | Read available transcript words or silence/filler/scenes segments. Transcript filter from/to is seconds; returned word and segment from/to values are source microseconds (divide by 1,000,000 for editing). Words contain text and optional speaker/filler; segments may include label/confidence. Request analysis first if unavailable. |\n| Insert, Update, Delete | Insert returns the new clip ID; Update changes supplied fields; Delete removes the clip. Optional ripple on Insert/Delete closes or opens space on the track. |\n| SetSpeed | Change video/audio rate in 0.25–4; keep is required. A `{curve: [{at, rate, ease?}, ...], audio?: "mute" | "resample"}` rate is forward-only and holds output duration fixed; pitch preservation is unavailable. Scalar rates: source preserves consumed source and changes length; duration preserves output length. Returns actual length and sourceOut in seconds. Optional ripple explicitly shifts same-track followers when keeping source; otherwise overlaps are rejected. |\n| Join, UpdateJoin, DeleteJoin | Join creates an overlap between two butt-adjacent visual clips on the same track and returns its ID. length defaults to 0.5 seconds; effect is required. The right clip and all same-track followers move left by length, shortening that track and potentially the project. UpdateJoin moves those followers by the difference in length; omitted fields are preserved. DeleteJoin moves them right to restore the butt cut. Other tracks stay in place. |\n| Split, Trim, Move | Split at a timeline position and return the new right-hand clip ID. Trim changes the in or out edge by delta seconds. Move sets the timeline start and optionally a new track. |\n| RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |\n| AddTrack, UpdateTrack, DeleteTrack | Add video/audio/caption tracks; index selects layer order (0 is top). TrackPatch supports name, locked, hidden, muted, gainDb, audio role (`voice`, `music`, `sfx`) and style as appropriate to track kind. |\n| SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |\n| AddCaptionsFromTranscript | Create captions from an audio/video clip\'s kept words. Optional maxChars is 1–1000, default 16; style updates the caption track. Returns caption IDs. |\n| ImportCaptions, ExportCaptions | Import SRT or WebVTT text onto a caption track and export it back. format is inferred from a WEBVTT header when omitted. offset shifts imported cues in seconds. Import rejects more than 100000 bytes, more than 5000 cues, malformed or overlapping file cues with INVALID_CAPTION_FILE; overlap with existing timeline clips uses the normal OVERLAP rejection. Export sorts by timeline start and writes millisecond timecodes. |\n| SetMarker | Add a label at a timeline time and return its ID. |\n| Print, Preview | Print appends text to prints. Preview requests up to eight times total per execute and puts images in the result\'s frames. Each url is an inline PNG data URL, not an HTTP image link. Decode the base64 payload to save an image. Codemode returns at most four images per call; request at most four times there. |\n\n#### Joins between clips\n\nEndpoints may be video, image, text, color or shape; audio and caption are rejected. Require 0 < length < each endpoint\'s length. Each clip allows at most one incoming and one outgoing join; their summed lengths cannot exceed its length. Three-input overlaps, nonadjacent endpoints and cross-track joins are rejected with OPS_REJECTED. Read the rejection\'s code and message, shorten or remove conflicting joins, and retry the saved edit.\n\nTransitionInput is an object with kind plus the parameters returned by ListTransitions; omitted parameters use catalog defaults. Unknown kinds and invalid parameters return INVALID_TRANSITION_PARAM with available parameters. Effects: dissolve; dip color black/white default black; push and wipe direction left/right/up/down default left; wipe softness 0–1 default 0; iris centerX/centerY 0–1 default 0.5; blinds integer count 2–64 default 8 and orientation vertical/horizontal default vertical; blur radius 0–100 pixels at 1080-pixel frame height default 24; zoom direction in/out default in, amount 0.1–3 default 1, blur 0–1 default 0.5; clock direction clockwise/counterclockwise default clockwise, startAngle 0–360 degrees default 0 (twelve o\'clock), softness 0–1 default 0; flash color white/black default white, intensity 0–1 default 1. Zoom blur uses up to eight radial samples per shot and is slower on server rendering. Join options and UpdateJoin patches accept only length and effect. Effect updates replace the effect object and apply defaults for omitted parameters.\n\nMinimal example on an existing visual track with adjacent clips left and right: `Print(ListTransitions()); const j = Join(left, right, {length: 0.5, effect: {kind: "dissolve"}}); Print(GetTimeline().joins); Preview([GetItem(right).start + 0.25]);` Use `UpdateJoin(j, {length: 0.8})` to adjust it in a later edit or `DeleteJoin(j)` to restore the cut. Preview uses server-rendered frames and includes joins. Per-clip transitionIn/transitionOut remain separate entrance/exit effects.\n\n#### Insert fields (ItemInit)\n\nEvery item requires `type` and `start`. Times used for editing are seconds and snap to the project frame rate: start, length, sourceIn, fadeIn/fadeOut, transition length, keyframe at, reveal delay/stagger/duration. Keyframe and reveal times are relative to the clip start. Video/audio may omit length to use the remaining source duration; other types require length.\n\n| type | Required fields beyond type/start | Optional fields |\n| --- | --- | --- |\n| video | media | length, sourceIn, playback, volumeDb, transform, fit, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| image | media, length | transform, fit, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| text | text, length | style, transform, blend, reveal, animate, animation, effects, mask, transitionIn, transitionOut |\n| color | color, length | transform, fill, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| shape | shape, length, width, height, fill | radius, stroke, transform, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| audio | media | length, sourceIn, playback, volumeDb, gain, fadeIn, fadeOut, duck |\n| caption | text, length | — |\n\nVisual Insert/Update also accepts `blend`: `normal` (default), `screen`, `multiply`, `overlay`, or `add`; set it to null in Update to clear it. During a Join overlap, both inputs render with normal blending. Video tracks accept video/image/text/color/shape; audio and caption tracks accept their corresponding type. Media is `{libraryId: string, assetId: string}` from a bound library. sourceIn defaults to 0, volumeDb to 0 dB, audio fades to 0 seconds. fit defaults to contain: contain fits the whole image, cover fills and crops, fill stretches, none keeps native dimensions.\n\n| Field | Value |\n| --- | --- |\n| transform | Partial `{x, y, scale, rotation, opacity, crop, blur}`. x/y are normalized canvas center coordinates (default 0.5); scale 1 is fitted size; rotation is degrees (default 0); opacity is 0–1 (default 1). crop is `{top,right,bottom,left}`. blur is 0–100 pixels at 1080-pixel frame height. |\n| style | Partial `{fontFamily, fontSize, fontWeight, color, fill, stroke, strokes, shadows, glow, background, align, maxWidth, position, margin}`. fill accepts a color or linear/radial gradient across the entire text bounding box. strokes draw outside to inside; at most 4, width 0–40. shadows accepts at most 4 `{color,x,y,blur}` entries; blur is 0–100. glow is `{color,radius,strength}` with radius 0–100 and strength 0–1. All dimensions use pixels at 1080 frame height and scale with the text. Glow and large shadow blur increase render time. Invalid colors or ranges return actionable INVALID_STYLE errors. `ListFonts()` discovers family, available weights, scripts and bundled/catalog source. Text and captions share the style fields; caption style additionally supports highlightColor and maxLines: 2. |\n| animate | An object keyed by x, y, scale, rotation, opacity or blur. Each value is an array of `{at: number, value: number, ease?: Ease}` sorted by at with distinct frame-snapped times. Values hold before the first and after the last keyframe, overriding the static transform. |\n| animation | `{in?: AnimationUse, out?: AnimationUse, loop?: AnimationUse}` on visual clips. Each use is `{preset: string, duration?: number, ...params}`; duration and parameter units follow `ListAnimations()`. Presets replace existing animate and reveal when applied. Update accepts `animation: null` to clear the preset and its generated effects. |\n| Ease | linear, in, out, inOut, `{bezier: [x1,y1,x2,y2]}` or `{spring: {stiffness, damping, mass?}}`. Easing shapes the segment arriving at that keyframe; springs may overshoot. |\n| reveal | `{by, delay?: number, stagger: number, duration: number, from: {y?, opacity?, scale?, blur?}, ease?: Ease}`. by selects char, word or line. Unit k starts at delay + k * stagger and takes duration seconds to reach its resting state; from.y is a fraction of font size. |\n| fill | A color string (#RRGGBB or #RRGGBBAA), `{linear: {angle, stops: [{at,color}, ...]}}` or `{radial: {stops: [{at,color}, ...]}}`. Stop positions are 0–1; angle is degrees, 0 left to right. On color clips, fill replaces color when supplied. |\n| shape, width, height, radius, stroke | shape is rect or ellipse. width/height are fractions of canvas width/height before scaling. radius rounds rect corners in pixels at 1080-pixel frame height. stroke is `{color: string, width: number}`. |\n| transitionIn, transitionOut | `{kind, length: number}` at the clip\'s beginning/end. length is seconds. fade changes opacity; dissolve blends; push_left/push_right move horizontally; wipe_left reveals horizontally. |\n\n#### Visual effects\n\n`effects` is an ordered stack of at most 8 catalog entries. Call `ListEffects()` to discover the catalog; unknown kinds return `UNKNOWN_EFFECT`, invalid names/values/keyframes return `INVALID_EFFECT_PARAM`, and stacks over 8 return `TOO_MANY_EFFECTS`. Entries include blur, color adjustment, vignette, film grain, chromatic aberration, pixelate, glitch, shake, flash, light leak and built-in `lut` looks; user `.cube` LUTs are not supported. `speed` is cycles per second. Effects run on CPU during export and increase render time. Parameters are discovered with ListEffects(). Catalog entries expose their own parameters through ListEffects(), including `blur` (`radius` 0–100, default 24) and `color_adjust`: `brightness`, `contrast`, `temperature`, and `tint` each range -1–1 (default 0), while `saturation` ranges 0–2 (default 1). Disabled entries are skipped. `color_adjust` uses an SDR-only Rec.709 adjustment matrix with no color management.\n\nNumeric and integer effect parameters accept `keyframes: {parameter: [{at, value, ease?}, ...]}`; times are seconds relative to the clip, snap to frames like `animate`, must be strictly increasing and within clip duration, and values follow that parameter\'s catalog range. Omitted parameters use catalog defaults. Trim and Split preserve effect keyframes with the same clip-local behavior as `animate`. There are no custom shaders.\n\n`blend` applies to the completed visual layer after its content, effects and `transform.blur`; `add` maps to Skia Plus. The default `normal` path adds no blend layer. During Join overlaps, blending is forced to normal because each input is composed on transparency.\n\n#### Update fields (ItemPatchView)\n\nAll fields are optional; use only fields relevant to the item\'s type. Supported fields: start, length, sourceIn, playback, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, duck, animate, reveal, animation, fill, stroke, shape, width, height, radius, transitionIn, transitionOut, effects, blend, mask, gain. Values and units match Insert; set effects or blend to null to clear them. Set animation to null to clear the preset; set animate or reveal to null to remove that effect. Applying a preset replaces existing animate/reveal. Do not set animation together with animate or reveal in one Insert/Update call. Omit a field to preserve it.\n\n#### Animation presets\n\nDiscover the catalog with `ListAnimations()`. Its entries contain id, version, phase (`in`, `out`, `loop`), target (`any` or `text`), name, description, defaultDuration in seconds, and params. Slots may combine one in, one out and one loop preset. A loop runs only in the interval between in and out; if the same property is animated by multiple slots, loop occupies only that middle interval. Text-target presets are entrances. Their duration controls the rhythm per character/word/line, not the total reveal time. Out and loop presets apply to the whole clip, not per text unit.\n\nPresets replace the clip\'s existing animate and reveal when applied. The source preset is retained, so changing clip length or transform automatically regenerates its keyframes/reveal. If a clip becomes shorter, in/out durations shrink proportionally; when it grows, the requested durations are restored. Split keeps in on the left, out on the right, and loop on both. Writing animate or reveal directly detaches the preset; setting animation to null clears both source and generated effects. Insert/Update reject a call that supplies animation together with animate or reveal.\n\nErrors: UNKNOWN_ANIMATION (unknown preset), INVALID_ANIMATION_PARAM (invalid slot/parameter or frame/keyframe limit), ANIMATION_TOO_LONG (in+out exceed clip length), ANIMATION_TARGET_MISMATCH (text-only preset on a non-text or preset on non-visual clip), ANIMATION_PHASE_MISMATCH (preset in the wrong slot). Each animated property is limited to 600 keyframes; loop duration must be at least 4 frames. `ANIMATION_TOO_LONG` is avoided during later length changes by proportional fitting.\n\n#### Speed, reverse and freeze\n\nVideo/audio Insert and Update accept playback as `{kind: "rate", rate: number, direction: "forward" | "reverse", audio: "preservePitch" | "resample" | "mute"}` or `{kind: "freeze"}`. Rate is finite and inclusive 0.25–4. Omitted playback defaults to 1× forward with preservePitch; supply the complete rate object when changing playback. preservePitch keeps pitch, resample changes pitch with speed, mute removes audio. Reverse requires explicit audio: "mute"; preservePitch/resample are rejected with UNSUPPORTED_PLAYBACK rather than silently muted. Freeze holds sourceIn and is silent. GetItem/GetTimeline echo playback and the source interval in seconds; sourceOut is exclusive even for reverse and equals sourceIn for freeze.\n\nUpdate of playback keeps output length unless length is also supplied. SetSpeed preserves direction/audio, rejects frozen and non-video/audio clips, and requires keep: "source" or "duration". keep: "source" computes round(consumed source / new rate × fps) frames, falling back to floor if rounding would exceed the source end; the returned length/sourceOut are actual frame-rounded seconds. keep: "duration" keeps output length and changes source consumption. Length conflicts fail with OVERLAP; move/shorten the conflicting clip, keep duration, or explicitly use ripple: true to shift following clips on the same track. Source overflow fails with OUT_OF_SOURCE; rate limits fail with RATE_OUT_OF_RANGE. Unknown playback fields and SetSpeed options are rejected with UNKNOWN_FIELD; options only accept keep and boolean ripple.\n\nExample for an existing four-second video/audio clip id: `Print(SetSpeed(id, 0.5, {keep: "source"})); Print(SetSpeed(id, 2, {keep: "source"}));` returns lengths 8 then 2, keeping the same source interval. Reverse: `Update(id, {playback: {kind: "rate", rate: 1, direction: "reverse", audio: "mute"}})`. Freeze: `Update(id, {playback: {kind: "freeze"}})`. Ensure enough source remains for the chosen length/rate. Browser reverse playback currently displays a placeholder; server-rendered Preview/frames and exports support reverse normally. Speed-adjusted audio is generated asynchronously after the edit transaction commits; exports wait for that audio before rendering.\n\n#### Script names versus HTTP response names\n\nUse camelCase inside scripts, including nested objects. HTTP request/response JSON outside script source uses snake_case. Map media.library_id → media.libraryId, media.asset_id → media.assetId, source_in → sourceIn, volume_db → volumeDb, fade_in/fade_out → fadeIn/fadeOut, transition_in/transition_out → transitionIn/transitionOut, font_family/font_size/font_weight/max_width → fontFamily/fontSize/fontWeight/maxWidth, gain_db → gainDb, highlight_color/max_lines → highlightColor/maxLines. Fields such as animate, reveal, fill, stroke, at and length retain their spelling. GetTimeline/GetItem already return camelCase compact views; the expanded retrieveTimeline HTTP response is not an Insert object.\n\nUnrecognized script fields fail with OPS_REJECTED and rejection code UNKNOWN_FIELD; snake_case mistakes suggest the corresponding camelCase name. The error message lists each rejection\'s #opIndex, code and reason. Correct the named fields and retry the saved edit; do not assume an ignored field applied an effect.\n',
10458
10395
  http: "POST",
10459
10396
  path: "/cut/v1/projects/{project_id}:execute",
10460
10397
  streaming: "no",
@@ -11641,7 +11578,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11641
11578
  resource: "file.files.contentLinks",
11642
11579
  method: "revoke",
11643
11580
  summary: "Revoke a file content link",
11644
- 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/>"}.',
11581
+ 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/>"}.',
11645
11582
  http: "POST",
11646
11583
  path: "/file/v1/files/{file_id}/content_links:revoke",
11647
11584
  streaming: "no",
@@ -11670,7 +11607,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11670
11607
  resource: "file.files.contentUrl",
11671
11608
  method: "create",
11672
11609
  summary: "Create a download URL",
11673
- 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}.`,
11610
+ 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}.`,
11674
11611
  http: "POST",
11675
11612
  path: "/file/v1/files/{file_id}/content_url",
11676
11613
  streaming: "no",
@@ -11690,7 +11627,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11690
11627
  name: "ttl_seconds",
11691
11628
  type: "integer",
11692
11629
  required: false,
11693
- description: "Download link lifetime in seconds, from 1 through 604800; omitted means 3600. This does not change the file's own expiry."
11630
+ description: "Download link lifetime in seconds, from 1 through 604800; omitted means 900. This does not change the file's own expiry."
11694
11631
  }
11695
11632
  ]
11696
11633
  }
@@ -11699,7 +11636,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11699
11636
  resource: "file.uploads",
11700
11637
  method: "create",
11701
11638
  summary: "Create an upload",
11702
- description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data, assistants and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.",
11639
+ description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 20 GiB (21474836480 bytes) and only user_data, assistants and vision purposes. Send parts of at most 64000000 bytes; an unfinished upload waits for them for 7 days, so a client can create → send parts → query GET /file/v1/uploads/{upload_id} → resend only the missing parts → complete. Optional part_size fixes every part length and makes each numbered part retryable with identical bytes. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.",
11703
11640
  http: "POST",
11704
11641
  path: "/file/v1/uploads",
11705
11642
  streaming: "no",
@@ -11713,7 +11650,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11713
11650
  name: "bytes",
11714
11651
  type: "integer",
11715
11652
  required: true,
11716
- description: "Exact complete file length in bytes, from 1 through 2147483648 (2 GiB); the sum of completed parts must match."
11653
+ description: "Exact complete file length in bytes, from 1 through 21474836480 (20 GiB); the sum of completed parts must match."
11717
11654
  },
11718
11655
  {
11719
11656
  name: "filename",
@@ -11757,7 +11694,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11757
11694
  resource: "file.uploads",
11758
11695
  method: "createSigned",
11759
11696
  summary: "Create a one-time upload URL",
11760
- description: "Upload a local file of up to 2 GiB from a coding agent without sending bytes through the model. Provide basename, exact byte count and MIME type. Up to 104857600 bytes, PUT the file to url with curl -T photo.png -H 'Content-Type: image/png' '<url>'; success returns 201 with the file object, and reuse returns 410 CAPABILITY_USED. Above that threshold, split the file into part_size chunks (default 64000000 bytes), PUT each chunk to its numbered parts[].url in any order, then POST complete_url without a body. Part PUTs return 200; completion returns 201 with the file object, including its state, or 400 if a part is missing. A processing file can be polled with files.retrieve until active. Identical part bytes may be retried; changed bytes at the same number return 400. Completion reuse returns 410 CAPABILITY_USED. Each PUT requires the exact signed Content-Length; single-PUT Content-Type must match content_type or be omitted. Expired, revoked, invalid, wrong-action or cross-organization URLs return 404. URL lifetime defaults to 900 seconds for single PUT or 3600 for multipart, at most 604800; all multipart URLs share an expiry. Multipart creation reserves storage quota. Issuance requires the same unscoped credential as direct file creation. Each issuance creates a new upload and is not idempotent. Example body: {\"filename\":\"photo.png\",\"bytes\":2048,\"content_type\":\"image/png\"}.",
11697
+ description: "Upload a local file of up to 20 GiB from a coding agent without sending bytes through the model. Provide basename, exact byte count and MIME type. Up to 104857600 bytes, PUT the file to url with curl -T photo.png -H 'Content-Type: image/png' '<url>'; success returns 201 with the file object, and reuse returns 410 CAPABILITY_USED. Above that threshold, split the file into part_size chunks (default 64000000 bytes) and PUT each chunk to its numbered parts[].url in any order; an interrupted client GETs status_url to see the received parts and resends only what is missing, then POSTs complete_url without a body. Part PUTs return 200; completion returns 201 with the file object, including its state, or 400 if a part is missing. A processing file can be polled with files.retrieve until active. Identical part bytes may be retried; changed bytes at the same number return 400. Completion reuse returns 410 CAPABILITY_USED. Each PUT requires the exact signed Content-Length; single-PUT Content-Type must match content_type or be omitted. Expired, revoked, invalid, wrong-action or cross-organization URLs return 404. URL lifetime defaults to 900 seconds for single PUT or 604800 (7 days) for multipart, at most 604800; all multipart URLs, including status_url, share an expiry. Multipart creation reserves storage quota. Issuance requires the same unscoped credential as direct file creation. Each issuance creates a new upload and is not idempotent. Example body: {\"filename\":\"photo.png\",\"bytes\":2048,\"content_type\":\"image/png\"}.",
11761
11698
  http: "POST",
11762
11699
  path: "/file/v1/uploads/signed",
11763
11700
  streaming: "no",
@@ -11777,7 +11714,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11777
11714
  name: "bytes",
11778
11715
  type: "integer",
11779
11716
  required: true,
11780
- description: "Exact local file size in bytes, from 1 through 2147483648 (2 GiB). Up to 104857600 bytes returns one PUT URL; larger files return numbered part URLs and a completion URL. Every PUT requires its exact signed Content-Length."
11717
+ description: "Exact local file size in bytes, from 1 through 21474836480 (20 GiB). Up to 104857600 bytes returns one PUT URL; larger files return numbered part URLs, a completion URL and a status URL. Every PUT requires its exact signed Content-Length."
11781
11718
  },
11782
11719
  {
11783
11720
  name: "content_type",
@@ -11800,7 +11737,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11800
11737
  name: "expires_in",
11801
11738
  type: "integer",
11802
11739
  required: false,
11803
- description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or 3600 for multipart. All part URLs and the completion URL share one expiry. This does not set the resulting file's lifetime."
11740
+ description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or 604800 (7 days) for multipart. All part URLs, the status URL and the completion URL share one expiry. This does not set the resulting file's lifetime."
11804
11741
  },
11805
11742
  {
11806
11743
  name: "part_size",
@@ -11811,6 +11748,24 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11811
11748
  ]
11812
11749
  }
11813
11750
  },
11751
+ {
11752
+ resource: "file.uploads",
11753
+ method: "retrieve",
11754
+ summary: "Retrieve an upload",
11755
+ description: "Read the state of an unfinished upload — its status, declared bytes, fixed part_size and the parts it already holds (received_parts, each with part_number, bytes and sha256). After a break or a failed part, call it to resend only the missing numbers, then complete. A cancelled or expired upload is refused; a completed one returns its file. A missing or other-organization upload returns 404.",
11756
+ http: "GET",
11757
+ path: "/file/v1/uploads/{upload_id}",
11758
+ streaming: "no",
11759
+ pagination: false,
11760
+ pathParams: [
11761
+ {
11762
+ name: "upload_id",
11763
+ sdkName: "upload_id",
11764
+ description: "Upload identifier returned by create; the upload must belong to your organization."
11765
+ }
11766
+ ],
11767
+ query: []
11768
+ },
11814
11769
  {
11815
11770
  resource: "file.uploads",
11816
11771
  method: "cancel",
@@ -11833,7 +11788,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11833
11788
  resource: "file.uploads",
11834
11789
  method: "complete",
11835
11790
  summary: "Complete an upload",
11836
- description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.",
11791
+ description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. When parts were lost, query GET /file/v1/uploads/{upload_id} and resend them before completing. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.",
11837
11792
  http: "POST",
11838
11793
  path: "/file/v1/uploads/{upload_id}/complete",
11839
11794
  streaming: "no",
@@ -11869,7 +11824,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11869
11824
  resource: "file.uploads.parts",
11870
11825
  method: "create",
11871
11826
  summary: "Add an upload part",
11872
- description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.",
11827
+ description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID, and query GET /file/v1/uploads/{upload_id} to see which numbers already arrived. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.",
11873
11828
  http: "POST",
11874
11829
  path: "/file/v1/uploads/{upload_id}/parts",
11875
11830
  streaming: "no",
@@ -11957,7 +11912,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11957
11912
  resource: "knowledge.vectorStores",
11958
11913
  method: "create",
11959
11914
  summary: "Create knowledge base",
11960
- description: 'Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. Each file accepts up to 52428800 bytes and 5000000 estimated tokens; each account holds up to 100 active/nondeleted stores. Minimal body: {"name":"Refund policies"}.',
11915
+ description: 'Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; each account holds up to 100 active/nondeleted stores. Minimal body: {"name":"Refund policies"}.',
11961
11916
  http: "POST",
11962
11917
  path: "/knowledge/v1/vector_stores",
11963
11918
  streaming: "no",
@@ -11996,7 +11951,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11996
11951
  name: "chunking_strategy",
11997
11952
  type: "object",
11998
11953
  required: false,
11999
- description: "auto resolves to static with 800 estimated tokens and 400 overlap tokens. Unlike OpenAI vector stores, token counts are estimates; each Han character counts as one, and other whitespace-delimited words count as their UTF-16 length divided by four, rounded up."
11954
+ description: "Native attachment strategy. auto uses static chunks of 800 estimated tokens with 400 overlap; static supplies explicit chunk sizes; hierarchical indexes child chunks and supplies bounded parent context. Existing attachments are reused unchanged; remove and reattach a file to change its strategy."
12000
11955
  },
12001
11956
  {
12002
11957
  name: "description",
@@ -12343,7 +12298,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12343
12298
  resource: "knowledge.vectorStores.files",
12344
12299
  method: "create",
12345
12300
  summary: "Add file",
12346
- description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching. Each file accepts up to 52428800 bytes and 5000000 estimated tokens; chunk sizes use estimated tokens rather than a model tokenizer. Text, Markdown, CSV, JSON, HTML, PDF, DOCX, PPTX, XLSX and PNG/JPEG/GIF/WebP images can be extracted; audio and video uploads are not knowledge documents. Images may yield generated descriptions rather than verbatim OCR. auto chunking resolves to static 800/400; explicit sizes are 100–4096 with overlap at most half the size. Each store holds at most 10000 attached files. Reattaching the same file returns its existing record without applying new attributes or chunking; inspect last_error after failure.",
12301
+ description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; chunk sizes use estimated tokens rather than a model tokenizer. Text, Markdown, CSV, JSON, HTML, PDF, DOCX, PPTX, XLSX and PNG/JPEG/GIF/WebP images can be extracted; audio and video uploads are not knowledge documents. Images may yield generated descriptions rather than verbatim OCR. auto chunking resolves to static 800/400; explicit sizes are 100–4096 with overlap at most half the size. Each store holds at most 10000 attached files. Reattaching the same file returns its existing record without applying new attributes or chunking; inspect last_error after failure.",
12347
12302
  http: "POST",
12348
12303
  path: "/knowledge/v1/vector_stores/{vector_store_id}/files",
12349
12304
  streaming: "no",
@@ -12375,7 +12330,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12375
12330
  name: "chunking_strategy",
12376
12331
  type: "object",
12377
12332
  required: false,
12378
- description: "auto resolves to static with 800 estimated tokens and 400 overlap tokens. Unlike OpenAI vector stores, token counts are estimates; each Han character counts as one, and other whitespace-delimited words count as their UTF-16 length divided by four, rounded up."
12333
+ description: "Native attachment strategy. auto uses static chunks of 800 estimated tokens with 400 overlap; static supplies explicit chunk sizes; hierarchical indexes child chunks and supplies bounded parent context. Existing attachments are reused unchanged; remove and reattach a file to change its strategy."
12379
12334
  }
12380
12335
  ]
12381
12336
  }
@@ -12682,11 +12637,23 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12682
12637
  ],
12683
12638
  query: []
12684
12639
  },
12640
+ {
12641
+ resource: "media.generation.capabilities",
12642
+ method: "list",
12643
+ summary: "Get generation capabilities",
12644
+ description: "Read supported text-to-video intent, default model, duration and aspect-ratio limits, per-library concurrency and candidate retention. Generation is charged per second; unsaved candidates expire after 7 days.",
12645
+ http: "GET",
12646
+ path: "/media/v1/generation/capabilities",
12647
+ streaming: "no",
12648
+ pagination: false,
12649
+ pathParams: [],
12650
+ query: []
12651
+ },
12685
12652
  {
12686
12653
  resource: "media.libraries",
12687
12654
  method: "list",
12688
12655
  summary: "List libraries",
12689
- description: "List libraries owned by the caller, newest first. By default, deleting and deleted libraries are excluded; use status=deleting to find libraries awaiting purge. All supplied label pairs must match.",
12656
+ description: "Read a caller-owned library’s current settings, usage and lifecycle status. A deleting library remains readable; missing, foreign or purged libraries return LIBRARY_NOT_FOUND.",
12690
12657
  http: "GET",
12691
12658
  path: "/media/v1/libraries",
12692
12659
  streaming: "no",
@@ -12768,7 +12735,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12768
12735
  resource: "media.libraries",
12769
12736
  method: "delete",
12770
12737
  summary: "Delete library",
12771
- description: "Soft-delete an active library, returning its deleting status and purge_at deadline. Asset operations and delivery become unavailable; the library can be restored before purge_at. Repeated deletion while deleting returns the current library.",
12738
+ description: "Restore a deleting library before its purge_at deadline. The library becomes active again and deleted_at and purge_at are cleared; expired or non-deleting libraries cannot be restored.",
12772
12739
  http: "DELETE",
12773
12740
  path: "/media/v1/libraries/{library_id}",
12774
12741
  streaming: "no",
@@ -12786,7 +12753,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12786
12753
  resource: "media.libraries",
12787
12754
  method: "retrieve",
12788
12755
  summary: "Get library",
12789
- description: "Read a caller-owned library’s current settings, usage and lifecycle status. A deleting library remains readable; missing, foreign or purged libraries return LIBRARY_NOT_FOUND.",
12756
+ description: "Update an active library’s supplied settings. Labels replace the complete map; understanding settings and model roles merge with current values. Changing the embedding model is rejected while assets exist.",
12790
12757
  http: "GET",
12791
12758
  path: "/media/v1/libraries/{library_id}",
12792
12759
  streaming: "no",
@@ -12804,7 +12771,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12804
12771
  resource: "media.libraries",
12805
12772
  method: "update",
12806
12773
  summary: "Update library",
12807
- description: "Update an active library’s supplied settings. Labels replace the complete map; understanding settings and model roles merge with current values. Changing the embedding model is rejected while assets exist.",
12774
+ description: "Update an active library. Set hotwords for spelling evidence in subsequent transcripts; [] disables inferred vocabulary. Transcript understanding calls the timestamped ASR, optional reference ASR and correction model through the existing metered model path. Reprocess assets to apply new settings to existing transcripts.",
12808
12775
  http: "PATCH",
12809
12776
  path: "/media/v1/libraries/{library_id}",
12810
12777
  streaming: "no",
@@ -12820,6 +12787,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12820
12787
  body: {
12821
12788
  required: true,
12822
12789
  fields: [
12790
+ {
12791
+ name: "hotwords",
12792
+ type: "array",
12793
+ itemType: "string",
12794
+ required: false,
12795
+ 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."
12796
+ },
12823
12797
  {
12824
12798
  name: "models",
12825
12799
  type: "object",
@@ -12851,7 +12825,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12851
12825
  resource: "media.libraries.assets",
12852
12826
  method: "list",
12853
12827
  summary: "List assets",
12854
- description: "List assets in an active library, newest first, optionally filtering by exact folder and stored resource type. Continue using next_cursor; video includes audio-only assets.",
12828
+ description: "Upload content into an active library and return a Cloudinary-compatible resource. Use file for a multipart file, data URI, public HTTPS URL or same-owner file identifier. Reusing public_id overwrites by default; overwrite=false returns the existing resource. Chunk uploads require both chunk headers.",
12855
12829
  http: "GET",
12856
12830
  path: "/media/v1/libraries/{library_id}/assets",
12857
12831
  streaming: "no",
@@ -12899,7 +12873,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12899
12873
  resource: "media.libraries.assets",
12900
12874
  method: "create",
12901
12875
  summary: "Upload asset",
12902
- description: "Upload content into an active library and return a Cloudinary-compatible resource. Use file for a multipart file, data URI, public HTTPS URL or same-owner file identifier. Reusing public_id overwrites by default; overwrite=false returns the existing resource. Chunk uploads require both chunk headers.",
12876
+ description: " For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.",
12903
12877
  http: "POST",
12904
12878
  path: "/media/v1/libraries/{library_id}/assets",
12905
12879
  streaming: "no",
@@ -12944,7 +12918,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12944
12918
  name: "asset_folder",
12945
12919
  type: "string",
12946
12920
  required: false,
12947
- description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
12921
+ description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
12948
12922
  },
12949
12923
  {
12950
12924
  name: "use_filename",
@@ -13023,7 +12997,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13023
12997
  resource: "media.libraries.assets.import",
13024
12998
  method: "create",
13025
12999
  summary: "Import file",
13026
- description: "Copy source content into an active library using upload options and return the full native Asset. The imported asset is independent of the source after copying. Reusing public_id follows overwrite semantics.",
13000
+ description: "Copy a File into an independent Media asset. New assets default to organization-private delivery (type=authenticated); explicitly set type=upload for public originals and derivatives. Omitting type on overwrite preserves the current type. Deleting the source File does not delete this copy. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.",
13027
13001
  http: "POST",
13028
13002
  path: "/media/v1/libraries/{library_id}/assets/import",
13029
13003
  streaming: "no",
@@ -13043,7 +13017,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13043
13017
  name: "file_id",
13044
13018
  type: "string",
13045
13019
  required: true,
13046
- description: "File ID to copy into this library instead of file bytes. This independent copy defaults to public delivery; set type=authenticated for private delivery. Deleting the source File does not delete this asset."
13020
+ description: "File ID to copy into this library instead of file bytes. This independent copy defaults to organization-private delivery (type=authenticated); explicitly set type=upload for public delivery. Deleting the source File does not delete this asset."
13047
13021
  },
13048
13022
  {
13049
13023
  name: "public_id",
@@ -13067,7 +13041,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13067
13041
  name: "asset_folder",
13068
13042
  type: "string",
13069
13043
  required: false,
13070
- description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
13044
+ description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
13071
13045
  },
13072
13046
  {
13073
13047
  name: "use_filename",
@@ -13146,7 +13120,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13146
13120
  resource: "media.libraries.assets",
13147
13121
  method: "delete",
13148
13122
  summary: "Delete asset",
13149
- description: "Delete an asset from the library so it is no longer readable, searchable or deliverable. This removes the asset rather than placing it in the library’s restoration window; a missing asset returns ASSET_NOT_FOUND.",
13123
+ description: "Queue reprocessing of the asset’s current version and return its updated state immediately. Omit kinds to retry failed tasks and legacy source-size unsupported tasks; explicit kinds rerun applicable completed tasks and recoverable source-size unsupported tasks. Other unsupported causes remain unchanged. Replaced understandings become superseded, and processing finishes asynchronously.",
13150
13124
  http: "DELETE",
13151
13125
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
13152
13126
  streaming: "no",
@@ -13169,7 +13143,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13169
13143
  resource: "media.libraries.assets",
13170
13144
  method: "retrieve",
13171
13145
  summary: "Get asset",
13172
- description: "Read a non-deleted asset by its asset_id in an active library, including content hashes, processing progress and available previews. Missing or deleted assets return ASSET_NOT_FOUND.",
13146
+ description: "Update an asset’s supplied metadata fields. Tags and context replace their current collections; an empty collection clears them. Moving asset_folder or changing display_name preserves public_id and delivery URLs.",
13173
13147
  http: "GET",
13174
13148
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
13175
13149
  streaming: "no",
@@ -13192,7 +13166,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13192
13166
  resource: "media.libraries.assets",
13193
13167
  method: "update",
13194
13168
  summary: "Update asset",
13195
- description: "Update an asset’s supplied metadata fields. Tags and context replace their current collections; an empty collection clears them. Moving asset_folder or changing display_name preserves public_id and delivery URLs.",
13169
+ description: "Delete an asset from the library so it is no longer readable, searchable or deliverable. This removes the asset rather than placing it in the library’s restoration window; a missing asset returns ASSET_NOT_FOUND.",
13196
13170
  http: "PATCH",
13197
13171
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
13198
13172
  streaming: "no",
@@ -13223,7 +13197,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13223
13197
  name: "asset_folder",
13224
13198
  type: "string",
13225
13199
  required: false,
13226
- description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
13200
+ description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
13227
13201
  },
13228
13202
  {
13229
13203
  name: "tags",
@@ -13241,11 +13215,57 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13241
13215
  ]
13242
13216
  }
13243
13217
  },
13218
+ {
13219
+ resource: "media.libraries.assets.frames",
13220
+ method: "create",
13221
+ summary: "Create frame URLs",
13222
+ description: 'Media creates JPEG frame URLs for inspecting one or more moments in a video without downloading the original. Obtain library_id from libraries and asset_id plus duration from assets. Send 1–20 integer microsecond timestamps strictly below duration, for example {"at_micros":[0,1000000],"width":640}. Only video assets are supported; audio and images return INVALID_PARAMS. Width defaults to 640 and accepts 160, 320 or 640. This read operation does not store a new asset or rerun understanding. Fetch each returned URL to obtain the frame; delivery usage follows media pricing. Authenticated links expire after 300 seconds; upload links remain public and permanent. Reissue expired links. Foreign libraries and assets return 404 without revealing their existence.',
13223
+ http: "POST",
13224
+ path: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames",
13225
+ streaming: "no",
13226
+ pagination: false,
13227
+ pathParams: [
13228
+ {
13229
+ name: "library_id",
13230
+ sdkName: "library_id",
13231
+ description: "Library identifier returned by library creation or listing; must be accessible to the current credential."
13232
+ },
13233
+ {
13234
+ name: "asset_id",
13235
+ sdkName: "asset_id",
13236
+ description: "Video asset identifier returned by asset upload or listing in this library; read its duration before choosing timestamps."
13237
+ }
13238
+ ],
13239
+ query: [],
13240
+ body: {
13241
+ required: true,
13242
+ fields: [
13243
+ {
13244
+ name: "at_micros",
13245
+ type: "array",
13246
+ itemType: "integer",
13247
+ required: true,
13248
+ description: "One to twenty timestamps in microseconds from the start of the video. Each must be a nonnegative safe integer strictly below the video duration; order and duplicates are preserved."
13249
+ },
13250
+ {
13251
+ name: "width",
13252
+ type: "integer",
13253
+ enum: [
13254
+ 160,
13255
+ 320,
13256
+ 640
13257
+ ],
13258
+ required: false,
13259
+ description: "Maximum JPEG width in pixels: 160 is a small thumbnail, 320 a preview and 640 a larger preview. Defaults to 640; larger widths are unavailable."
13260
+ }
13261
+ ]
13262
+ }
13263
+ },
13244
13264
  {
13245
13265
  resource: "media.libraries.assets.reprocess",
13246
13266
  method: "create",
13247
13267
  summary: "Reprocess asset",
13248
- description: "Queue reprocessing of the asset’s current version and return its updated state immediately. Omit kinds to retry failed tasks; explicit kinds rerun applicable completed tasks. Replaced understandings become superseded, and processing finishes asynchronously.",
13268
+ description: " For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.",
13249
13269
  http: "POST",
13250
13270
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess",
13251
13271
  streaming: "no",
@@ -13277,7 +13297,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13277
13297
  "embedding"
13278
13298
  ],
13279
13299
  required: false,
13280
- description: "Processing tasks to rerun. Omit to retry failed tasks only; explicit kinds rerun applicable ready, failed or unsupported tasks. Pending and running tasks are unchanged; an empty array does nothing."
13300
+ description: "Processing tasks to rerun. Omit to retry failed tasks and legacy source-size unsupported tasks; explicit kinds rerun applicable ready or failed tasks and recoverable source-size unsupported tasks. Other unsupported causes remain unchanged. Pending and running tasks are unchanged; an empty array does nothing."
13281
13301
  }
13282
13302
  ]
13283
13303
  }
@@ -13286,7 +13306,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13286
13306
  resource: "media.libraries.assets.understandings",
13287
13307
  method: "list",
13288
13308
  summary: "List understandings",
13289
- description: "List an asset’s understanding results in creation order. By default only current, non-superseded results are returned; use include_superseded=true for history or kind to select an output type.",
13309
+ description: "List understanding results for an asset, ordered by creation time. Use the cursor to continue; include_superseded also returns replaced records. The optional shots array contains current-version shot boundaries and per-shot captions, scene, location guesses, visible text and confidence flags; it is absent on legacy records. Location guesses and folder mismatch are unverified hints. Correction-enabled transcripts expose text_original, corrected text and a correction audit. Their timed data array remains suitable for subtitles. Reference failure is marked missing; correction failure returns the original verbatim. Model inference uses the existing metered model path.",
13290
13310
  http: "GET",
13291
13311
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}/understandings",
13292
13312
  streaming: "no",
@@ -13318,10 +13338,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13318
13338
  "tags",
13319
13339
  "ocr",
13320
13340
  "transcript",
13321
- "frame"
13341
+ "frame",
13342
+ "overview",
13343
+ "audio",
13344
+ "embedding"
13322
13345
  ],
13323
13346
  required: false,
13324
- description: "Filter result kind: caption is a visual description, tags are recognized labels, ocr is recognized image text, transcript is speech text, and frame describes a video segment."
13347
+ description: "Return one output kind: caption is a visual description, tags are generated labels, ocr is visible text, transcript is speech, frame is a video shot, overview is a video summary, audio is sampled audio understanding, and embedding reports a failed embedding step."
13325
13348
  },
13326
13349
  {
13327
13350
  name: "cursor",
@@ -13341,7 +13364,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13341
13364
  resource: "media.libraries.assets",
13342
13365
  method: "batch",
13343
13366
  summary: "Batch assets alias",
13344
- description: "Alias of batch creation. Apply one metadata or deletion action to ids or a frozen expression selection asynchronously; poll the returned job id to inspect completion and item failures.",
13367
+ description: 'Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.',
13345
13368
  http: "POST",
13346
13369
  path: "/media/v1/libraries/{library_id}/assets:batch",
13347
13370
  streaming: "no",
@@ -13362,6 +13385,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13362
13385
  type: "object",
13363
13386
  required: true,
13364
13387
  description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
13388
+ },
13389
+ {
13390
+ name: "reason",
13391
+ type: "string",
13392
+ required: false,
13393
+ description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
13365
13394
  }
13366
13395
  ]
13367
13396
  }
@@ -13370,7 +13399,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13370
13399
  resource: "media.libraries.batches",
13371
13400
  method: "create",
13372
13401
  summary: "Create batch",
13373
- description: "Create an asynchronous batch for tagging, untagging, replacing context, moving or deleting assets. Select ids or an expression; selection is frozen at creation. Poll the returned job id for completion and per-item failures.",
13402
+ description: 'Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.',
13374
13403
  http: "POST",
13375
13404
  path: "/media/v1/libraries/{library_id}/batches",
13376
13405
  streaming: "no",
@@ -13391,6 +13420,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13391
13420
  type: "object",
13392
13421
  required: true,
13393
13422
  description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
13423
+ },
13424
+ {
13425
+ name: "reason",
13426
+ type: "string",
13427
+ required: false,
13428
+ description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
13394
13429
  }
13395
13430
  ]
13396
13431
  }
@@ -13399,7 +13434,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13399
13434
  resource: "media.libraries.batches",
13400
13435
  method: "retrieve",
13401
13436
  summary: "Get batch",
13402
- description: "Read a batch job’s status, successful and failed item counts, and a bounded list of failed items. Use the id returned by batch creation; a job outside this library is not found.",
13437
+ description: "Alias of batch creation. Apply one metadata or deletion action to ids or a frozen expression selection asynchronously; poll the returned job id to inspect completion and item failures.",
13403
13438
  http: "GET",
13404
13439
  path: "/media/v1/libraries/{library_id}/batches/{job_id}",
13405
13440
  streaming: "no",
@@ -13422,7 +13457,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13422
13457
  resource: "media.libraries.deliveryTokens",
13423
13458
  method: "create",
13424
13459
  summary: "Create delivery token",
13425
- 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.",
13460
+ 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.",
13426
13461
  http: "POST",
13427
13462
  path: "/media/v1/libraries/{library_id}/delivery_tokens",
13428
13463
  streaming: "no",
@@ -13448,7 +13483,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13448
13483
  name: "expires_in",
13449
13484
  type: "integer",
13450
13485
  required: false,
13451
- description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 3600."
13486
+ description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 900."
13452
13487
  }
13453
13488
  ]
13454
13489
  }
@@ -13457,7 +13492,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13457
13492
  resource: "media.libraries.events",
13458
13493
  method: "list",
13459
13494
  summary: "List events",
13460
- description: "Read library events in sequence order, including while the library is deleting. Page forward with asc and after_seq, or backward with desc and before_seq; never combine the two sequence cursors.",
13495
+ description: "Read library events in sequence order for observing asset writes and understanding progress. Obtain library_id from creation or listing; continue with after_seq for asc or before_seq for desc, without combining both. Use next_cursor when supplied. Reads do not start or retry understanding.",
13461
13496
  http: "GET",
13462
13497
  path: "/media/v1/libraries/{library_id}/events",
13463
13498
  streaming: "no",
@@ -13504,7 +13539,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13504
13539
  resource: "media.libraries.folders",
13505
13540
  method: "list",
13506
13541
  summary: "List folders",
13507
- description: "List all immediate child folders under parent, or under the root when parent is omitted. Counts include descendant assets. The result is unpaginated; limit and cursor are rejected.",
13542
+ description: "undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.",
13508
13543
  http: "GET",
13509
13544
  path: "/media/v1/libraries/{library_id}/folders",
13510
13545
  streaming: "no",
@@ -13525,11 +13560,155 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13525
13560
  }
13526
13561
  ]
13527
13562
  },
13563
+ {
13564
+ resource: "media.libraries.generations",
13565
+ method: "create",
13566
+ summary: "Create video generation",
13567
+ description: "Create a video.generate job. Generation is charged per second. The response is 202 with a queued Job; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until terminal, then save successful outputs. Unsaved candidate Files expire after 7 days.",
13568
+ http: "POST",
13569
+ path: "/media/v1/libraries/{library_id}/generations",
13570
+ streaming: "no",
13571
+ pagination: false,
13572
+ pathParams: [
13573
+ {
13574
+ name: "library_id",
13575
+ sdkName: "library_id",
13576
+ description: "Library ID returned by creation."
13577
+ }
13578
+ ],
13579
+ query: [],
13580
+ body: {
13581
+ required: true,
13582
+ fields: [
13583
+ {
13584
+ name: "intent",
13585
+ type: "string",
13586
+ required: true,
13587
+ description: "Generation operation; v1 accepts only video.generate text-to-video requests."
13588
+ },
13589
+ {
13590
+ name: "prompt",
13591
+ type: "string",
13592
+ required: true,
13593
+ description: "Text prompt describing the video to generate."
13594
+ },
13595
+ {
13596
+ name: "count",
13597
+ type: "integer",
13598
+ required: false,
13599
+ description: "Number of videos to generate; defaults to 1 and must be from 1 to 4."
13600
+ },
13601
+ {
13602
+ name: "duration_seconds",
13603
+ type: "integer",
13604
+ required: false,
13605
+ description: "Requested video duration in seconds; Router validates the model-specific supported durations."
13606
+ },
13607
+ {
13608
+ name: "aspect_ratio",
13609
+ type: "string",
13610
+ required: false,
13611
+ description: "Requested output aspect ratio; defaults to 16:9 and Router validates model support."
13612
+ },
13613
+ {
13614
+ name: "model",
13615
+ type: "string",
13616
+ required: false,
13617
+ description: "Router model with video_generation capability; defaults to wan2.7-t2v."
13618
+ },
13619
+ {
13620
+ name: "save",
13621
+ type: "string",
13622
+ enum: [
13623
+ "candidate",
13624
+ "library"
13625
+ ],
13626
+ required: false,
13627
+ description: "candidate keeps outputs temporary for explicit save calls; library saves successful outputs automatically."
13628
+ },
13629
+ {
13630
+ name: "asset_folder",
13631
+ type: "string",
13632
+ required: false,
13633
+ description: "Folder for assets saved automatically or by later save calls; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
13634
+ },
13635
+ {
13636
+ name: "tags",
13637
+ type: "array",
13638
+ itemType: "string",
13639
+ required: false,
13640
+ description: "Tags applied when an output becomes a library asset."
13641
+ },
13642
+ {
13643
+ name: "understanding",
13644
+ type: "string",
13645
+ enum: [
13646
+ "auto",
13647
+ "skip"
13648
+ ],
13649
+ required: false,
13650
+ description: "Understanding behavior when a candidate is saved as an asset; defaults to auto."
13651
+ },
13652
+ {
13653
+ name: "references",
13654
+ type: "array",
13655
+ itemType: "object",
13656
+ required: false,
13657
+ description: "Not supported in v1; omit this field. Only text-to-video is currently available."
13658
+ }
13659
+ ]
13660
+ }
13661
+ },
13662
+ {
13663
+ resource: "media.libraries.jobs",
13664
+ method: "list",
13665
+ summary: "List jobs",
13666
+ description: "List batch and video-generation jobs in a library. Filter by status and continue with next_cursor. Poll a generation Job until terminal, then save successful candidate outputs before they expire after 7 days.",
13667
+ http: "GET",
13668
+ path: "/media/v1/libraries/{library_id}/jobs",
13669
+ streaming: "no",
13670
+ pagination: true,
13671
+ pathParams: [
13672
+ {
13673
+ name: "library_id",
13674
+ sdkName: "library_id",
13675
+ description: "Library ID returned by creation."
13676
+ }
13677
+ ],
13678
+ query: [
13679
+ {
13680
+ name: "status",
13681
+ type: "string",
13682
+ enum: [
13683
+ "queued",
13684
+ "running",
13685
+ "completed",
13686
+ "completed_with_errors",
13687
+ "failed",
13688
+ "cancelled"
13689
+ ],
13690
+ required: false,
13691
+ description: "Filter jobs by their current status."
13692
+ },
13693
+ {
13694
+ name: "limit",
13695
+ type: "integer",
13696
+ required: false,
13697
+ description: "Maximum entries in this page, from 1 through 100; defaults to 100."
13698
+ },
13699
+ {
13700
+ name: "cursor",
13701
+ type: "string",
13702
+ required: false,
13703
+ description: "Job id from the previous page’s next_cursor; omit for the first page."
13704
+ }
13705
+ ]
13706
+ },
13528
13707
  {
13529
13708
  resource: "media.libraries.jobs",
13530
13709
  method: "retrieve",
13531
- summary: "Get job alias",
13532
- description: "Alias of batch retrieval. Read the job returned by a batch request, including terminal status, successful and failed counts, and individual failure codes.",
13710
+ summary: "Get job",
13711
+ description: "Read the current batch or video-generation Job status and progress. For generation, inspect outputs and failures, then save successful candidates before their preview and save window expires after 7 days.",
13533
13712
  http: "GET",
13534
13713
  path: "/media/v1/libraries/{library_id}/jobs/{job_id}",
13535
13714
  streaming: "no",
@@ -13543,16 +13722,101 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13543
13722
  {
13544
13723
  name: "job_id",
13545
13724
  sdkName: "job_id",
13546
- description: "Batch identifier returned by createBatch or batchAssets; resolved within this library."
13725
+ description: "Job identifier returned by batch creation, video-generation creation or job listing; resolved within this library."
13726
+ }
13727
+ ],
13728
+ query: []
13729
+ },
13730
+ {
13731
+ resource: "media.libraries.jobs",
13732
+ method: "cancel",
13733
+ summary: "Cancel job",
13734
+ description: "Cancel a queued or running generation job. Already completed outputs remain available to save; poll or read the returned Job to confirm its status.",
13735
+ http: "POST",
13736
+ path: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
13737
+ streaming: "no",
13738
+ pagination: false,
13739
+ pathParams: [
13740
+ {
13741
+ name: "library_id",
13742
+ sdkName: "library_id",
13743
+ description: "Library ID returned by creation."
13744
+ },
13745
+ {
13746
+ name: "job_id",
13747
+ sdkName: "job_id",
13748
+ description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
13547
13749
  }
13548
13750
  ],
13549
13751
  query: []
13550
13752
  },
13753
+ {
13754
+ resource: "media.libraries.jobs.outputs.save",
13755
+ method: "create",
13756
+ summary: "Save generation output",
13757
+ description: "Save a successful candidate as a library asset. Candidate outputs expire after 7 days; save before expiry. Generation is charged per second when the job runs, not when an output is saved.",
13758
+ http: "POST",
13759
+ path: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
13760
+ streaming: "no",
13761
+ pagination: false,
13762
+ pathParams: [
13763
+ {
13764
+ name: "library_id",
13765
+ sdkName: "library_id",
13766
+ description: "Library ID returned by creation."
13767
+ },
13768
+ {
13769
+ name: "job_id",
13770
+ sdkName: "job_id",
13771
+ description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
13772
+ },
13773
+ {
13774
+ name: "index",
13775
+ sdkName: "index",
13776
+ description: "Zero-based position of the candidate in the Job outputs array."
13777
+ }
13778
+ ],
13779
+ query: [],
13780
+ body: {
13781
+ required: false,
13782
+ fields: [
13783
+ {
13784
+ name: "public_id",
13785
+ type: "string",
13786
+ required: false,
13787
+ description: "Delivery identifier for the saved asset; defaults to gen_<job_id>_<index> and is idempotent."
13788
+ },
13789
+ {
13790
+ name: "asset_folder",
13791
+ type: "string",
13792
+ required: false,
13793
+ description: "Destination folder for the saved asset; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
13794
+ },
13795
+ {
13796
+ name: "tags",
13797
+ type: "array",
13798
+ itemType: "string",
13799
+ required: false,
13800
+ description: "Tags to apply to the saved asset."
13801
+ },
13802
+ {
13803
+ name: "understanding",
13804
+ type: "string",
13805
+ enum: [
13806
+ "auto",
13807
+ "skip"
13808
+ ],
13809
+ required: false,
13810
+ description: "Understanding behavior for the saved asset; defaults to auto."
13811
+ }
13812
+ ]
13813
+ }
13814
+ },
13551
13815
  {
13552
13816
  resource: "media.libraries.purge",
13553
13817
  method: "create",
13554
13818
  summary: "Purge library",
13555
- description: "Permanently remove a library that is already deleting, without waiting for purge_at. Its assets and related resources are removed and cannot be restored; first soft-delete an active library.",
13819
+ description: "List assets in an active library, newest first, optionally filtering by exact folder and stored resource type. Continue using next_cursor; video includes audio-only assets.",
13556
13820
  http: "POST",
13557
13821
  path: "/media/v1/libraries/{library_id}/purge",
13558
13822
  streaming: "no",
@@ -13570,7 +13834,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13570
13834
  resource: "media.libraries",
13571
13835
  method: "restore",
13572
13836
  summary: "Restore library",
13573
- description: "Restore a deleting library before its purge_at deadline. The library becomes active again and deleted_at and purge_at are cleared; expired or non-deleting libraries cannot be restored.",
13837
+ description: "Permanently remove a library that is already deleting, without waiting for purge_at. Its assets and related resources are removed and cannot be restored; first soft-delete an active library.",
13574
13838
  http: "POST",
13575
13839
  path: "/media/v1/libraries/{library_id}/restore",
13576
13840
  streaming: "no",
@@ -13588,7 +13852,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13588
13852
  resource: "media.libraries.search",
13589
13853
  method: "create",
13590
13854
  summary: "Semantic search alias",
13591
- description: "Alias of semantic search. Search assets with a nonblank text query, optional expression filter and top_k; hybrid combines semantic and keyword matches, while semantic uses vector similarity only.",
13855
+ description: "List all immediate child folders under parent, or under the root when parent is omitted. Counts include descendant assets. The result is unpaginated; limit and cursor are rejected.",
13592
13856
  http: "POST",
13593
13857
  path: "/media/v1/libraries/{library_id}/search",
13594
13858
  streaming: "no",
@@ -13639,7 +13903,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13639
13903
  resource: "media.libraries.search.expression",
13640
13904
  method: "create",
13641
13905
  summary: "Expression search",
13642
- description: "Search active assets using the supported filter-expression syntax, sorting and cursor pagination. Empty expression matches all assets. Tags and context require with_field; inspect the exactness flags before treating counts as complete.",
13906
+ description: "Find visually similar assets using exactly one of asset_id or an inline base64 image. The library must support image search; an asset query needs a current image embedding and excludes that source asset from results.",
13643
13907
  http: "POST",
13644
13908
  path: "/media/v1/libraries/{library_id}/search/expression",
13645
13909
  streaming: "no",
@@ -13659,7 +13923,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13659
13923
  name: "expression",
13660
13924
  type: "string",
13661
13925
  required: false,
13662
- 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.'
13926
+ description: 'Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets. For business metadata use context.sku=KETTLE-RED AND context.revision=2; request with_field: ["context"] to include context. Quality filters: flags:watermark matches any current shot with a watermark; flags.watermark:false requires an assessed video with no positive watermark judgment. The same syntax supports slideshow, hand_frame, text_sticker and low_quality. folder_mismatch:true selects lexical folder/location hints. Geometry filters support width, height, resolution:1920x1080, numeric aspect_ratio (width/height), and orientation:landscape, portrait or square. Missing geometry or unassessed legacy flags do not match positive filters. has_music:true AND audio_genre:jazz AND audio_mood:calm selects current-version audio profiles with music and matching model labels; has_music:false applies only to sampled ranges, not the entire source. failure_code=UPSTREAM_FAILED selects assets with a current failed understanding carrying that code; combine with processing_state=failed or processing_state=partial.'
13663
13927
  },
13664
13928
  {
13665
13929
  name: "sort_by",
@@ -13711,7 +13975,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13711
13975
  resource: "media.libraries.search.semantic",
13712
13976
  method: "create",
13713
13977
  summary: "Semantic search",
13714
- description: "Search assets with a nonblank text query and optional expression filter. Hybrid mode combines semantic and keyword matches; semantic mode uses vector similarity only. Results are ranked and limited by top_k.",
13978
+ description: "Alias of semantic search. Search assets with a nonblank text query, optional expression filter and top_k; hybrid combines semantic and keyword matches, while semantic uses vector similarity only.",
13715
13979
  http: "POST",
13716
13980
  path: "/media/v1/libraries/{library_id}/search/semantic",
13717
13981
  streaming: "no",
@@ -13762,7 +14026,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13762
14026
  resource: "media.libraries.search.visual",
13763
14027
  method: "create",
13764
14028
  summary: "Visual search",
13765
- description: "Find visually similar assets using exactly one of asset_id or an inline base64 image. The library must support image search; an asset query needs a current image embedding and excludes that source asset from results.",
14029
+ description: "Search assets with a nonblank text query and optional expression filter. Hybrid mode combines semantic and keyword matches; semantic mode uses vector similarity only. Results are ranked and limited by top_k.",
13766
14030
  http: "POST",
13767
14031
  path: "/media/v1/libraries/{library_id}/search/visual",
13768
14032
  streaming: "no",
@@ -13805,6 +14069,67 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13805
14069
  ]
13806
14070
  }
13807
14071
  },
14072
+ {
14073
+ resource: "media.libraries.understandings",
14074
+ method: "list",
14075
+ summary: "List understanding results across a library",
14076
+ description: "Read current understanding entries across one library without fetching every asset separately. Use library_id from creation or listing. folder includes descendants; kinds is a comma-separated list of output kinds. Entries are ordered by asset_id and then understanding id. Continue with next_cursor and the same folder and kinds; limit defaults to 100 and cannot exceed 100. Superseded, deleted and old-version entries are excluded. During historical backfill, this method returns 503 CAPACITY rather than incomplete pages; poll failureSummary until counts_complete is true, then start pagination. Example: GET /media/v1/libraries/lib_example/understandings?folder=travel&kinds=caption,transcript&limit=100.",
14077
+ http: "GET",
14078
+ path: "/media/v1/libraries/{library_id}/understandings",
14079
+ streaming: "no",
14080
+ pagination: true,
14081
+ pathParams: [
14082
+ {
14083
+ name: "library_id",
14084
+ sdkName: "library_id",
14085
+ description: "Library ID returned by creation."
14086
+ }
14087
+ ],
14088
+ query: [
14089
+ {
14090
+ name: "folder",
14091
+ type: "string",
14092
+ required: false,
14093
+ description: "Folder path including all descendants; omitted or empty selects the entire library."
14094
+ },
14095
+ {
14096
+ name: "kinds",
14097
+ type: "string",
14098
+ required: false,
14099
+ description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind."
14100
+ },
14101
+ {
14102
+ name: "cursor",
14103
+ type: "string",
14104
+ required: false,
14105
+ description: "Cursor from the previous next_cursor."
14106
+ },
14107
+ {
14108
+ name: "limit",
14109
+ type: "integer",
14110
+ required: false,
14111
+ description: "Maximum entries in this page, from 1 through 100; defaults to 100."
14112
+ }
14113
+ ]
14114
+ },
14115
+ {
14116
+ resource: "media.libraries.understandings",
14117
+ method: "retrieveFailureSummary",
14118
+ summary: "Summarize understanding failures",
14119
+ description: "Inspect current understanding failures before retrying. Use library_id from library creation or listing. Groups include code, output kind, actual producer model, retryability and up to five sample asset IDs. At most 1024 detailed groups plus two overflow groups are returned; overflow groups separate retryable and unrecoverable entries and mark overflow=true. Unknown failure codes remain retryable. Historical counts are provisional while counts_complete is false. Example: GET /media/v1/libraries/lib_example/understandings/failure_summary.",
14120
+ http: "GET",
14121
+ path: "/media/v1/libraries/{library_id}/understandings/failure_summary",
14122
+ streaming: "no",
14123
+ pagination: false,
14124
+ pathParams: [
14125
+ {
14126
+ name: "library_id",
14127
+ sdkName: "library_id",
14128
+ description: "Library ID returned by creation."
14129
+ }
14130
+ ],
14131
+ query: []
14132
+ },
13808
14133
  {
13809
14134
  resource: "meta.docs",
13810
14135
  method: "search",
@@ -14092,25 +14417,25 @@ services (model, agent, automation…); call the operation you need and read its
14092
14417
  name: "model",
14093
14418
  type: "string",
14094
14419
  required: true,
14095
- description: "Transcription model id, for example `whisper-large-v3-turbo` or `qwen3-asr-flash`; list candidates with listModels?type=transcription. Router support (supported): Verified to take effect."
14420
+ description: "Model catalog identifier declaring openai.audio.transcriptions; use it unchanged, including any creator prefix."
14096
14421
  },
14097
14422
  {
14098
14423
  name: "file",
14099
14424
  type: "string",
14100
14425
  required: true,
14101
- description: "Audio file to transcribe, uploaded as multipart/form-data. Router support (supported): Verified to take effect."
14426
+ description: "Audio bytes uploaded as a multipart file; supported formats and input limits depend on the selected model."
14102
14427
  },
14103
14428
  {
14104
14429
  name: "language",
14105
14430
  type: "string",
14106
14431
  required: false,
14107
- description: "Language of the audio as an ISO-639-1 code such as `en` or `zh`. Router support (partial): Both models accept ISO language codes. qwen3-asr-flash may translate output to that language; whisper-large-v3-turbo treats it as an input hint. Non-ISO names may return 502."
14432
+ description: "Source language code when known; omit to let the model detect the language."
14108
14433
  },
14109
14434
  {
14110
14435
  name: "prompt",
14111
14436
  type: "string",
14112
14437
  required: false,
14113
- description: "Text that primes the model with vocabulary or context. Router support (partial): Vocabulary hints work on whisper-large-v3-turbo only; qwen3-asr-flash returns 400."
14438
+ description: "Optional vocabulary or contextual guidance for recognizing the audio; support depends on the selected model."
14114
14439
  },
14115
14440
  {
14116
14441
  name: "response_format",
@@ -14118,20 +14443,22 @@ services (model, agent, automation…); call the operation you need and read its
14118
14443
  enum: [
14119
14444
  "json",
14120
14445
  "text",
14121
- "verbose_json"
14446
+ "verbose_json",
14447
+ "diarized_json"
14122
14448
  ],
14123
14449
  required: false,
14124
- description: "Format of the response body. `json` and `text` are the commonly supported formats. Router support (partial): json/text work on both; verbose_json works only on whisper-large-v3-turbo. srt/vtt return 400."
14450
+ description: "Output format: json returns text in JSON; text returns plain text; verbose_json includes requested timestamps; diarized_json includes speaker-labelled segments when supported. Defaults to json."
14125
14451
  },
14126
14452
  {
14127
14453
  name: "timestamp_granularities[]",
14128
14454
  type: "array",
14129
14455
  itemType: "string",
14130
14456
  enum: [
14457
+ "word",
14131
14458
  "segment"
14132
14459
  ],
14133
14460
  required: false,
14134
- description: "Timestamp levels to include with `verbose_json`; only `segment` exists in this schema. Router support (partial): Only whisper-large-v3-turbo supports segment with verbose_json. word returns 400; qwen3-asr-flash does not support timestamps."
14461
+ description: "Timestamp levels to request as repeated multipart fields: word returns per-word times; segment returns segment times. Omit for the model default. Use verbose_json, or diarized_json on supporting models."
14135
14462
  },
14136
14463
  {
14137
14464
  name: "temperature",
@@ -16285,6 +16612,539 @@ for more details.`
16285
16612
  ],
16286
16613
  query: []
16287
16614
  },
16615
+ {
16616
+ resource: "ontology.changesets",
16617
+ method: "create",
16618
+ summary: "Apply changeset",
16619
+ description: "Apply a batch of node, relation and invalidation operations as one transaction, when a mirror has several records to write together and a partial write would leave the graph inconsistent. Every operation succeeds or none is applied. Send an Idempotency-Key header; the same key with the same content replays the first result, and the same key with different content is ONTOLOGY_CONFLICT.",
16620
+ http: "POST",
16621
+ path: "/ontology/v1/changesets",
16622
+ streaming: "no",
16623
+ pagination: false,
16624
+ pathParams: [],
16625
+ query: [],
16626
+ body: {
16627
+ required: true,
16628
+ fields: [
16629
+ {
16630
+ name: "at",
16631
+ type: "string",
16632
+ required: true,
16633
+ description: "World time the batch describes, in ISO 8601 UTC; operations without their own time are dated by it."
16634
+ },
16635
+ {
16636
+ name: "scope",
16637
+ type: "string",
16638
+ required: false,
16639
+ description: "Scope the batch came from, normally the session id it was observed in; it is stored with the operations for later reading."
16640
+ },
16641
+ {
16642
+ name: "ops",
16643
+ type: "array",
16644
+ itemType: "object",
16645
+ required: true,
16646
+ description: "At most 500 operations, applied in order; each names its kind in op and the fields that kind requires."
16647
+ }
16648
+ ]
16649
+ }
16650
+ },
16651
+ {
16652
+ resource: "ontology.nodes",
16653
+ method: "list",
16654
+ summary: "List nodes",
16655
+ description: "Discover the entities in this organization's graph and obtain node ids for retrieval, updates and relations. Filter by type, by free text over names, aliases, descriptions and facts, or by owner; limit is 1–100 and defaults to 50. Omit cursor for the first page, then copy next_cursor into the next request until it is null. A node whose content belongs to somebody else comes back as a restricted entry carrying only its id, type and name.",
16656
+ http: "GET",
16657
+ path: "/ontology/v1/nodes",
16658
+ streaming: "no",
16659
+ pagination: true,
16660
+ pathParams: [],
16661
+ query: [
16662
+ {
16663
+ name: "type",
16664
+ type: "array",
16665
+ itemType: "string",
16666
+ required: false,
16667
+ description: "Repeat to filter to any of several registered node type names, for example type=file&type=ticket; omit to list every type."
16668
+ },
16669
+ {
16670
+ name: "q",
16671
+ type: "string",
16672
+ required: false,
16673
+ description: "Free text matched against node names, aliases and descriptions; omit to list without a text filter."
16674
+ },
16675
+ {
16676
+ name: "owner",
16677
+ type: "string",
16678
+ required: false,
16679
+ description: "Filter to nodes owned by this member id, or omit to list nodes of every owner; organization-wide nodes carry no owner."
16680
+ },
16681
+ {
16682
+ name: "as_of",
16683
+ type: "string",
16684
+ required: false,
16685
+ description: "ISO 8601 timestamp; return the graph as it was then, so a node recorded later is absent. Omit to read current state."
16686
+ },
16687
+ {
16688
+ name: "limit",
16689
+ type: "integer",
16690
+ required: false,
16691
+ description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100."
16692
+ },
16693
+ {
16694
+ name: "cursor",
16695
+ type: "string",
16696
+ required: false,
16697
+ description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
16698
+ }
16699
+ ]
16700
+ },
16701
+ {
16702
+ resource: "ontology.nodes",
16703
+ method: "create",
16704
+ summary: "Create node",
16705
+ description: "Record one entity in the graph, for a system mirroring a record it owns. type must already be registered and ref, when given, must match that type's ref_prefix. Send an Idempotency-Key header; repeating the same key with the same content returns the first result instead of creating a second node. This writes structure only — to give an agent something to remember, use POST /agent/v1/agents/{agent_id}/consolidations.",
16706
+ http: "POST",
16707
+ path: "/ontology/v1/nodes",
16708
+ streaming: "no",
16709
+ pagination: false,
16710
+ pathParams: [],
16711
+ query: [],
16712
+ body: {
16713
+ required: true,
16714
+ fields: [
16715
+ {
16716
+ name: "type",
16717
+ type: "string",
16718
+ required: true,
16719
+ description: "Registered node type name from types.list; an unregistered name is refused and nothing is written."
16720
+ },
16721
+ {
16722
+ name: "ref",
16723
+ type: "string",
16724
+ required: false,
16725
+ description: "Id of the mirrored record in the owning service, which must start with the type's ref_prefix; omit or null for a concept with no external record."
16726
+ },
16727
+ {
16728
+ name: "name",
16729
+ type: "string",
16730
+ required: true,
16731
+ description: "Display name of the entity, at most 200 characters."
16732
+ },
16733
+ {
16734
+ name: "aliases",
16735
+ type: "array",
16736
+ itemType: "string",
16737
+ required: false,
16738
+ description: "Other names this entity is known by; they are matched by search alongside the name."
16739
+ },
16740
+ {
16741
+ name: "description",
16742
+ type: "string",
16743
+ required: false,
16744
+ description: "Profile of the entity, at most 500 characters; omit or null for none."
16745
+ },
16746
+ {
16747
+ name: "owner",
16748
+ type: "string",
16749
+ required: false,
16750
+ description: "Member id whose content this is, restricting it to that member; omit or null to make it readable organization-wide."
16751
+ }
16752
+ ]
16753
+ }
16754
+ },
16755
+ {
16756
+ resource: "ontology.nodes",
16757
+ method: "retrieve",
16758
+ summary: "Retrieve node",
16759
+ description: "Read one node's content and, with expand=relations, every relation on and around it. as_of reads the node as it was at that time. A node id from another organization, or one that never existed, answers ONTOLOGY_NODE_NOT_FOUND; a node you may reach but not read returns restricted true with its name only.",
16760
+ http: "GET",
16761
+ path: "/ontology/v1/nodes/{node_id}",
16762
+ streaming: "no",
16763
+ pagination: false,
16764
+ pathParams: [
16765
+ {
16766
+ name: "node_id",
16767
+ sdkName: "node_id",
16768
+ description: "Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted."
16769
+ }
16770
+ ],
16771
+ query: [
16772
+ {
16773
+ name: "expand",
16774
+ type: "string",
16775
+ enum: [
16776
+ "relations"
16777
+ ],
16778
+ required: false,
16779
+ description: "Set to relations to include the node's incoming and outgoing relations in the same response; omit for the node alone."
16780
+ },
16781
+ {
16782
+ name: "as_of",
16783
+ type: "string",
16784
+ required: false,
16785
+ description: "ISO 8601 timestamp; read the node and its relations as they were then, including relations invalidated since. Omit to read current state."
16786
+ }
16787
+ ]
16788
+ },
16789
+ {
16790
+ resource: "ontology.nodes",
16791
+ method: "update",
16792
+ summary: "Update node",
16793
+ description: "Change a node's name, aliases or description when the mirrored record was renamed, without touching its type or identity. Send only the fields to change; omitted fields keep their current values and an explicitly null description clears it. Repeating the same edit converges on the same node, so this needs no Idempotency-Key.",
16794
+ http: "PATCH",
16795
+ path: "/ontology/v1/nodes/{node_id}",
16796
+ streaming: "no",
16797
+ pagination: false,
16798
+ pathParams: [
16799
+ {
16800
+ name: "node_id",
16801
+ sdkName: "node_id",
16802
+ description: "Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted."
16803
+ }
16804
+ ],
16805
+ query: [],
16806
+ body: {
16807
+ required: true,
16808
+ fields: [
16809
+ {
16810
+ name: "name",
16811
+ type: "string",
16812
+ required: false,
16813
+ description: "New display name, at most 200 characters; omit to keep the current name."
16814
+ },
16815
+ {
16816
+ name: "aliases",
16817
+ type: "array",
16818
+ itemType: "string",
16819
+ required: false,
16820
+ description: "Replacement alias list; an empty array clears the aliases and omitting the field keeps them."
16821
+ },
16822
+ {
16823
+ name: "description",
16824
+ type: "string",
16825
+ required: false,
16826
+ description: "Replacement profile, at most 500 characters; an explicit null clears it and omitting the field keeps it."
16827
+ }
16828
+ ]
16829
+ }
16830
+ },
16831
+ {
16832
+ resource: "ontology.nodes.merge",
16833
+ method: "create",
16834
+ summary: "Merge node",
16835
+ description: "Fold a duplicate node into the node that should survive, when two records are discovered to be the same entity. The merged node's relations and aliases move to the survivor and later reads of the duplicate resolve to it. Send an Idempotency-Key header; repeating the same key replays the first result. Reversal is a staff operation, not available here.",
16836
+ http: "POST",
16837
+ path: "/ontology/v1/nodes/{node_id}/merge",
16838
+ streaming: "no",
16839
+ pagination: false,
16840
+ pathParams: [
16841
+ {
16842
+ name: "node_id",
16843
+ sdkName: "node_id",
16844
+ description: "Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted."
16845
+ }
16846
+ ],
16847
+ query: [],
16848
+ body: {
16849
+ required: true,
16850
+ fields: [
16851
+ {
16852
+ name: "into",
16853
+ type: "string",
16854
+ required: true,
16855
+ description: "Node id that should survive, from nodes.list or search; the merged node's relations and aliases move to it."
16856
+ }
16857
+ ]
16858
+ }
16859
+ },
16860
+ {
16861
+ resource: "ontology.relations",
16862
+ method: "list",
16863
+ summary: "List relations",
16864
+ description: "Read the facts in the graph and obtain relation ids for retrieval, invalidation or spreading. Filter by endpoint node, by type and by direction; as_of reads the relations as they were then. Invalidated relations are omitted unless include_invalid is true. limit is 1–100 and defaults to 50; follow next_cursor until it is null.",
16865
+ http: "GET",
16866
+ path: "/ontology/v1/relations",
16867
+ streaming: "no",
16868
+ pagination: true,
16869
+ pathParams: [],
16870
+ query: [
16871
+ {
16872
+ name: "node",
16873
+ type: "string",
16874
+ required: false,
16875
+ description: "A node id from nodes.list or nodes.create; returns the relations this node takes part in, narrowed by direction. Omit to list relations between every node."
16876
+ },
16877
+ {
16878
+ name: "type",
16879
+ type: "array",
16880
+ itemType: "string",
16881
+ required: false,
16882
+ description: "Repeat to filter to any of several registered relation type names, for example type=references&type=serves; omit to list every type."
16883
+ },
16884
+ {
16885
+ name: "direction",
16886
+ type: "string",
16887
+ enum: [
16888
+ "out",
16889
+ "in",
16890
+ "both"
16891
+ ],
16892
+ required: false,
16893
+ description: "Which side of node to follow; out returns relations the node is the source of, in returns those it is the target of. Only meaningful together with node."
16894
+ },
16895
+ {
16896
+ name: "as_of",
16897
+ type: "string",
16898
+ required: false,
16899
+ description: "ISO 8601 timestamp; read relations as they were then, so one recorded or invalidated later is judged by that time. Omit to read current state."
16900
+ },
16901
+ {
16902
+ name: "include_invalid",
16903
+ type: "boolean",
16904
+ required: false,
16905
+ description: "Set true to include relations whose invalid_at has passed, which is how a relation that stopped being true stays readable. Omit or false for currently valid relations only."
16906
+ },
16907
+ {
16908
+ name: "limit",
16909
+ type: "integer",
16910
+ required: false,
16911
+ description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100."
16912
+ },
16913
+ {
16914
+ name: "cursor",
16915
+ type: "string",
16916
+ required: false,
16917
+ description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
16918
+ }
16919
+ ]
16920
+ },
16921
+ {
16922
+ resource: "ontology.relations",
16923
+ method: "create",
16924
+ summary: "Create relation",
16925
+ description: "Record one fact between two existing nodes, for a system mirroring a relationship it owns. type must be registered and must admit these endpoints; fact states the relationship in one sentence. Send an Idempotency-Key header; repeating the same key returns the first result instead of writing a second relation. This writes structure only — to give an agent something to remember, use POST /agent/v1/agents/{agent_id}/consolidations.",
16926
+ http: "POST",
16927
+ path: "/ontology/v1/relations",
16928
+ streaming: "no",
16929
+ pagination: false,
16930
+ pathParams: [],
16931
+ query: [],
16932
+ body: {
16933
+ required: true,
16934
+ fields: [
16935
+ {
16936
+ name: "type",
16937
+ type: "string",
16938
+ required: true,
16939
+ description: "Registered relation type name from types.list; it must admit both endpoints or the write is refused."
16940
+ },
16941
+ {
16942
+ name: "source",
16943
+ type: "string",
16944
+ required: true,
16945
+ description: "Node id the fact starts from, from nodes.list or nodes.create."
16946
+ },
16947
+ {
16948
+ name: "target",
16949
+ type: "string",
16950
+ required: true,
16951
+ description: "Node id the fact points at, from nodes.list or nodes.create."
16952
+ },
16953
+ {
16954
+ name: "fact",
16955
+ type: "string",
16956
+ required: true,
16957
+ description: "The relationship in one sentence, at most 280 characters, written to read back on its own."
16958
+ },
16959
+ {
16960
+ name: "valid_at",
16961
+ type: "string",
16962
+ required: false,
16963
+ description: "World time the fact became true, when the mirrored record dates it; omit to leave it undated."
16964
+ },
16965
+ {
16966
+ name: "owner",
16967
+ type: "string",
16968
+ required: false,
16969
+ description: "Member id whose content this fact is, restricting it to that member; omit or null for organization-wide."
16970
+ }
16971
+ ]
16972
+ }
16973
+ },
16974
+ {
16975
+ resource: "ontology.relations",
16976
+ method: "retrieve",
16977
+ summary: "Retrieve relation",
16978
+ description: "Read one relation's fact and both of its clocks — valid_at and invalid_at for when it was true in the world, created_at and expired_at for when it was recorded and retired. An id from another organization, or one that never existed, answers ONTOLOGY_EDGE_NOT_FOUND.",
16979
+ http: "GET",
16980
+ path: "/ontology/v1/relations/{relation_id}",
16981
+ streaming: "no",
16982
+ pagination: false,
16983
+ pathParams: [
16984
+ {
16985
+ name: "relation_id",
16986
+ sdkName: "relation_id",
16987
+ description: "Relation id returned by relations.list, relations.create or a changeset, in the form oed_ followed by 32 lowercase letters or digits; a node id is not accepted."
16988
+ }
16989
+ ],
16990
+ query: []
16991
+ },
16992
+ {
16993
+ resource: "ontology.relations.invalidate",
16994
+ method: "create",
16995
+ summary: "Invalidate relation",
16996
+ description: "Mark a relation as no longer true from a world time, when the mirrored record changed. The relation is kept — invalid_at moves and the relation still reads at an earlier as_of, so history stays answerable. Send an Idempotency-Key header; repeating the same key replays the first result. There is no delete.",
16997
+ http: "POST",
16998
+ path: "/ontology/v1/relations/{relation_id}/invalidate",
16999
+ streaming: "no",
17000
+ pagination: false,
17001
+ pathParams: [
17002
+ {
17003
+ name: "relation_id",
17004
+ sdkName: "relation_id",
17005
+ description: "Relation id returned by relations.list, relations.create or a changeset, in the form oed_ followed by 32 lowercase letters or digits; a node id is not accepted."
17006
+ }
17007
+ ],
17008
+ query: [],
17009
+ body: {
17010
+ required: true,
17011
+ fields: [
17012
+ {
17013
+ name: "invalid_at",
17014
+ type: "string",
17015
+ required: true,
17016
+ description: "World time the fact stopped being true, in ISO 8601 UTC; reads at an earlier as_of still return the relation."
17017
+ },
17018
+ {
17019
+ name: "superseded_by",
17020
+ type: "string",
17021
+ required: false,
17022
+ description: "Relation id that replaces this one, when a successor was recorded; omit or null when nothing replaced it."
17023
+ },
17024
+ {
17025
+ name: "reason",
17026
+ type: "string",
17027
+ required: false,
17028
+ description: "Why it stopped being true, for people reading the history later; not enforced and safe to omit."
17029
+ }
17030
+ ]
17031
+ }
17032
+ },
17033
+ {
17034
+ resource: "ontology.search",
17035
+ method: "create",
17036
+ summary: "Search nodes",
17037
+ description: "Resolve text to the nodes it most likely names, when a mirror holds a name and needs the node id it corresponds to. Results are ranked candidates, not an answer, each reporting whether the match came from the node's name, an alias, its description or a relation's fact. Narrow with types, and cap the result count with limit (1–50, default 20). This reads structure; it is not an agent recall — agents recall through POST /agent/v1/agents/{agent_id}/consolidations.",
17038
+ http: "POST",
17039
+ path: "/ontology/v1/search",
17040
+ streaming: "no",
17041
+ pagination: false,
17042
+ pathParams: [],
17043
+ query: [],
17044
+ body: {
17045
+ required: true,
17046
+ fields: [
17047
+ {
17048
+ name: "text",
17049
+ type: "string",
17050
+ required: true,
17051
+ description: "Text to find nodes for, matched against names, aliases, descriptions and relation facts; an empty string is refused."
17052
+ },
17053
+ {
17054
+ name: "types",
17055
+ type: "array",
17056
+ itemType: "string",
17057
+ required: false,
17058
+ description: "Registered node type names to search within; omit to search every type."
17059
+ },
17060
+ {
17061
+ name: "window",
17062
+ type: "object",
17063
+ required: false,
17064
+ description: "Restrict matches to facts recorded within a period; omit to search all time."
17065
+ },
17066
+ {
17067
+ name: "limit",
17068
+ type: "integer",
17069
+ required: false,
17070
+ description: "Maximum candidate nodes to return, from 1 to 50; defaults to 20 when omitted."
17071
+ }
17072
+ ]
17073
+ }
17074
+ },
17075
+ {
17076
+ resource: "ontology.types",
17077
+ method: "list",
17078
+ summary: "List types",
17079
+ description: "Read the node and relation types registered for this organization before writing, so a create names a type the graph accepts. Each entry is one registrant's registration with its owner, version and definitions. Types cannot be created at runtime; they are registered by the owning service at deploy time, so a type missing here is not available to write.",
17080
+ http: "GET",
17081
+ path: "/ontology/v1/types",
17082
+ streaming: "no",
17083
+ pagination: false,
17084
+ pathParams: [],
17085
+ query: []
17086
+ },
17087
+ {
17088
+ resource: "ontology.types",
17089
+ method: "create",
17090
+ summary: "Register type",
17091
+ description: "Register a node or relation type for this organization. Not open yet — this call currently answers 501 NOT_IMPLEMENTED and writes nothing, because a registration is checked and stored by the deploy gate that ships the registering service, not by a runtime call. Until it opens, read the types already in force with praxis.ontology.types.list and create records only of those types.",
17092
+ http: "POST",
17093
+ path: "/ontology/v1/types",
17094
+ streaming: "no",
17095
+ pagination: false,
17096
+ pathParams: [],
17097
+ query: [],
17098
+ body: {
17099
+ required: true,
17100
+ fields: [
17101
+ {
17102
+ name: "owner",
17103
+ type: "string",
17104
+ required: true,
17105
+ description: "Service that registered these types, for example file or ticket; it is the registrant a later change to a type is checked against."
17106
+ },
17107
+ {
17108
+ name: "version",
17109
+ type: "integer",
17110
+ required: true,
17111
+ description: "Monotonic version of this owner's registration; a later registration must extend this one without removing or narrowing anything."
17112
+ },
17113
+ {
17114
+ name: "nodes",
17115
+ type: "array",
17116
+ itemType: "object",
17117
+ required: true,
17118
+ description: "Node types this owner registers."
17119
+ },
17120
+ {
17121
+ name: "edges",
17122
+ type: "array",
17123
+ itemType: "object",
17124
+ required: true,
17125
+ description: "Relation types this owner registers."
17126
+ }
17127
+ ]
17128
+ }
17129
+ },
17130
+ {
17131
+ resource: "ontology.types",
17132
+ method: "retrieve",
17133
+ summary: "Retrieve type",
17134
+ description: "Read one registered type's definition before writing a record of it, to learn whether it is a node or an edge, which endpoints an edge type admits, and which origins it accepts. The name comes from types.list; a name that is not registered answers ONTOLOGY_TYPE_UNKNOWN, and writes of that type are refused.",
17135
+ http: "GET",
17136
+ path: "/ontology/v1/types/{name}",
17137
+ streaming: "no",
17138
+ pagination: false,
17139
+ pathParams: [
17140
+ {
17141
+ name: "name",
17142
+ sdkName: "name",
17143
+ description: "A type name from types.list, with its dots preserved — a display label is not accepted."
17144
+ }
17145
+ ],
17146
+ query: []
17147
+ },
16288
17148
  {
16289
17149
  resource: "organization.charges",
16290
17150
  method: "list",
@@ -19371,7 +20231,7 @@ for more details.`
19371
20231
  name: "filter",
19372
20232
  type: "string",
19373
20233
  required: false,
19374
- 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."
20234
+ 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."
19375
20235
  }
19376
20236
  ]
19377
20237
  },
@@ -20477,7 +21337,7 @@ for more details.`
20477
21337
  resource: "vault.vaults",
20478
21338
  method: "create",
20479
21339
  summary: "Create vault",
20480
- description: "Create an empty, active vault to hold credentials for your account, with a display name and optional metadata. Use its returned id as vault_id when creating secrets or OAuth authorizations. Unlike Anthropic, Agent sessions do not accept nonempty vault_ids; storing a credential or adding its ID to metadata does not enable vault-backed MCP authentication. Application vault references are also unavailable; praxis_vault_ref version bindings and secret writes with a vault source return 501, so creating a vault does not yet enable either consumer.",
21340
+ description: "Create an empty, active vault to hold credentials for your account, with a display name and optional metadata. Use its returned id as vault_id when creating secrets or OAuth authorizations. Agent sessions and deployments accept up to 50 vault_ids and match their credentials against the session's MCP servers, so a stored static or oauth credential does serve as vault-backed MCP authentication; only environment_variable credentials are not yet placed, because the egress proxy ADR-058 §6 gives them is not built. Application vault references are also unavailable; praxis_vault_ref version bindings and secret writes with a vault source return 501, so creating a vault does not yet enable either consumer.",
20481
21341
  http: "POST",
20482
21342
  path: "/vault/v1/vaults",
20483
21343
  streaming: "no",
@@ -22937,6 +23797,15 @@ var fileCancelUpload = (options) => (options.client ?? client).post({
22937
23797
  url: "/file/v1/uploads/{upload_id}/cancel",
22938
23798
  ...options
22939
23799
  });
23800
+ var fileRetrieveUpload = (options) => (options.client ?? client).get({
23801
+ security: [{
23802
+ key: "BearerAuth",
23803
+ scheme: "bearer",
23804
+ type: "http"
23805
+ }],
23806
+ url: "/file/v1/uploads/{upload_id}",
23807
+ ...options
23808
+ });
22940
23809
  var fileCreateSignedUpload = (options) => (options.client ?? client).post({
22941
23810
  security: [{
22942
23811
  key: "BearerAuth",
@@ -27347,6 +28216,19 @@ var mediaCreateLibrary = (options) => (options.client ?? client).post({
27347
28216
  ...options.headers
27348
28217
  }
27349
28218
  });
28219
+ var mediaCreateFrameUrls = (options) => (options.client ?? client).post({
28220
+ security: [{
28221
+ key: "media-BearerAuth",
28222
+ scheme: "bearer",
28223
+ type: "http"
28224
+ }],
28225
+ url: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames",
28226
+ ...options,
28227
+ headers: {
28228
+ "Content-Type": "application/json",
28229
+ ...options.headers
28230
+ }
28231
+ });
27350
28232
  var mediaDeleteLibrary = (options) => (options.client ?? client).delete({
27351
28233
  security: [{
27352
28234
  key: "media-BearerAuth",
@@ -27611,6 +28493,235 @@ var mediaCreateDeliveryToken = (options) => (options.client ?? client).post({
27611
28493
  ...options.headers
27612
28494
  }
27613
28495
  });
28496
+ var mediaUnderstandingFailureSummary = (options) => (options.client ?? client).get({
28497
+ security: [{
28498
+ key: "media-BearerAuth",
28499
+ scheme: "bearer",
28500
+ type: "http"
28501
+ }],
28502
+ url: "/media/v1/libraries/{library_id}/understandings/failure_summary",
28503
+ ...options
28504
+ });
28505
+ var mediaListUnderstandingsByLibrary = (options) => (options.client ?? client).get({
28506
+ security: [{
28507
+ key: "media-BearerAuth",
28508
+ scheme: "bearer",
28509
+ type: "http"
28510
+ }],
28511
+ url: "/media/v1/libraries/{library_id}/understandings",
28512
+ ...options
28513
+ });
28514
+ var mediaCreateGeneration = (options) => (options.client ?? client).post({
28515
+ security: [{
28516
+ key: "media-BearerAuth",
28517
+ scheme: "bearer",
28518
+ type: "http"
28519
+ }],
28520
+ url: "/media/v1/libraries/{library_id}/generations",
28521
+ ...options,
28522
+ headers: {
28523
+ "Content-Type": "application/json",
28524
+ ...options.headers
28525
+ }
28526
+ });
28527
+ var mediaListJobs = (options) => (options.client ?? client).get({
28528
+ security: [{
28529
+ key: "media-BearerAuth",
28530
+ scheme: "bearer",
28531
+ type: "http"
28532
+ }],
28533
+ url: "/media/v1/libraries/{library_id}/jobs",
28534
+ ...options
28535
+ });
28536
+ var mediaCancelJob = (options) => (options.client ?? client).post({
28537
+ security: [{
28538
+ key: "media-BearerAuth",
28539
+ scheme: "bearer",
28540
+ type: "http"
28541
+ }],
28542
+ url: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
28543
+ ...options
28544
+ });
28545
+ var mediaSaveGenerationOutput = (options) => (options.client ?? client).post({
28546
+ security: [{
28547
+ key: "media-BearerAuth",
28548
+ scheme: "bearer",
28549
+ type: "http"
28550
+ }],
28551
+ url: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
28552
+ ...options,
28553
+ headers: {
28554
+ "Content-Type": "application/json",
28555
+ ...options.headers
28556
+ }
28557
+ });
28558
+ var mediaGetGenerationCapabilities = (options) => (options?.client ?? client).get({
28559
+ security: [{
28560
+ key: "media-BearerAuth",
28561
+ scheme: "bearer",
28562
+ type: "http"
28563
+ }],
28564
+ url: "/media/v1/generation/capabilities",
28565
+ ...options
28566
+ });
28567
+ var ontologyListTypes = (options) => (options?.client ?? client).get({
28568
+ security: [{
28569
+ key: "ontology-bearerAuth",
28570
+ scheme: "bearer",
28571
+ type: "http"
28572
+ }],
28573
+ url: "/ontology/v1/types",
28574
+ ...options
28575
+ });
28576
+ var ontologyRegisterType = (options) => (options.client ?? client).post({
28577
+ security: [{
28578
+ key: "ontology-bearerAuth",
28579
+ scheme: "bearer",
28580
+ type: "http"
28581
+ }],
28582
+ url: "/ontology/v1/types",
28583
+ ...options,
28584
+ headers: {
28585
+ "Content-Type": "application/json",
28586
+ ...options.headers
28587
+ }
28588
+ });
28589
+ var ontologyRetrieveType = (options) => (options.client ?? client).get({
28590
+ security: [{
28591
+ key: "ontology-bearerAuth",
28592
+ scheme: "bearer",
28593
+ type: "http"
28594
+ }],
28595
+ url: "/ontology/v1/types/{name}",
28596
+ ...options
28597
+ });
28598
+ var ontologyListNodes = (options) => (options?.client ?? client).get({
28599
+ security: [{
28600
+ key: "ontology-bearerAuth",
28601
+ scheme: "bearer",
28602
+ type: "http"
28603
+ }],
28604
+ url: "/ontology/v1/nodes",
28605
+ ...options
28606
+ });
28607
+ var ontologyCreateNode = (options) => (options.client ?? client).post({
28608
+ security: [{
28609
+ key: "ontology-bearerAuth",
28610
+ scheme: "bearer",
28611
+ type: "http"
28612
+ }],
28613
+ url: "/ontology/v1/nodes",
28614
+ ...options,
28615
+ headers: {
28616
+ "Content-Type": "application/json",
28617
+ ...options.headers
28618
+ }
28619
+ });
28620
+ var ontologyRetrieveNode = (options) => (options.client ?? client).get({
28621
+ security: [{
28622
+ key: "ontology-bearerAuth",
28623
+ scheme: "bearer",
28624
+ type: "http"
28625
+ }],
28626
+ url: "/ontology/v1/nodes/{node_id}",
28627
+ ...options
28628
+ });
28629
+ var ontologyUpdateNode = (options) => (options.client ?? client).patch({
28630
+ security: [{
28631
+ key: "ontology-bearerAuth",
28632
+ scheme: "bearer",
28633
+ type: "http"
28634
+ }],
28635
+ url: "/ontology/v1/nodes/{node_id}",
28636
+ ...options,
28637
+ headers: {
28638
+ "Content-Type": "application/json",
28639
+ ...options.headers
28640
+ }
28641
+ });
28642
+ var ontologyMergeNode = (options) => (options.client ?? client).post({
28643
+ security: [{
28644
+ key: "ontology-bearerAuth",
28645
+ scheme: "bearer",
28646
+ type: "http"
28647
+ }],
28648
+ url: "/ontology/v1/nodes/{node_id}/merge",
28649
+ ...options,
28650
+ headers: {
28651
+ "Content-Type": "application/json",
28652
+ ...options.headers
28653
+ }
28654
+ });
28655
+ var ontologyListRelations = (options) => (options?.client ?? client).get({
28656
+ security: [{
28657
+ key: "ontology-bearerAuth",
28658
+ scheme: "bearer",
28659
+ type: "http"
28660
+ }],
28661
+ url: "/ontology/v1/relations",
28662
+ ...options
28663
+ });
28664
+ var ontologyCreateRelation = (options) => (options.client ?? client).post({
28665
+ security: [{
28666
+ key: "ontology-bearerAuth",
28667
+ scheme: "bearer",
28668
+ type: "http"
28669
+ }],
28670
+ url: "/ontology/v1/relations",
28671
+ ...options,
28672
+ headers: {
28673
+ "Content-Type": "application/json",
28674
+ ...options.headers
28675
+ }
28676
+ });
28677
+ var ontologyRetrieveRelation = (options) => (options.client ?? client).get({
28678
+ security: [{
28679
+ key: "ontology-bearerAuth",
28680
+ scheme: "bearer",
28681
+ type: "http"
28682
+ }],
28683
+ url: "/ontology/v1/relations/{relation_id}",
28684
+ ...options
28685
+ });
28686
+ var ontologyInvalidateRelation = (options) => (options.client ?? client).post({
28687
+ security: [{
28688
+ key: "ontology-bearerAuth",
28689
+ scheme: "bearer",
28690
+ type: "http"
28691
+ }],
28692
+ url: "/ontology/v1/relations/{relation_id}/invalidate",
28693
+ ...options,
28694
+ headers: {
28695
+ "Content-Type": "application/json",
28696
+ ...options.headers
28697
+ }
28698
+ });
28699
+ var ontologyApplyChangeset = (options) => (options.client ?? client).post({
28700
+ security: [{
28701
+ key: "ontology-bearerAuth",
28702
+ scheme: "bearer",
28703
+ type: "http"
28704
+ }],
28705
+ url: "/ontology/v1/changesets",
28706
+ ...options,
28707
+ headers: {
28708
+ "Content-Type": "application/json",
28709
+ ...options.headers
28710
+ }
28711
+ });
28712
+ var ontologySearch = (options) => (options.client ?? client).post({
28713
+ security: [{
28714
+ key: "ontology-bearerAuth",
28715
+ scheme: "bearer",
28716
+ type: "http"
28717
+ }],
28718
+ url: "/ontology/v1/search",
28719
+ ...options,
28720
+ headers: {
28721
+ "Content-Type": "application/json",
28722
+ ...options.headers
28723
+ }
28724
+ });
27614
28725
  var getSandboxV1Sandboxes = (options) => (options?.client ?? client).get({
27615
28726
  querySerializer: { parameters: { state: { array: { explode: false } } } },
27616
28727
  security: [
@@ -30009,7 +31120,8 @@ function createFile(transport) {
30009
31120
  createSigned: bind(transport, fileCreateSignedUpload),
30010
31121
  parts: {
30011
31122
  create: bind(transport, (options) => fileAddUploadPart({ ...options, bodySerializer: multipartBodySerializer, headers: { "Content-Type": null, ...options.headers } }))
30012
- }
31123
+ },
31124
+ retrieve: bind(transport, fileRetrieveUpload)
30013
31125
  }
30014
31126
  };
30015
31127
  }
@@ -30061,11 +31173,19 @@ function createKnowledge(transport) {
30061
31173
  }
30062
31174
  function createMedia(transport) {
30063
31175
  return {
31176
+ generation: {
31177
+ capabilities: {
31178
+ list: bind(transport, mediaGetGenerationCapabilities)
31179
+ }
31180
+ },
30064
31181
  libraries: {
30065
31182
  assets: {
30066
31183
  batch: bind(transport, mediaBatchAssets),
30067
31184
  create: bind(transport, (options) => mediaUploadAsset({ ...options, bodySerializer: multipartBodySerializer, headers: { "Content-Type": null, ...options.headers } })),
30068
31185
  delete: bind(transport, mediaDeleteAsset),
31186
+ frames: {
31187
+ create: bind(transport, mediaCreateFrameUrls)
31188
+ },
30069
31189
  import: {
30070
31190
  create: bind(transport, mediaImportAsset)
30071
31191
  },
@@ -30094,7 +31214,17 @@ function createMedia(transport) {
30094
31214
  folders: {
30095
31215
  list: bind(transport, mediaListFolders)
30096
31216
  },
31217
+ generations: {
31218
+ create: bind(transport, mediaCreateGeneration)
31219
+ },
30097
31220
  jobs: {
31221
+ cancel: bind(transport, mediaCancelJob),
31222
+ list: bindPage(transport, mediaListJobs),
31223
+ outputs: {
31224
+ save: {
31225
+ create: bind(transport, mediaSaveGenerationOutput)
31226
+ }
31227
+ },
30098
31228
  retrieve: bind(transport, mediaGetJob)
30099
31229
  },
30100
31230
  list: bindPage(transport, mediaListLibraries),
@@ -30115,6 +31245,10 @@ function createMedia(transport) {
30115
31245
  create: bind(transport, mediaVisualSearch)
30116
31246
  }
30117
31247
  },
31248
+ understandings: {
31249
+ list: bindPage(transport, mediaListUnderstandingsByLibrary),
31250
+ retrieveFailureSummary: bind(transport, mediaUnderstandingFailureSummary)
31251
+ },
30118
31252
  update: bind(transport, mediaUpdateLibrary)
30119
31253
  }
30120
31254
  };
@@ -30215,6 +31349,38 @@ function createModel(transport) {
30215
31349
  }
30216
31350
  };
30217
31351
  }
31352
+ function createOntology(transport) {
31353
+ return {
31354
+ changesets: {
31355
+ create: bind(transport, ontologyApplyChangeset)
31356
+ },
31357
+ nodes: {
31358
+ create: bind(transport, ontologyCreateNode),
31359
+ list: bindPage(transport, ontologyListNodes),
31360
+ merge: {
31361
+ create: bind(transport, ontologyMergeNode)
31362
+ },
31363
+ retrieve: bind(transport, ontologyRetrieveNode),
31364
+ update: bind(transport, ontologyUpdateNode)
31365
+ },
31366
+ relations: {
31367
+ create: bind(transport, ontologyCreateRelation),
31368
+ invalidate: {
31369
+ create: bind(transport, ontologyInvalidateRelation)
31370
+ },
31371
+ list: bindPage(transport, ontologyListRelations),
31372
+ retrieve: bind(transport, ontologyRetrieveRelation)
31373
+ },
31374
+ search: {
31375
+ create: bind(transport, ontologySearch)
31376
+ },
31377
+ types: {
31378
+ create: bind(transport, ontologyRegisterType),
31379
+ list: bind(transport, ontologyListTypes),
31380
+ retrieve: bind(transport, ontologyRetrieveType)
31381
+ }
31382
+ };
31383
+ }
30218
31384
  function createOrganization(transport) {
30219
31385
  return {
30220
31386
  charges: {
@@ -30481,6 +31647,7 @@ var resourceFactories = {
30481
31647
  media: createMedia,
30482
31648
  meta: createMeta,
30483
31649
  model: createModel,
31650
+ ontology: createOntology,
30484
31651
  organization: createOrganization,
30485
31652
  sandbox: createSandbox,
30486
31653
  search: createSearch,
@@ -33494,7 +34661,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
33494
34661
  }
33495
34662
 
33496
34663
  // src/main.ts
33497
- var version = "0.2.1-dev.5c83a98";
34664
+ var version = "0.2.1-dev.5ce75d1";
33498
34665
  var commands = commandTree(operations);
33499
34666
  var manual = [...workflows.map((w) => w.words), [API_WORD]];
33500
34667
  function route(argv) {