@deepraxis/cli 0.2.1-dev.da4893e → 0.2.1-dev.df9eeaa

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/COMMANDS.md +22 -1
  2. package/dist/praxis.js +1475 -136
  3. package/package.json +1 -1
package/dist/praxis.js CHANGED
@@ -143,7 +143,7 @@ across all toolsets allowed.`
143
143
  type: "array",
144
144
  itemType: "object",
145
145
  required: false,
146
- description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time."
146
+ description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time."
147
147
  },
148
148
  {
149
149
  name: "kind",
@@ -1218,6 +1218,37 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
1218
1218
  }
1219
1219
  ]
1220
1220
  },
1221
+ {
1222
+ resource: "agent.computers.files.convert",
1223
+ method: "create",
1224
+ summary: "Convert a Computer Document to PDF",
1225
+ description: `Convert an Office document (docx, doc, ppt, pptx, rtf, odt; up to 16 MiB) to PDF inside a platform-owned ephemeral document sandbox, whatever machine family the computer itself runs on. Returns base64 PDF bytes.
1226
+
1227
+ Praxis extension: the preview conversion endpoint. The browser never parses an untrusted document — LibreOffice runs only inside an ephemeral document-family sandbox and the converter instance is killed after use. The file stays tenant-owned; non-convertible types answer EXTENSION_NOT_CONVERTIBLE and a failed conversion answers CONVERSION_FAILED.`,
1228
+ http: "POST",
1229
+ path: "/agent/v1/computers/{computer_id}/files/convert",
1230
+ streaming: "no",
1231
+ pagination: false,
1232
+ pathParams: [
1233
+ {
1234
+ name: "computer_id",
1235
+ sdkName: "computer_id",
1236
+ description: "Computer id (cmp_...), as returned by computers.create or computers.list."
1237
+ }
1238
+ ],
1239
+ query: [],
1240
+ body: {
1241
+ required: true,
1242
+ fields: [
1243
+ {
1244
+ name: "name",
1245
+ type: "string",
1246
+ required: true,
1247
+ description: "Name of the entry or object."
1248
+ }
1249
+ ]
1250
+ }
1251
+ },
1221
1252
  {
1222
1253
  resource: "agent.computers.leases",
1223
1254
  method: "delete",
@@ -6100,7 +6131,7 @@ file at the root of that directory.`
6100
6131
  "allow"
6101
6132
  ],
6102
6133
  required: false,
6103
- description: "skip (default) skips when a previous run is still active; allow permits overlapping runs."
6134
+ 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."
6104
6135
  },
