@deepraxis/sdk 0.1.1-dev.e5614a0 → 0.1.1-dev.e9377c2

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.
@@ -135,7 +135,7 @@ export const operations = [
135
135
  "type": "array",
136
136
  "itemType": "object",
137
137
  "required": false,
138
- "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."
138
+ "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."
139
139
  },
140
140
  {
141
141
  "name": "kind",
@@ -5987,7 +5987,7 @@ export const operations = [
5987
5987
  "allow"
5988
5988
  ],
5989
5989
  "required": false,
5990
- "description": "skip (default) skips when a previous run is still active; allow permits overlapping runs."
5990
+ "description": "skip skips while a previous run is still active; allow permits overlapping runs. When omitted, schedule triggers use skip and webhook triggers use allow."
5991
5991
  },
5992
5992
  {
5993
5993
  "name": "catchup_window_seconds",
@@ -6161,7 +6161,7 @@ export const operations = [
6161
6161
  "allow"
6162
6162
  ],
6163
6163
  "required": false,
6164
- "description": "skip (default) skips when a previous run is still active; allow permits overlapping runs."
6164
+ "description": "skip skips while a previous run is still active; allow permits overlapping runs. When omitted, schedule triggers use skip and webhook triggers use allow."
6165
6165
  },
6166
6166
  {
6167
6167
  "name": "catchup_window_seconds",
@@ -9827,7 +9827,7 @@ export const operations = [
9827
9827
  "resource": "cut.projects.analysis",
9828
9828
  "method": "create",
9829
9829
  "summary": "Analyze project media",
9830
- "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.",
9830
+ "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.",
9831
9831
  "http": "POST",
9832
9832
  "path": "/cut/v1/projects/{project_id}/analysis",
9833
9833
  "streaming": "no",
@@ -9998,6 +9998,18 @@ export const operations = [
9998
9998
  "body": {
9999
9999
  "required": true,
10000
10000
  "fields": [
10001
+ {
10002
+ "name": "folder",
10003
+ "type": "string",
10004
+ "required": false,
10005
+ "description": "Optional destination path within the bound media library; omitted uses its default folder."
10006
+ },
10007
+ {
10008
+ "name": "name",
10009
+ "type": "string",
10010
+ "required": false,
10011
+ "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."
10012
+ },
10001
10013
  {
10002
10014
  "name": "output",
10003
10015
  "type": "object",
@@ -10015,6 +10027,12 @@ export const operations = [
10015
10027
  "type": "integer",
10016
10028
  "required": false,
10017
10029
  "description": "Committed project revision from retrieve, state, timeline or execute; increases after each successful write."
10030
+ },
10031
+ {
10032
+ "name": "loudness",
10033
+ "type": "object",
10034
+ "required": false,
10035
+ "description": "Optional loudness normalization target; normalization adds analysis and rendering work."
10018
10036
  }
10019
10037
  ]
10020
10038
  }
@@ -10023,7 +10041,7 @@ export const operations = [
10023
10041
  "resource": "cut.projects.frames",
10024
10042
  "method": "list",
10025
10043
  "summary": "Render preview frames",
10026
- "description": "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Fetch the returned image URLs before expires_at; render again when they expire.",
10044
+ "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.",
10027
10045
  "http": "GET",
10028
10046
  "path": "/cut/v1/projects/{project_id}/frames",
10029
10047
  "streaming": "no",
@@ -10046,7 +10064,7 @@ export const operations = [
10046
10064
  "name": "scale",
10047
10065
  "type": "number",
10048
10066
  "required": false,
10049
- "description": "Positive image size multiplier; 0.5 renders at half the project dimensions."
10067
+ "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."
10050
10068
  },
10051
10069
  {
10052
10070
  "name": "revision",
@@ -10238,7 +10256,7 @@ export const operations = [
10238
10256
  "resource": "cut.projects",
10239
10257
  "method": "execute",
10240
10258
  "summary": "Execute editing script",
10241
- "description": "Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Use AddTrack, Insert, Update, Delete, Split, Trim, Move, RippleDeleteRange, UpdateTrack, DeleteTrack, SetSettings, AddCaptionsFromTranscript and SetMarker for writes; GetTimeline, GetItem, FindItems, GetMedia, GetTranscript and GetAnalysis read editing context; Print emits text and Preview requests frame previews. All script times are seconds; script object fields use camelCase, for example `media: {libraryId, assetId}`. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project:\n\n```js\nconst t = AddTrack(\"video\");\nInsert(t, {type: \"color\", color: \"#123456\", start: 0, length: 3});\nPrint(t);\n```",
10259
+ "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",
10242
10260
  "http": "POST",
10243
10261
  "path": "/cut/v1/projects/{project_id}:execute",
10244
10262
  "streaming": "no",
@@ -11327,7 +11345,7 @@ export const operations = [
11327
11345
  "resource": "file.files",
11328
11346
  "method": "create",
11329
11347
  "summary": "Upload file",
11330
- "description": "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.",
11348
+ "description": "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.",
11331
11349
  "http": "POST",
11332
11350
  "path": "/file/v1/files",
11333
11351
  "streaming": "no",
@@ -11349,10 +11367,11 @@ export const operations = [
11349
11367
  "type": "string",
11350
11368
  "enum": [
11351
11369
  "user_data",
11370
+ "assistants",
11352
11371
  "vision"
11353
11372
  ],
11354
11373
  "required": true,
11355
- "description": "Purpose label stored with the file: user_data or vision. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data."
11374
+ "description": "Purpose label stored with the file: user_data, assistants or vision. The label is stored and returned unchanged; assistants follows the same rules as user_data. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data."
11356
11375
  },
11357
11376
  {
11358
11377
  "name": "expires_after",
@@ -11421,7 +11440,7 @@ export const operations = [
11421
11440
  "resource": "file.files.contentLinks",
11422
11441
  "method": "revoke",
11423
11442
  "summary": "Revoke a file content link",
11424
- "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/>\"}.",
11443
+ "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/>\"}.",
11425
11444
  "http": "POST",
11426
11445
  "path": "/file/v1/files/{file_id}/content_links:revoke",
11427
11446
  "streaming": "no",
@@ -11450,7 +11469,7 @@ export const operations = [
11450
11469
  "resource": "file.files.contentUrl",
11451
11470
  "method": "create",
11452
11471
  "summary": "Create a download URL",
11453
- "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}.",
11472
+ "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}.",
11454
11473
  "http": "POST",
11455
11474
  "path": "/file/v1/files/{file_id}/content_url",
11456
11475
  "streaming": "no",
@@ -11470,7 +11489,7 @@ export const operations = [
11470
11489
  "name": "ttl_seconds",
11471
11490
  "type": "integer",
11472
11491
  "required": false,
11473
- "description": "Download link lifetime in seconds, from 1 through 604800; omitted means 3600. This does not change the file's own expiry."
11492
+ "description": "Download link lifetime in seconds, from 1 through 604800; omitted means 900. This does not change the file's own expiry."
11474
11493
  }
11475
11494
  ]
11476
11495
  }
@@ -11479,7 +11498,7 @@ export const operations = [
11479
11498
  "resource": "file.uploads",
11480
11499
  "method": "create",
11481
11500
  "summary": "Create an upload",
11482
- "description": "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.",
11501
+ "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.",
11483
11502
  "http": "POST",
11484
11503
  "path": "/file/v1/uploads",
11485
11504
  "streaming": "no",
@@ -11493,7 +11512,7 @@ export const operations = [
11493
11512
  "name": "bytes",
11494
11513
  "type": "integer",
11495
11514
  "required": true,
11496
- "description": "Exact complete file length in bytes, from 1 through 2147483648 (2 GiB); the sum of completed parts must match."
11515
+ "description": "Exact complete file length in bytes, from 1 through 21474836480 (20 GiB); the sum of completed parts must match."
11497
11516
  },
11498
11517
  {
11499
11518
  "name": "filename",
@@ -11512,10 +11531,11 @@ export const operations = [
11512
11531
  "type": "string",
11513
11532
  "enum": [
11514
11533
  "user_data",
11534
+ "assistants",
11515
11535
  "vision"
11516
11536
  ],
11517
11537
  "required": true,
11518
- "description": "Use user_data for conversation attachments, or vision for PNG, JPEG, GIF and WebP images."
11538
+ "description": "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images."
11519
11539
  },
11520
11540
  {
11521
11541
  "name": "expires_after",
@@ -11536,7 +11556,7 @@ export const operations = [
11536
11556
  "resource": "file.uploads",
11537
11557
  "method": "createSigned",
11538
11558
  "summary": "Create a one-time upload URL",
11539
- "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\"}.",
11559
+ "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\"}.",
11540
11560
  "http": "POST",
11541
11561
  "path": "/file/v1/uploads/signed",
11542
11562
  "streaming": "no",
@@ -11556,7 +11576,7 @@ export const operations = [
11556
11576
  "name": "bytes",
11557
11577
  "type": "integer",
11558
11578
  "required": true,
11559
- "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."
11579
+ "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."
11560
11580
  },
11561
11581
  {
11562
11582
  "name": "content_type",
@@ -11569,16 +11589,17 @@ export const operations = [
11569
11589
  "type": "string",
11570
11590
  "enum": [
11571
11591
  "user_data",
11592
+ "assistants",
11572
11593
  "vision"
11573
11594
  ],
11574
11595
  "required": false,
11575
- "description": "user_data stores ordinary files and conversation images; vision accepts PNG, JPEG, GIF or WebP images only. Omitted means user_data."
11596
+ "description": "user_data and assistants store ordinary files and conversation images with their original purpose label; vision accepts PNG, JPEG, GIF or WebP images only. Omitted means user_data."
11576
11597
  },
11577
11598
  {
11578
11599
  "name": "expires_in",
11579
11600
  "type": "integer",
11580
11601
  "required": false,
11581
- "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."
11602
+ "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."
11582
11603
  },
11583
11604
  {
11584
11605
  "name": "part_size",
@@ -11589,6 +11610,24 @@ export const operations = [
11589
11610
  ]
11590
11611
  }
11591
11612
  },
11613
+ {
11614
+ "resource": "file.uploads",
11615
+ "method": "retrieve",
11616
+ "summary": "Retrieve an upload",
11617
+ "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.",
11618
+ "http": "GET",
11619
+ "path": "/file/v1/uploads/{upload_id}",
11620
+ "streaming": "no",
11621
+ "pagination": false,
11622
+ "pathParams": [
11623
+ {
11624
+ "name": "upload_id",
11625
+ "sdkName": "upload_id",
11626
+ "description": "Upload identifier returned by create; the upload must belong to your organization."
11627
+ }
11628
+ ],
11629
+ "query": []
11630
+ },
11592
11631
  {
11593
11632
  "resource": "file.uploads",
11594
11633
  "method": "cancel",
@@ -11611,7 +11650,7 @@ export const operations = [
11611
11650
  "resource": "file.uploads",
11612
11651
  "method": "complete",
11613
11652
  "summary": "Complete an upload",
11614
- "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.",
11653
+ "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.",
11615
11654
  "http": "POST",
11616
11655
  "path": "/file/v1/uploads/{upload_id}/complete",
11617
11656
  "streaming": "no",
@@ -11647,7 +11686,7 @@ export const operations = [
11647
11686
  "resource": "file.uploads.parts",
11648
11687
  "method": "create",
11649
11688
  "summary": "Add an upload part",
11650
- "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.",
11689
+ "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.",
11651
11690
  "http": "POST",
11652
11691
  "path": "/file/v1/uploads/{upload_id}/parts",
11653
11692
  "streaming": "no",
@@ -11735,7 +11774,7 @@ export const operations = [
11735
11774
  "resource": "knowledge.vectorStores",
11736
11775
  "method": "create",
11737
11776
  "summary": "Create knowledge base",
11738
- "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\"}.",
11777
+ "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\"}.",
11739
11778
  "http": "POST",
11740
11779
  "path": "/knowledge/v1/vector_stores",
11741
11780
  "streaming": "no",
@@ -11774,7 +11813,7 @@ export const operations = [
11774
11813
  "name": "chunking_strategy",
11775
11814
  "type": "object",
11776
11815
  "required": false,
11777
- "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."
11816
+ "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."
11778
11817
  },
11779
11818
  {
11780
11819
  "name": "description",
@@ -12121,7 +12160,7 @@ export const operations = [
12121
12160
  "resource": "knowledge.vectorStores.files",
12122
12161
  "method": "create",
12123
12162
  "summary": "Add file",
12124
- "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.",
12163
+ "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.",
12125
12164
  "http": "POST",
12126
12165
  "path": "/knowledge/v1/vector_stores/{vector_store_id}/files",
12127
12166
  "streaming": "no",
@@ -12153,7 +12192,7 @@ export const operations = [
12153
12192
  "name": "chunking_strategy",
12154
12193
  "type": "object",
12155
12194
  "required": false,
12156
- "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."
12195
+ "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."
12157
12196
  }
12158
12197
  ]
12159
12198
  }
@@ -12460,11 +12499,23 @@ export const operations = [
12460
12499
  ],
12461
12500
  "query": []
12462
12501
  },
12502
+ {
12503
+ "resource": "media.generation.capabilities",
12504
+ "method": "list",
12505
+ "summary": "Get generation capabilities",
12506
+ "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.",
12507
+ "http": "GET",
12508
+ "path": "/media/v1/generation/capabilities",
12509
+ "streaming": "no",
12510
+ "pagination": false,
12511
+ "pathParams": [],
12512
+ "query": []
12513
+ },
12463
12514
  {
12464
12515
  "resource": "media.libraries",
12465
12516
  "method": "list",
12466
12517
  "summary": "List libraries",
12467
- "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.",
12518
+ "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.",
12468
12519
  "http": "GET",
12469
12520
  "path": "/media/v1/libraries",
12470
12521
  "streaming": "no",
@@ -12546,7 +12597,7 @@ export const operations = [
12546
12597
  "resource": "media.libraries",
12547
12598
  "method": "delete",
12548
12599
  "summary": "Delete library",
12549
- "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.",
12600
+ "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.",
12550
12601
  "http": "DELETE",
12551
12602
  "path": "/media/v1/libraries/{library_id}",
12552
12603
  "streaming": "no",
@@ -12564,7 +12615,7 @@ export const operations = [
12564
12615
  "resource": "media.libraries",
12565
12616
  "method": "retrieve",
12566
12617
  "summary": "Get library",
12567
- "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.",
12618
+ "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.",
12568
12619
  "http": "GET",
12569
12620
  "path": "/media/v1/libraries/{library_id}",
12570
12621
  "streaming": "no",
@@ -12582,7 +12633,7 @@ export const operations = [
12582
12633
  "resource": "media.libraries",
12583
12634
  "method": "update",
12584
12635
  "summary": "Update library",
12585
- "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.",
12636
+ "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.",
12586
12637
  "http": "PATCH",
12587
12638
  "path": "/media/v1/libraries/{library_id}",
12588
12639
  "streaming": "no",
@@ -12598,6 +12649,13 @@ export const operations = [
12598
12649
  "body": {
12599
12650
  "required": true,
12600
12651
  "fields": [
12652
+ {
12653
+ "name": "hotwords",
12654
+ "type": "array",
12655
+ "itemType": "string",
12656
+ "required": false,
12657
+ "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."
12658
+ },
12601
12659
  {
12602
12660
  "name": "models",
12603
12661
  "type": "object",
@@ -12629,7 +12687,7 @@ export const operations = [
12629
12687
  "resource": "media.libraries.assets",
12630
12688
  "method": "list",
12631
12689
  "summary": "List assets",
12632
- "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.",
12690
+ "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.",
12633
12691
  "http": "GET",
12634
12692
  "path": "/media/v1/libraries/{library_id}/assets",
12635
12693
  "streaming": "no",
@@ -12677,7 +12735,7 @@ export const operations = [
12677
12735
  "resource": "media.libraries.assets",
12678
12736
  "method": "create",
12679
12737
  "summary": "Upload asset",
12680
- "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.",
12738
+ "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.",
12681
12739
  "http": "POST",
12682
12740
  "path": "/media/v1/libraries/{library_id}/assets",
12683
12741
  "streaming": "no",
@@ -12722,7 +12780,7 @@ export const operations = [
12722
12780
  "name": "asset_folder",
12723
12781
  "type": "string",
12724
12782
  "required": false,
12725
- "description": "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
12783
+ "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."
12726
12784
  },
12727
12785
  {
12728
12786
  "name": "use_filename",
@@ -12801,7 +12859,7 @@ export const operations = [
12801
12859
  "resource": "media.libraries.assets.import",
12802
12860
  "method": "create",
12803
12861
  "summary": "Import file",
12804
- "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.",
12862
+ "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.",
12805
12863
  "http": "POST",
12806
12864
  "path": "/media/v1/libraries/{library_id}/assets/import",
12807
12865
  "streaming": "no",
@@ -12821,7 +12879,7 @@ export const operations = [
12821
12879
  "name": "file_id",
12822
12880
  "type": "string",
12823
12881
  "required": true,
12824
- "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."
12882
+ "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."
12825
12883
  },
12826
12884
  {
12827
12885
  "name": "public_id",
@@ -12845,7 +12903,7 @@ export const operations = [
12845
12903
  "name": "asset_folder",
12846
12904
  "type": "string",
12847
12905
  "required": false,
12848
- "description": "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
12906
+ "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."
12849
12907
  },
12850
12908
  {
12851
12909
  "name": "use_filename",
@@ -12924,7 +12982,7 @@ export const operations = [
12924
12982
  "resource": "media.libraries.assets",
12925
12983
  "method": "delete",
12926
12984
  "summary": "Delete asset",
12927
- "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.",
12985
+ "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.",
12928
12986
  "http": "DELETE",
12929
12987
  "path": "/media/v1/libraries/{library_id}/assets/{asset_id}",
12930
12988
  "streaming": "no",
@@ -12947,7 +13005,7 @@ export const operations = [
12947
13005
  "resource": "media.libraries.assets",
12948
13006
  "method": "retrieve",
12949
13007
  "summary": "Get asset",
12950
- "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.",
13008
+ "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.",
12951
13009
  "http": "GET",
12952
13010
  "path": "/media/v1/libraries/{library_id}/assets/{asset_id}",
12953
13011
  "streaming": "no",
@@ -12970,7 +13028,7 @@ export const operations = [
12970
13028
  "resource": "media.libraries.assets",
12971
13029
  "method": "update",
12972
13030
  "summary": "Update asset",
12973
- "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.",
13031
+ "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.",
12974
13032
  "http": "PATCH",
12975
13033
  "path": "/media/v1/libraries/{library_id}/assets/{asset_id}",
12976
13034
  "streaming": "no",
@@ -13001,7 +13059,7 @@ export const operations = [
13001
13059
  "name": "asset_folder",
13002
13060
  "type": "string",
13003
13061
  "required": false,
13004
- "description": "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
13062
+ "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."
13005
13063
  },
13006
13064
  {
13007
13065
  "name": "tags",
@@ -13019,11 +13077,57 @@ export const operations = [
13019
13077
  ]
13020
13078
  }
13021
13079
  },
13080
+ {
13081
+ "resource": "media.libraries.assets.frames",
13082
+ "method": "create",
13083
+ "summary": "Create frame URLs",
13084
+ "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.",
13085
+ "http": "POST",
13086
+ "path": "/media/v1/libraries/{library_id}/assets/{asset_id}/frames",
13087
+ "streaming": "no",
13088
+ "pagination": false,
13089
+ "pathParams": [
13090
+ {
13091
+ "name": "library_id",
13092
+ "sdkName": "library_id",
13093
+ "description": "Library identifier returned by library creation or listing; must be accessible to the current credential."
13094
+ },
13095
+ {
13096
+ "name": "asset_id",
13097
+ "sdkName": "asset_id",
13098
+ "description": "Video asset identifier returned by asset upload or listing in this library; read its duration before choosing timestamps."
13099
+ }
13100
+ ],
13101
+ "query": [],
13102
+ "body": {
13103
+ "required": true,
13104
+ "fields": [
13105
+ {
13106
+ "name": "at_micros",
13107
+ "type": "array",
13108
+ "itemType": "integer",
13109
+ "required": true,
13110
+ "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."
13111
+ },
13112
+ {
13113
+ "name": "width",
13114
+ "type": "integer",
13115
+ "enum": [
13116
+ 160,
13117
+ 320,
13118
+ 640
13119
+ ],
13120
+ "required": false,
13121
+ "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."
13122
+ }
13123
+ ]
13124
+ }
13125
+ },
13022
13126
  {
13023
13127
  "resource": "media.libraries.assets.reprocess",
13024
13128
  "method": "create",
13025
13129
  "summary": "Reprocess asset",
13026
- "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.",
13130
+ "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.",
13027
13131
  "http": "POST",
13028
13132
  "path": "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess",
13029
13133
  "streaming": "no",
@@ -13055,7 +13159,7 @@ export const operations = [
13055
13159
  "embedding"
13056
13160
  ],
13057
13161
  "required": false,
13058
- "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."
13162
+ "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."
13059
13163
  }
13060
13164
  ]
13061
13165
  }
@@ -13064,7 +13168,7 @@ export const operations = [
13064
13168
  "resource": "media.libraries.assets.understandings",
13065
13169
  "method": "list",
13066
13170
  "summary": "List understandings",
13067
- "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.",
13171
+ "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.",
13068
13172
  "http": "GET",
13069
13173
  "path": "/media/v1/libraries/{library_id}/assets/{asset_id}/understandings",
13070
13174
  "streaming": "no",
@@ -13096,10 +13200,13 @@ export const operations = [
13096
13200
  "tags",
13097
13201
  "ocr",
13098
13202
  "transcript",
13099
- "frame"
13203
+ "frame",
13204
+ "overview",
13205
+ "audio",
13206
+ "embedding"
13100
13207
  ],
13101
13208
  "required": false,
13102
- "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."
13209
+ "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."
13103
13210
  },
13104
13211
  {
13105
13212
  "name": "cursor",
@@ -13119,7 +13226,7 @@ export const operations = [
13119
13226
  "resource": "media.libraries.assets",
13120
13227
  "method": "batch",
13121
13228
  "summary": "Batch assets alias",
13122
- "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.",
13229
+ "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.",
13123
13230
  "http": "POST",
13124
13231
  "path": "/media/v1/libraries/{library_id}/assets:batch",
13125
13232
  "streaming": "no",
@@ -13140,6 +13247,12 @@ export const operations = [
13140
13247
  "type": "object",
13141
13248
  "required": true,
13142
13249
  "description": "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
13250
+ },
13251
+ {
13252
+ "name": "reason",
13253
+ "type": "string",
13254
+ "required": false,
13255
+ "description": "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
13143
13256
  }
13144
13257
  ]
13145
13258
  }
@@ -13148,7 +13261,7 @@ export const operations = [
13148
13261
  "resource": "media.libraries.batches",
13149
13262
  "method": "create",
13150
13263
  "summary": "Create batch",
13151
- "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.",
13264
+ "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.",
13152
13265
  "http": "POST",
13153
13266
  "path": "/media/v1/libraries/{library_id}/batches",
13154
13267
  "streaming": "no",
@@ -13169,6 +13282,12 @@ export const operations = [
13169
13282
  "type": "object",
13170
13283
  "required": true,
13171
13284
  "description": "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
13285
+ },
13286
+ {
13287
+ "name": "reason",
13288
+ "type": "string",
13289
+ "required": false,
13290
+ "description": "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
13172
13291
  }
13173
13292
  ]
13174
13293
  }
@@ -13177,7 +13296,7 @@ export const operations = [
13177
13296
  "resource": "media.libraries.batches",
13178
13297
  "method": "retrieve",
13179
13298
  "summary": "Get batch",
13180
- "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.",
13299
+ "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.",
13181
13300
  "http": "GET",
13182
13301
  "path": "/media/v1/libraries/{library_id}/batches/{job_id}",
13183
13302
  "streaming": "no",
@@ -13200,7 +13319,7 @@ export const operations = [
13200
13319
  "resource": "media.libraries.deliveryTokens",
13201
13320
  "method": "create",
13202
13321
  "summary": "Create delivery token",
13203
- "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.",
13322
+ "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.",
13204
13323
  "http": "POST",
13205
13324
  "path": "/media/v1/libraries/{library_id}/delivery_tokens",
13206
13325
  "streaming": "no",
@@ -13226,7 +13345,7 @@ export const operations = [
13226
13345
  "name": "expires_in",
13227
13346
  "type": "integer",
13228
13347
  "required": false,
13229
- "description": "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 3600."
13348
+ "description": "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 900."
13230
13349
  }
13231
13350
  ]
13232
13351
  }
@@ -13235,7 +13354,7 @@ export const operations = [
13235
13354
  "resource": "media.libraries.events",
13236
13355
  "method": "list",
13237
13356
  "summary": "List events",
13238
- "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.",
13357
+ "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.",
13239
13358
  "http": "GET",
13240
13359
  "path": "/media/v1/libraries/{library_id}/events",
13241
13360
  "streaming": "no",
@@ -13282,7 +13401,7 @@ export const operations = [
13282
13401
  "resource": "media.libraries.folders",
13283
13402
  "method": "list",
13284
13403
  "summary": "List folders",
13285
- "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.",
13404
+ "description": "undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.",
13286
13405
  "http": "GET",
13287
13406
  "path": "/media/v1/libraries/{library_id}/folders",
13288
13407
  "streaming": "no",
@@ -13304,71 +13423,12 @@ export const operations = [
13304
13423
  ]
13305
13424
  },
13306
13425
  {
13307
- "resource": "media.libraries.jobs",
13308
- "method": "retrieve",
13309
- "summary": "Get job alias",
13310
- "description": "Alias of batch retrieval. Read the job returned by a batch request, including terminal status, successful and failed counts, and individual failure codes.",
13311
- "http": "GET",
13312
- "path": "/media/v1/libraries/{library_id}/jobs/{job_id}",
13313
- "streaming": "no",
13314
- "pagination": false,
13315
- "pathParams": [
13316
- {
13317
- "name": "library_id",
13318
- "sdkName": "library_id",
13319
- "description": "Library ID returned by creation."
13320
- },
13321
- {
13322
- "name": "job_id",
13323
- "sdkName": "job_id",
13324
- "description": "Batch identifier returned by createBatch or batchAssets; resolved within this library."
13325
- }
13326
- ],
13327
- "query": []
13328
- },
13329
- {
13330
- "resource": "media.libraries.purge",
13331
- "method": "create",
13332
- "summary": "Purge library",
13333
- "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.",
13334
- "http": "POST",
13335
- "path": "/media/v1/libraries/{library_id}/purge",
13336
- "streaming": "no",
13337
- "pagination": false,
13338
- "pathParams": [
13339
- {
13340
- "name": "library_id",
13341
- "sdkName": "library_id",
13342
- "description": "Library ID returned by creation."
13343
- }
13344
- ],
13345
- "query": []
13346
- },
13347
- {
13348
- "resource": "media.libraries",
13349
- "method": "restore",
13350
- "summary": "Restore library",
13351
- "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.",
13352
- "http": "POST",
13353
- "path": "/media/v1/libraries/{library_id}/restore",
13354
- "streaming": "no",
13355
- "pagination": false,
13356
- "pathParams": [
13357
- {
13358
- "name": "library_id",
13359
- "sdkName": "library_id",
13360
- "description": "Library ID returned by creation."
13361
- }
13362
- ],
13363
- "query": []
13364
- },
13365
- {
13366
- "resource": "media.libraries.search",
13426
+ "resource": "media.libraries.generations",
13367
13427
  "method": "create",
13368
- "summary": "Semantic search alias",
13369
- "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.",
13428
+ "summary": "Create video generation",
13429
+ "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.",
13370
13430
  "http": "POST",
13371
- "path": "/media/v1/libraries/{library_id}/search",
13431
+ "path": "/media/v1/libraries/{library_id}/generations",
13372
13432
  "streaming": "no",
13373
13433
  "pagination": false,
13374
13434
  "pathParams": [
@@ -13383,117 +13443,93 @@ export const operations = [
13383
13443
  "required": true,
13384
13444
  "fields": [
13385
13445
  {
13386
- "name": "query",
13446
+ "name": "intent",
13387
13447
  "type": "string",
13388
13448
  "required": true,
13389
- "description": "Nonblank text to search against asset content and metadata."
13449
+ "description": "Generation operation; v1 accepts only video.generate text-to-video requests."
13390
13450
  },
13391
13451
  {
13392
- "name": "filter",
13452
+ "name": "prompt",
13393
13453
  "type": "string",
13394
- "required": false,
13395
- "description": "Optional expression filter restricting eligible assets; uses the expression-search syntax."
13454
+ "required": true,
13455
+ "description": "Text prompt describing the video to generate."
13396
13456
  },
13397
13457
  {
13398
- "name": "top_k",
13458
+ "name": "count",
13399
13459
  "type": "integer",
13400
13460
  "required": false,
13401
- "description": "Maximum search hits, from 1 to 50; defaults to 20."
13461
+ "description": "Number of videos to generate; defaults to 1 and must be from 1 to 4."
13402
13462
  },
13403
13463
  {
13404
- "name": "mode",
13405
- "type": "string",
13406
- "enum": [
13407
- "hybrid",
13408
- "semantic"
13409
- ],
13464
+ "name": "duration_seconds",
13465
+ "type": "integer",
13410
13466
  "required": false,
13411
- "description": "Ranking mode: hybrid combines semantic and keyword matches; semantic uses vector similarity only. Defaults to hybrid."
13412
- }
13413
- ]
13414
- }
13415
- },
13416
- {
13417
- "resource": "media.libraries.search.expression",
13418
- "method": "create",
13419
- "summary": "Expression search",
13420
- "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.",
13421
- "http": "POST",
13422
- "path": "/media/v1/libraries/{library_id}/search/expression",
13423
- "streaming": "no",
13424
- "pagination": false,
13425
- "pathParams": [
13426
- {
13427
- "name": "library_id",
13428
- "sdkName": "library_id",
13429
- "description": "Library ID returned by creation."
13430
- }
13431
- ],
13432
- "query": [],
13433
- "body": {
13434
- "required": true,
13435
- "fields": [
13467
+ "description": "Requested video duration in seconds; Router validates the model-specific supported durations."
13468
+ },
13436
13469
  {
13437
- "name": "expression",
13470
+ "name": "aspect_ratio",
13438
13471
  "type": "string",
13439
13472
  "required": false,
13440
- "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."
13473
+ "description": "Requested output aspect ratio; defaults to 16:9 and Router validates model support."
13441
13474
  },
13442
13475
  {
13443
- "name": "sort_by",
13444
- "type": "array",
13445
- "itemType": "object",
13476
+ "name": "model",
13477
+ "type": "string",
13446
13478
  "required": false,
13447
- "description": "Ordered list of single-field sort objects. Allowed fields are created_at, public_id, display_name, bytes and uploaded_at; directions are asc or desc. Fields cannot repeat. Defaults to created_at descending."
13479
+ "description": "Router model with video_generation capability; defaults to wan2.7-t2v."
13448
13480
  },
13449
13481
  {
13450
- "name": "max_results",
13451
- "type": "integer",
13482
+ "name": "save",
13483
+ "type": "string",
13484
+ "enum": [
13485
+ "candidate",
13486
+ "library"
13487
+ ],
13452
13488
  "required": false,
13453
- "description": "Maximum assets per page, from 1 to 500; defaults to 100."
13489
+ "description": "candidate keeps outputs temporary for explicit save calls; library saves successful outputs automatically."
13454
13490
  },
13455
13491
  {
13456
- "name": "next_cursor",
13492
+ "name": "asset_folder",
13457
13493
  "type": "string",
13458
13494
  "required": false,
13459
- "description": "Continuation token returned by the previous expression-search page. Keep sort_by unchanged when continuing."
13495
+ "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."
13460
13496
  },
13461
13497
  {
13462
- "name": "with_field",
13498
+ "name": "tags",
13463
13499
  "type": "array",
13464
13500
  "itemType": "string",
13501
+ "required": false,
13502
+ "description": "Tags applied when an output becomes a library asset."
13503
+ },
13504
+ {
13505
+ "name": "understanding",
13506
+ "type": "string",
13465
13507
  "enum": [
13466
- "tags",
13467
- "context"
13508
+ "auto",
13509
+ "skip"
13468
13510
  ],
13469
13511
  "required": false,
13470
- "description": "Additional resource fields to include: tags adds asset labels and context adds custom metadata. Both are omitted unless requested."
13512
+ "description": "Understanding behavior when a candidate is saved as an asset; defaults to auto."
13471
13513
  },
13472
13514
  {
13473
- "name": "aggregate",
13515
+ "name": "references",
13474
13516
  "type": "array",
13475
- "itemType": "string",
13476
- "enum": [
13477
- "resource_type",
13478
- "format",
13479
- "asset_folder",
13480
- "processing_state"
13481
- ],
13517
+ "itemType": "object",
13482
13518
  "required": false,
13483
- "description": "Facets to count over matching assets, returned under aggregations."
13519
+ "description": "Not supported in v1; omit this field. Only text-to-video is currently available."
13484
13520
  }
13485
13521
  ]
13486
13522
  }
13487
13523
  },
13488
13524
  {
13489
- "resource": "media.libraries.search.semantic",
13490
- "method": "create",
13491
- "summary": "Semantic search",
13492
- "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.",
13493
- "http": "POST",
13494
- "path": "/media/v1/libraries/{library_id}/search/semantic",
13525
+ "resource": "media.libraries.jobs",
13526
+ "method": "list",
13527
+ "summary": "List jobs",
13528
+ "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.",
13529
+ "http": "GET",
13530
+ "path": "/media/v1/libraries/{library_id}/jobs",
13495
13531
  "streaming": "no",
13496
- "pagination": false,
13532
+ "pagination": true,
13497
13533
  "pathParams": [
13498
13534
  {
13499
13535
  "name": "library_id",
@@ -13501,12 +13537,201 @@ export const operations = [
13501
13537
  "description": "Library ID returned by creation."
13502
13538
  }
13503
13539
  ],
13504
- "query": [],
13505
- "body": {
13506
- "required": true,
13507
- "fields": [
13508
- {
13509
- "name": "query",
13540
+ "query": [
13541
+ {
13542
+ "name": "status",
13543
+ "type": "string",
13544
+ "enum": [
13545
+ "queued",
13546
+ "running",
13547
+ "completed",
13548
+ "completed_with_errors",
13549
+ "failed",
13550
+ "cancelled"
13551
+ ],
13552
+ "required": false,
13553
+ "description": "Filter jobs by their current status."
13554
+ },
13555
+ {
13556
+ "name": "limit",
13557
+ "type": "integer",
13558
+ "required": false,
13559
+ "description": "Maximum entries in this page, from 1 through 100; defaults to 100."
13560
+ },
13561
+ {
13562
+ "name": "cursor",
13563
+ "type": "string",
13564
+ "required": false,
13565
+ "description": "Job id from the previous page’s next_cursor; omit for the first page."
13566
+ }
13567
+ ]
13568
+ },
13569
+ {
13570
+ "resource": "media.libraries.jobs",
13571
+ "method": "retrieve",
13572
+ "summary": "Get job",
13573
+ "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.",
13574
+ "http": "GET",
13575
+ "path": "/media/v1/libraries/{library_id}/jobs/{job_id}",
13576
+ "streaming": "no",
13577
+ "pagination": false,
13578
+ "pathParams": [
13579
+ {
13580
+ "name": "library_id",
13581
+ "sdkName": "library_id",
13582
+ "description": "Library ID returned by creation."
13583
+ },
13584
+ {
13585
+ "name": "job_id",
13586
+ "sdkName": "job_id",
13587
+ "description": "Job identifier returned by batch creation, video-generation creation or job listing; resolved within this library."
13588
+ }
13589
+ ],
13590
+ "query": []
13591
+ },
13592
+ {
13593
+ "resource": "media.libraries.jobs",
13594
+ "method": "cancel",
13595
+ "summary": "Cancel job",
13596
+ "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.",
13597
+ "http": "POST",
13598
+ "path": "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
13599
+ "streaming": "no",
13600
+ "pagination": false,
13601
+ "pathParams": [
13602
+ {
13603
+ "name": "library_id",
13604
+ "sdkName": "library_id",
13605
+ "description": "Library ID returned by creation."
13606
+ },
13607
+ {
13608
+ "name": "job_id",
13609
+ "sdkName": "job_id",
13610
+ "description": "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
13611
+ }
13612
+ ],
13613
+ "query": []
13614
+ },
13615
+ {
13616
+ "resource": "media.libraries.jobs.outputs.save",
13617
+ "method": "create",
13618
+ "summary": "Save generation output",
13619
+ "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.",
13620
+ "http": "POST",
13621
+ "path": "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
13622
+ "streaming": "no",
13623
+ "pagination": false,
13624
+ "pathParams": [
13625
+ {
13626
+ "name": "library_id",
13627
+ "sdkName": "library_id",
13628
+ "description": "Library ID returned by creation."
13629
+ },
13630
+ {
13631
+ "name": "job_id",
13632
+ "sdkName": "job_id",
13633
+ "description": "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
13634
+ },
13635
+ {
13636
+ "name": "index",
13637
+ "sdkName": "index",
13638
+ "description": "Zero-based position of the candidate in the Job outputs array."
13639
+ }
13640
+ ],
13641
+ "query": [],
13642
+ "body": {
13643
+ "required": false,
13644
+ "fields": [
13645
+ {
13646
+ "name": "public_id",
13647
+ "type": "string",
13648
+ "required": false,
13649
+ "description": "Delivery identifier for the saved asset; defaults to gen_<job_id>_<index> and is idempotent."
13650
+ },
13651
+ {
13652
+ "name": "asset_folder",
13653
+ "type": "string",
13654
+ "required": false,
13655
+ "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."
13656
+ },
13657
+ {
13658
+ "name": "tags",
13659
+ "type": "array",
13660
+ "itemType": "string",
13661
+ "required": false,
13662
+ "description": "Tags to apply to the saved asset."
13663
+ },
13664
+ {
13665
+ "name": "understanding",
13666
+ "type": "string",
13667
+ "enum": [
13668
+ "auto",
13669
+ "skip"
13670
+ ],
13671
+ "required": false,
13672
+ "description": "Understanding behavior for the saved asset; defaults to auto."
13673
+ }
13674
+ ]
13675
+ }
13676
+ },
13677
+ {
13678
+ "resource": "media.libraries.purge",
13679
+ "method": "create",
13680
+ "summary": "Purge library",
13681
+ "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.",
13682
+ "http": "POST",
13683
+ "path": "/media/v1/libraries/{library_id}/purge",
13684
+ "streaming": "no",
13685
+ "pagination": false,
13686
+ "pathParams": [
13687
+ {
13688
+ "name": "library_id",
13689
+ "sdkName": "library_id",
13690
+ "description": "Library ID returned by creation."
13691
+ }
13692
+ ],
13693
+ "query": []
13694
+ },
13695
+ {
13696
+ "resource": "media.libraries",
13697
+ "method": "restore",
13698
+ "summary": "Restore library",
13699
+ "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.",
13700
+ "http": "POST",
13701
+ "path": "/media/v1/libraries/{library_id}/restore",
13702
+ "streaming": "no",
13703
+ "pagination": false,
13704
+ "pathParams": [
13705
+ {
13706
+ "name": "library_id",
13707
+ "sdkName": "library_id",
13708
+ "description": "Library ID returned by creation."
13709
+ }
13710
+ ],
13711
+ "query": []
13712
+ },
13713
+ {
13714
+ "resource": "media.libraries.search",
13715
+ "method": "create",
13716
+ "summary": "Semantic search alias",
13717
+ "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.",
13718
+ "http": "POST",
13719
+ "path": "/media/v1/libraries/{library_id}/search",
13720
+ "streaming": "no",
13721
+ "pagination": false,
13722
+ "pathParams": [
13723
+ {
13724
+ "name": "library_id",
13725
+ "sdkName": "library_id",
13726
+ "description": "Library ID returned by creation."
13727
+ }
13728
+ ],
13729
+ "query": [],
13730
+ "body": {
13731
+ "required": true,
13732
+ "fields": [
13733
+ {
13734
+ "name": "query",
13510
13735
  "type": "string",
13511
13736
  "required": true,
13512
13737
  "description": "Nonblank text to search against asset content and metadata."
@@ -13537,12 +13762,12 @@ export const operations = [
13537
13762
  }
13538
13763
  },
13539
13764
  {
13540
- "resource": "media.libraries.search.visual",
13765
+ "resource": "media.libraries.search.expression",
13541
13766
  "method": "create",
13542
- "summary": "Visual search",
13767
+ "summary": "Expression search",
13543
13768
  "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.",
13544
13769
  "http": "POST",
13545
- "path": "/media/v1/libraries/{library_id}/search/visual",
13770
+ "path": "/media/v1/libraries/{library_id}/search/expression",
13546
13771
  "streaming": "no",
13547
13772
  "pagination": false,
13548
13773
  "pathParams": [
@@ -13557,66 +13782,250 @@ export const operations = [
13557
13782
  "required": true,
13558
13783
  "fields": [
13559
13784
  {
13560
- "name": "asset_id",
13785
+ "name": "expression",
13561
13786
  "type": "string",
13562
13787
  "required": false,
13563
- "description": "Asset identifier returned by upload or asset listing; distinct from public_id and content hashes."
13788
+ "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."
13564
13789
  },
13565
13790
  {
13566
- "name": "image",
13567
- "type": "object",
13791
+ "name": "sort_by",
13792
+ "type": "array",
13793
+ "itemType": "object",
13568
13794
  "required": false,
13569
- "description": "Inline image used as the visual query; mutually exclusive with asset_id."
13795
+ "description": "Ordered list of single-field sort objects. Allowed fields are created_at, public_id, display_name, bytes and uploaded_at; directions are asc or desc. Fields cannot repeat. Defaults to created_at descending."
13570
13796
  },
13571
13797
  {
13572
- "name": "top_k",
13798
+ "name": "max_results",
13573
13799
  "type": "integer",
13574
13800
  "required": false,
13575
- "description": "Maximum visual-search hits, from 1 to 50; defaults to 20."
13801
+ "description": "Maximum assets per page, from 1 to 500; defaults to 100."
13576
13802
  },
13577
13803
  {
13578
- "name": "filter",
13804
+ "name": "next_cursor",
13579
13805
  "type": "string",
13580
13806
  "required": false,
13581
- "description": "Expression filter restricting eligible result assets."
13807
+ "description": "Continuation token returned by the previous expression-search page. Keep sort_by unchanged when continuing."
13808
+ },
13809
+ {
13810
+ "name": "with_field",
13811
+ "type": "array",
13812
+ "itemType": "string",
13813
+ "enum": [
13814
+ "tags",
13815
+ "context"
13816
+ ],
13817
+ "required": false,
13818
+ "description": "Additional resource fields to include: tags adds asset labels and context adds custom metadata. Both are omitted unless requested."
13819
+ },
13820
+ {
13821
+ "name": "aggregate",
13822
+ "type": "array",
13823
+ "itemType": "string",
13824
+ "enum": [
13825
+ "resource_type",
13826
+ "format",
13827
+ "asset_folder",
13828
+ "processing_state"
13829
+ ],
13830
+ "required": false,
13831
+ "description": "Facets to count over matching assets, returned under aggregations."
13582
13832
  }
13583
13833
  ]
13584
13834
  }
13585
13835
  },
13586
13836
  {
13587
- "resource": "meta.docs",
13588
- "method": "search",
13589
- "summary": "Search platform documentation",
13590
- "description": "Find guides and references by keyword before reading them with praxis.meta.docs.retrieve. Public; no API key required. Matches documentation titles, headings and page text without case sensitivity; all query words must occur. q is required; limit defaults to 20 and accepts 1–50. lang defaults to zh or use en for English. Returns paths, page titles, canonical URLs and short matching snippets; no matches returns an empty array.",
13591
- "http": "GET",
13592
- "path": "/meta/v1/docs/search",
13837
+ "resource": "media.libraries.search.semantic",
13838
+ "method": "create",
13839
+ "summary": "Semantic search",
13840
+ "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.",
13841
+ "http": "POST",
13842
+ "path": "/media/v1/libraries/{library_id}/search/semantic",
13593
13843
  "streaming": "no",
13594
13844
  "pagination": false,
13595
- "pathParams": [],
13596
- "query": [
13597
- {
13598
- "name": "q",
13599
- "type": "string",
13600
- "required": true,
13601
- "description": "Keywords describing the syntax or guide needed, for example export or workflow."
13602
- },
13603
- {
13604
- "name": "limit",
13605
- "type": "integer",
13606
- "required": false,
13607
- "description": "Maximum number of matching pages returned; integer 1–50, default 20."
13608
- },
13845
+ "pathParams": [
13609
13846
  {
13610
- "name": "lang",
13611
- "type": "string",
13612
- "enum": [
13613
- "zh",
13614
- "en"
13615
- ],
13616
- "required": false,
13617
- "description": "Documentation language: zh for Chinese (default), en for English."
13618
- }
13619
- ]
13847
+ "name": "library_id",
13848
+ "sdkName": "library_id",
13849
+ "description": "Library ID returned by creation."
13850
+ }
13851
+ ],
13852
+ "query": [],
13853
+ "body": {
13854
+ "required": true,
13855
+ "fields": [
13856
+ {
13857
+ "name": "query",
13858
+ "type": "string",
13859
+ "required": true,
13860
+ "description": "Nonblank text to search against asset content and metadata."
13861
+ },
13862
+ {
13863
+ "name": "filter",
13864
+ "type": "string",
13865
+ "required": false,
13866
+ "description": "Optional expression filter restricting eligible assets; uses the expression-search syntax."
13867
+ },
13868
+ {
13869
+ "name": "top_k",
13870
+ "type": "integer",
13871
+ "required": false,
13872
+ "description": "Maximum search hits, from 1 to 50; defaults to 20."
13873
+ },
13874
+ {
13875
+ "name": "mode",
13876
+ "type": "string",
13877
+ "enum": [
13878
+ "hybrid",
13879
+ "semantic"
13880
+ ],
13881
+ "required": false,
13882
+ "description": "Ranking mode: hybrid combines semantic and keyword matches; semantic uses vector similarity only. Defaults to hybrid."
13883
+ }
13884
+ ]
13885
+ }
13886
+ },
13887
+ {
13888
+ "resource": "media.libraries.search.visual",
13889
+ "method": "create",
13890
+ "summary": "Visual search",
13891
+ "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.",
13892
+ "http": "POST",
13893
+ "path": "/media/v1/libraries/{library_id}/search/visual",
13894
+ "streaming": "no",
13895
+ "pagination": false,
13896
+ "pathParams": [
13897
+ {
13898
+ "name": "library_id",
13899
+ "sdkName": "library_id",
13900
+ "description": "Library ID returned by creation."
13901
+ }
13902
+ ],
13903
+ "query": [],
13904
+ "body": {
13905
+ "required": true,
13906
+ "fields": [
13907
+ {
13908
+ "name": "asset_id",
13909
+ "type": "string",
13910
+ "required": false,
13911
+ "description": "Asset identifier returned by upload or asset listing; distinct from public_id and content hashes."
13912
+ },
13913
+ {
13914
+ "name": "image",
13915
+ "type": "object",
13916
+ "required": false,
13917
+ "description": "Inline image used as the visual query; mutually exclusive with asset_id."
13918
+ },
13919
+ {
13920
+ "name": "top_k",
13921
+ "type": "integer",
13922
+ "required": false,
13923
+ "description": "Maximum visual-search hits, from 1 to 50; defaults to 20."
13924
+ },
13925
+ {
13926
+ "name": "filter",
13927
+ "type": "string",
13928
+ "required": false,
13929
+ "description": "Expression filter restricting eligible result assets."
13930
+ }
13931
+ ]
13932
+ }
13933
+ },
13934
+ {
13935
+ "resource": "media.libraries.understandings",
13936
+ "method": "list",
13937
+ "summary": "List understanding results across a library",
13938
+ "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.",
13939
+ "http": "GET",
13940
+ "path": "/media/v1/libraries/{library_id}/understandings",
13941
+ "streaming": "no",
13942
+ "pagination": true,
13943
+ "pathParams": [
13944
+ {
13945
+ "name": "library_id",
13946
+ "sdkName": "library_id",
13947
+ "description": "Library ID returned by creation."
13948
+ }
13949
+ ],
13950
+ "query": [
13951
+ {
13952
+ "name": "folder",
13953
+ "type": "string",
13954
+ "required": false,
13955
+ "description": "Folder path including all descendants; omitted or empty selects the entire library."
13956
+ },
13957
+ {
13958
+ "name": "kinds",
13959
+ "type": "string",
13960
+ "required": false,
13961
+ "description": "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind."
13962
+ },
13963
+ {
13964
+ "name": "cursor",
13965
+ "type": "string",
13966
+ "required": false,
13967
+ "description": "Cursor from the previous next_cursor."
13968
+ },
13969
+ {
13970
+ "name": "limit",
13971
+ "type": "integer",
13972
+ "required": false,
13973
+ "description": "Maximum entries in this page, from 1 through 100; defaults to 100."
13974
+ }
13975
+ ]
13976
+ },
13977
+ {
13978
+ "resource": "media.libraries.understandings",
13979
+ "method": "retrieveFailureSummary",
13980
+ "summary": "Summarize understanding failures",
13981
+ "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.",
13982
+ "http": "GET",
13983
+ "path": "/media/v1/libraries/{library_id}/understandings/failure_summary",
13984
+ "streaming": "no",
13985
+ "pagination": false,
13986
+ "pathParams": [
13987
+ {
13988
+ "name": "library_id",
13989
+ "sdkName": "library_id",
13990
+ "description": "Library ID returned by creation."
13991
+ }
13992
+ ],
13993
+ "query": []
13994
+ },
13995
+ {
13996
+ "resource": "meta.docs",
13997
+ "method": "search",
13998
+ "summary": "Search platform documentation",
13999
+ "description": "Find guides and references by keyword before reading them with praxis.meta.docs.retrieve. Public; no API key required. Matches documentation titles, headings and page text without case sensitivity; all query words must occur. q is required; limit defaults to 20 and accepts 1–50. lang defaults to zh or use en for English. Returns paths, page titles, canonical URLs and short matching snippets; no matches returns an empty array.",
14000
+ "http": "GET",
14001
+ "path": "/meta/v1/docs/search",
14002
+ "streaming": "no",
14003
+ "pagination": false,
14004
+ "pathParams": [],
14005
+ "query": [
14006
+ {
14007
+ "name": "q",
14008
+ "type": "string",
14009
+ "required": true,
14010
+ "description": "Keywords describing the syntax or guide needed, for example export or workflow."
14011
+ },
14012
+ {
14013
+ "name": "limit",
14014
+ "type": "integer",
14015
+ "required": false,
14016
+ "description": "Maximum number of matching pages returned; integer 1–50, default 20."
14017
+ },
14018
+ {
14019
+ "name": "lang",
14020
+ "type": "string",
14021
+ "enum": [
14022
+ "zh",
14023
+ "en"
14024
+ ],
14025
+ "required": false,
14026
+ "description": "Documentation language: zh for Chinese (default), en for English."
14027
+ }
14028
+ ]
13620
14029
  },
13621
14030
  {
13622
14031
  "resource": "meta.docs",
@@ -13866,25 +14275,25 @@ export const operations = [
13866
14275
  "name": "model",
13867
14276
  "type": "string",
13868
14277
  "required": true,
13869
- "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."
14278
+ "description": "Model catalog identifier declaring openai.audio.transcriptions; use it unchanged, including any creator prefix."
13870
14279
  },
13871
14280
  {
13872
14281
  "name": "file",
13873
14282
  "type": "string",
13874
14283
  "required": true,
13875
- "description": "Audio file to transcribe, uploaded as multipart/form-data. Router support (supported): Verified to take effect."
14284
+ "description": "Audio bytes uploaded as a multipart file; supported formats and input limits depend on the selected model."
13876
14285
  },
13877
14286
  {
13878
14287
  "name": "language",
13879
14288
  "type": "string",
13880
14289
  "required": false,
13881
- "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."
14290
+ "description": "Source language code when known; omit to let the model detect the language."
13882
14291
  },
13883
14292
  {
13884
14293
  "name": "prompt",
13885
14294
  "type": "string",
13886
14295
  "required": false,
13887
- "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."
14296
+ "description": "Optional vocabulary or contextual guidance for recognizing the audio; support depends on the selected model."
13888
14297
  },
13889
14298
  {
13890
14299
  "name": "response_format",
@@ -13892,20 +14301,22 @@ export const operations = [
13892
14301
  "enum": [
13893
14302
  "json",
13894
14303
  "text",
13895
- "verbose_json"
14304
+ "verbose_json",
14305
+ "diarized_json"
13896
14306
  ],
13897
14307
  "required": false,
13898
- "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."
14308
+ "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."
13899
14309
  },
13900
14310
  {
13901
14311
  "name": "timestamp_granularities[]",
13902
14312
  "type": "array",
13903
14313
  "itemType": "string",
13904
14314
  "enum": [
14315
+ "word",
13905
14316
  "segment"
13906
14317
  ],
13907
14318
  "required": false,
13908
- "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."
14319
+ "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."
13909
14320
  },
13910
14321
  {
13911
14322
  "name": "temperature",
@@ -15438,421 +15849,954 @@ export const operations = [
15438
15849
  "description": "How to handle input that exceeds the context window."
15439
15850
  },
15440
15851
  {
15441
- "name": "user",
15852
+ "name": "user",
15853
+ "type": "string",
15854
+ "required": false,
15855
+ "description": "A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters."
15856
+ },
15857
+ {
15858
+ "name": "conversation",
15859
+ "type": "object",
15860
+ "required": false,
15861
+ "description": "The conversation this response belongs to (a conversation id string, or a `{id}` object). Before the request reaches the upstream provider, we prepend that conversation's existing items to this request's input; after the response completes, this turn's input and output items are appended back to the conversation. Only the conversation's owner may reference it — otherwise 404 object_not_found; cannot be used together with previous_response_id — sending both returns 400."
15862
+ },
15863
+ {
15864
+ "name": "context_management",
15865
+ "type": "array",
15866
+ "itemType": "object",
15867
+ "required": false,
15868
+ "description": "Context management configuration for this request (e.g. automatic compaction once a token threshold is exceeded)."
15869
+ },
15870
+ {
15871
+ "name": "moderation",
15872
+ "type": "object",
15873
+ "required": false,
15874
+ "description": "Configuration for running moderation on the input and output of this response."
15875
+ },
15876
+ {
15877
+ "name": "prompt_cache_retention",
15878
+ "type": "string",
15879
+ "required": false,
15880
+ "description": "The retention policy for the prompt cache. Set to 24h to keep cached prefixes active for up to 24 hours."
15881
+ },
15882
+ {
15883
+ "name": "stream_options",
15884
+ "type": "object",
15885
+ "required": false,
15886
+ "description": "Options for streaming responses. Only set this when stream=true (e.g. whether to include usage statistics at the end of the stream)."
15887
+ },
15888
+ {
15889
+ "name": "access_programs",
15890
+ "type": "object",
15891
+ "required": false,
15892
+ "description": "Recognized official field; access programs are not implemented and return 400 explicitly stating that the parameter is not supported."
15893
+ }
15894
+ ]
15895
+ }
15896
+ },
15897
+ {
15898
+ "resource": "model.responses",
15899
+ "method": "compact",
15900
+ "summary": "Compact Response",
15901
+ "description": "Request context compaction for a response. Unlike OpenAI, this operation is unavailable and returns 501; do not use it to prepare a subsequent inference call.",
15902
+ "http": "POST",
15903
+ "path": "/model/v1/responses/compact",
15904
+ "streaming": "no",
15905
+ "pagination": false,
15906
+ "pathParams": [],
15907
+ "query": [],
15908
+ "body": {
15909
+ "required": true,
15910
+ "fields": []
15911
+ }
15912
+ },
15913
+ {
15914
+ "resource": "model.responses.inputTokens",
15915
+ "method": "create",
15916
+ "summary": "Count Response Input Tokens",
15917
+ "description": "Request an input-token count for Responses input. Unlike OpenAI, this operation is unavailable and returns 501; use the documented Messages token-count operation only when its input shape and estimation limits fit your task.",
15918
+ "http": "POST",
15919
+ "path": "/model/v1/responses/input_tokens",
15920
+ "streaming": "no",
15921
+ "pagination": false,
15922
+ "pathParams": [],
15923
+ "query": [],
15924
+ "body": {
15925
+ "required": true,
15926
+ "fields": []
15927
+ }
15928
+ },
15929
+ {
15930
+ "resource": "model.responses",
15931
+ "method": "delete",
15932
+ "summary": "Delete Response",
15933
+ "description": "Delete a stored response by its id when you no longer need to retrieve it. The response will no longer be available for later retrieval.",
15934
+ "http": "DELETE",
15935
+ "path": "/model/v1/responses/{response_id}",
15936
+ "streaming": "no",
15937
+ "pagination": false,
15938
+ "pathParams": [
15939
+ {
15940
+ "name": "response_id",
15941
+ "sdkName": "response_id",
15942
+ "description": "Id of the stored response, the `id` returned by createResponse (it looks like resp_...). An unknown id, a response created with store false, an expired response and another tenant's response all answer 404."
15943
+ }
15944
+ ],
15945
+ "query": []
15946
+ },
15947
+ {
15948
+ "resource": "model.responses",
15949
+ "method": "retrieve",
15950
+ "summary": "Retrieve Response",
15951
+ "description": "Read a stored response by its id from creation. A response created with store=false, an expired response, an unknown id or another account's response returns 404.",
15952
+ "http": "GET",
15953
+ "path": "/model/v1/responses/{response_id}",
15954
+ "streaming": "no",
15955
+ "pagination": false,
15956
+ "pathParams": [
15957
+ {
15958
+ "name": "response_id",
15959
+ "sdkName": "response_id",
15960
+ "description": "Id of the stored response, the `id` returned by createResponse (it looks like resp_...). An unknown id, a response created with store false, an expired response and another tenant's response all answer 404."
15961
+ }
15962
+ ],
15963
+ "query": []
15964
+ },
15965
+ {
15966
+ "resource": "model.responses",
15967
+ "method": "cancel",
15968
+ "summary": "Cancel Response",
15969
+ "description": "Cancel an in-progress background response using its id from creation. Unlike OpenAI, cancellation cannot guarantee that upstream compute stops; usage is settled for the output received. Repeating cancellation returns the terminal response; a synchronous response can return 400 native_responses_operation_unsupported or 404 if absent.",
15970
+ "http": "POST",
15971
+ "path": "/model/v1/responses/{response_id}/cancel",
15972
+ "streaming": "no",
15973
+ "pagination": false,
15974
+ "pathParams": [
15975
+ {
15976
+ "name": "response_id",
15977
+ "sdkName": "response_id",
15978
+ "description": "Id of the stored response, the `id` returned by createResponse (it looks like resp_...). An unknown id, a response created with store false, an expired response and another tenant's response all answer 404."
15979
+ }
15980
+ ],
15981
+ "query": []
15982
+ },
15983
+ {
15984
+ "resource": "model.responses.inputItems",
15985
+ "method": "list",
15986
+ "summary": "List Response Input Items",
15987
+ "description": "Read the input items of a stored response using its id from creation. Use the returned items to inspect the input that produced that response.",
15988
+ "http": "GET",
15989
+ "path": "/model/v1/responses/{response_id}/input_items",
15990
+ "streaming": "no",
15991
+ "pagination": false,
15992
+ "pathParams": [
15993
+ {
15994
+ "name": "response_id",
15995
+ "sdkName": "response_id",
15996
+ "description": "Id of the stored response, the `id` returned by createResponse (it looks like resp_...). An unknown id, a response created with store false, an expired response and another tenant's response all answer 404."
15997
+ }
15998
+ ],
15999
+ "query": []
16000
+ },
16001
+ {
16002
+ "resource": "model.systemone",
16003
+ "method": "create",
16004
+ "summary": "Ask structured decision questions",
16005
+ "description": "Ask typed questions about a state and get calibrated probabilities instead of generated text. Same request and response as TypeSafe System One. Use model ids from model.models.list declaring typesafe.systemone. Send one or more noul, choice or score questions; answers use the same question ids. Input tokens are charged at the catalog input price; output tokens are free. usage.cost and X-Praxis-Cost-Usd expose the same customer charge in USD. box questions and assets are unsupported and return 400: images are not supported. Unknown top-level fields pass unchanged to the native upstream.",
16006
+ "http": "POST",
16007
+ "path": "/model/v1/systemone",
16008
+ "streaming": "no",
16009
+ "pagination": false,
16010
+ "pathParams": [],
16011
+ "query": [],
16012
+ "body": {
16013
+ "required": true,
16014
+ "fields": [
16015
+ {
16016
+ "name": "model",
16017
+ "type": "string",
16018
+ "required": true,
16019
+ "description": "Published model id from model.models.list with supported_apis containing typesafe.systemone; returned unchanged in the response."
16020
+ },
16021
+ {
16022
+ "name": "state",
16023
+ "type": "object",
16024
+ "required": true,
16025
+ "description": "Shared content evaluated by every question, supplied as text, a JSON object or an array."
16026
+ },
16027
+ {
16028
+ "name": "questions",
16029
+ "type": "object",
16030
+ "required": true,
16031
+ "description": "Non-empty map of caller-chosen question ids to typed questions; answers preserve these ids. noul evaluates yes/no, choice selects a named option, score rates ordered levels. box is unsupported."
16032
+ },
16033
+ {
16034
+ "name": "assets",
16035
+ "type": "object",
16036
+ "required": false,
16037
+ "description": "Unsupported image assets. Supplying this field, including null or an empty collection, returns 400: images are not supported."
16038
+ }
16039
+ ]
16040
+ }
16041
+ },
16042
+ {
16043
+ "resource": "model.videos",
16044
+ "method": "list",
16045
+ "summary": "List videos",
16046
+ "description": "OpenAI video API with OpenRouter request and response extensions.",
16047
+ "http": "GET",
16048
+ "path": "/model/v1/videos",
16049
+ "streaming": "no",
16050
+ "pagination": false,
16051
+ "pathParams": [],
16052
+ "query": [
16053
+ {
16054
+ "name": "after",
16055
+ "type": "string",
16056
+ "required": false,
16057
+ "description": "Cursor: the id of the video job after which the page starts, normally the `last_id` of the previous page. It must refer to an existing job of yours, otherwise the call fails."
16058
+ },
16059
+ {
16060
+ "name": "limit",
16061
+ "type": "integer",
16062
+ "required": false,
16063
+ "description": "Maximum number of jobs per page, from 1 to 100; defaults to 20."
16064
+ },
16065
+ {
16066
+ "name": "order",
16067
+ "type": "string",
16068
+ "enum": [
16069
+ "asc",
16070
+ "desc"
16071
+ ],
16072
+ "required": false,
16073
+ "description": "Sort order by creation time: desc (default) lists the newest job first, asc the oldest first."
16074
+ }
16075
+ ]
16076
+ },
16077
+ {
16078
+ "resource": "model.videos",
16079
+ "method": "create",
16080
+ "summary": "Create video",
16081
+ "description": "OpenAI video API with OpenRouter request and response extensions.",
16082
+ "http": "POST",
16083
+ "path": "/model/v1/videos",
16084
+ "streaming": "no",
16085
+ "pagination": false,
16086
+ "multipart": true,
16087
+ "pathParams": [],
16088
+ "query": [],
16089
+ "body": {
16090
+ "required": true,
16091
+ "fields": [
16092
+ {
16093
+ "name": "model",
16094
+ "type": "string",
16095
+ "required": false,
16096
+ "description": "Video model id, for example `wan2.7-t2v`; list candidates with listModels?type=video. Router support (partial): Select a registered video model explicitly, for example wan2.7-t2v (size=1280x720, seconds=4). Capability preflight errors are reported before creation."
16097
+ },
16098
+ {
16099
+ "name": "prompt",
16100
+ "type": "string",
16101
+ "required": true,
16102
+ "description": "Text description of the video, at least 1 character. Router support (supported): Controls video content; missing or empty values return 400."
16103
+ },
16104
+ {
16105
+ "name": "seconds",
16106
+ "type": "object",
16107
+ "required": false,
16108
+ "description": "Takes precedence over duration."
16109
+ },
16110
+ {
16111
+ "name": "duration",
16112
+ "type": "integer",
16113
+ "required": false,
16114
+ "description": "Length of the video in whole seconds. `seconds` takes precedence when both are given."
16115
+ },
16116
+ {
16117
+ "name": "size",
16118
+ "type": "string",
16119
+ "required": false,
16120
+ "description": "Output resolution as `WIDTHxHEIGHT`, for example `1280x720`. Router support (partial): Subject to model capability preflight. Earlier wan2.7-t2v samples always produced 1280x720; accepted sizes are not guaranteed pixel-for-pixel."
16121
+ },
16122
+ {
16123
+ "name": "input_reference",
16124
+ "type": "object",
16125
+ "required": false,
16126
+ "description": "Reference image for image-to-video: a URL or base64 data URL, an object with `image_url`, or an uploaded image file (multipart, at most 20 MiB)."
16127
+ },
16128
+ {
16129
+ "name": "input_references",
16130
+ "type": "array",
16131
+ "itemType": "object",
16132
+ "required": false,
16133
+ "description": "Several reference images; each entry is a URL or base64 data URL, or an object with `image_url`."
16134
+ },
16135
+ {
16136
+ "name": "frame_images",
16137
+ "type": "array",
16138
+ "itemType": "object",
16139
+ "required": false,
16140
+ "description": "Images that pin the first and last frame; at most 2 entries."
16141
+ },
16142
+ {
16143
+ "name": "resolution",
16144
+ "type": "string",
16145
+ "required": false,
16146
+ "description": "Output resolution label such as `720p`, for models that take a label instead of `size`."
16147
+ },
16148
+ {
16149
+ "name": "aspect_ratio",
16150
+ "type": "string",
16151
+ "required": false,
16152
+ "description": "Aspect ratio of the video such as `16:9`."
16153
+ },
16154
+ {
16155
+ "name": "generate_audio",
16156
+ "type": "boolean",
16157
+ "required": false,
16158
+ "description": "Whether the video carries a generated audio track. Router support (supported): false produces no audio track on wan2.7-t2v; the default output includes audio."
16159
+ },
16160
+ {
16161
+ "name": "seed",
16162
+ "type": "integer",
16163
+ "required": false,
16164
+ "description": "Seed for reproducible generation, on models that support it."
16165
+ },
16166
+ {
16167
+ "name": "callback_url",
16168
+ "type": "string",
16169
+ "required": false,
16170
+ "description": "HTTP or HTTPS callback URL, forwarded to models that support completion callbacks."
16171
+ },
16172
+ {
16173
+ "name": "quality",
16174
+ "type": "string",
16175
+ "required": false,
16176
+ "description": "Provider-specific quality setting."
16177
+ }
16178
+ ]
16179
+ }
16180
+ },
16181
+ {
16182
+ "resource": "model.videos",
16183
+ "method": "delete",
16184
+ "summary": "Delete video",
16185
+ "description": "OpenAI video API with OpenRouter request and response extensions.",
16186
+ "http": "DELETE",
16187
+ "path": "/model/v1/videos/{video_id}",
16188
+ "streaming": "no",
16189
+ "pagination": false,
16190
+ "pathParams": [
16191
+ {
16192
+ "name": "video_id",
16193
+ "sdkName": "video_id",
16194
+ "description": "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400."
16195
+ }
16196
+ ],
16197
+ "query": []
16198
+ },
16199
+ {
16200
+ "resource": "model.videos",
16201
+ "method": "retrieve",
16202
+ "summary": "Retrieve video",
16203
+ "description": "OpenAI video API with OpenRouter request and response extensions.",
16204
+ "http": "GET",
16205
+ "path": "/model/v1/videos/{video_id}",
16206
+ "streaming": "no",
16207
+ "pagination": false,
16208
+ "pathParams": [
16209
+ {
16210
+ "name": "video_id",
16211
+ "sdkName": "video_id",
16212
+ "description": "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400."
16213
+ }
16214
+ ],
16215
+ "query": []
16216
+ },
16217
+ {
16218
+ "resource": "model.videos",
16219
+ "method": "retrieveContent",
16220
+ "summary": "Download video",
16221
+ "description": "OpenAI video API with OpenRouter request and response extensions.",
16222
+ "http": "GET",
16223
+ "path": "/model/v1/videos/{video_id}/content",
16224
+ "streaming": "no",
16225
+ "pagination": false,
16226
+ "pathParams": [
16227
+ {
16228
+ "name": "video_id",
16229
+ "sdkName": "video_id",
16230
+ "description": "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400."
16231
+ }
16232
+ ],
16233
+ "query": [
16234
+ {
16235
+ "name": "variant",
16236
+ "type": "string",
16237
+ "enum": [
16238
+ "video",
16239
+ "thumbnail",
16240
+ "spritesheet"
16241
+ ],
16242
+ "required": false,
16243
+ "description": "Spritesheet is not available in this release (400)."
16244
+ },
16245
+ {
16246
+ "name": "index",
16247
+ "type": "integer",
16248
+ "required": false,
16249
+ "description": "Output index; this release produces index 0. variant takes precedence."
16250
+ }
16251
+ ]
16252
+ },
16253
+ {
16254
+ "resource": "model.videos",
16255
+ "method": "remix",
16256
+ "summary": "Remix video",
16257
+ "description": "Not supported in this release; always returns 400.",
16258
+ "http": "POST",
16259
+ "path": "/model/v1/videos/{video_id}/remix",
16260
+ "streaming": "no",
16261
+ "pagination": false,
16262
+ "pathParams": [
16263
+ {
16264
+ "name": "video_id",
16265
+ "sdkName": "video_id",
16266
+ "description": "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400."
16267
+ }
16268
+ ],
16269
+ "query": []
16270
+ },
16271
+ {
16272
+ "resource": "ontology.changesets",
16273
+ "method": "create",
16274
+ "summary": "Apply changeset",
16275
+ "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.",
16276
+ "http": "POST",
16277
+ "path": "/ontology/v1/changesets",
16278
+ "streaming": "no",
16279
+ "pagination": false,
16280
+ "pathParams": [],
16281
+ "query": [],
16282
+ "body": {
16283
+ "required": true,
16284
+ "fields": [
16285
+ {
16286
+ "name": "at",
15442
16287
  "type": "string",
15443
- "required": false,
15444
- "description": "A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters."
16288
+ "required": true,
16289
+ "description": "World time the batch describes, in ISO 8601 UTC; operations without their own time are dated by it."
15445
16290
  },
15446
16291
  {
15447
- "name": "conversation",
15448
- "type": "object",
16292
+ "name": "scope",
16293
+ "type": "string",
15449
16294
  "required": false,
15450
- "description": "The conversation this response belongs to (a conversation id string, or a `{id}` object). Before the request reaches the upstream provider, we prepend that conversation's existing items to this request's input; after the response completes, this turn's input and output items are appended back to the conversation. Only the conversation's owner may reference it — otherwise 404 object_not_found; cannot be used together with previous_response_id — sending both returns 400."
16295
+ "description": "Scope the batch came from, normally the session id it was observed in; it is stored with the operations for later reading."
15451
16296
  },
15452
16297
  {
15453
- "name": "context_management",
16298
+ "name": "ops",
15454
16299
  "type": "array",
15455
16300
  "itemType": "object",
15456
- "required": false,
15457
- "description": "Context management configuration for this request (e.g. automatic compaction once a token threshold is exceeded)."
15458
- },
15459
- {
15460
- "name": "moderation",
15461
- "type": "object",
15462
- "required": false,
15463
- "description": "Configuration for running moderation on the input and output of this response."
15464
- },
15465
- {
15466
- "name": "prompt_cache_retention",
15467
- "type": "string",
15468
- "required": false,
15469
- "description": "The retention policy for the prompt cache. Set to 24h to keep cached prefixes active for up to 24 hours."
15470
- },
15471
- {
15472
- "name": "stream_options",
15473
- "type": "object",
15474
- "required": false,
15475
- "description": "Options for streaming responses. Only set this when stream=true (e.g. whether to include usage statistics at the end of the stream)."
15476
- },
15477
- {
15478
- "name": "access_programs",
15479
- "type": "object",
15480
- "required": false,
15481
- "description": "Recognized official field; access programs are not implemented and return 400 explicitly stating that the parameter is not supported."
16301
+ "required": true,
16302
+ "description": "At most 500 operations, applied in order; each names its kind in op and the fields that kind requires."
15482
16303
  }
15483
16304
  ]
15484
16305
  }
15485
16306
  },
15486
16307
  {
15487
- "resource": "model.responses",
15488
- "method": "compact",
15489
- "summary": "Compact Response",
15490
- "description": "Request context compaction for a response. Unlike OpenAI, this operation is unavailable and returns 501; do not use it to prepare a subsequent inference call.",
15491
- "http": "POST",
15492
- "path": "/model/v1/responses/compact",
16308
+ "resource": "ontology.nodes",
16309
+ "method": "list",
16310
+ "summary": "List nodes",
16311
+ "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.",
16312
+ "http": "GET",
16313
+ "path": "/ontology/v1/nodes",
15493
16314
  "streaming": "no",
15494
- "pagination": false,
16315
+ "pagination": true,
15495
16316
  "pathParams": [],
15496
- "query": [],
15497
- "body": {
15498
- "required": true,
15499
- "fields": []
15500
- }
16317
+ "query": [
16318
+ {
16319
+ "name": "type",
16320
+ "type": "array",
16321
+ "itemType": "string",
16322
+ "required": false,
16323
+ "description": "Repeat to filter to any of several registered node type names, for example type=file&type=ticket; omit to list every type."
16324
+ },
16325
+ {
16326
+ "name": "q",
16327
+ "type": "string",
16328
+ "required": false,
16329
+ "description": "Free text matched against node names, aliases and descriptions; omit to list without a text filter."
16330
+ },
16331
+ {
16332
+ "name": "owner",
16333
+ "type": "string",
16334
+ "required": false,
16335
+ "description": "Filter to nodes owned by this member id, or omit to list nodes of every owner; organization-wide nodes carry no owner."
16336
+ },
16337
+ {
16338
+ "name": "as_of",
16339
+ "type": "string",
16340
+ "required": false,
16341
+ "description": "ISO 8601 timestamp; return the graph as it was then, so a node recorded later is absent. Omit to read current state."
16342
+ },
16343
+ {
16344
+ "name": "limit",
16345
+ "type": "integer",
16346
+ "required": false,
16347
+ "description": "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100."
16348
+ },
16349
+ {
16350
+ "name": "cursor",
16351
+ "type": "string",
16352
+ "required": false,
16353
+ "description": "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
16354
+ }
16355
+ ]
15501
16356
  },
15502
16357
  {
15503
- "resource": "model.responses.inputTokens",
16358
+ "resource": "ontology.nodes",
15504
16359
  "method": "create",
15505
- "summary": "Count Response Input Tokens",
15506
- "description": "Request an input-token count for Responses input. Unlike OpenAI, this operation is unavailable and returns 501; use the documented Messages token-count operation only when its input shape and estimation limits fit your task.",
16360
+ "summary": "Create node",
16361
+ "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.",
15507
16362
  "http": "POST",
15508
- "path": "/model/v1/responses/input_tokens",
16363
+ "path": "/ontology/v1/nodes",
15509
16364
  "streaming": "no",
15510
16365
  "pagination": false,
15511
16366
  "pathParams": [],
15512
16367
  "query": [],
15513
16368
  "body": {
15514
16369
  "required": true,
15515
- "fields": []
16370
+ "fields": [
16371
+ {
16372
+ "name": "type",
16373
+ "type": "string",
16374
+ "required": true,
16375
+ "description": "Registered node type name from types.list; an unregistered name is refused and nothing is written."
16376
+ },
16377
+ {
16378
+ "name": "ref",
16379
+ "type": "string",
16380
+ "required": false,
16381
+ "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."
16382
+ },
16383
+ {
16384
+ "name": "name",
16385
+ "type": "string",
16386
+ "required": true,
16387
+ "description": "Display name of the entity, at most 200 characters."
16388
+ },
16389
+ {
16390
+ "name": "aliases",
16391
+ "type": "array",
16392
+ "itemType": "string",
16393
+ "required": false,
16394
+ "description": "Other names this entity is known by; they are matched by search alongside the name."
16395
+ },
16396
+ {
16397
+ "name": "description",
16398
+ "type": "string",
16399
+ "required": false,
16400
+ "description": "Profile of the entity, at most 500 characters; omit or null for none."
16401
+ },
16402
+ {
16403
+ "name": "owner",
16404
+ "type": "string",
16405
+ "required": false,
16406
+ "description": "Member id whose content this is, restricting it to that member; omit or null to make it readable organization-wide."
16407
+ }
16408
+ ]
15516
16409
  }
15517
16410
  },
15518
16411
  {
15519
- "resource": "model.responses",
15520
- "method": "delete",
15521
- "summary": "Delete Response",
15522
- "description": "Delete a stored response by its id when you no longer need to retrieve it. The response will no longer be available for later retrieval.",
15523
- "http": "DELETE",
15524
- "path": "/model/v1/responses/{response_id}",
15525
- "streaming": "no",
15526
- "pagination": false,
15527
- "pathParams": [
15528
- {
15529
- "name": "response_id",
15530
- "sdkName": "response_id",
15531
- "description": "Id of the stored response, the `id` returned by createResponse (it looks like resp_...). An unknown id, a response created with store false, an expired response and another tenant's response all answer 404."
15532
- }
15533
- ],
15534
- "query": []
15535
- },
15536
- {
15537
- "resource": "model.responses",
16412
+ "resource": "ontology.nodes",
15538
16413
  "method": "retrieve",
15539
- "summary": "Retrieve Response",
15540
- "description": "Read a stored response by its id from creation. A response created with store=false, an expired response, an unknown id or another account's response returns 404.",
16414
+ "summary": "Retrieve node",
16415
+ "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.",
15541
16416
  "http": "GET",
15542
- "path": "/model/v1/responses/{response_id}",
16417
+ "path": "/ontology/v1/nodes/{node_id}",
15543
16418
  "streaming": "no",
15544
16419
  "pagination": false,
15545
16420
  "pathParams": [
15546
16421
  {
15547
- "name": "response_id",
15548
- "sdkName": "response_id",
15549
- "description": "Id of the stored response, the `id` returned by createResponse (it looks like resp_...). An unknown id, a response created with store false, an expired response and another tenant's response all answer 404."
16422
+ "name": "node_id",
16423
+ "sdkName": "node_id",
16424
+ "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."
15550
16425
  }
15551
16426
  ],
15552
- "query": []
15553
- },
15554
- {
15555
- "resource": "model.responses",
15556
- "method": "cancel",
15557
- "summary": "Cancel Response",
15558
- "description": "Cancel an in-progress background response using its id from creation. Unlike OpenAI, cancellation cannot guarantee that upstream compute stops; usage is settled for the output received. Repeating cancellation returns the terminal response; a synchronous response can return 400 native_responses_operation_unsupported or 404 if absent.",
15559
- "http": "POST",
15560
- "path": "/model/v1/responses/{response_id}/cancel",
15561
- "streaming": "no",
15562
- "pagination": false,
15563
- "pathParams": [
16427
+ "query": [
15564
16428
  {
15565
- "name": "response_id",
15566
- "sdkName": "response_id",
15567
- "description": "Id of the stored response, the `id` returned by createResponse (it looks like resp_...). An unknown id, a response created with store false, an expired response and another tenant's response all answer 404."
16429
+ "name": "expand",
16430
+ "type": "string",
16431
+ "enum": [
16432
+ "relations"
16433
+ ],
16434
+ "required": false,
16435
+ "description": "Set to relations to include the node's incoming and outgoing relations in the same response; omit for the node alone."
16436
+ },
16437
+ {
16438
+ "name": "as_of",
16439
+ "type": "string",
16440
+ "required": false,
16441
+ "description": "ISO 8601 timestamp; read the node and its relations as they were then, including relations invalidated since. Omit to read current state."
15568
16442
  }
15569
- ],
15570
- "query": []
16443
+ ]
15571
16444
  },
15572
16445
  {
15573
- "resource": "model.responses.inputItems",
15574
- "method": "list",
15575
- "summary": "List Response Input Items",
15576
- "description": "Read the input items of a stored response using its id from creation. Use the returned items to inspect the input that produced that response.",
15577
- "http": "GET",
15578
- "path": "/model/v1/responses/{response_id}/input_items",
16446
+ "resource": "ontology.nodes",
16447
+ "method": "update",
16448
+ "summary": "Update node",
16449
+ "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.",
16450
+ "http": "PATCH",
16451
+ "path": "/ontology/v1/nodes/{node_id}",
15579
16452
  "streaming": "no",
15580
16453
  "pagination": false,
15581
16454
  "pathParams": [
15582
16455
  {
15583
- "name": "response_id",
15584
- "sdkName": "response_id",
15585
- "description": "Id of the stored response, the `id` returned by createResponse (it looks like resp_...). An unknown id, a response created with store false, an expired response and another tenant's response all answer 404."
16456
+ "name": "node_id",
16457
+ "sdkName": "node_id",
16458
+ "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."
15586
16459
  }
15587
16460
  ],
15588
- "query": []
16461
+ "query": [],
16462
+ "body": {
16463
+ "required": true,
16464
+ "fields": [
16465
+ {
16466
+ "name": "name",
16467
+ "type": "string",
16468
+ "required": false,
16469
+ "description": "New display name, at most 200 characters; omit to keep the current name."
16470
+ },
16471
+ {
16472
+ "name": "aliases",
16473
+ "type": "array",
16474
+ "itemType": "string",
16475
+ "required": false,
16476
+ "description": "Replacement alias list; an empty array clears the aliases and omitting the field keeps them."
16477
+ },
16478
+ {
16479
+ "name": "description",
16480
+ "type": "string",
16481
+ "required": false,
16482
+ "description": "Replacement profile, at most 500 characters; an explicit null clears it and omitting the field keeps it."
16483
+ }
16484
+ ]
16485
+ }
15589
16486
  },
15590
16487
  {
15591
- "resource": "model.systemone",
16488
+ "resource": "ontology.nodes.merge",
15592
16489
  "method": "create",
15593
- "summary": "Ask structured decision questions",
15594
- "description": "Ask typed questions about a state and get calibrated probabilities instead of generated text. Same request and response as TypeSafe System One. Use model ids from model.models.list declaring typesafe.systemone. Send one or more noul, choice or score questions; answers use the same question ids. Input tokens are charged at the catalog input price; output tokens are free. usage.cost and X-Praxis-Cost-Usd expose the same customer charge in USD. box questions and assets are unsupported and return 400: images are not supported. Unknown top-level fields pass unchanged to the native upstream.",
16490
+ "summary": "Merge node",
16491
+ "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.",
15595
16492
  "http": "POST",
15596
- "path": "/model/v1/systemone",
16493
+ "path": "/ontology/v1/nodes/{node_id}/merge",
15597
16494
  "streaming": "no",
15598
16495
  "pagination": false,
15599
- "pathParams": [],
16496
+ "pathParams": [
16497
+ {
16498
+ "name": "node_id",
16499
+ "sdkName": "node_id",
16500
+ "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."
16501
+ }
16502
+ ],
15600
16503
  "query": [],
15601
16504
  "body": {
15602
16505
  "required": true,
15603
16506
  "fields": [
15604
16507
  {
15605
- "name": "model",
16508
+ "name": "into",
15606
16509
  "type": "string",
15607
16510
  "required": true,
15608
- "description": "Published model id from model.models.list with supported_apis containing typesafe.systemone; returned unchanged in the response."
15609
- },
15610
- {
15611
- "name": "state",
15612
- "type": "object",
15613
- "required": true,
15614
- "description": "Shared content evaluated by every question, supplied as text, a JSON object or an array."
15615
- },
15616
- {
15617
- "name": "questions",
15618
- "type": "object",
15619
- "required": true,
15620
- "description": "Non-empty map of caller-chosen question ids to typed questions; answers preserve these ids. noul evaluates yes/no, choice selects a named option, score rates ordered levels. box is unsupported."
15621
- },
15622
- {
15623
- "name": "assets",
15624
- "type": "object",
15625
- "required": false,
15626
- "description": "Unsupported image assets. Supplying this field, including null or an empty collection, returns 400: images are not supported."
16511
+ "description": "Node id that should survive, from nodes.list or search; the merged node's relations and aliases move to it."
15627
16512
  }
15628
16513
  ]
15629
16514
  }
15630
16515
  },
15631
16516
  {
15632
- "resource": "model.videos",
16517
+ "resource": "ontology.relations",
15633
16518
  "method": "list",
15634
- "summary": "List videos",
15635
- "description": "OpenAI video API with OpenRouter request and response extensions.",
16519
+ "summary": "List relations",
16520
+ "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.",
15636
16521
  "http": "GET",
15637
- "path": "/model/v1/videos",
16522
+ "path": "/ontology/v1/relations",
15638
16523
  "streaming": "no",
15639
- "pagination": false,
16524
+ "pagination": true,
15640
16525
  "pathParams": [],
15641
16526
  "query": [
15642
16527
  {
15643
- "name": "after",
16528
+ "name": "node",
16529
+ "type": "string",
16530
+ "required": false,
16531
+ "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."
16532
+ },
16533
+ {
16534
+ "name": "type",
16535
+ "type": "array",
16536
+ "itemType": "string",
16537
+ "required": false,
16538
+ "description": "Repeat to filter to any of several registered relation type names, for example type=references&type=serves; omit to list every type."
16539
+ },
16540
+ {
16541
+ "name": "direction",
16542
+ "type": "string",
16543
+ "enum": [
16544
+ "out",
16545
+ "in",
16546
+ "both"
16547
+ ],
16548
+ "required": false,
16549
+ "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."
16550
+ },
16551
+ {
16552
+ "name": "as_of",
15644
16553
  "type": "string",
15645
16554
  "required": false,
15646
- "description": "Cursor: the id of the video job after which the page starts, normally the `last_id` of the previous page. It must refer to an existing job of yours, otherwise the call fails."
16555
+ "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."
16556
+ },
16557
+ {
16558
+ "name": "include_invalid",
16559
+ "type": "boolean",
16560
+ "required": false,
16561
+ "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."
15647
16562
  },
15648
16563
  {
15649
16564
  "name": "limit",
15650
16565
  "type": "integer",
15651
16566
  "required": false,
15652
- "description": "Maximum number of jobs per page, from 1 to 100; defaults to 20."
16567
+ "description": "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100."
15653
16568
  },
15654
16569
  {
15655
- "name": "order",
16570
+ "name": "cursor",
15656
16571
  "type": "string",
15657
- "enum": [
15658
- "asc",
15659
- "desc"
15660
- ],
15661
16572
  "required": false,
15662
- "description": "Sort order by creation time: desc (default) lists the newest job first, asc the oldest first."
16573
+ "description": "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
15663
16574
  }
15664
16575
  ]
15665
16576
  },
15666
16577
  {
15667
- "resource": "model.videos",
16578
+ "resource": "ontology.relations",
15668
16579
  "method": "create",
15669
- "summary": "Create video",
15670
- "description": "OpenAI video API with OpenRouter request and response extensions.",
16580
+ "summary": "Create relation",
16581
+ "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.",
15671
16582
  "http": "POST",
15672
- "path": "/model/v1/videos",
16583
+ "path": "/ontology/v1/relations",
15673
16584
  "streaming": "no",
15674
16585
  "pagination": false,
15675
- "multipart": true,
15676
16586
  "pathParams": [],
15677
16587
  "query": [],
15678
16588
  "body": {
15679
16589
  "required": true,
15680
16590
  "fields": [
15681
16591
  {
15682
- "name": "model",
16592
+ "name": "type",
15683
16593
  "type": "string",
15684
- "required": false,
15685
- "description": "Video model id, for example `wan2.7-t2v`; list candidates with listModels?type=video. Router support (partial): Select a registered video model explicitly, for example wan2.7-t2v (size=1280x720, seconds=4). Capability preflight errors are reported before creation."
16594
+ "required": true,
16595
+ "description": "Registered relation type name from types.list; it must admit both endpoints or the write is refused."
15686
16596
  },
15687
16597
  {
15688
- "name": "prompt",
16598
+ "name": "source",
15689
16599
  "type": "string",
15690
16600
  "required": true,
15691
- "description": "Text description of the video, at least 1 character. Router support (supported): Controls video content; missing or empty values return 400."
15692
- },
15693
- {
15694
- "name": "seconds",
15695
- "type": "object",
15696
- "required": false,
15697
- "description": "Takes precedence over duration."
16601
+ "description": "Node id the fact starts from, from nodes.list or nodes.create."
15698
16602
  },
15699
16603
  {
15700
- "name": "duration",
15701
- "type": "integer",
15702
- "required": false,
15703
- "description": "Length of the video in whole seconds. `seconds` takes precedence when both are given."
16604
+ "name": "target",
16605
+ "type": "string",
16606
+ "required": true,
16607
+ "description": "Node id the fact points at, from nodes.list or nodes.create."
15704
16608
  },
15705
16609
  {
15706
- "name": "size",
16610
+ "name": "fact",
15707
16611
  "type": "string",
15708
- "required": false,
15709
- "description": "Output resolution as `WIDTHxHEIGHT`, for example `1280x720`. Router support (partial): Subject to model capability preflight. Earlier wan2.7-t2v samples always produced 1280x720; accepted sizes are not guaranteed pixel-for-pixel."
16612
+ "required": true,
16613
+ "description": "The relationship in one sentence, at most 280 characters, written to read back on its own."
15710
16614
  },
15711
16615
  {
15712
- "name": "input_reference",
15713
- "type": "object",
16616
+ "name": "valid_at",
16617
+ "type": "string",
15714
16618
  "required": false,
15715
- "description": "Reference image for image-to-video: a URL or base64 data URL, an object with `image_url`, or an uploaded image file (multipart, at most 20 MiB)."
16619
+ "description": "World time the fact became true, when the mirrored record dates it; omit to leave it undated."
15716
16620
  },
15717
16621
  {
15718
- "name": "input_references",
15719
- "type": "array",
15720
- "itemType": "object",
16622
+ "name": "owner",
16623
+ "type": "string",
15721
16624
  "required": false,
15722
- "description": "Several reference images; each entry is a URL or base64 data URL, or an object with `image_url`."
15723
- },
16625
+ "description": "Member id whose content this fact is, restricting it to that member; omit or null for organization-wide."
16626
+ }
16627
+ ]
16628
+ }
16629
+ },
16630
+ {
16631
+ "resource": "ontology.relations",
16632
+ "method": "retrieve",
16633
+ "summary": "Retrieve relation",
16634
+ "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.",
16635
+ "http": "GET",
16636
+ "path": "/ontology/v1/relations/{relation_id}",
16637
+ "streaming": "no",
16638
+ "pagination": false,
16639
+ "pathParams": [
16640
+ {
16641
+ "name": "relation_id",
16642
+ "sdkName": "relation_id",
16643
+ "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."
16644
+ }
16645
+ ],
16646
+ "query": []
16647
+ },
16648
+ {
16649
+ "resource": "ontology.relations.invalidate",
16650
+ "method": "create",
16651
+ "summary": "Invalidate relation",
16652
+ "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.",
16653
+ "http": "POST",
16654
+ "path": "/ontology/v1/relations/{relation_id}/invalidate",
16655
+ "streaming": "no",
16656
+ "pagination": false,
16657
+ "pathParams": [
16658
+ {
16659
+ "name": "relation_id",
16660
+ "sdkName": "relation_id",
16661
+ "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."
16662
+ }
16663
+ ],
16664
+ "query": [],
16665
+ "body": {
16666
+ "required": true,
16667
+ "fields": [
15724
16668
  {
15725
- "name": "frame_images",
15726
- "type": "array",
15727
- "itemType": "object",
15728
- "required": false,
15729
- "description": "Images that pin the first and last frame; at most 2 entries."
16669
+ "name": "invalid_at",
16670
+ "type": "string",
16671
+ "required": true,
16672
+ "description": "World time the fact stopped being true, in ISO 8601 UTC; reads at an earlier as_of still return the relation."
15730
16673
  },
15731
16674
  {
15732
- "name": "resolution",
16675
+ "name": "superseded_by",
15733
16676
  "type": "string",
15734
16677
  "required": false,
15735
- "description": "Output resolution label such as `720p`, for models that take a label instead of `size`."
16678
+ "description": "Relation id that replaces this one, when a successor was recorded; omit or null when nothing replaced it."
15736
16679
  },
15737
16680
  {
15738
- "name": "aspect_ratio",
16681
+ "name": "reason",
15739
16682
  "type": "string",
15740
16683
  "required": false,
15741
- "description": "Aspect ratio of the video such as `16:9`."
15742
- },
16684
+ "description": "Why it stopped being true, for people reading the history later; not enforced and safe to omit."
16685
+ }
16686
+ ]
16687
+ }
16688
+ },
16689
+ {
16690
+ "resource": "ontology.search",
16691
+ "method": "create",
16692
+ "summary": "Search nodes",
16693
+ "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.",
16694
+ "http": "POST",
16695
+ "path": "/ontology/v1/search",
16696
+ "streaming": "no",
16697
+ "pagination": false,
16698
+ "pathParams": [],
16699
+ "query": [],
16700
+ "body": {
16701
+ "required": true,
16702
+ "fields": [
15743
16703
  {
15744
- "name": "generate_audio",
15745
- "type": "boolean",
15746
- "required": false,
15747
- "description": "Whether the video carries a generated audio track. Router support (supported): false produces no audio track on wan2.7-t2v; the default output includes audio."
16704
+ "name": "text",
16705
+ "type": "string",
16706
+ "required": true,
16707
+ "description": "Text to find nodes for, matched against names, aliases, descriptions and relation facts; an empty string is refused."
15748
16708
  },
15749
16709
  {
15750
- "name": "seed",
15751
- "type": "integer",
16710
+ "name": "types",
16711
+ "type": "array",
16712
+ "itemType": "string",
15752
16713
  "required": false,
15753
- "description": "Seed for reproducible generation, on models that support it."
16714
+ "description": "Registered node type names to search within; omit to search every type."
15754
16715
  },
15755
16716
  {
15756
- "name": "callback_url",
15757
- "type": "string",
16717
+ "name": "window",
16718
+ "type": "object",
15758
16719
  "required": false,
15759
- "description": "HTTP or HTTPS callback URL, forwarded to models that support completion callbacks."
16720
+ "description": "Restrict matches to facts recorded within a period; omit to search all time."
15760
16721
  },
15761
16722
  {
15762
- "name": "quality",
15763
- "type": "string",
16723
+ "name": "limit",
16724
+ "type": "integer",
15764
16725
  "required": false,
15765
- "description": "Provider-specific quality setting."
16726
+ "description": "Maximum candidate nodes to return, from 1 to 50; defaults to 20 when omitted."
15766
16727
  }
15767
16728
  ]
15768
16729
  }
15769
16730
  },
15770
16731
  {
15771
- "resource": "model.videos",
15772
- "method": "delete",
15773
- "summary": "Delete video",
15774
- "description": "OpenAI video API with OpenRouter request and response extensions.",
15775
- "http": "DELETE",
15776
- "path": "/model/v1/videos/{video_id}",
15777
- "streaming": "no",
15778
- "pagination": false,
15779
- "pathParams": [
15780
- {
15781
- "name": "video_id",
15782
- "sdkName": "video_id",
15783
- "description": "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400."
15784
- }
15785
- ],
15786
- "query": []
15787
- },
15788
- {
15789
- "resource": "model.videos",
15790
- "method": "retrieve",
15791
- "summary": "Retrieve video",
15792
- "description": "OpenAI video API with OpenRouter request and response extensions.",
16732
+ "resource": "ontology.types",
16733
+ "method": "list",
16734
+ "summary": "List types",
16735
+ "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.",
15793
16736
  "http": "GET",
15794
- "path": "/model/v1/videos/{video_id}",
16737
+ "path": "/ontology/v1/types",
15795
16738
  "streaming": "no",
15796
16739
  "pagination": false,
15797
- "pathParams": [
15798
- {
15799
- "name": "video_id",
15800
- "sdkName": "video_id",
15801
- "description": "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400."
15802
- }
15803
- ],
16740
+ "pathParams": [],
15804
16741
  "query": []
15805
16742
  },
15806
16743
  {
15807
- "resource": "model.videos",
15808
- "method": "retrieveContent",
15809
- "summary": "Download video",
15810
- "description": "OpenAI video API with OpenRouter request and response extensions.",
15811
- "http": "GET",
15812
- "path": "/model/v1/videos/{video_id}/content",
16744
+ "resource": "ontology.types",
16745
+ "method": "create",
16746
+ "summary": "Register type",
16747
+ "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.",
16748
+ "http": "POST",
16749
+ "path": "/ontology/v1/types",
15813
16750
  "streaming": "no",
15814
16751
  "pagination": false,
15815
- "pathParams": [
15816
- {
15817
- "name": "video_id",
15818
- "sdkName": "video_id",
15819
- "description": "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400."
15820
- }
15821
- ],
15822
- "query": [
15823
- {
15824
- "name": "variant",
15825
- "type": "string",
15826
- "enum": [
15827
- "video",
15828
- "thumbnail",
15829
- "spritesheet"
15830
- ],
15831
- "required": false,
15832
- "description": "Spritesheet is not available in this release (400)."
15833
- },
15834
- {
15835
- "name": "index",
15836
- "type": "integer",
15837
- "required": false,
15838
- "description": "Output index; this release produces index 0. variant takes precedence."
15839
- }
15840
- ]
16752
+ "pathParams": [],
16753
+ "query": [],
16754
+ "body": {
16755
+ "required": true,
16756
+ "fields": [
16757
+ {
16758
+ "name": "owner",
16759
+ "type": "string",
16760
+ "required": true,
16761
+ "description": "Service that registered these types, for example file or ticket; it is the registrant a later change to a type is checked against."
16762
+ },
16763
+ {
16764
+ "name": "version",
16765
+ "type": "integer",
16766
+ "required": true,
16767
+ "description": "Monotonic version of this owner's registration; a later registration must extend this one without removing or narrowing anything."
16768
+ },
16769
+ {
16770
+ "name": "nodes",
16771
+ "type": "array",
16772
+ "itemType": "object",
16773
+ "required": true,
16774
+ "description": "Node types this owner registers."
16775
+ },
16776
+ {
16777
+ "name": "edges",
16778
+ "type": "array",
16779
+ "itemType": "object",
16780
+ "required": true,
16781
+ "description": "Relation types this owner registers."
16782
+ }
16783
+ ]
16784
+ }
15841
16785
  },
15842
16786
  {
15843
- "resource": "model.videos",
15844
- "method": "remix",
15845
- "summary": "Remix video",
15846
- "description": "Not supported in this release; always returns 400.",
15847
- "http": "POST",
15848
- "path": "/model/v1/videos/{video_id}/remix",
16787
+ "resource": "ontology.types",
16788
+ "method": "retrieve",
16789
+ "summary": "Retrieve type",
16790
+ "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.",
16791
+ "http": "GET",
16792
+ "path": "/ontology/v1/types/{name}",
15849
16793
  "streaming": "no",
15850
16794
  "pagination": false,
15851
16795
  "pathParams": [
15852
16796
  {
15853
- "name": "video_id",
15854
- "sdkName": "video_id",
15855
- "description": "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400."
16797
+ "name": "name",
16798
+ "sdkName": "name",
16799
+ "description": "A type name from types.list, with its dots preserved — a display label is not accepted."
15856
16800
  }
15857
16801
  ],
15858
16802
  "query": []
@@ -16219,6 +17163,31 @@ export const operations = [
16219
17163
  ]
16220
17164
  }
16221
17165
  },
17166
+ {
17167
+ "resource": "organization.members",
17168
+ "method": "list",
17169
+ "summary": "List organization members",
17170
+ "description": "Concepts follow GitHub org members: find a person's user id, for example to assign an approver to an approval task. Lists only members of the organization behind your API key or runtime token, ordered by joined_at ascending (membership id breaks ties). Ask the user who should approve, then use that member's id. Emails are visible only within this organization. The request cannot select another organization. Pass next_page unchanged as page; null means the end. Read-only; no usage charge. Example: GET /organization/v1/members?limit=20.",
17171
+ "http": "GET",
17172
+ "path": "/organization/v1/members",
17173
+ "streaming": "no",
17174
+ "pagination": false,
17175
+ "pathParams": [],
17176
+ "query": [
17177
+ {
17178
+ "name": "limit",
17179
+ "type": "integer",
17180
+ "required": false,
17181
+ "description": "Maximum members per page, from 1 to 100; defaults to 20."
17182
+ },
17183
+ {
17184
+ "name": "page",
17185
+ "type": "string",
17186
+ "required": false,
17187
+ "description": "Opaque next_page cursor returned by the previous response; omit for the first page."
17188
+ }
17189
+ ]
17190
+ },
16222
17191
  {
16223
17192
  "resource": "organization.usage",
16224
17193
  "method": "list",
@@ -18908,7 +19877,7 @@ export const operations = [
18908
19877
  "name": "filter",
18909
19878
  "type": "string",
18910
19879
  "required": false,
18911
- "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."
19880
+ "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."
18912
19881
  }
18913
19882
  ]
18914
19883
  },
@@ -20014,7 +20983,7 @@ export const operations = [
20014
20983
  "resource": "vault.vaults",
20015
20984
  "method": "create",
20016
20985
  "summary": "Create vault",
20017
- "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.",
20986
+ "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.",
20018
20987
  "http": "POST",
20019
20988
  "path": "/vault/v1/vaults",
20020
20989
  "streaming": "no",