6105
6136
  {
6106
6137
  name: "catchup_window_seconds",
@@ -6274,7 +6305,7 @@ file at the root of that directory.`
6274
6305
  "allow"
6275
6306
  ],
6276
6307
  required: false,
6277
- description: "skip (default) skips when a previous run is still active; allow permits overlapping runs."
6308
+ 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."
6278
6309
  },
6279
6310
  {
6280
6311
  name: "catchup_window_seconds",
@@ -10162,6 +10193,12 @@ Execution errors include error.details.prints containing output printed before f
10162
10193
  type: "integer",
10163
10194
  required: false,
10164
10195
  description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write."
10196
+ },
10197
+ {
10198
+ name: "loudness",
10199
+ type: "object",
10200
+ required: false,
10201
+ description: "Loudness normalization target. Omitted, the export is normalized to -14 LUFS integrated and -1 dBTP true peak, the level short-video and streaming platforms play at; null renders without normalization. Normalization adds analysis and rendering work."
10165
10202
  }
10166
10203
  ]
10167
10204
  }
@@ -10170,7 +10207,7 @@ Execution errors include error.details.prints containing output printed before f
10170
10207
  resource: "cut.projects.frames",
10171
10208
  method: "list",
10172
10209
  summary: "Render preview frames",
10173
- description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution. FRAME_UNAVAILABLE warnings on execute mean a source preview could not be fetched and an offline tile was drawn; edits still commit, and this warning alone does not establish that the source media is broken. Decode its base64 payload to save the image. Codemode returns at most four images per call, so request at most four times when reviewing there.",
10210
+ description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution. The response always includes warnings; FRAME_UNAVAILABLE means a source preview could not be obtained and an offline tile was drawn. Its message identifies a timeout, delivery capacity limit, or unavailable source and contains no source URL. Decode each image's base64 payload to save it. Codemode returns at most four images per call, so request at most four times when reviewing there.",
10174
10211
  http: "GET",
10175
10212
  path: "/cut/v1/projects/{project_id}/frames",
10176
10213
  streaming: "no",
@@ -10385,7 +10422,158 @@ Execution errors include error.details.prints containing output printed before f
10385
10422
  resource: "cut.projects",
10386
10423
  method: "execute",
10387
10424
  summary: "Execute editing script",
10388
- description: 'Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: `const t = AddTrack("video"); Insert(t, {type: "color", color: "#123456", start: 0, length: 3}); Print(t);`\n\n### Script function reference\n\nFunctions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. JoinId is the string returned by Join or read from GetTimeline().joins. Reads see earlier writes in the same script.\n\n```ts\nGetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;\nGetItem(id: ClipId): ItemView;\nFindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];\nGetMedia(ref: MediaRef): MediaInfo;\nGetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];\nGetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];\nListTransitions(): TransitionInfo[];\nInsert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;\nUpdate(id: ClipId, patch: ItemPatchView): void;\nSetSpeed(id: ClipId, rate: number, o: { keep: "source" | "duration"; ripple?: boolean }): { length: number; sourceOut: number };\nDelete(id: ClipId, o?: { ripple?: boolean }): void;\nJoin(left: ClipId, right: ClipId, o: { length?: number; effect: TransitionInput }): JoinId;\nUpdateJoin(id: JoinId, patch: { length?: number; effect?: TransitionInput }): void;\nDeleteJoin(id: JoinId): void;\nSplit(id: ClipId, at: number): ClipId;\nTrim(id: ClipId, edge: "in" | "out", delta: number, o?: { ripple?: boolean }): void;\nMove(id: ClipId, start: number, track?: TrackId): void;\nRippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;\nAddTrack(kind: "video" | "audio" | "caption", init?: { name?: string }, index?: number): TrackId;\nUpdateTrack(id: TrackId, patch: TrackPatch): void;\nDeleteTrack(id: TrackId): void;\nSetSettings(patch: Partial<ProjectSettingsView>): void;\nAddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle>; maxChars?: number }): ClipId[];\nSetMarker(at: number, label: string): string;\nPrint(...values: unknown[]): void;\nPreview(at: number[]): void;\n```\n\n| Functions | Behavior and arguments |\n| --- | --- |\n| GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, playback, sourceIn/sourceOut, text and offline reason. GetTimeline returns duration, tracks (id, kind, name, index, locked, items), and joins (id, track, left, right, length in seconds, normalized effect). from/to and tracks narrow the items and joins; joins are selected by their overlap window. |\n| ListTransitions | Discover the shared validation catalog: each entry contains kind (effect ID), name, description and params. Each parameter has name, type (enum/number/integer), default, description, enum values or numeric min/max. Use the returned kind and parameter names inside effect. |\n| FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |\n| GetMedia | Read metadata for `{libraryId, assetId}` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |\n| GetTranscript, GetAnalysis | Read available transcript words or silence/filler/scenes segments. Transcript filter from/to is seconds; returned word and segment from/to values are source microseconds (divide by 1,000,000 for editing). Words contain text and optional speaker/filler; segments may include label/confidence. Request analysis first if unavailable. |\n| Insert, Update, Delete | Insert returns the new clip ID; Update changes supplied fields; Delete removes the clip. Optional ripple on Insert/Delete closes or opens space on the track. |\n| SetSpeed | Change video/audio rate in 0.25–4; keep is required. source preserves consumed source and changes length, duration preserves output length. Returns actual length and sourceOut in seconds. Optional ripple explicitly shifts same-track followers when keeping source; otherwise overlaps are rejected. |\n| Join, UpdateJoin, DeleteJoin | Join creates an overlap between two butt-adjacent visual clips on the same track and returns its ID. length defaults to 0.5 seconds; effect is required. The right clip and all same-track followers move left by length, shortening that track and potentially the project. UpdateJoin moves those followers by the difference in length; omitted fields are preserved. DeleteJoin moves them right to restore the butt cut. Other tracks stay in place. |\n| Split, Trim, Move | Split at a timeline position and return the new right-hand clip ID. Trim changes the in or out edge by delta seconds. Move sets the timeline start and optionally a new track. |\n| RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |\n| AddTrack, UpdateTrack, DeleteTrack | Add video/audio/caption tracks; index selects layer order (0 is top). TrackPatch supports name, locked, hidden, muted, gainDb and style as appropriate to track kind. |\n| SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |\n| AddCaptionsFromTranscript | Create captions from an audio/video clip\'s kept words. Optional maxChars is 1–1000, default 16; style updates the caption track. Returns caption IDs. |\n| SetMarker | Add a label at a timeline time and return its ID. |\n| Print, Preview | Print appends text to prints. Preview requests up to eight times total per execute and puts images in the result\'s frames. Each url is an inline PNG data URL, not an HTTP image link. Decode the base64 payload to save an image. Codemode returns at most four images per call; request at most four times there. |\n\n#### Joins between clips\n\nEndpoints may be video, image, text, color or shape; audio and caption are rejected. Require 0 < length < each endpoint\'s length. Each clip allows at most one incoming and one outgoing join; their summed lengths cannot exceed its length. Three-input overlaps, nonadjacent endpoints and cross-track joins are rejected with OPS_REJECTED. Read the rejection\'s code and message, shorten or remove conflicting joins, and retry the saved edit.\n\nTransitionInput is an object with kind plus the parameters returned by ListTransitions; omitted parameters use the catalog defaults. Unknown kinds and unknown or invalid parameters are rejected. Effects: dissolve (no parameters); dip (color black/white, default black); push and wipe (direction left/right/up/down, default left); wipe also has softness 0–1, default 0; iris has centerX/centerY 0–1, both default 0.5; blinds has integer count 2–64, default 8, and orientation vertical/horizontal, default vertical; blur has radius 0–100 pixels at 1080-pixel frame height, default 24. Join options and UpdateJoin patches accept only length and effect. Effect updates replace the effect object and apply defaults for omitted parameters.\n\nMinimal example on an existing visual track with adjacent clips left and right: `Print(ListTransitions()); const j = Join(left, right, {length: 0.5, effect: {kind: "dissolve"}}); Print(GetTimeline().joins); Preview([GetItem(right).start + 0.25]);` Use `UpdateJoin(j, {length: 0.8})` to adjust it in a later edit or `DeleteJoin(j)` to restore the cut. Preview uses server-rendered frames and includes joins. Per-clip transitionIn/transitionOut remain separate entrance/exit effects.\n\n#### Insert fields (ItemInit)\n\nEvery item requires `type` and `start`. Times used for editing are seconds and snap to the project frame rate: start, length, sourceIn, fadeIn/fadeOut, transition length, keyframe at, reveal delay/stagger/duration. Keyframe and reveal times are relative to the clip start. Video/audio may omit length to use the remaining source duration; other types require length.\n\n| type | Required fields beyond type/start | Optional fields |\n| --- | --- | --- |\n| video | media | length, sourceIn, playback, volumeDb, transform, fit, animate, transitionIn, transitionOut |\n| image | media, length | transform, fit, animate, transitionIn, transitionOut |\n| text | text, length | style, transform, reveal, animate, transitionIn, transitionOut |\n| color | color, length | transform, fill, animate, transitionIn, transitionOut |\n| shape | shape, length, width, height, fill | radius, stroke, transform, animate, transitionIn, transitionOut |\n| audio | media | length, sourceIn, playback, volumeDb, fadeIn, fadeOut |\n| caption | text, length | — |\n\nVideo tracks accept video/image/text/color/shape; audio and caption tracks accept their corresponding type. Media is `{libraryId: string, assetId: string}` from a bound library. sourceIn defaults to 0, volumeDb to 0 dB, audio fades to 0 seconds. fit defaults to contain: contain fits the whole image, cover fills and crops, fill stretches, none keeps native dimensions.\n\n| Field | Value |\n| --- | --- |\n| transform | Partial `{x, y, scale, rotation, opacity, crop, blur}`. x/y are normalized canvas center coordinates (default 0.5); scale 1 is fitted size; rotation is degrees (default 0); opacity is 0–1 (default 1). crop is `{top,right,bottom,left}`. blur is 0–100 pixels at 1080-pixel frame height. |\n| style | Partial `{fontFamily, fontSize, fontWeight, color, stroke, background, align, maxWidth, position, margin}`. fontFamily: Geist or Noto Sans SC (default); fontSize defaults to 48; fontWeight: 400 (default), 500 or 700; color defaults to #FFFFFF; align: left, center (default), right; maxWidth is a fraction of canvas width (default 0.9). stroke is `{color,width}`. Text and captions support position (top/middle/bottom; box centers at 12%/50%/85% of height without margin) and optional margin (0–0.4 of canvas height, box edge distance for top/bottom; middle ignores it). Omitted position preserves the text transform (center by default); explicit position controls vertical placement, so omit it for y animation. Caption style additionally supports highlightColor and maxLines: 2. GetItem and GetTimeline return text style and current caption track style. Caption tracks only accept captions; use AddCaptionsFromTranscript, and place text on video tracks. |\n| animate | An object keyed by x, y, scale, rotation, opacity or blur. Each value is an array of `{at: number, value: number, ease?: Ease}` sorted by at with distinct frame-snapped times. Values hold before the first and after the last keyframe, overriding the static transform. |\n| Ease | linear, in, out, inOut, `{bezier: [x1,y1,x2,y2]}` or `{spring: {stiffness, damping, mass?}}`. Easing shapes the segment arriving at that keyframe; springs may overshoot. |\n| reveal | `{by, delay?: number, stagger: number, duration: number, from: {y?, opacity?, scale?, blur?}, ease?: Ease}`. by selects char, word or line. Unit k starts at delay + k * stagger and takes duration seconds to reach its resting state; from.y is a fraction of font size. |\n| fill | A color string (#RRGGBB or #RRGGBBAA), `{linear: {angle, stops: [{at,color}, ...]}}` or `{radial: {stops: [{at,color}, ...]}}`. Stop positions are 0–1; angle is degrees, 0 left to right. On color clips, fill replaces color when supplied. |\n| shape, width, height, radius, stroke | shape is rect or ellipse. width/height are fractions of canvas width/height before scaling. radius rounds rect corners in pixels at 1080-pixel frame height. stroke is `{color: string, width: number}`. |\n| transitionIn, transitionOut | `{kind, length: number}` at the clip\'s beginning/end. length is seconds. fade changes opacity; dissolve blends; push_left/push_right move horizontally; wipe_left reveals horizontally. |\n\n#### Update fields (ItemPatchView)\n\nAll fields are optional; use only fields relevant to the item\'s type. Supported fields: start, length, sourceIn, playback, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, animate, reveal, fill, stroke, shape, width, height, radius, transitionIn, transitionOut. Values and units match Insert. Set animate, reveal, fill, stroke, transitionIn or transitionOut to null to remove that effect; omitting a field preserves it. For example: `Update(id, {volumeDb: -12})` or `Update(id, {transitionIn: null})`.\n\n#### 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',
10425
+ 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);\`
10426
+
10427
+ <!-- cut-reference:start -->
10428
+ ### Script function, field and error reference
10429
+
10430
+ Every script function, clip field and error code has its own section, read one at a time:
10431
+
10432
+ \`\`\`
10433
+ codemode.describe("praxis.cut.script.<Name>") // one function: signature, arguments, return, errors, example
10434
+ codemode.describe("praxis.cut.fields.<name>") // one field: type, unit, range, default, where writable
10435
+ codemode.describe("praxis.cut.errors.<CODE>") // one code: meaning, causes, fix
10436
+ codemode.describe("praxis.cut.script") // names, one page at a time
10437
+ \`\`\`
10438
+
10439
+ Published at https://docs.deepraxis.com/docs/developers/cut/script-reference with one anchor per entry. Names below omit the \`praxis.cut.<kind>.\` prefix.
10440
+
10441
+ #### Script functions (script)
10442
+
10443
+ - \`GetTimeline\` — Duration, tracks, joins; clips are under \`items\`.
10444
+ - \`GetItem\` — One clip's compact view, by id.
10445
+ - \`FindItems\` — Visit every clip with its track; collect results.
10446
+ - \`GetMedia\` — Media metadata; \`durationUs\` is microseconds.
10447
+ - \`GetTranscript\` — Transcript words in source microseconds.
10448
+ - \`GetAnalysis\` — Silence, filler or scene segments.
10449
+ - \`ListTransitions\` — Join transition kinds and parameters.
10450
+ - \`ListEffects\` — Visual-effect catalog and parameters.
10451
+ - \`ListAnimations\` — Animation presets by phase and target.
10452
+ - \`ListFonts\` — Font families, weights and scripts.
10453
+ - \`ListTextStyles\` — Text style presets for \`style.preset\`.
10454
+ - \`ListTextTemplates\` — Multi-layer templates and their slots.
10455
+ - \`Insert\` — Add a clip; a track never overlaps itself.
10456
+ - \`Append\` — Add a clip at the end of a track.
10457
+ - \`Update\` — Change named fields; the rest stay.
10458
+ - \`SetSpeed\` — Change rate, keeping source or duration.
10459
+ - \`Delete\` — Remove a clip. There is no \`Remove\`.
10460
+ - \`Join\` — Overlap clips; followers shift, track shortens.
10461
+ - \`UpdateJoin\` — Change a join's length or effect.
10462
+ - \`DeleteJoin\` — Remove a join; restore the butt cut.
10463
+ - \`Split\` — Cut a clip in two at a time.
10464
+ - \`Trim\` — Move one clip edge by seconds.
10465
+ - \`Move\` — Set a clip's start or track.
10466
+ - \`RippleDeleteRange\` — Cut a time range and close the gap.
10467
+ - \`AddTrack\` — Add a video, audio or caption track.
10468
+ - \`UpdateTrack\` — Change a track's name, lock, gain or role.
10469
+ - \`DeleteTrack\` — Remove a track and its clips.
10470
+ - \`SetSettings\` — Change canvas, frame rate or background.
10471
+ - \`AddCaptionsFromTranscript\` — Captions from a clip's kept words.
10472
+ - \`InsertTemplate\` — Insert a template and fill its slots.
10473
+ - \`AlignCaptions\` — Rebuild captions from text punctuation.
10474
+ - \`ImportCaptions\` — Import SRT or WebVTT onto captions.
10475
+ - \`ExportCaptions\` — Export captions as SRT or WebVTT.
10476
+ - \`SetMarker\` — Label a timeline position.
10477
+ - \`Print\` — Append values to the result's \`prints\`.
10478
+ - \`Preview\` — Up to 8 frames as inline PNG data URLs.
10479
+
10480
+ #### Fields (fields)
10481
+
10482
+ - \`type\` — Clip kind; decides which fields apply.
10483
+ - \`start\` — Clip start in seconds; snaps to frames.
10484
+ - \`length\` — Duration; optional for video and audio.
10485
+ - \`media\` — Source \`{ libraryId, assetId }\`.
10486
+ - \`sourceIn\` — First source second kept; default 0.
10487
+ - \`sourceOut\` — Exclusive source end; read-only.
10488
+ - \`text\` — Text of a text or caption clip.
10489
+ - \`color\` — Solid colour of a color clip.
10490
+ - \`shape\` — Shape clip kind: \`rect\` or \`ellipse\`.
10491
+ - \`width\` — Shape width, a fraction of canvas width.
10492
+ - \`height\` — Shape height, a fraction of canvas height.
10493
+ - \`radius\` — Rect corner rounding, in 1080-height px.
10494
+ - \`fill\` — Shape or text paint: colour or gradient.
10495
+ - \`stroke\` — Shape outline: colour and width.
10496
+ - \`transform\` — Position, scale, rotation, opacity, crop, blur.
10497
+ - \`fit\` — contain, cover, fill or none.
10498
+ - \`blend\` — Layer blend mode; null clears.
10499
+ - \`style\` — Text styling: font, fill, strokes, glow, position.
10500
+ - \`style.position\` — top, middle or bottom; omit it, never null.
10501
+ - \`playback\` — Rate, direction, audio policy, or freeze.
10502
+ - \`volumeDb\` — Audio level in dB; 0 is source level.
10503
+ - \`gain\` — Keyframed audio level in dB.
10504
+ - \`fadeIn\` — Fade-in seconds at the clip's start.
10505
+ - \`fadeOut\` — Fade-out seconds at the clip's end.
10506
+ - \`duck\` — Lower this clip while another track plays.
10507
+ - \`animate\` — Transform keyframes; \`at\` is clip-relative seconds.
10508
+ - \`reveal\` — Per-character, word or line reveal timing.
10509
+ - \`animation\` — Preset slots \`{ in, out, loop }\`; null clears.
10510
+ - \`effects\` — Effect stack, at most 8; null clears.
10511
+ - \`transitionIn\` — Entrance effect: kind plus seconds.
10512
+ - \`transitionOut\` — Exit effect: kind plus seconds.
10513
+ - \`mask\` — Shape, path or track matte.
10514
+ - \`words\` — Caption words with clip-local times.
10515
+
10516
+ #### Error codes (errors)
10517
+
10518
+ - \`JOIN_CONFLICT\` — A join is invalid or blocks this edit.
10519
+ - \`INVALID_TRANSITION\` — Bad transition kind, parameter or length.
10520
+ - \`INVALID_STYLE\` — A style value is out of range.
10521
+ - \`INVALID_MASK\` — A mask definition is malformed.
10522
+ - \`MASK_IN_USE\` — The edit would break a live mask.
10523
+ - \`TOO_MANY_MASKS\` — At most 16 masks per project.
10524
+ - \`RATE_OUT_OF_RANGE\` — A rate is outside 0.25-4.
10525
+ - \`UNSUPPORTED_PLAYBACK\` — Reverse without an explicit mute.
10526
+ - \`INVALID_PLAYBACK\` — A playback object is partial or malformed.
10527
+ - \`UNKNOWN_FONT\` — The family is not in \`ListFonts()\`.
10528
+ - \`UNKNOWN_FIELD\` — The field name is not accepted here.
10529
+ - \`UNKNOWN_TEXT_STYLE\` — \`style.preset\` is not in the catalog.
10530
+ - \`TEXT_STYLE_TARGET_MISMATCH\` — Preset on the wrong clip type.
10531
+ - \`CAPTION_ALIGN_LOW_CONFIDENCE\` — Alignment confidence too low; nothing changed.
10532
+ - \`OVERLAP\` — Two clips on one track would share time.
10533
+ - \`OUT_OF_SOURCE\` — The clip would read past its source.
10534
+ - \`LOCKED_TRACK\` — The edit targets a locked track.
10535
+ - \`UNBOUND_LIBRARY\` — The library is not bound to the project.
10536
+ - \`TRACK_KIND_MISMATCH\` — The clip type does not fit the track.
10537
+ - \`NOT_FOUND\` — The named id is not in this project.
10538
+ - \`TOO_SHORT\` — The result would be under one frame.
10539
+ - \`INVALID_DUCK\` — Bad \`duck\` level or a missing track.
10540
+ - \`UNKNOWN_ANIMATION\` — The preset is not in \`ListAnimations()\`.
10541
+ - \`INVALID_ANIMATION_PARAM\` — Bad slot, parameter or keyframe limit.
10542
+ - \`ANIMATION_TOO_LONG\` — In plus out exceed the clip length.
10543
+ - \`ANIMATION_TARGET_MISMATCH\` — The preset does not match the clip type.
10544
+ - \`ANIMATION_PHASE_MISMATCH\` — The preset is in the wrong slot.
10545
+ - \`UNKNOWN_EFFECT\` — The effect is not in \`ListEffects()\`.
10546
+ - \`INVALID_EFFECT_PARAM\` — Bad effect parameter or keyframe.
10547
+ - \`TOO_MANY_EFFECTS\` — More than 8 effects on one clip.
10548
+ - \`PROJECT_NOT_FOUND\` — No visible project has this id.
10549
+ - \`EXPORT_NOT_FOUND\` — No such export in this project.
10550
+ - \`VERSION_NOT_FOUND\` — No saved version has this revision.
10551
+ - \`LIBRARY_NOT_FOUND\` — The library is missing or invisible.
10552
+ - \`BINDING_INVALID\` — The binding request is malformed.
10553
+ - \`BINDING_IN_USE\` — Clips still use this library's assets.
10554
+ - \`NOTHING_TO_UNDO\` — No earlier revision to return to.
10555
+ - \`NOTHING_TO_REDO\` — No undone revision is waiting.
10556
+ - \`UNDO_CONFLICT\` — The revision to undo is no longer head.
10557
+ - \`REVISION_CONFLICT\` — The project moved; your revision is stale.
10558
+ - \`CUT_BUSY\` — The project is busy; retry.
10559
+ - \`INVALID_CAPTION_FILE\` — The subtitle file is malformed or too big.
10560
+ - \`SCRIPT_ERROR\` — The script threw or did not parse.
10561
+ - \`SCRIPT_LIMIT\` — An execute budget was exceeded.
10562
+ - \`OPS_REJECTED\` — An op failed; the whole edit rolled back.
10563
+ - \`EDIT_EXPIRED\` — The saved edit id is over ten minutes old.
10564
+ - \`MEDIA_OFFLINE\` — The asset cannot be fetched right now.
10565
+ - \`MEDIA_UNAVAILABLE\` — The asset is not usable for rendering.
10566
+ - \`MEDIA_IMPORT_FAILED\` — Importing media failed.
10567
+ - \`FRAME_OUT_OF_RANGE\` — The preview time is outside the project.
10568
+ - \`PROJECT_TOO_LARGE\` — The project exceeds the size limit.
10569
+ - \`RESPONSE_TOO_LARGE\` — The response would exceed its budget.
10570
+ - \`EXPORT_FAILED\` — The render failed; read \`error.cause\`.
10571
+ - \`INVALID_PARAMS\` — The request is malformed.
10572
+ - \`PERMISSION_DENIED\` — This credential may not do that here.
10573
+ - \`NOT_IMPLEMENTED\` — Not available on this platform yet.
10574
+ - \`INTERNAL\` — Unexpected failure; retry with the request id.
10575
+ <!-- cut-reference:end -->
10576
+ `,
10389
10577
  http: "POST",
10390
10578
  path: "/cut/v1/projects/{project_id}:execute",
10391
10579
  streaming: "no",
@@ -11630,7 +11818,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11630
11818
  resource: "file.uploads",
11631
11819
  method: "create",
11632
11820
  summary: "Create an upload",
11633
- description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data, assistants and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.",
11821
+ description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 20 GiB (21474836480 bytes) and only user_data, assistants and vision purposes. Send parts of at most 64000000 bytes; an unfinished upload waits for them for 7 days, so a client can create → send parts → query GET /file/v1/uploads/{upload_id} → resend only the missing parts → complete. Optional part_size fixes every part length and makes each numbered part retryable with identical bytes. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.",
11634
11822
  http: "POST",
11635
11823
  path: "/file/v1/uploads",
11636
11824
  streaming: "no",
@@ -11644,7 +11832,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11644
11832
  name: "bytes",
11645
11833
  type: "integer",
11646
11834
  required: true,
11647
- description: "Exact complete file length in bytes, from 1 through 2147483648 (2 GiB); the sum of completed parts must match."
11835
+ description: "Exact complete file length in bytes, from 1 through 21474836480 (20 GiB); the sum of completed parts must match."
11648
11836
  },
11649
11837
  {
11650
11838
  name: "filename",
@@ -11688,7 +11876,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11688
11876
  resource: "file.uploads",
11689
11877
  method: "createSigned",
11690
11878
  summary: "Create a one-time upload URL",
11691
- description: "Upload a local file of up to 2 GiB from a coding agent without sending bytes through the model. Provide basename, exact byte count and MIME type. Up to 104857600 bytes, PUT the file to url with curl -T photo.png -H 'Content-Type: image/png' '<url>'; success returns 201 with the file object, and reuse returns 410 CAPABILITY_USED. Above that threshold, split the file into part_size chunks (default 64000000 bytes), PUT each chunk to its numbered parts[].url in any order, then POST complete_url without a body. Part PUTs return 200; completion returns 201 with the file object, including its state, or 400 if a part is missing. A processing file can be polled with files.retrieve until active. Identical part bytes may be retried; changed bytes at the same number return 400. Completion reuse returns 410 CAPABILITY_USED. Each PUT requires the exact signed Content-Length; single-PUT Content-Type must match content_type or be omitted. Expired, revoked, invalid, wrong-action or cross-organization URLs return 404. URL lifetime defaults to 900 seconds for single PUT or 3600 for multipart, at most 604800; all multipart URLs share an expiry. Multipart creation reserves storage quota. Issuance requires the same unscoped credential as direct file creation. Each issuance creates a new upload and is not idempotent. Example body: {\"filename\":\"photo.png\",\"bytes\":2048,\"content_type\":\"image/png\"}.",
11879
+ description: "Upload a local file of up to 20 GiB from a coding agent without sending bytes through the model. Provide basename, exact byte count and MIME type. Up to 104857600 bytes, PUT the file to url with curl -T photo.png -H 'Content-Type: image/png' '<url>'; success returns 201 with the file object, and reuse returns 410 CAPABILITY_USED. Above that threshold, split the file into part_size chunks (default 64000000 bytes) and PUT each chunk to its numbered parts[].url in any order; an interrupted client GETs status_url to see the received parts and resends only what is missing, then POSTs complete_url without a body. Part PUTs return 200; completion returns 201 with the file object, including its state, or 400 if a part is missing. A processing file can be polled with files.retrieve until active. Identical part bytes may be retried; changed bytes at the same number return 400. Completion reuse returns 410 CAPABILITY_USED. Each PUT requires the exact signed Content-Length; single-PUT Content-Type must match content_type or be omitted. Expired, revoked, invalid, wrong-action or cross-organization URLs return 404. URL lifetime defaults to 900 seconds for single PUT or 604800 (7 days) for multipart, at most 604800; all multipart URLs, including status_url, share an expiry. Multipart creation reserves storage quota. Issuance requires the same unscoped credential as direct file creation. Each issuance creates a new upload and is not idempotent. Example body: {\"filename\":\"photo.png\",\"bytes\":2048,\"content_type\":\"image/png\"}.",
11692
11880
  http: "POST",
11693
11881
  path: "/file/v1/uploads/signed",
11694
11882
  streaming: "no",
@@ -11708,7 +11896,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11708
11896
  name: "bytes",
11709
11897
  type: "integer",
11710
11898
  required: true,
11711
- description: "Exact local file size in bytes, from 1 through 2147483648 (2 GiB). Up to 104857600 bytes returns one PUT URL; larger files return numbered part URLs and a completion URL. Every PUT requires its exact signed Content-Length."
11899
+ description: "Exact local file size in bytes, from 1 through 21474836480 (20 GiB). Up to 104857600 bytes returns one PUT URL; larger files return numbered part URLs, a completion URL and a status URL. Every PUT requires its exact signed Content-Length."
11712
11900
  },
11713
11901
  {
11714
11902
  name: "content_type",
@@ -11731,7 +11919,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11731
11919
  name: "expires_in",
11732
11920
  type: "integer",
11733
11921
  required: false,
11734
- description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or 3600 for multipart. All part URLs and the completion URL share one expiry. This does not set the resulting file's lifetime."
11922
+ description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or 604800 (7 days) for multipart. All part URLs, the status URL and the completion URL share one expiry. This does not set the resulting file's lifetime."
11735
11923
  },
11736
11924
  {
11737
11925
  name: "part_size",
@@ -11742,6 +11930,24 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11742
11930
  ]
11743
11931
  }
11744
11932
  },
11933
+ {
11934
+ resource: "file.uploads",
11935
+ method: "retrieve",
11936
+ summary: "Retrieve an upload",
11937
+ 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.",
11938
+ http: "GET",
11939
+ path: "/file/v1/uploads/{upload_id}",
11940
+ streaming: "no",
11941
+ pagination: false,
11942
+ pathParams: [
11943
+ {
11944
+ name: "upload_id",
11945
+ sdkName: "upload_id",
11946
+ description: "Upload identifier returned by create; the upload must belong to your organization."
11947
+ }
11948
+ ],
11949
+ query: []
11950
+ },
11745
11951
  {
11746
11952
  resource: "file.uploads",
11747
11953
  method: "cancel",
@@ -11764,7 +11970,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11764
11970
  resource: "file.uploads",
11765
11971
  method: "complete",
11766
11972
  summary: "Complete an upload",
11767
- description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.",
11973
+ description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. When parts were lost, query GET /file/v1/uploads/{upload_id} and resend them before completing. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.",
11768
11974
  http: "POST",
11769
11975
  path: "/file/v1/uploads/{upload_id}/complete",
11770
11976
  streaming: "no",
@@ -11800,7 +12006,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
11800
12006
  resource: "file.uploads.parts",
11801
12007
  method: "create",
11802
12008
  summary: "Add an upload part",
11803
- description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.",
12009
+ description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID, and query GET /file/v1/uploads/{upload_id} to see which numbers already arrived. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.",
11804
12010
  http: "POST",
11805
12011
  path: "/file/v1/uploads/{upload_id}/parts",
11806
12012
  streaming: "no",
@@ -12613,6 +12819,18 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12613
12819
  ],
12614
12820
  query: []
12615
12821
  },
12822
+ {
12823
+ resource: "media.generation.capabilities",
12824
+ method: "list",
12825
+ summary: "Get generation capabilities",
12826
+ 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.",
12827
+ http: "GET",
12828
+ path: "/media/v1/generation/capabilities",
12829
+ streaming: "no",
12830
+ pagination: false,
12831
+ pathParams: [],
12832
+ query: []
12833
+ },
12616
12834
  {
12617
12835
  resource: "media.libraries",
12618
12836
  method: "list",
@@ -12837,7 +13055,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12837
13055
  resource: "media.libraries.assets",
12838
13056
  method: "create",
12839
13057
  summary: "Upload asset",
12840
- description: " For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.",
13058
+ 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.",
12841
13059
  http: "POST",
12842
13060
  path: "/media/v1/libraries/{library_id}/assets",
12843
13061
  streaming: "no",
@@ -12961,7 +13179,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
12961
13179
  resource: "media.libraries.assets.import",
12962
13180
  method: "create",
12963
13181
  summary: "Import file",
12964
- description: "Copy a File into an independent Media asset. New assets default to organization-private delivery (type=authenticated); explicitly set type=upload for public originals and derivatives. Omitting type on overwrite preserves the current type. Deleting the source File does not delete this copy. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.",
13182
+ 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.",
12965
13183
  http: "POST",
12966
13184
  path: "/media/v1/libraries/{library_id}/assets/import",
12967
13185
  streaming: "no",
@@ -13229,7 +13447,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13229
13447
  resource: "media.libraries.assets.reprocess",
13230
13448
  method: "create",
13231
13449
  summary: "Reprocess asset",
13232
- description: " For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.",
13450
+ 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.",
13233
13451
  http: "POST",
13234
13452
  path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess",
13235
13453
  streaming: "no",
@@ -13328,7 +13546,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13328
13546
  resource: "media.libraries.assets",
13329
13547
  method: "batch",
13330
13548
  summary: "Batch assets alias",
13331
- description: 'Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.',
13549
+ 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.',
13332
13550
  http: "POST",
13333
13551
  path: "/media/v1/libraries/{library_id}/assets:batch",
13334
13552
  streaming: "no",
@@ -13363,7 +13581,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13363
13581
  resource: "media.libraries.batches",
13364
13582
  method: "create",
13365
13583
  summary: "Create batch",
13366
- description: 'Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.',
13584
+ 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.',
13367
13585
  http: "POST",
13368
13586
  path: "/media/v1/libraries/{library_id}/batches",
13369
13587
  streaming: "no",
@@ -13524,36 +13742,157 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13524
13742
  }
13525
13743
  ]
13526
13744
  },
13745
+ {
13746
+ resource: "media.libraries.generations",
13747
+ method: "create",
13748
+ summary: "Create video generation",
13749
+ 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.",
13750
+ http: "POST",
13751
+ path: "/media/v1/libraries/{library_id}/generations",
13752
+ streaming: "no",
13753
+ pagination: false,
13754
+ pathParams: [
13755
+ {
13756
+ name: "library_id",
13757
+ sdkName: "library_id",
13758
+ description: "Library ID returned by creation."
13759
+ }
13760
+ ],
13761
+ query: [],
13762
+ body: {
13763
+ required: true,
13764
+ fields: [
13765
+ {
13766
+ name: "intent",
13767
+ type: "string",
13768
+ required: true,
13769
+ description: "Generation operation; v1 accepts only video.generate text-to-video requests."
13770
+ },
13771
+ {
13772
+ name: "prompt",
13773
+ type: "string",
13774
+ required: true,
13775
+ description: "Text prompt describing the video to generate."
13776
+ },
13777
+ {
13778
+ name: "count",
13779
+ type: "integer",
13780
+ required: false,
13781
+ description: "Number of videos to generate; defaults to 1 and must be from 1 to 4."
13782
+ },
13783
+ {
13784
+ name: "duration_seconds",
13785
+ type: "integer",
13786
+ required: false,
13787
+ description: "Requested video duration in seconds; Router validates the model-specific supported durations."
13788
+ },
13789
+ {
13790
+ name: "aspect_ratio",
13791
+ type: "string",
13792
+ required: false,
13793
+ description: "Requested output aspect ratio; defaults to 16:9 and Router validates model support."
13794
+ },
13795
+ {
13796
+ name: "model",
13797
+ type: "string",
13798
+ required: false,
13799
+ description: "Router model with video_generation capability; defaults to wan2.7-t2v."
13800
+ },
13801
+ {
13802
+ name: "save",
13803
+ type: "string",
13804
+ enum: [
13805
+ "candidate",
13806
+ "library"
13807
+ ],
13808
+ required: false,
13809
+ description: "candidate keeps outputs temporary for explicit save calls; library saves successful outputs automatically."
13810
+ },
13811
+ {
13812
+ name: "asset_folder",
13813
+ type: "string",
13814
+ required: false,
13815
+ 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."
13816
+ },
13817
+ {
13818
+ name: "tags",
13819
+ type: "array",
13820
+ itemType: "string",
13821
+ required: false,
13822
+ description: "Tags applied when an output becomes a library asset."
13823
+ },
13824
+ {
13825
+ name: "understanding",
13826
+ type: "string",
13827
+ enum: [
13828
+ "auto",
13829
+ "skip"
13830
+ ],
13831
+ required: false,
13832
+ description: "Understanding behavior when a candidate is saved as an asset; defaults to auto."
13833
+ },
13834
+ {
13835
+ name: "references",
13836
+ type: "array",
13837
+ itemType: "object",
13838
+ required: false,
13839
+ description: "Not supported in v1; omit this field. Only text-to-video is currently available."
13840
+ }
13841
+ ]
13842
+ }
13843
+ },
13527
13844
  {
13528
13845
  resource: "media.libraries.jobs",
13529
- method: "retrieve",
13530
- summary: "Get job alias",
13531
- 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.",
13846
+ method: "list",
13847
+ summary: "List jobs",
13848
+ 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.",
13532
13849
  http: "GET",
13533
- path: "/media/v1/libraries/{library_id}/jobs/{job_id}",
13850
+ path: "/media/v1/libraries/{library_id}/jobs",
13534
13851
  streaming: "no",
13535
- pagination: false,
13852
+ pagination: true,
13536
13853
  pathParams: [
13537
13854
  {
13538
13855
  name: "library_id",
13539
13856
  sdkName: "library_id",
13540
13857
  description: "Library ID returned by creation."
13858
+ }
13859
+ ],
13860
+ query: [
13861
+ {
13862
+ name: "status",
13863
+ type: "string",
13864
+ enum: [
13865
+ "queued",
13866
+ "running",
13867
+ "completed",
13868
+ "completed_with_errors",
13869
+ "failed",
13870
+ "cancelled"
13871
+ ],
13872
+ required: false,
13873
+ description: "Filter jobs by their current status."
13541
13874
  },
13542
13875
  {
13543
- name: "job_id",
13544
- sdkName: "job_id",
13545
- description: "Batch identifier returned by createBatch or batchAssets; resolved within this library."
13876
+ name: "limit",
13877
+ type: "integer",
13878
+ required: false,
13879
+ description: "Maximum entries in this page, from 1 through 100; defaults to 100."
13880
+ },
13881
+ {
13882
+ name: "cursor",
13883
+ type: "string",
13884
+ required: false,
13885
+ description: "Job id from the previous page’s next_cursor; omit for the first page."
13546
13886
  }
13547
- ],
13548
- query: []
13887
+ ]
13549
13888
  },
13550
13889
  {
13551
- resource: "media.libraries.purge",
13552
- method: "create",
13553
- summary: "Purge library",
13554
- 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.",
13555
- http: "POST",
13556
- path: "/media/v1/libraries/{library_id}/purge",
13890
+ resource: "media.libraries.jobs",
13891
+ method: "retrieve",
13892
+ summary: "Get job",
13893
+ 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.",
13894
+ http: "GET",
13895
+ path: "/media/v1/libraries/{library_id}/jobs/{job_id}",
13557
13896
  streaming: "no",
13558
13897
  pagination: false,
13559
13898
  pathParams: [
@@ -13561,17 +13900,22 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13561
13900
  name: "library_id",
13562
13901
  sdkName: "library_id",
13563
13902
  description: "Library ID returned by creation."
13903
+ },
13904
+ {
13905
+ name: "job_id",
13906
+ sdkName: "job_id",
13907
+ description: "Job identifier returned by batch creation, video-generation creation or job listing; resolved within this library."
13564
13908
  }
13565
13909
  ],
13566
13910
  query: []
13567
13911
  },
13568
13912
  {
13569
- resource: "media.libraries",
13570
- method: "restore",
13571
- summary: "Restore library",
13572
- 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.",
13913
+ resource: "media.libraries.jobs",
13914
+ method: "cancel",
13915
+ summary: "Cancel job",
13916
+ 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.",
13573
13917
  http: "POST",
13574
- path: "/media/v1/libraries/{library_id}/restore",
13918
+ path: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
13575
13919
  streaming: "no",
13576
13920
  pagination: false,
13577
13921
  pathParams: [
@@ -13579,17 +13923,22 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13579
13923
  name: "library_id",
13580
13924
  sdkName: "library_id",
13581
13925
  description: "Library ID returned by creation."
13926
+ },
13927
+ {
13928
+ name: "job_id",
13929
+ sdkName: "job_id",
13930
+ description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
13582
13931
  }
13583
13932
  ],
13584
13933
  query: []
13585
13934
  },
13586
13935
  {
13587
- resource: "media.libraries.search",
13936
+ resource: "media.libraries.jobs.outputs.save",
13588
13937
  method: "create",
13589
- summary: "Semantic search alias",
13590
- 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.",
13938
+ summary: "Save generation output",
13939
+ 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.",
13591
13940
  http: "POST",
13592
- path: "/media/v1/libraries/{library_id}/search",
13941
+ path: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
13593
13942
  streaming: "no",
13594
13943
  pagination: false,
13595
13944
  pathParams: [
@@ -13597,50 +13946,61 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13597
13946
  name: "library_id",
13598
13947
  sdkName: "library_id",
13599
13948
  description: "Library ID returned by creation."
13949
+ },
13950
+ {
13951
+ name: "job_id",
13952
+ sdkName: "job_id",
13953
+ description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
13954
+ },
13955
+ {
13956
+ name: "index",
13957
+ sdkName: "index",
13958
+ description: "Zero-based position of the candidate in the Job outputs array."
13600
13959
  }
13601
13960
  ],
13602
13961
  query: [],
13603
13962
  body: {
13604
- required: true,
13963
+ required: false,
13605
13964
  fields: [
13606
13965
  {
13607
- name: "query",
13966
+ name: "public_id",
13608
13967
  type: "string",
13609
- required: true,
13610
- description: "Nonblank text to search against asset content and metadata."
13968
+ required: false,
13969
+ description: "Delivery identifier for the saved asset; defaults to gen_<job_id>_<index> and is idempotent."
13611
13970
  },
13612
13971
  {
13613
- name: "filter",
13972
+ name: "asset_folder",
13614
13973
  type: "string",
13615
13974
  required: false,
13616
- description: "Optional expression filter restricting eligible assets; uses the expression-search syntax."
13975
+ 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."
13617
13976
  },
13618
13977
  {
13619
- name: "top_k",
13620
- type: "integer",
13978
+ name: "tags",
13979
+ type: "array",
13980
+ itemType: "string",
13621
13981
  required: false,
13622
- description: "Maximum search hits, from 1 to 50; defaults to 20."
13982
+ description: "Tags to apply to the saved asset."
13623
13983
  },
13624
13984
  {
13625
- name: "mode",
13985
+ name: "understanding",
13626
13986
  type: "string",
13627
13987
  enum: [
13628
- "hybrid",
13629
- "semantic"
13988
+ "auto",
13989
+ "skip"
13630
13990
  ],
13631
13991
  required: false,
13632
- description: "Ranking mode: hybrid combines semantic and keyword matches; semantic uses vector similarity only. Defaults to hybrid."
13992
+ description: "Understanding behavior for the saved asset; defaults to auto."
13633
13993
  }
13634
13994
  ]
13635
13995
  }
13636
13996
  },
13637
13997
  {
13638
- resource: "media.libraries.search.expression",
13998
+ resource: "media.libraries.purge",
13639
13999
  method: "create",
13640
- summary: "Expression search",
13641
- 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.",
14000
+ summary: "Purge library",
14001
+ 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.",
13642
14002
  http: "POST",
13643
- path: "/media/v1/libraries/{library_id}/search/expression",
14003
+ path: "/media/v1/libraries/{library_id}/purge",
13644
14004
  streaming: "no",
13645
14005
  pagination: false,
13646
14006
  pathParams: [
@@ -13650,69 +14010,156 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
13650
14010
  description: "Library ID returned by creation."
13651
14011
  }
13652
14012
  ],
13653
- query: [],
13654
- body: {
13655
- required: true,
13656
- fields: [
13657
- {
13658
- name: "expression",
13659
- type: "string",
13660
- required: false,
13661
- 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.'
13662
- },
13663
- {
13664
- name: "sort_by",
13665
- type: "array",
13666
- itemType: "object",
13667
- required: false,
13668
- 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."
13669
- },
13670
- {
13671
- name: "max_results",
13672
- type: "integer",
13673
- required: false,
13674
- description: "Maximum assets per page, from 1 to 500; defaults to 100."
13675
- },
13676
- {
13677
- name: "next_cursor",
13678
- type: "string",
13679
- required: false,
13680
- description: "Continuation token returned by the previous expression-search page. Keep sort_by unchanged when continuing."
13681
- },
13682
- {
13683
- name: "with_field",
13684
- type: "array",
13685
- itemType: "string",
13686
- enum: [
13687
- "tags",
13688
- "context"
13689
- ],
13690
- required: false,
13691
- description: "Additional resource fields to include: tags adds asset labels and context adds custom metadata. Both are omitted unless requested."
13692
- },
13693
- {
13694
- name: "aggregate",
13695
- type: "array",
13696
- itemType: "string",
13697
- enum: [
13698
- "resource_type",
13699
- "format",
13700
- "asset_folder",
13701
- "processing_state"
13702
- ],
13703
- required: false,
13704
- description: "Facets to count over matching assets, returned under aggregations."
13705
- }
13706
- ]
13707
- }
14013
+ query: []
13708
14014
  },
13709
14015
  {
13710
- resource: "media.libraries.search.semantic",
14016
+ resource: "media.libraries",
14017
+ method: "restore",
14018
+ summary: "Restore library",
14019
+ 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.",
14020
+ http: "POST",
14021
+ path: "/media/v1/libraries/{library_id}/restore",
14022
+ streaming: "no",
14023
+ pagination: false,
14024
+ pathParams: [
14025
+ {
14026
+ name: "library_id",
14027
+ sdkName: "library_id",
14028
+ description: "Library ID returned by creation."
14029
+ }
14030
+ ],
14031
+ query: []
14032
+ },
14033
+ {
14034
+ resource: "media.libraries.search",
13711
14035
  method: "create",
13712
- summary: "Semantic search",
13713
- 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.",
14036
+ summary: "Semantic search alias",
14037
+ 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.",
13714
14038
  http: "POST",
13715
- path: "/media/v1/libraries/{library_id}/search/semantic",
14039
+ path: "/media/v1/libraries/{library_id}/search",
14040
+ streaming: "no",
14041
+ pagination: false,
14042
+ pathParams: [
14043
+ {
14044
+ name: "library_id",
14045
+ sdkName: "library_id",
14046
+ description: "Library ID returned by creation."
14047
+ }
14048
+ ],
14049
+ query: [],
14050
+ body: {
14051
+ required: true,
14052
+ fields: [
14053
+ {
14054
+ name: "query",
14055
+ type: "string",
14056
+ required: true,
14057
+ description: "Nonblank text to search against asset content and metadata."
14058
+ },
14059
+ {
14060
+ name: "filter",
14061
+ type: "string",
14062
+ required: false,
14063
+ description: "Optional expression filter restricting eligible assets; uses the expression-search syntax."
14064
+ },
14065
+ {
14066
+ name: "top_k",
14067
+ type: "integer",
14068
+ required: false,
14069
+ description: "Maximum search hits, from 1 to 50; defaults to 20."
14070
+ },
14071
+ {
14072
+ name: "mode",
14073
+ type: "string",
14074
+ enum: [
14075
+ "hybrid",
14076
+ "semantic"
14077
+ ],
14078
+ required: false,
14079
+ description: "Ranking mode: hybrid combines semantic and keyword matches; semantic uses vector similarity only. Defaults to hybrid."
14080
+ }
14081
+ ]
14082
+ }
14083
+ },
14084
+ {
14085
+ resource: "media.libraries.search.expression",
14086
+ method: "create",
14087
+ summary: "Expression search",
14088
+ 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.",
14089
+ http: "POST",
14090
+ path: "/media/v1/libraries/{library_id}/search/expression",
14091
+ streaming: "no",
14092
+ pagination: false,
14093
+ pathParams: [
14094
+ {
14095
+ name: "library_id",
14096
+ sdkName: "library_id",
14097
+ description: "Library ID returned by creation."
14098
+ }
14099
+ ],
14100
+ query: [],
14101
+ body: {
14102
+ required: true,
14103
+ fields: [
14104
+ {
14105
+ name: "expression",
14106
+ type: "string",
14107
+ required: false,
14108
+ 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.'
14109
+ },
14110
+ {
14111
+ name: "sort_by",
14112
+ type: "array",
14113
+ itemType: "object",
14114
+ required: false,
14115
+ 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."
14116
+ },
14117
+ {
14118
+ name: "max_results",
14119
+ type: "integer",
14120
+ required: false,
14121
+ description: "Maximum assets per page, from 1 to 500; defaults to 100."
14122
+ },
14123
+ {
14124
+ name: "next_cursor",
14125
+ type: "string",
14126
+ required: false,
14127
+ description: "Continuation token returned by the previous expression-search page. Keep sort_by unchanged when continuing."
14128
+ },
14129
+ {
14130
+ name: "with_field",
14131
+ type: "array",
14132
+ itemType: "string",
14133
+ enum: [
14134
+ "tags",
14135
+ "context"
14136
+ ],
14137
+ required: false,
14138
+ description: "Additional resource fields to include: tags adds asset labels and context adds custom metadata. Both are omitted unless requested."
14139
+ },
14140
+ {
14141
+ name: "aggregate",
14142
+ type: "array",
14143
+ itemType: "string",
14144
+ enum: [
14145
+ "resource_type",
14146
+ "format",
14147
+ "asset_folder",
14148
+ "processing_state"
14149
+ ],
14150
+ required: false,
14151
+ description: "Facets to count over matching assets, returned under aggregations."
14152
+ }
14153
+ ]
14154
+ }
14155
+ },
14156
+ {
14157
+ resource: "media.libraries.search.semantic",
14158
+ method: "create",
14159
+ summary: "Semantic search",
14160
+ 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.",
14161
+ http: "POST",
14162
+ path: "/media/v1/libraries/{library_id}/search/semantic",
13716
14163
  streaming: "no",
13717
14164
  pagination: false,
13718
14165
  pathParams: [
@@ -16347,6 +16794,539 @@ for more details.`
16347
16794
  ],
16348
16795
  query: []
16349
16796
  },
16797
+ {
16798
+ resource: "ontology.changesets",
16799
+ method: "create",
16800
+ summary: "Apply changeset",
16801
+ 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.",
16802
+ http: "POST",
16803
+ path: "/ontology/v1/changesets",
16804
+ streaming: "no",
16805
+ pagination: false,
16806
+ pathParams: [],
16807
+ query: [],
16808
+ body: {
16809
+ required: true,
16810
+ fields: [
16811
+ {
16812
+ name: "at",
16813
+ type: "string",
16814
+ required: true,
16815
+ description: "World time the batch describes, in ISO 8601 UTC; operations without their own time are dated by it."
16816
+ },
16817
+ {
16818
+ name: "scope",
16819
+ type: "string",
16820
+ required: false,
16821
+ description: "Scope the batch came from, normally the session id it was observed in; it is stored with the operations for later reading."
16822
+ },
16823
+ {
16824
+ name: "ops",
16825
+ type: "array",
16826
+ itemType: "object",
16827
+ required: true,
16828
+ description: "At most 500 operations, applied in order; each names its kind in op and the fields that kind requires."
16829
+ }
16830
+ ]
16831
+ }
16832
+ },
16833
+ {
16834
+ resource: "ontology.nodes",
16835
+ method: "list",
16836
+ summary: "List nodes",
16837
+ 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.",
16838
+ http: "GET",
16839
+ path: "/ontology/v1/nodes",
16840
+ streaming: "no",
16841
+ pagination: true,
16842
+ pathParams: [],
16843
+ query: [
16844
+ {
16845
+ name: "type",
16846
+ type: "array",
16847
+ itemType: "string",
16848
+ required: false,
16849
+ description: "Repeat to filter to any of several registered node type names, for example type=file&type=ticket; omit to list every type."
16850
+ },
16851
+ {
16852
+ name: "q",
16853
+ type: "string",
16854
+ required: false,
16855
+ description: "Free text matched against node names, aliases and descriptions; omit to list without a text filter."
16856
+ },
16857
+ {
16858
+ name: "owner",
16859
+ type: "string",
16860
+ required: false,
16861
+ description: "Filter to nodes owned by this member id, or omit to list nodes of every owner; organization-wide nodes carry no owner."
16862
+ },
16863
+ {
16864
+ name: "as_of",
16865
+ type: "string",
16866
+ required: false,
16867
+ description: "ISO 8601 timestamp; return the graph as it was then, so a node recorded later is absent. Omit to read current state."
16868
+ },
16869
+ {
16870
+ name: "limit",
16871
+ type: "integer",
16872
+ required: false,
16873
+ description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100."
16874
+ },
16875
+ {
16876
+ name: "cursor",
16877
+ type: "string",
16878
+ required: false,
16879
+ description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
16880
+ }
16881
+ ]
16882
+ },
16883
+ {
16884
+ resource: "ontology.nodes",
16885
+ method: "create",
16886
+ summary: "Create node",
16887
+ 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.",
16888
+ http: "POST",
16889
+ path: "/ontology/v1/nodes",
16890
+ streaming: "no",
16891
+ pagination: false,
16892
+ pathParams: [],
16893
+ query: [],
16894
+ body: {
16895
+ required: true,
16896
+ fields: [
16897
+ {
16898
+ name: "type",
16899
+ type: "string",
16900
+ required: true,
16901
+ description: "Registered node type name from types.list; an unregistered name is refused and nothing is written."
16902
+ },
16903
+ {
16904
+ name: "ref",
16905
+ type: "string",
16906
+ required: false,
16907
+ 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."
16908
+ },
16909
+ {
16910
+ name: "name",
16911
+ type: "string",
16912
+ required: true,
16913
+ description: "Display name of the entity, at most 200 characters."
16914
+ },
16915
+ {
16916
+ name: "aliases",
16917
+ type: "array",
16918
+ itemType: "string",
16919
+ required: false,
16920
+ description: "Other names this entity is known by; they are matched by search alongside the name."
16921
+ },
16922
+ {
16923
+ name: "description",
16924
+ type: "string",
16925
+ required: false,
16926
+ description: "Profile of the entity, at most 500 characters; omit or null for none."
16927
+ },
16928
+ {
16929
+ name: "owner",
16930
+ type: "string",
16931
+ required: false,
16932
+ description: "Member id whose content this is, restricting it to that member; omit or null to make it readable organization-wide."
16933
+ }
16934
+ ]
16935
+ }
16936
+ },
16937
+ {
16938
+ resource: "ontology.nodes",
16939
+ method: "retrieve",
16940
+ summary: "Retrieve node",
16941
+ 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.",
16942
+ http: "GET",
16943
+ path: "/ontology/v1/nodes/{node_id}",
16944
+ streaming: "no",
16945
+ pagination: false,
16946
+ pathParams: [
16947
+ {
16948
+ name: "node_id",
16949
+ sdkName: "node_id",
16950
+ 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."
16951
+ }
16952
+ ],
16953
+ query: [
16954
+ {
16955
+ name: "expand",
16956
+ type: "string",
16957
+ enum: [
16958
+ "relations"
16959
+ ],
16960
+ required: false,
16961
+ description: "Set to relations to include the node's incoming and outgoing relations in the same response; omit for the node alone."
16962
+ },
16963
+ {
16964
+ name: "as_of",
16965
+ type: "string",
16966
+ required: false,
16967
+ description: "ISO 8601 timestamp; read the node and its relations as they were then, including relations invalidated since. Omit to read current state."
16968
+ }
16969
+ ]
16970
+ },
16971
+ {
16972
+ resource: "ontology.nodes",
16973
+ method: "update",
16974
+ summary: "Update node",
16975
+ 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.",
16976
+ http: "PATCH",
16977
+ path: "/ontology/v1/nodes/{node_id}",
16978
+ streaming: "no",
16979
+ pagination: false,
16980
+ pathParams: [
16981
+ {
16982
+ name: "node_id",
16983
+ sdkName: "node_id",
16984
+ 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."
16985
+ }
16986
+ ],
16987
+ query: [],
16988
+ body: {
16989
+ required: true,
16990
+ fields: [
16991
+ {
16992
+ name: "name",
16993
+ type: "string",
16994
+ required: false,
16995
+ description: "New display name, at most 200 characters; omit to keep the current name."
16996
+ },
16997
+ {
16998
+ name: "aliases",
16999
+ type: "array",
17000
+ itemType: "string",
17001
+ required: false,
17002
+ description: "Replacement alias list; an empty array clears the aliases and omitting the field keeps them."
17003
+ },
17004
+ {
17005
+ name: "description",
17006
+ type: "string",
17007
+ required: false,
17008
+ description: "Replacement profile, at most 500 characters; an explicit null clears it and omitting the field keeps it."
17009
+ }
17010
+ ]
17011
+ }
17012
+ },
17013
+ {
17014
+ resource: "ontology.nodes.merge",
17015
+ method: "create",
17016
+ summary: "Merge node",
17017
+ 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.",
17018
+ http: "POST",
17019
+ path: "/ontology/v1/nodes/{node_id}/merge",
17020
+ streaming: "no",
17021
+ pagination: false,
17022
+ pathParams: [
17023
+ {
17024
+ name: "node_id",
17025
+ sdkName: "node_id",
17026
+ 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."
17027
+ }
17028
+ ],
17029
+ query: [],
17030
+ body: {
17031
+ required: true,
17032
+ fields: [
17033
+ {
17034
+ name: "into",
17035
+ type: "string",
17036
+ required: true,
17037
+ description: "Node id that should survive, from nodes.list or search; the merged node's relations and aliases move to it."
17038
+ }
17039
+ ]
17040
+ }
17041
+ },
17042
+ {
17043
+ resource: "ontology.relations",
17044
+ method: "list",
17045
+ summary: "List relations",
17046
+ 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.",
17047
+ http: "GET",
17048
+ path: "/ontology/v1/relations",
17049
+ streaming: "no",
17050
+ pagination: true,
17051
+ pathParams: [],
17052
+ query: [
17053
+ {
17054
+ name: "node",
17055
+ type: "string",
17056
+ required: false,
17057
+ 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."
17058
+ },
17059
+ {
17060
+ name: "type",
17061
+ type: "array",
17062
+ itemType: "string",
17063
+ required: false,
17064
+ description: "Repeat to filter to any of several registered relation type names, for example type=references&type=serves; omit to list every type."
17065
+ },
17066
+ {
17067
+ name: "direction",
17068
+ type: "string",
17069
+ enum: [
17070
+ "out",
17071
+ "in",
17072
+ "both"
17073
+ ],
17074
+ required: false,
17075
+ 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."
17076
+ },
17077
+ {
17078
+ name: "as_of",
17079
+ type: "string",
17080
+ required: false,
17081
+ 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."
17082
+ },
17083
+ {
17084
+ name: "include_invalid",
17085
+ type: "boolean",
17086
+ required: false,
17087
+ 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."
17088
+ },
17089
+ {
17090
+ name: "limit",
17091
+ type: "integer",
17092
+ required: false,
17093
+ description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100."
17094
+ },
17095
+ {
17096
+ name: "cursor",
17097
+ type: "string",
17098
+ required: false,
17099
+ description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
17100
+ }
17101
+ ]
17102
+ },
17103
+ {
17104
+ resource: "ontology.relations",
17105
+ method: "create",
17106
+ summary: "Create relation",
17107
+ 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.",
17108
+ http: "POST",
17109
+ path: "/ontology/v1/relations",
17110
+ streaming: "no",
17111
+ pagination: false,
17112
+ pathParams: [],
17113
+ query: [],
17114
+ body: {
17115
+ required: true,
17116
+ fields: [
17117
+ {
17118
+ name: "type",
17119
+ type: "string",
17120
+ required: true,
17121
+ description: "Registered relation type name from types.list; it must admit both endpoints or the write is refused."
17122
+ },
17123
+ {
17124
+ name: "source",
17125
+ type: "string",
17126
+ required: true,
17127
+ description: "Node id the fact starts from, from nodes.list or nodes.create."
17128
+ },
17129
+ {
17130
+ name: "target",
17131
+ type: "string",
17132
+ required: true,
17133
+ description: "Node id the fact points at, from nodes.list or nodes.create."
17134
+ },
17135
+ {
17136
+ name: "fact",
17137
+ type: "string",
17138
+ required: true,
17139
+ description: "The relationship in one sentence, at most 280 characters, written to read back on its own."
17140
+ },
17141
+ {
17142
+ name: "valid_at",
17143
+ type: "string",
17144
+ required: false,
17145
+ description: "World time the fact became true, when the mirrored record dates it; omit to leave it undated."
17146
+ },
17147
+ {
17148
+ name: "owner",
17149
+ type: "string",
17150
+ required: false,
17151
+ description: "Member id whose content this fact is, restricting it to that member; omit or null for organization-wide."
17152
+ }
17153
+ ]
17154
+ }
17155
+ },
17156
+ {
17157
+ resource: "ontology.relations",
17158
+ method: "retrieve",
17159
+ summary: "Retrieve relation",
17160
+ 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.",
17161
+ http: "GET",
17162
+ path: "/ontology/v1/relations/{relation_id}",
17163
+ streaming: "no",
17164
+ pagination: false,
17165
+ pathParams: [
17166
+ {
17167
+ name: "relation_id",
17168
+ sdkName: "relation_id",
17169
+ 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."
17170
+ }
17171
+ ],
17172
+ query: []
17173
+ },
17174
+ {
17175
+ resource: "ontology.relations.invalidate",
17176
+ method: "create",
17177
+ summary: "Invalidate relation",
17178
+ 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.",
17179
+ http: "POST",
17180
+ path: "/ontology/v1/relations/{relation_id}/invalidate",
17181
+ streaming: "no",
17182
+ pagination: false,
17183
+ pathParams: [
17184
+ {
17185
+ name: "relation_id",
17186
+ sdkName: "relation_id",
17187
+ 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."
17188
+ }
17189
+ ],
17190
+ query: [],
17191
+ body: {
17192
+ required: true,
17193
+ fields: [
17194
+ {
17195
+ name: "invalid_at",
17196
+ type: "string",
17197
+ required: true,
17198
+ description: "World time the fact stopped being true, in ISO 8601 UTC; reads at an earlier as_of still return the relation."
17199
+ },
17200
+ {
17201
+ name: "superseded_by",
17202
+ type: "string",
17203
+ required: false,
17204
+ description: "Relation id that replaces this one, when a successor was recorded; omit or null when nothing replaced it."
17205
+ },
17206
+ {
17207
+ name: "reason",
17208
+ type: "string",
17209
+ required: false,
17210
+ description: "Why it stopped being true, for people reading the history later; not enforced and safe to omit."
17211
+ }
17212
+ ]
17213
+ }
17214
+ },
17215
+ {
17216
+ resource: "ontology.search",
17217
+ method: "create",
17218
+ summary: "Search nodes",
17219
+ 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.",
17220
+ http: "POST",
17221
+ path: "/ontology/v1/search",
17222
+ streaming: "no",
17223
+ pagination: false,
17224
+ pathParams: [],
17225
+ query: [],
17226
+ body: {
17227
+ required: true,
17228
+ fields: [
17229
+ {
17230
+ name: "text",
17231
+ type: "string",
17232
+ required: true,
17233
+ description: "Text to find nodes for, matched against names, aliases, descriptions and relation facts; an empty string is refused."
17234
+ },
17235
+ {
17236
+ name: "types",
17237
+ type: "array",
17238
+ itemType: "string",
17239
+ required: false,
17240
+ description: "Registered node type names to search within; omit to search every type."
17241
+ },
17242
+ {
17243
+ name: "window",
17244
+ type: "object",
17245
+ required: false,
17246
+ description: "Restrict matches to facts recorded within a period; omit to search all time."
17247
+ },
17248
+ {
17249
+ name: "limit",
17250
+ type: "integer",
17251
+ required: false,
17252
+ description: "Maximum candidate nodes to return, from 1 to 50; defaults to 20 when omitted."
17253
+ }
17254
+ ]
17255
+ }
17256
+ },
17257
+ {
17258
+ resource: "ontology.types",
17259
+ method: "list",
17260
+ summary: "List types",
17261
+ 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.",
17262
+ http: "GET",
17263
+ path: "/ontology/v1/types",
17264
+ streaming: "no",
17265
+ pagination: false,
17266
+ pathParams: [],
17267
+ query: []
17268
+ },
17269
+ {
17270
+ resource: "ontology.types",
17271
+ method: "create",
17272
+ summary: "Register type",
17273
+ 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.",
17274
+ http: "POST",
17275
+ path: "/ontology/v1/types",
17276
+ streaming: "no",
17277
+ pagination: false,
17278
+ pathParams: [],
17279
+ query: [],
17280
+ body: {
17281
+ required: true,
17282
+ fields: [
17283
+ {
17284
+ name: "owner",
17285
+ type: "string",
17286
+ required: true,
17287
+ description: "Service that registered these types, for example file or ticket; it is the registrant a later change to a type is checked against."
17288
+ },
17289
+ {
17290
+ name: "version",
17291
+ type: "integer",
17292
+ required: true,
17293
+ description: "Monotonic version of this owner's registration; a later registration must extend this one without removing or narrowing anything."
17294
+ },
17295
+ {
17296
+ name: "nodes",
17297
+ type: "array",
17298
+ itemType: "object",
17299
+ required: true,
17300
+ description: "Node types this owner registers."
17301
+ },
17302
+ {
17303
+ name: "edges",
17304
+ type: "array",
17305
+ itemType: "object",
17306
+ required: true,
17307
+ description: "Relation types this owner registers."
17308
+ }
17309
+ ]
17310
+ }
17311
+ },
17312
+ {
17313
+ resource: "ontology.types",
17314
+ method: "retrieve",
17315
+ summary: "Retrieve type",
17316
+ 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.",
17317
+ http: "GET",
17318
+ path: "/ontology/v1/types/{name}",
17319
+ streaming: "no",
17320
+ pagination: false,
17321
+ pathParams: [
17322
+ {
17323
+ name: "name",
17324
+ sdkName: "name",
17325
+ description: "A type name from types.list, with its dots preserved — a display label is not accepted."
17326
+ }
17327
+ ],
17328
+ query: []
17329
+ },
16350
17330
  {
16351
17331
  resource: "organization.charges",
16352
17332
  method: "list",
@@ -19070,7 +20050,7 @@ for more details.`
19070
20050
  resource: "ticket.labels",
19071
20051
  method: "create",
19072
20052
  summary: "Create or add labels",
19073
- description: "Create or add labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
20053
+ description: "Create or add labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
19074
20054
  http: "POST",
19075
20055
  path: "/ticket/v1/labels",
19076
20056
  streaming: "no",
@@ -19112,7 +20092,7 @@ for more details.`
19112
20092
  resource: "ticket.labels",
19113
20093
  method: "delete",
19114
20094
  summary: "Remove labels",
19115
- description: "Remove labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
20095
+ description: "Remove labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
19116
20096
  http: "DELETE",
19117
20097
  path: "/ticket/v1/labels/{name}",
19118
20098
  streaming: "no",
@@ -19137,7 +20117,7 @@ for more details.`
19137
20117
  resource: "ticket.labels",
19138
20118
  method: "update",
19139
20119
  summary: "Update labels",
19140
- description: "Update labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
20120
+ description: "Update labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
19141
20121
  http: "PATCH",
19142
20122
  path: "/ticket/v1/labels/{name}",
19143
20123
  streaming: "no",
@@ -19433,7 +20413,7 @@ for more details.`
19433
20413
  name: "filter",
19434
20414
  type: "string",
19435
20415
  required: false,
19436
- 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."
20416
+ 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."
19437
20417
  }
19438
20418
  ]
19439
20419
  },
@@ -20539,7 +21519,7 @@ for more details.`
20539
21519
  resource: "vault.vaults",
20540
21520
  method: "create",
20541
21521
  summary: "Create vault",
20542
- 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.",
21522
+ 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.",
20543
21523
  http: "POST",
20544
21524
  path: "/vault/v1/vaults",
20545
21525
  streaming: "no",
@@ -22501,6 +23481,23 @@ var computersFilesContent = (options) => (options.client ?? client).get({
22501
23481
  url: "/agent/v1/computers/{computer_id}/files/content",
22502
23482
  ...options
22503
23483
  });
23484
+ var computersFilesConvert = (options) => (options.client ?? client).post({
23485
+ security: [{
23486
+ key: "BearerAuth",
23487
+ scheme: "bearer",
23488
+ type: "http"
23489
+ }, {
23490
+ key: "ApiKeyAuth",
23491
+ name: "X-API-Key",
23492
+ type: "apiKey"
23493
+ }],
23494
+ url: "/agent/v1/computers/{computer_id}/files/convert",
23495
+ ...options,
23496
+ headers: {
23497
+ "Content-Type": "application/json",
23498
+ ...options.headers
23499
+ }
23500
+ });
22504
23501
  var connectComputer = (options) => (options.client ?? client).post({
22505
23502
  security: [{
22506
23503
  key: "BearerAuth",
@@ -22999,6 +23996,15 @@ var fileCancelUpload = (options) => (options.client ?? client).post({
22999
23996
  url: "/file/v1/uploads/{upload_id}/cancel",
23000
23997
  ...options
23001
23998
  });
23999
+ var fileRetrieveUpload = (options) => (options.client ?? client).get({
24000
+ security: [{
24001
+ key: "BearerAuth",
24002
+ scheme: "bearer",
24003
+ type: "http"
24004
+ }],
24005
+ url: "/file/v1/uploads/{upload_id}",
24006
+ ...options
24007
+ });
23002
24008
  var fileCreateSignedUpload = (options) => (options.client ?? client).post({
23003
24009
  security: [{
23004
24010
  key: "BearerAuth",
@@ -27704,6 +28710,217 @@ var mediaListUnderstandingsByLibrary = (options) => (options.client ?? client).g
27704
28710
  url: "/media/v1/libraries/{library_id}/understandings",
27705
28711
  ...options
27706
28712
  });
28713
+ var mediaCreateGeneration = (options) => (options.client ?? client).post({
28714
+ security: [{
28715
+ key: "media-BearerAuth",
28716
+ scheme: "bearer",
28717
+ type: "http"
28718
+ }],
28719
+ url: "/media/v1/libraries/{library_id}/generations",
28720
+ ...options,
28721
+ headers: {
28722
+ "Content-Type": "application/json",
28723
+ ...options.headers
28724
+ }
28725
+ });
28726
+ var mediaListJobs = (options) => (options.client ?? client).get({
28727
+ security: [{
28728
+ key: "media-BearerAuth",
28729
+ scheme: "bearer",
28730
+ type: "http"
28731
+ }],
28732
+ url: "/media/v1/libraries/{library_id}/jobs",
28733
+ ...options
28734
+ });
28735
+ var mediaCancelJob = (options) => (options.client ?? client).post({
28736
+ security: [{
28737
+ key: "media-BearerAuth",
28738
+ scheme: "bearer",
28739
+ type: "http"
28740
+ }],
28741
+ url: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
28742
+ ...options
28743
+ });
28744
+ var mediaSaveGenerationOutput = (options) => (options.client ?? client).post({
28745
+ security: [{
28746
+ key: "media-BearerAuth",
28747
+ scheme: "bearer",
28748
+ type: "http"
28749
+ }],
28750
+ url: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
28751
+ ...options,
28752
+ headers: {
28753
+ "Content-Type": "application/json",
28754
+ ...options.headers
28755
+ }
28756
+ });
28757
+ var mediaGetGenerationCapabilities = (options) => (options?.client ?? client).get({
28758
+ security: [{
28759
+ key: "media-BearerAuth",
28760
+ scheme: "bearer",
28761
+ type: "http"
28762
+ }],
28763
+ url: "/media/v1/generation/capabilities",
28764
+ ...options
28765
+ });
28766
+ var ontologyListTypes = (options) => (options?.client ?? client).get({
28767
+ security: [{
28768
+ key: "ontology-bearerAuth",
28769
+ scheme: "bearer",
28770
+ type: "http"
28771
+ }],
28772
+ url: "/ontology/v1/types",
28773
+ ...options
28774
+ });
28775
+ var ontologyRegisterType = (options) => (options.client ?? client).post({
28776
+ security: [{
28777
+ key: "ontology-bearerAuth",
28778
+ scheme: "bearer",
28779
+ type: "http"
28780
+ }],
28781
+ url: "/ontology/v1/types",
28782
+ ...options,
28783
+ headers: {
28784
+ "Content-Type": "application/json",
28785
+ ...options.headers
28786
+ }
28787
+ });
28788
+ var ontologyRetrieveType = (options) => (options.client ?? client).get({
28789
+ security: [{
28790
+ key: "ontology-bearerAuth",
28791
+ scheme: "bearer",
28792
+ type: "http"
28793
+ }],
28794
+ url: "/ontology/v1/types/{name}",
28795
+ ...options
28796
+ });
28797
+ var ontologyListNodes = (options) => (options?.client ?? client).get({
28798
+ security: [{
28799
+ key: "ontology-bearerAuth",
28800
+ scheme: "bearer",
28801
+ type: "http"
28802
+ }],
28803
+ url: "/ontology/v1/nodes",
28804
+ ...options
28805
+ });
28806
+ var ontologyCreateNode = (options) => (options.client ?? client).post({
28807
+ security: [{
28808
+ key: "ontology-bearerAuth",
28809
+ scheme: "bearer",
28810
+ type: "http"
28811
+ }],
28812
+ url: "/ontology/v1/nodes",
28813
+ ...options,
28814
+ headers: {
28815
+ "Content-Type": "application/json",
28816
+ ...options.headers
28817
+ }
28818
+ });
28819
+ var ontologyRetrieveNode = (options) => (options.client ?? client).get({
28820
+ security: [{
28821
+ key: "ontology-bearerAuth",
28822
+ scheme: "bearer",
28823
+ type: "http"
28824
+ }],
28825
+ url: "/ontology/v1/nodes/{node_id}",
28826
+ ...options
28827
+ });
28828
+ var ontologyUpdateNode = (options) => (options.client ?? client).patch({
28829
+ security: [{
28830
+ key: "ontology-bearerAuth",
28831
+ scheme: "bearer",
28832
+ type: "http"
28833
+ }],
28834
+ url: "/ontology/v1/nodes/{node_id}",
28835
+ ...options,
28836
+ headers: {
28837
+ "Content-Type": "application/json",
28838
+ ...options.headers
28839
+ }
28840
+ });
28841
+ var ontologyMergeNode = (options) => (options.client ?? client).post({
28842
+ security: [{
28843
+ key: "ontology-bearerAuth",
28844
+ scheme: "bearer",
28845
+ type: "http"
28846
+ }],
28847
+ url: "/ontology/v1/nodes/{node_id}/merge",
28848
+ ...options,
28849
+ headers: {
28850
+ "Content-Type": "application/json",
28851
+ ...options.headers
28852
+ }
28853
+ });
28854
+ var ontologyListRelations = (options) => (options?.client ?? client).get({
28855
+ security: [{
28856
+ key: "ontology-bearerAuth",
28857
+ scheme: "bearer",
28858
+ type: "http"
28859
+ }],
28860
+ url: "/ontology/v1/relations",
28861
+ ...options
28862
+ });
28863
+ var ontologyCreateRelation = (options) => (options.client ?? client).post({
28864
+ security: [{
28865
+ key: "ontology-bearerAuth",
28866
+ scheme: "bearer",
28867
+ type: "http"
28868
+ }],
28869
+ url: "/ontology/v1/relations",
28870
+ ...options,
28871
+ headers: {
28872
+ "Content-Type": "application/json",
28873
+ ...options.headers
28874
+ }
28875
+ });
28876
+ var ontologyRetrieveRelation = (options) => (options.client ?? client).get({
28877
+ security: [{
28878
+ key: "ontology-bearerAuth",
28879
+ scheme: "bearer",
28880
+ type: "http"
28881
+ }],
28882
+ url: "/ontology/v1/relations/{relation_id}",
28883
+ ...options
28884
+ });
28885
+ var ontologyInvalidateRelation = (options) => (options.client ?? client).post({
28886
+ security: [{
28887
+ key: "ontology-bearerAuth",
28888
+ scheme: "bearer",
28889
+ type: "http"
28890
+ }],
28891
+ url: "/ontology/v1/relations/{relation_id}/invalidate",
28892
+ ...options,
28893
+ headers: {
28894
+ "Content-Type": "application/json",
28895
+ ...options.headers
28896
+ }
28897
+ });
28898
+ var ontologyApplyChangeset = (options) => (options.client ?? client).post({
28899
+ security: [{
28900
+ key: "ontology-bearerAuth",
28901
+ scheme: "bearer",
28902
+ type: "http"
28903
+ }],
28904
+ url: "/ontology/v1/changesets",
28905
+ ...options,
28906
+ headers: {
28907
+ "Content-Type": "application/json",
28908
+ ...options.headers
28909
+ }
28910
+ });
28911
+ var ontologySearch = (options) => (options.client ?? client).post({
28912
+ security: [{
28913
+ key: "ontology-bearerAuth",
28914
+ scheme: "bearer",
28915
+ type: "http"
28916
+ }],
28917
+ url: "/ontology/v1/search",
28918
+ ...options,
28919
+ headers: {
28920
+ "Content-Type": "application/json",
28921
+ ...options.headers
28922
+ }
28923
+ });
27707
28924
  var getSandboxV1Sandboxes = (options) => (options?.client ?? client).get({
27708
28925
  querySerializer: { parameters: { state: { array: { explode: false } } } },
27709
28926
  security: [
@@ -29581,6 +30798,9 @@ function createAgent(transport) {
29581
30798
  create: bind(transport, computersCreate),
29582
30799
  delete: bind(transport, computersDelete),
29583
30800
  files: {
30801
+ convert: {
30802
+ create: bind(transport, computersFilesConvert)
30803
+ },
29584
30804
  list: bind(transport, computersFilesList),
29585
30805
  retrieveContent: bind(transport, computersFilesContent)
29586
30806
  },
@@ -30102,7 +31322,8 @@ function createFile(transport) {
30102
31322
  createSigned: bind(transport, fileCreateSignedUpload),
30103
31323
  parts: {
30104
31324
  create: bind(transport, (options) => fileAddUploadPart({ ...options, bodySerializer: multipartBodySerializer, headers: { "Content-Type": null, ...options.headers } }))
30105
- }
31325
+ },
31326
+ retrieve: bind(transport, fileRetrieveUpload)
30106
31327
  }
30107
31328
  };
30108
31329
  }
@@ -30154,6 +31375,11 @@ function createKnowledge(transport) {
30154
31375
  }
30155
31376
  function createMedia(transport) {
30156
31377
  return {
31378
+ generation: {
31379
+ capabilities: {
31380
+ list: bind(transport, mediaGetGenerationCapabilities)
31381
+ }
31382
+ },
30157
31383
  libraries: {
30158
31384
  assets: {
30159
31385
  batch: bind(transport, mediaBatchAssets),
@@ -30190,7 +31416,17 @@ function createMedia(transport) {
30190
31416
  folders: {
30191
31417
  list: bind(transport, mediaListFolders)
30192
31418
  },
31419
+ generations: {
31420
+ create: bind(transport, mediaCreateGeneration)
31421
+ },
30193
31422
  jobs: {
31423
+ cancel: bind(transport, mediaCancelJob),
31424
+ list: bindPage(transport, mediaListJobs),
31425
+ outputs: {
31426
+ save: {
31427
+ create: bind(transport, mediaSaveGenerationOutput)
31428
+ }
31429
+ },
30194
31430
  retrieve: bind(transport, mediaGetJob)
30195
31431
  },
30196
31432
  list: bindPage(transport, mediaListLibraries),
@@ -30315,6 +31551,38 @@ function createModel(transport) {
30315
31551
  }
30316
31552
  };
30317
31553
  }
31554
+ function createOntology(transport) {
31555
+ return {
31556
+ changesets: {
31557
+ create: bind(transport, ontologyApplyChangeset)
31558
+ },
31559
+ nodes: {
31560
+ create: bind(transport, ontologyCreateNode),
31561
+ list: bindPage(transport, ontologyListNodes),
31562
+ merge: {
31563
+ create: bind(transport, ontologyMergeNode)
31564
+ },
31565
+ retrieve: bind(transport, ontologyRetrieveNode),
31566
+ update: bind(transport, ontologyUpdateNode)
31567
+ },
31568
+ relations: {
31569
+ create: bind(transport, ontologyCreateRelation),
31570
+ invalidate: {
31571
+ create: bind(transport, ontologyInvalidateRelation)
31572
+ },
31573
+ list: bindPage(transport, ontologyListRelations),
31574
+ retrieve: bind(transport, ontologyRetrieveRelation)
31575
+ },
31576
+ search: {
31577
+ create: bind(transport, ontologySearch)
31578
+ },
31579
+ types: {
31580
+ create: bind(transport, ontologyRegisterType),
31581
+ list: bind(transport, ontologyListTypes),
31582
+ retrieve: bind(transport, ontologyRetrieveType)
31583
+ }
31584
+ };
31585
+ }
30318
31586
  function createOrganization(transport) {
30319
31587
  return {
30320
31588
  charges: {
@@ -30581,6 +31849,7 @@ var resourceFactories = {
30581
31849
  media: createMedia,
30582
31850
  meta: createMeta,
30583
31851
  model: createModel,
31852
+ ontology: createOntology,
30584
31853
  organization: createOrganization,
30585
31854
  sandbox: createSandbox,
30586
31855
  search: createSearch,
@@ -31654,6 +32923,26 @@ async function prepareMultipart(op, opts) {
31654
32923
  opts.body = body;
31655
32924
  }
31656
32925
 
32926
+ // src/core/pagination.ts
32927
+ var PAGE_TOKENS = /^(page_?token|next_?page_?token)$/i;
32928
+ function pageTokenField(op) {
32929
+ return op.query.find((field) => PAGE_TOKENS.test(field.name));
32930
+ }
32931
+ function nextPageToken(result) {
32932
+ const value = result;
32933
+ const token = value?.next_page_token ?? value?.nextPageToken ?? value?.next_cursor;
32934
+ return typeof token === "string" && token ? token : undefined;
32935
+ }
32936
+ function pageOf(result) {
32937
+ const value = result;
32938
+ const arrays = value && typeof value === "object" ? Object.values(value).filter(Array.isArray) : [];
32939
+ const data = Array.isArray(value?.data) ? value.data : Array.isArray(value?.items) ? value.items : arrays.length === 1 ? arrays[0] : undefined;
32940
+ if (!Array.isArray(data))
32941
+ return;
32942
+ const token = nextPageToken(result);
32943
+ return { items: data, ...token ? { token } : {} };
32944
+ }
32945
+
31657
32946
  // src/core/bind-args.ts
31658
32947
  var globalOptions = [
31659
32948
  { name: "org", type: "string" },
@@ -31869,7 +33158,7 @@ function bindArgs(parsed, op, data) {
31869
33158
  (opts.query ??= {})[key] ??= convert(String(globals[name]), { name, type: field.type, enum: field.enum });
31870
33159
  }
31871
33160
  }
31872
- if (globals.all && !op.pagination)
33161
+ if (globals.all && !op.pagination && !pageTokenField(op))
31873
33162
  throw new UsageError("--all requires a paginated operation");
31874
33163
  for (const p of op.pathParams)
31875
33164
  if (p !== target && opts.path?.[p.sdkName] === undefined)
@@ -31895,8 +33184,8 @@ function bindArgs(parsed, op, data) {
31895
33184
  }
31896
33185
 
31897
33186
  // src/core/help.ts
31898
- function describeOption(s) {
31899
- return `--${s.name}${s.type === "boolean" ? " [true|false]" : ` <${s.type}>`}${s.repeated ? " (repeatable)" : ""}${s.required ? " (required)" : ""}${s.enum ? ` [${s.enum.join(" | ")}]` : ""}${s.description ? ` — ${s.description.replace(/\s+/g, " ")}` : ""}`;
33187
+ function describeOption(s, required = s.required) {
33188
+ return `--${s.name}${s.type === "boolean" ? " [true|false]" : ` <${s.type}>`}${s.repeated ? " (repeatable)" : ""}${required ? " (required)" : ""}${s.enum ? ` [${s.enum.join(" | ")}]` : ""}${s.description ? ` — ${s.description.replace(/\s+/g, " ")}` : ""}`;
31900
33189
  }
31901
33190
  function example(command) {
31902
33191
  const target = targetParam(command.op);
@@ -31912,18 +33201,22 @@ function example(command) {
31912
33201
  args.push("--yes");
31913
33202
  return args.join(" ");
31914
33203
  }
33204
+ function fieldRequired(op, field, location) {
33205
+ return Boolean(field.required) && (location === "path" || location === "query" || Boolean(op.body?.required));
33206
+ }
31915
33207
  function help(commands, prefix, command) {
31916
33208
  if (command) {
31917
33209
  const target = targetParam(command.op);
33210
+ const parents = operationOptions(command.op).filter((s) => s.location === "path" && s.required).map((s) => ` --${s.name} <${s.field?.name ?? s.sdkName}>`).join("");
31918
33211
  return [
31919
- `praxis ${command.words.join(" ")}${target ? ` <${target.sdkName}>` : ""} [options]`,
33212
+ `praxis ${command.words.join(" ")}${parents}${target ? ` <${target.sdkName}>` : ""} [options]`,
31920
33213
  `SDK: ${command.op.resource}.${command.alias ?? command.op.method}`,
31921
33214
  `${command.op.http} ${command.op.path}`,
31922
33215
  ...target ? [`Position: <${target.sdkName}>${target.type ? ` <${target.type}>` : ""} (required target ID)`] : [],
31923
33216
  "",
31924
33217
  "Options:",
31925
33218
  ...target?.description ? [` <${target.sdkName}> — ${target.description.replace(/\s+/g, " ")}`] : [],
31926
- ...[...operationOptions(command.op), ...bodyDataOption(command.op), ...globalOptions].map((s) => ` ${describeOption(s)}`),
33219
+ ...[...operationOptions(command.op), ...bodyDataOption(command.op), ...globalOptions].map((s) => ` ${describeOption(s, s.required && fieldRequired(command.op, s, s.location ?? "query"))}`),
31927
33220
  ...command.op.body?.fields.filter((f) => !operationOptions(command.op).some((s) => s.location === "body" && s.field === f) && (f.type === "object" || f.type === "array" && !["string", "number", "integer", "boolean"].includes(f.itemType ?? ""))).map((f) => ` --data: ${f.name} (${f.type}${f.required ? ", required" : ""})`) ?? [],
31928
33221
  " -h is an alias of --help",
31929
33222
  "PRAXIS_ENV=develop|production (default: develop); no --env option.",
@@ -33291,9 +34584,11 @@ function renderHuman(result, ctx) {
33291
34584
  const details = result.details !== undefined ? JSON.stringify(result.details) : undefined;
33292
34585
  const detailsLine = details !== undefined ? ` details ${details.length > 2000 ? details.slice(0, 1999) + "…" : details}
33293
34586
  ` : "";
34587
+ const problemLine = problemLines(result.problem).map((line) => ` ${plain(line)}
34588
+ `).join("");
33294
34589
  return { stderr: err.red(`✗ ${plain(result.message)}`) + `
33295
34590
  ` + err.dim(` code ${plain(result.code)}${result.status !== undefined ? ` · ${result.status}` : ""} · env ${plain(result.env)}${result.request_id ? ` · request ${plain(result.request_id)}` : ""}`) + `
33296
- ` + detailsLine + (result.hint ? ` → ${plain(result.hint)}
34591
+ ` + detailsLine + problemLine + (result.hint ? ` → ${plain(result.hint)}
33297
34592
  ` : "") };
33298
34593
  }
33299
34594
  case "list":
@@ -33381,8 +34676,33 @@ ${usage ? `usage: ${JSON.stringify(usage)}
33381
34676
  }
33382
34677
 
33383
34678
  // src/output/render.ts
34679
+ var PROBLEM_HINTS = ["hint", "errors", "violations", "title", "type"];
34680
+ function serverProblem(raw) {
34681
+ const value = record(raw);
34682
+ const problem = {};
34683
+ for (const member of ["code", "detail", ...PROBLEM_HINTS, "status"]) {
34684
+ const entry = value[member];
34685
+ if (entry !== undefined && entry !== null)
34686
+ problem[member] = entry;
34687
+ }
34688
+ const adds = PROBLEM_HINTS.some((member) => Array.isArray(problem[member]) ? problem[member].length > 0 : problem[member] !== undefined);
34689
+ return adds ? problem : undefined;
34690
+ }
34691
+ function problemLines(problem) {
34692
+ const lines = [];
34693
+ for (const group of [problem?.errors, problem?.violations]) {
34694
+ for (const item of Array.isArray(group) ? group : []) {
34695
+ const entry = record(item);
34696
+ const where = scalar(entry.pointer ?? entry.field);
34697
+ const detail = scalar(entry.detail ?? entry.message ?? entry.reason);
34698
+ if (where || detail)
34699
+ lines.push(`${where ? `${where}: ` : ""}${detail}`);
34700
+ }
34701
+ }
34702
+ return lines;
34703
+ }
33384
34704
  function errorJSON(result, ctx) {
33385
- return JSON.stringify({ error: { code: result.code, ...result.details !== undefined ? { details: result.details } : {}, message: result.message, hint: result.hint ?? null, env: result.env, command: ctx.command ?? null, status: result.status ?? null, request_id: result.request_id ?? null, ...result.credential_source ? { credential_source: result.credential_source } : {} } }) + `
34705
+ return JSON.stringify({ error: { code: result.code, ...result.details !== undefined ? { details: result.details } : {}, message: result.message, hint: result.hint ?? null, env: result.env, command: ctx.command ?? null, status: result.status ?? null, request_id: result.request_id ?? null, ...result.problem !== undefined ? { problem: result.problem } : {}, ...result.credential_source ? { credential_source: result.credential_source } : {} } }) + `
33386
34706
  `;
33387
34707
  }
33388
34708
  function render(result, ctx) {
@@ -33538,6 +34858,8 @@ function errorInput(error, ctx) {
33538
34858
  const raw = record(sdk?.raw), nested = record(raw.error);
33539
34859
  const candidate = nested.details ?? raw.details;
33540
34860
  const details = candidate !== null && typeof candidate === "object" && !Array.isArray(candidate) ? candidate : undefined;
34861
+ const problem = serverProblem(Object.keys(nested).length ? nested : raw);
34862
+ const serverText = (value) => typeof value === "string" && value.trim() ? value : undefined;
33541
34863
  let message = error instanceof Error ? error.message : "Unexpected error";
33542
34864
  const prefix = message.match(/^([A-Z][A-Z0-9_]+):\s*/)?.[1];
33543
34865
  const code = error instanceof UsageError ? error.code : businessCode(raw.code) ?? businessCode(nested.code) ?? businessCode(raw.error_code) ?? prefix ?? businessCode(sdk?.code) ?? (sdk?.status ? `HTTP_${sdk.status}` : sdk ? "API_ERROR" : "RUNTIME_ERROR");
@@ -33549,11 +34871,14 @@ function errorInput(error, ctx) {
33549
34871
  if (stripped)
33550
34872
  message = `${humanize(code)}${message ? `: ${message}` : ""}`;
33551
34873
  const status = sdk?.status, request_id = sdk?.requestId;
34874
+ message = serverText(problem?.detail) ?? serverText(problem?.title) ?? message;
33552
34875
  const authFailure = status === 401 || ["NOT_LOGGED_IN", "UNAUTHENTICATED", "TOKEN_REVOKED", "LOGIN_FAILED"].includes(code);
33553
34876
  const source = ctx.credentialSource ?? "login";
33554
34877
  let hint = genericHint;
33555
34878
  if (error instanceof UsageError)
33556
34879
  hint = error.hint;
34880
+ else if (serverText(problem?.hint))
34881
+ hint = serverText(problem?.hint);
33557
34882
  else if (authFailure)
33558
34883
  hint = authHint(source);
33559
34884
  else if (status === 404)
@@ -33564,7 +34889,7 @@ function errorInput(error, ctx) {
33564
34889
  hint = "Rate limited; retry later.";
33565
34890
  else if (status !== undefined && status >= 500)
33566
34891
  hint = `Server error; retry later.${request_id ? ` Request id: ${request_id}.` : ""}`;
33567
- return { kind: "error", code, message, hint, ...details !== undefined ? { details } : {}, env: ctx.env, ...authFailure ? { credential_source: source } : {}, ...status !== undefined ? { status } : {}, ...request_id ? { request_id } : {} };
34892
+ return { kind: "error", code, message, hint, ...details !== undefined ? { details } : {}, ...problem !== undefined ? { problem } : {}, env: ctx.env, ...authFailure ? { credential_source: source } : {}, ...status !== undefined ? { status } : {}, ...request_id ? { request_id } : {} };
33568
34893
  }
33569
34894
 
33570
34895
  // src/output/progress.ts
@@ -33594,7 +34919,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
33594
34919
  }
33595
34920
 
33596
34921
  // src/main.ts
33597
- var version = "0.2.1-dev.da4893e";
34922
+ var version = "0.2.1-dev.df9eeaa";
33598
34923
  var commands = commandTree(operations);
33599
34924
  var manual = [...workflows.map((w) => w.words), [API_WORD]];
33600
34925
  function route(argv) {
@@ -33812,7 +35137,7 @@ Examples:
33812
35137
  let owner = client2;
33813
35138
  for (const part of op.resource.split("."))
33814
35139
  owner = owner[part];
33815
- const result = await owner[op.method](opts);
35140
+ let result = await owner[op.method](opts);
33816
35141
  const name2 = `${op.resource}.${op.method}`;
33817
35142
  const list = (items) => {
33818
35143
  const view = clientList(items, op, flags.limit, ctx.mode);
@@ -33826,7 +35151,21 @@ Examples:
33826
35151
  const cursor = result instanceof Page ? result.next_cursor : record(result).next_cursor ?? record(result).nextToken;
33827
35152
  if (typeof cursor === "string" && cursor)
33828
35153
  ctx.nextCommand = nextPageCommand(selected.command, parsed, cursor);
33829
- if (result instanceof Page) {
35154
+ const pageToken = pageTokenField(op), token = pageToken?.sdkName ?? pageToken?.name;
35155
+ const firstPage = flags.all && !(result instanceof Page) && token ? pageOf(result) : undefined;
35156
+ if (flags.all && !(result instanceof Page) && token && !firstPage)
35157
+ throw new UsageError(`--all cannot find the list in ${op.resource}.${op.method}'s response; page with --${token.replace(/_/g, "-")} instead`);
35158
+ if (firstPage) {
35159
+ const items = [...firstPage.items];
35160
+ const seen = new Set;
35161
+ for (let next = firstPage.token;next && !seen.has(next); next = pageOf(result)?.token) {
35162
+ seen.add(next);
35163
+ result = await owner[op.method]({ ...opts, query: { ...opts.query, [token]: next } });
35164
+ items.push(...pageOf(result)?.items ?? []);
35165
+ }
35166
+ ctx.nextCommand = undefined;
35167
+ emit({ kind: "list", ...list(items), ...ctx.mode === "json" ? { raw: { data: items, next_page_token: null } } : {}, nextCursor: null, op: name2 });
35168
+ } else if (result instanceof Page) {
33830
35169
  if (flags.all) {
33831
35170
  const items = [];
33832
35171
  for await (const item of result)
@@ -33922,7 +35261,7 @@ Examples:
33922
35261
  }
33923
35262
  }
33924
35263
  if (true)
33925
- process.exit(await main(process.argv.slice(2)));
35264
+ process.exitCode = await main(process.argv.slice(2));
33926
35265
  export {
33927
35266
  main
33928
35267
  };