@deepraxis/cli 0.2.1-dev.6454a0a → 0.2.1-dev.7d20ab6
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.
- package/COMMANDS.md +7 -5
- package/dist/praxis.js +135 -100
- package/package.json +1 -1
package/COMMANDS.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Generated by `bun run commands`. DO NOT EDIT.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
524 HTTP operations; 526 commands including aliases.
|
|
6
6
|
|
|
7
7
|
Environment: `PRAXIS_ENV=develop|production` (dev package defaults to `develop`; stable package defaults to `production`). No `--env` option.
|
|
8
8
|
|
|
@@ -288,7 +288,7 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
288
288
|
| `praxis api cut project create` | `cut.projects.create` | POST `/cut/v1/projects` | `--name` |
|
|
289
289
|
| `praxis api cut project delete <project_id>` | `cut.projects.delete` | DELETE `/cut/v1/projects/{project_id}` | |
|
|
290
290
|
| `praxis api cut project execute <project_id>` | `cut.projects.execute` | POST `/cut/v1/projects/{project_id}:execute` | `--script`, `--edit-id`, `--expected-revision` |
|
|
291
|
-
| `praxis api cut project export create` | `cut.projects.exports.create` | POST `/cut/v1/projects/{project_id}/exports` | `--project`, `--binding`, `--revision` |
|
|
291
|
+
| `praxis api cut project export create` | `cut.projects.exports.create` | POST `/cut/v1/projects/{project_id}/exports` | `--project`, `--folder`, `--name`, `--binding`, `--revision` |
|
|
292
292
|
| `praxis api cut project export list` | `cut.projects.exports.list` | GET `/cut/v1/projects/{project_id}/exports` | `--project`, `--page-size`, `--page-token`, `--filter`, `--order-by` |
|
|
293
293
|
| `praxis api cut project frame list` | `cut.projects.frames.list` | GET `/cut/v1/projects/{project_id}/frames` | `--project`, `--at`, `--scale`, `--revision` |
|
|
294
294
|
| `praxis api cut project get <project_id>` | `cut.projects.retrieve` | GET `/cut/v1/projects/{project_id}` | `--expand` |
|
|
@@ -356,7 +356,7 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
356
356
|
| `praxis api knowledge vector-store search <vector_store_id>` | `knowledge.vectorStores.search.create` | POST `/knowledge/v1/vector_stores/{vector_store_id}/search` | `--max-num-results`, `--rewrite-query`, `--next-page` |
|
|
357
357
|
| `praxis api knowledge vector-store segment get <chunk_id>` | `knowledge.vectorStores.segments.retrieve` | GET `/knowledge/v1/vector_stores/{vector_store_id}/segments/{chunk_id}` | `--vector-store` |
|
|
358
358
|
| `praxis api knowledge vector-store update <vector_store_id>` | `knowledge.vectorStores.update` | POST `/knowledge/v1/vector_stores/{vector_store_id}` | `--name` |
|
|
359
|
-
| `praxis api media library asset batch <library_id>` | `media.libraries.assets.batch` | POST `/media/v1/libraries/{library_id}/assets:batch` |
|
|
359
|
+
| `praxis api media library asset batch <library_id>` | `media.libraries.assets.batch` | POST `/media/v1/libraries/{library_id}/assets:batch` | `--reason` |
|
|
360
360
|
| `praxis api media library asset create` | `media.libraries.assets.create` | POST `/media/v1/libraries/{library_id}/assets` | `--library`, `--file`, `--public-id`, `--public-id-prefix`, `--display-name`, `--asset-folder`, `--use-filename`, `--unique-filename`, `--use-filename-as-display-name`, `--filename-override`, `--overwrite`, `--auto-tagging`, `--resource-type`, `--type` |
|
|
361
361
|
| `praxis api media library asset delete <asset_id>` | `media.libraries.assets.delete` | DELETE `/media/v1/libraries/{library_id}/assets/{asset_id}` | `--library` |
|
|
362
362
|
| `praxis api media library asset get <asset_id>` | `media.libraries.assets.retrieve` | GET `/media/v1/libraries/{library_id}/assets/{asset_id}` | `--library` |
|
|
@@ -365,7 +365,7 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
365
365
|
| `praxis api media library asset reprocess <asset_id>` | `media.libraries.assets.reprocess.create` | POST `/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess` | `--library`, `--kinds` |
|
|
366
366
|
| `praxis api media library asset understanding list` | `media.libraries.assets.understandings.list` | GET `/media/v1/libraries/{library_id}/assets/{asset_id}/understandings` | `--library`, `--asset`, `--include-superseded`, `--kind`, `--param-cursor`, `--param-limit` |
|
|
367
367
|
| `praxis api media library asset update <asset_id>` | `media.libraries.assets.update` | PATCH `/media/v1/libraries/{library_id}/assets/{asset_id}` | `--library`, `--display-name`, `--asset-folder`, `--tags` |
|
|
368
|
-
| `praxis api media library batch create` | `media.libraries.batches.create` | POST `/media/v1/libraries/{library_id}/batches` | `--library` |
|
|
368
|
+
| `praxis api media library batch create` | `media.libraries.batches.create` | POST `/media/v1/libraries/{library_id}/batches` | `--library`, `--reason` |
|
|
369
369
|
| `praxis api media library batch get <job_id>` | `media.libraries.batches.retrieve` | GET `/media/v1/libraries/{library_id}/batches/{job_id}` | `--library` |
|
|
370
370
|
| `praxis api media library create` | `media.libraries.create` | POST `/media/v1/libraries` | `--name` |
|
|
371
371
|
| `praxis api media library delete <library_id>` | `media.libraries.delete` | DELETE `/media/v1/libraries/{library_id}` | |
|
|
@@ -381,7 +381,9 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
381
381
|
| `praxis api media library search-expression` | `media.libraries.search.expression.create` | POST `/media/v1/libraries/{library_id}/search/expression` | `--library`, `--expression`, `--max-results`, `--next-cursor`, `--with-field`, `--aggregate` |
|
|
382
382
|
| `praxis api media library search-semantic` | `media.libraries.search.semantic.create` | POST `/media/v1/libraries/{library_id}/search/semantic` | `--library`, `--query`, `--filter`, `--top-k`, `--mode` |
|
|
383
383
|
| `praxis api media library search-visual` | `media.libraries.search.visual.create` | POST `/media/v1/libraries/{library_id}/search/visual` | `--library`, `--asset-id`, `--top-k`, `--filter` |
|
|
384
|
-
| `praxis api media library
|
|
384
|
+
| `praxis api media library understanding get-failure-summary` | `media.libraries.understandings.retrieveFailureSummary` | GET `/media/v1/libraries/{library_id}/understandings/failure_summary` | `--library` |
|
|
385
|
+
| `praxis api media library understanding list` | `media.libraries.understandings.list` | GET `/media/v1/libraries/{library_id}/understandings` | `--library`, `--folder`, `--kinds`, `--param-cursor`, `--param-limit` |
|
|
386
|
+
| `praxis api media library update <library_id>` | `media.libraries.update` | PATCH `/media/v1/libraries/{library_id}` | `--hotwords`, `--name` |
|
|
385
387
|
| `praxis api meta doc get <path>` | `meta.docs.retrieve` | GET `/meta/v1/docs/{path}` | `--lang` |
|
|
386
388
|
| `praxis api meta doc search` | `meta.docs.search` | GET `/meta/v1/docs/search` | `--q`, `--param-limit`, `--lang` |
|
|
387
389
|
| `praxis api meta health get` | `meta.health.retrieve` | GET `/meta/v1/health` | |
|
package/dist/praxis.js
CHANGED
|
@@ -9962,7 +9962,7 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
9962
9962
|
resource: "cut.projects.analysis",
|
|
9963
9963
|
method: "create",
|
|
9964
9964
|
summary: "Analyze project media",
|
|
9965
|
-
description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible.",
|
|
9965
|
+
description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible. Silence measures transcript-based speech pauses, not music or loudness. A completed transcript without words returns ready with empty segments and reason no_speech; no completed transcript returns unsupported with reason no_transcript. A failed transcription remains failed.",
|
|
9966
9966
|
http: "POST",
|
|
9967
9967
|
path: "/cut/v1/projects/{project_id}/analysis",
|
|
9968
9968
|
streaming: "no",
|
|
@@ -10133,6 +10133,18 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10133
10133
|
body: {
|
|
10134
10134
|
required: true,
|
|
10135
10135
|
fields: [
|
|
10136
|
+
{
|
|
10137
|
+
name: "folder",
|
|
10138
|
+
type: "string",
|
|
10139
|
+
required: false,
|
|
10140
|
+
description: "Optional destination path within the bound media library; omitted uses its default folder."
|
|
10141
|
+
},
|
|
10142
|
+
{
|
|
10143
|
+
name: "name",
|
|
10144
|
+
type: "string",
|
|
10145
|
+
required: false,
|
|
10146
|
+
description: "Nonempty display name, frozen with the export. Path separators and control characters become hyphens; limited to 200 characters. Omitted uses project name and timestamp."
|
|
10147
|
+
},
|
|
10136
10148
|
{
|
|
10137
10149
|
name: "output",
|
|
10138
10150
|
type: "object",
|
|
@@ -10158,7 +10170,7 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10158
10170
|
resource: "cut.projects.frames",
|
|
10159
10171
|
method: "list",
|
|
10160
10172
|
summary: "Render preview frames",
|
|
10161
|
-
description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. Decode its base64 payload to save the image. Codemode returns at most four images per call, so request at most four times when reviewing there.",
|
|
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.",
|
|
10162
10174
|
http: "GET",
|
|
10163
10175
|
path: "/cut/v1/projects/{project_id}/frames",
|
|
10164
10176
|
streaming: "no",
|
|
@@ -10181,7 +10193,7 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10181
10193
|
name: "scale",
|
|
10182
10194
|
type: "number",
|
|
10183
10195
|
required: false,
|
|
10184
|
-
description: "
|
|
10196
|
+
description: "Image size multiplier, default 0.25, greater than zero and at most 0.5. Larger values return INVALID_PARAMS; pixel-area limits may reduce actual dimensions, reported as width and height."
|
|
10185
10197
|
},
|
|
10186
10198
|
{
|
|
10187
10199
|
name: "revision",
|
|
@@ -10373,88 +10385,7 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10373
10385
|
resource: "cut.projects",
|
|
10374
10386
|
method: "execute",
|
|
10375
10387
|
summary: "Execute editing script",
|
|
10376
|
-
description: `Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: \`const t = AddTrack("video"); Insert(t, {type: "color", color: "#123456", start: 0, length: 3}); Print(t);\`
|
|
10377
|
-
|
|
10378
|
-
### Script function reference
|
|
10379
|
-
|
|
10380
|
-
Functions are synchronous globals; do not import them. \`project\` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. Reads see earlier writes in the same script.
|
|
10381
|
-
|
|
10382
|
-
\`\`\`ts
|
|
10383
|
-
GetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;
|
|
10384
|
-
GetItem(id: ClipId): ItemView;
|
|
10385
|
-
FindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];
|
|
10386
|
-
GetMedia(ref: MediaRef): MediaInfo;
|
|
10387
|
-
GetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];
|
|
10388
|
-
GetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];
|
|
10389
|
-
Insert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;
|
|
10390
|
-
Update(id: ClipId, patch: ItemPatchView): void;
|
|
10391
|
-
Delete(id: ClipId, o?: { ripple?: boolean }): void;
|
|
10392
|
-
Split(id: ClipId, at: number): ClipId;
|
|
10393
|
-
Trim(id: ClipId, edge: "in" | "out", delta: number, o?: { ripple?: boolean }): void;
|
|
10394
|
-
Move(id: ClipId, start: number, track?: TrackId): void;
|
|
10395
|
-
RippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;
|
|
10396
|
-
AddTrack(kind: "video" | "audio" | "caption", init?: { name?: string }, index?: number): TrackId;
|
|
10397
|
-
UpdateTrack(id: TrackId, patch: TrackPatch): void;
|
|
10398
|
-
DeleteTrack(id: TrackId): void;
|
|
10399
|
-
SetSettings(patch: Partial<ProjectSettingsView>): void;
|
|
10400
|
-
AddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle>; maxChars?: number }): ClipId[];
|
|
10401
|
-
SetMarker(at: number, label: string): string;
|
|
10402
|
-
Print(...values: unknown[]): void;
|
|
10403
|
-
Preview(at: number[]): void;
|
|
10404
|
-
\`\`\`
|
|
10405
|
-
|
|
10406
|
-
| Functions | Behavior and arguments |
|
|
10407
|
-
| --- | --- |
|
|
10408
|
-
| GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, sourceIn/sourceOut, text and offline reason. GetTimeline returns duration and tracks (id, kind, name, index, locked, items); from/to and tracks narrow the read. |
|
|
10409
|
-
| FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |
|
|
10410
|
-
| GetMedia | Read metadata for \`{libraryId, assetId}\` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |
|
|
10411
|
-
| GetTranscript, GetAnalysis | Read available transcript words or silence/filler/scenes segments. Transcript filter from/to is seconds; returned word and segment from/to values are source microseconds (divide by 1,000,000 for editing). Words contain text and optional speaker/filler; segments may include label/confidence. Request analysis first if unavailable. |
|
|
10412
|
-
| Insert, Update, Delete | Insert returns the new clip ID; Update changes supplied fields; Delete removes the clip. Optional ripple on Insert/Delete closes or opens space on the track. |
|
|
10413
|
-
| Split, Trim, Move | Split at a timeline position and return the new right-hand clip ID. Trim changes the in or out edge by delta seconds. Move sets the timeline start and optionally a new track. |
|
|
10414
|
-
| RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |
|
|
10415
|
-
| AddTrack, UpdateTrack, DeleteTrack | Add video/audio/caption tracks; index selects layer order (0 is top). TrackPatch supports name, locked, hidden, muted, gainDb and style as appropriate to track kind. |
|
|
10416
|
-
| SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |
|
|
10417
|
-
| AddCaptionsFromTranscript | Create captions from an audio/video clip's kept words. Optional maxChars is 1–1000, default 16; style updates the caption track. Returns caption IDs. |
|
|
10418
|
-
| SetMarker | Add a label at a timeline time and return its ID. |
|
|
10419
|
-
| Print, Preview | Print appends text to prints. Preview requests up to eight times total per execute and puts images in the result's frames. Each url is an inline PNG data URL, not an HTTP image link. Decode the base64 payload to save an image. Codemode returns at most four images per call; request at most four times there. |
|
|
10420
|
-
|
|
10421
|
-
#### Insert fields (ItemInit)
|
|
10422
|
-
|
|
10423
|
-
Every item requires \`type\` and \`start\`. Times used for editing are seconds and snap to the project frame rate: start, length, sourceIn, fadeIn/fadeOut, transition length, keyframe at, reveal delay/stagger/duration. Keyframe and reveal times are relative to the clip start. Video/audio may omit length to use the remaining source duration; other types require length.
|
|
10424
|
-
|
|
10425
|
-
| type | Required fields beyond type/start | Optional fields |
|
|
10426
|
-
| --- | --- | --- |
|
|
10427
|
-
| video | media | length, sourceIn, volumeDb, transform, fit, animate, transitionIn, transitionOut |
|
|
10428
|
-
| image | media, length | transform, fit, animate, transitionIn, transitionOut |
|
|
10429
|
-
| text | text, length | style, transform, reveal, animate, transitionIn, transitionOut |
|
|
10430
|
-
| color | color, length | transform, fill, animate, transitionIn, transitionOut |
|
|
10431
|
-
| shape | shape, length, width, height, fill | radius, stroke, transform, animate, transitionIn, transitionOut |
|
|
10432
|
-
| audio | media | length, sourceIn, volumeDb, fadeIn, fadeOut, transitionIn, transitionOut |
|
|
10433
|
-
| caption | text, length | — |
|
|
10434
|
-
|
|
10435
|
-
Video tracks accept video/image/text/color/shape; audio and caption tracks accept their corresponding type. Media is \`{libraryId: string, assetId: string}\` from a bound library. sourceIn defaults to 0, volumeDb to 0 dB, audio fades to 0 seconds. fit defaults to contain: contain fits the whole image, cover fills and crops, fill stretches, none keeps native dimensions.
|
|
10436
|
-
|
|
10437
|
-
| Field | Value |
|
|
10438
|
-
| --- | --- |
|
|
10439
|
-
| transform | Partial \`{x, y, scale, rotation, opacity, crop, blur}\`. x/y are normalized canvas center coordinates (default 0.5); scale 1 is fitted size; rotation is degrees (default 0); opacity is 0–1 (default 1). crop is \`{top,right,bottom,left}\`. blur is 0–100 pixels at 1080-pixel frame height. |
|
|
10440
|
-
| style | Partial \`{fontFamily, fontSize, fontWeight, color, stroke, background, align, maxWidth}\`. fontFamily: Geist or Noto Sans SC (default); fontSize defaults to 48; fontWeight: 400 (default), 500 or 700; color defaults to #FFFFFF; align: left, center (default), right; maxWidth is a fraction of canvas width (default 0.9). stroke is \`{color,width}\`. Caption style additionally supports position (top/middle/bottom), margin (0–0.4 of canvas height), highlightColor and maxLines: 2. |
|
|
10441
|
-
| animate | An object keyed by x, y, scale, rotation, opacity or blur. Each value is an array of \`{at: number, value: number, ease?: Ease}\` sorted by at with distinct frame-snapped times. Values hold before the first and after the last keyframe, overriding the static transform. |
|
|
10442
|
-
| Ease | linear, in, out, inOut, \`{bezier: [x1,y1,x2,y2]}\` or \`{spring: {stiffness, damping, mass?}}\`. Easing shapes the segment arriving at that keyframe; springs may overshoot. |
|
|
10443
|
-
| reveal | \`{by, delay?: number, stagger: number, duration: number, from: {y?, opacity?, scale?, blur?}, ease?: Ease}\`. by selects char, word or line. Unit k starts at delay + k * stagger and takes duration seconds to reach its resting state; from.y is a fraction of font size. |
|
|
10444
|
-
| fill | A color string (#RRGGBB or #RRGGBBAA), \`{linear: {angle, stops: [{at,color}, ...]}}\` or \`{radial: {stops: [{at,color}, ...]}}\`. Stop positions are 0–1; angle is degrees, 0 left to right. On color clips, fill replaces color when supplied. |
|
|
10445
|
-
| shape, width, height, radius, stroke | shape is rect or ellipse. width/height are fractions of canvas width/height before scaling. radius rounds rect corners in pixels at 1080-pixel frame height. stroke is \`{color: string, width: number}\`. |
|
|
10446
|
-
| transitionIn, transitionOut | \`{kind, length: number}\` at the clip's beginning/end. length is seconds. fade changes opacity; dissolve blends; push_left/push_right move horizontally; wipe_left reveals horizontally. |
|
|
10447
|
-
|
|
10448
|
-
#### Update fields (ItemPatchView)
|
|
10449
|
-
|
|
10450
|
-
All fields are optional; use only fields relevant to the item's type. Supported fields: start, length, sourceIn, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, animate, reveal, fill, stroke, shape, width, height, radius, transitionIn, transitionOut. Values and units match Insert. Set animate, reveal, fill, stroke, transitionIn or transitionOut to null to remove that effect; omitting a field preserves it. For example: \`Update(id, {volumeDb: -12})\` or \`Update(id, {transitionIn: null})\`.
|
|
10451
|
-
|
|
10452
|
-
#### Script names versus HTTP response names
|
|
10453
|
-
|
|
10454
|
-
Use camelCase inside scripts, including nested objects. HTTP request/response JSON outside script source uses snake_case. Map media.library_id → media.libraryId, media.asset_id → media.assetId, source_in → sourceIn, volume_db → volumeDb, fade_in/fade_out → fadeIn/fadeOut, transition_in/transition_out → transitionIn/transitionOut, font_family/font_size/font_weight/max_width → fontFamily/fontSize/fontWeight/maxWidth, gain_db → gainDb, highlight_color/max_lines → highlightColor/maxLines. Fields such as animate, reveal, fill, stroke, at and length retain their spelling. GetTimeline/GetItem already return camelCase compact views; the expanded retrieveTimeline HTTP response is not an Insert object.
|
|
10455
|
-
|
|
10456
|
-
Unrecognized script fields fail with OPS_REJECTED and rejection code UNKNOWN_FIELD; snake_case mistakes suggest the corresponding camelCase name. The error message lists each rejection's #opIndex, code and reason. Correct the named fields and retry the saved edit; do not assume an ignored field applied an effect.
|
|
10457
|
-
`,
|
|
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',
|
|
10458
10389
|
http: "POST",
|
|
10459
10390
|
path: "/cut/v1/projects/{project_id}:execute",
|
|
10460
10391
|
streaming: "no",
|
|
@@ -11641,7 +11572,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11641
11572
|
resource: "file.files.contentLinks",
|
|
11642
11573
|
method: "revoke",
|
|
11643
11574
|
summary: "Revoke a file content link",
|
|
11644
|
-
description: 'Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within
|
|
11575
|
+
description: 'Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within 15 minutes; the file and other links remain available. Only current IAM capability tokens can be revoked; legacy content links expire at the migration deadline. Example body: {"token":"<token from /c/>"}.',
|
|
11645
11576
|
http: "POST",
|
|
11646
11577
|
path: "/file/v1/files/{file_id}/content_links:revoke",
|
|
11647
11578
|
streaming: "no",
|
|
@@ -11670,7 +11601,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11670
11601
|
resource: "file.files.contentUrl",
|
|
11671
11602
|
method: "create",
|
|
11672
11603
|
summary: "Create a download URL",
|
|
11673
|
-
description: `Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to
|
|
11604
|
+
description: `Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to 900 seconds and is at most 604800 seconds. Issuance requires the same credential and file-read access as files.retrieveContent; a processing file returns 409 FILE_NOT_READY, so poll files.retrieve until active before retrying. A missing, expired or other-organization file returns 404. Each issuance creates a new link. OpenAI Files has no signed download URL; this follows S3 presigned GET semantics. Example body: {"ttl_seconds":3600}.`,
|
|
11674
11605
|
http: "POST",
|
|
11675
11606
|
path: "/file/v1/files/{file_id}/content_url",
|
|
11676
11607
|
streaming: "no",
|
|
@@ -11690,7 +11621,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11690
11621
|
name: "ttl_seconds",
|
|
11691
11622
|
type: "integer",
|
|
11692
11623
|
required: false,
|
|
11693
|
-
description: "Download link lifetime in seconds, from 1 through 604800; omitted means
|
|
11624
|
+
description: "Download link lifetime in seconds, from 1 through 604800; omitted means 900. This does not change the file's own expiry."
|
|
11694
11625
|
}
|
|
11695
11626
|
]
|
|
11696
11627
|
}
|
|
@@ -12804,7 +12735,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12804
12735
|
resource: "media.libraries",
|
|
12805
12736
|
method: "update",
|
|
12806
12737
|
summary: "Update library",
|
|
12807
|
-
description: "Update an active library
|
|
12738
|
+
description: "Update an active library. Set hotwords for spelling evidence in subsequent transcripts; [] disables inferred vocabulary. Transcript understanding calls the timestamped ASR, optional reference ASR and correction model through the existing metered model path. Reprocess assets to apply new settings to existing transcripts.",
|
|
12808
12739
|
http: "PATCH",
|
|
12809
12740
|
path: "/media/v1/libraries/{library_id}",
|
|
12810
12741
|
streaming: "no",
|
|
@@ -12820,6 +12751,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12820
12751
|
body: {
|
|
12821
12752
|
required: true,
|
|
12822
12753
|
fields: [
|
|
12754
|
+
{
|
|
12755
|
+
name: "hotwords",
|
|
12756
|
+
type: "array",
|
|
12757
|
+
itemType: "string",
|
|
12758
|
+
required: false,
|
|
12759
|
+
description: "Correction vocabulary, at most 200 nonblank terms of at most 32 Unicode characters each. Omitted on an unconfigured library: correction derives up to 200 distinct names from the library name and every folder level, excluding generic names such as 原始素材 and 混剪成品. An explicit empty array disables this vocabulary. Updating affects subsequent understanding and explicit reprocessing, not existing results."
|
|
12760
|
+
},
|
|
12823
12761
|
{
|
|
12824
12762
|
name: "models",
|
|
12825
12763
|
type: "object",
|
|
@@ -13023,7 +12961,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13023
12961
|
resource: "media.libraries.assets.import",
|
|
13024
12962
|
method: "create",
|
|
13025
12963
|
summary: "Import file",
|
|
13026
|
-
description: "Copy
|
|
12964
|
+
description: "Copy a File into an independent Media asset. Defaults to public delivery (type=upload); use type=authenticated for private originals and derivatives. Deleting the source File does not delete this copy.",
|
|
13027
12965
|
http: "POST",
|
|
13028
12966
|
path: "/media/v1/libraries/{library_id}/assets/import",
|
|
13029
12967
|
streaming: "no",
|
|
@@ -13286,7 +13224,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13286
13224
|
resource: "media.libraries.assets.understandings",
|
|
13287
13225
|
method: "list",
|
|
13288
13226
|
summary: "List understandings",
|
|
13289
|
-
description: "List an asset
|
|
13227
|
+
description: "List understanding results for an asset, ordered by creation time. Use the cursor to continue; include_superseded also returns replaced records. The optional shots array contains current-version shot boundaries and per-shot captions, scene, location guesses, visible text and confidence flags; it is absent on legacy records. Location guesses and folder mismatch are unverified hints. Correction-enabled transcripts expose text_original, corrected text and a correction audit. Their timed data array remains suitable for subtitles. Reference failure is marked missing; correction failure returns the original verbatim. Model inference uses the existing metered model path.",
|
|
13290
13228
|
http: "GET",
|
|
13291
13229
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}/understandings",
|
|
13292
13230
|
streaming: "no",
|
|
@@ -13318,10 +13256,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13318
13256
|
"tags",
|
|
13319
13257
|
"ocr",
|
|
13320
13258
|
"transcript",
|
|
13321
|
-
"frame"
|
|
13259
|
+
"frame",
|
|
13260
|
+
"overview",
|
|
13261
|
+
"embedding"
|
|
13322
13262
|
],
|
|
13323
13263
|
required: false,
|
|
13324
|
-
description: "
|
|
13264
|
+
description: "Return one output kind: caption is a visual description, tags are generated labels, ocr is visible text, transcript is speech, frame is a video shot, overview is a video summary, and embedding reports a failed embedding step."
|
|
13325
13265
|
},
|
|
13326
13266
|
{
|
|
13327
13267
|
name: "cursor",
|
|
@@ -13341,7 +13281,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13341
13281
|
resource: "media.libraries.assets",
|
|
13342
13282
|
method: "batch",
|
|
13343
13283
|
summary: "Batch assets alias",
|
|
13344
|
-
description:
|
|
13284
|
+
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 rerun. Omit kinds to inspect all failed steps, or supply kinds to narrow them. Unsupported, permanent and completed steps remain unchanged and do not block other retryable steps on the same asset. Assets without any selected retryable failed 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"}}.',
|
|
13345
13285
|
http: "POST",
|
|
13346
13286
|
path: "/media/v1/libraries/{library_id}/assets:batch",
|
|
13347
13287
|
streaming: "no",
|
|
@@ -13362,6 +13302,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13362
13302
|
type: "object",
|
|
13363
13303
|
required: true,
|
|
13364
13304
|
description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
|
|
13305
|
+
},
|
|
13306
|
+
{
|
|
13307
|
+
name: "reason",
|
|
13308
|
+
type: "string",
|
|
13309
|
+
required: false,
|
|
13310
|
+
description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
|
|
13365
13311
|
}
|
|
13366
13312
|
]
|
|
13367
13313
|
}
|
|
@@ -13370,7 +13316,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13370
13316
|
resource: "media.libraries.batches",
|
|
13371
13317
|
method: "create",
|
|
13372
13318
|
summary: "Create batch",
|
|
13373
|
-
description:
|
|
13319
|
+
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 rerun. Omit kinds to inspect all failed steps, or supply kinds to narrow them. Unsupported, permanent and completed steps remain unchanged and do not block other retryable steps on the same asset. Assets without any selected retryable failed 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"}}.',
|
|
13374
13320
|
http: "POST",
|
|
13375
13321
|
path: "/media/v1/libraries/{library_id}/batches",
|
|
13376
13322
|
streaming: "no",
|
|
@@ -13391,6 +13337,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13391
13337
|
type: "object",
|
|
13392
13338
|
required: true,
|
|
13393
13339
|
description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
|
|
13340
|
+
},
|
|
13341
|
+
{
|
|
13342
|
+
name: "reason",
|
|
13343
|
+
type: "string",
|
|
13344
|
+
required: false,
|
|
13345
|
+
description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
|
|
13394
13346
|
}
|
|
13395
13347
|
]
|
|
13396
13348
|
}
|
|
@@ -13422,7 +13374,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13422
13374
|
resource: "media.libraries.deliveryTokens",
|
|
13423
13375
|
method: "create",
|
|
13424
13376
|
summary: "Create delivery token",
|
|
13425
|
-
description: "Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is
|
|
13377
|
+
description: "Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is 900 seconds; narrow acl and expires_in before sharing. Anyone holding the token can read matching paths until expires_at.",
|
|
13426
13378
|
http: "POST",
|
|
13427
13379
|
path: "/media/v1/libraries/{library_id}/delivery_tokens",
|
|
13428
13380
|
streaming: "no",
|
|
@@ -13448,7 +13400,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13448
13400
|
name: "expires_in",
|
|
13449
13401
|
type: "integer",
|
|
13450
13402
|
required: false,
|
|
13451
|
-
description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to
|
|
13403
|
+
description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 900."
|
|
13452
13404
|
}
|
|
13453
13405
|
]
|
|
13454
13406
|
}
|
|
@@ -13504,7 +13456,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13504
13456
|
resource: "media.libraries.folders",
|
|
13505
13457
|
method: "list",
|
|
13506
13458
|
summary: "List folders",
|
|
13507
|
-
description: "
|
|
13459
|
+
description: "undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.",
|
|
13508
13460
|
http: "GET",
|
|
13509
13461
|
path: "/media/v1/libraries/{library_id}/folders",
|
|
13510
13462
|
streaming: "no",
|
|
@@ -13659,7 +13611,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13659
13611
|
name: "expression",
|
|
13660
13612
|
type: "string",
|
|
13661
13613
|
required: false,
|
|
13662
|
-
description: 'Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets. For business metadata use context.sku=KETTLE-RED AND context.revision=2; request with_field: ["context"] to include context. 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.'
|
|
13614
|
+
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. failure_code=UPSTREAM_FAILED selects assets with a current failed understanding carrying that code; combine with processing_state=failed or processing_state=partial.'
|
|
13663
13615
|
},
|
|
13664
13616
|
{
|
|
13665
13617
|
name: "sort_by",
|
|
@@ -13805,6 +13757,67 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13805
13757
|
]
|
|
13806
13758
|
}
|
|
13807
13759
|
},
|
|
13760
|
+
{
|
|
13761
|
+
resource: "media.libraries.understandings",
|
|
13762
|
+
method: "list",
|
|
13763
|
+
summary: "List understanding results across a library",
|
|
13764
|
+
description: "Read current understanding entries across one library without fetching every asset separately. Use library_id from creation or listing. folder includes descendants; kinds is a comma-separated list of output kinds. Entries are ordered by asset_id and then understanding id. Continue with next_cursor and the same folder and kinds; limit defaults to 100 and cannot exceed 100. Superseded, deleted and old-version entries are excluded. During historical backfill, this method returns 503 CAPACITY rather than incomplete pages; poll failureSummary until counts_complete is true, then start pagination. Example: GET /media/v1/libraries/lib_example/understandings?folder=travel&kinds=caption,transcript&limit=100.",
|
|
13765
|
+
http: "GET",
|
|
13766
|
+
path: "/media/v1/libraries/{library_id}/understandings",
|
|
13767
|
+
streaming: "no",
|
|
13768
|
+
pagination: true,
|
|
13769
|
+
pathParams: [
|
|
13770
|
+
{
|
|
13771
|
+
name: "library_id",
|
|
13772
|
+
sdkName: "library_id",
|
|
13773
|
+
description: "Library ID returned by creation."
|
|
13774
|
+
}
|
|
13775
|
+
],
|
|
13776
|
+
query: [
|
|
13777
|
+
{
|
|
13778
|
+
name: "folder",
|
|
13779
|
+
type: "string",
|
|
13780
|
+
required: false,
|
|
13781
|
+
description: "Folder path including all descendants; omitted or empty selects the entire library."
|
|
13782
|
+
},
|
|
13783
|
+
{
|
|
13784
|
+
name: "kinds",
|
|
13785
|
+
type: "string",
|
|
13786
|
+
required: false,
|
|
13787
|
+
description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, embedding. Omit or empty to include every kind."
|
|
13788
|
+
},
|
|
13789
|
+
{
|
|
13790
|
+
name: "cursor",
|
|
13791
|
+
type: "string",
|
|
13792
|
+
required: false,
|
|
13793
|
+
description: "Cursor from the previous next_cursor."
|
|
13794
|
+
},
|
|
13795
|
+
{
|
|
13796
|
+
name: "limit",
|
|
13797
|
+
type: "integer",
|
|
13798
|
+
required: false,
|
|
13799
|
+
description: "Maximum entries in this page, from 1 through 100; defaults to 100."
|
|
13800
|
+
}
|
|
13801
|
+
]
|
|
13802
|
+
},
|
|
13803
|
+
{
|
|
13804
|
+
resource: "media.libraries.understandings",
|
|
13805
|
+
method: "retrieveFailureSummary",
|
|
13806
|
+
summary: "Summarize understanding failures",
|
|
13807
|
+
description: "Inspect current understanding failures before retrying. Use library_id from library creation or listing. Groups include code, output kind, actual producer model, retryability and up to five sample asset IDs. At most 1024 detailed groups plus two overflow groups are returned; overflow groups separate retryable and unrecoverable entries and mark overflow=true. Unknown failure codes remain retryable. Historical counts are provisional while counts_complete is false. Example: GET /media/v1/libraries/lib_example/understandings/failure_summary.",
|
|
13808
|
+
http: "GET",
|
|
13809
|
+
path: "/media/v1/libraries/{library_id}/understandings/failure_summary",
|
|
13810
|
+
streaming: "no",
|
|
13811
|
+
pagination: false,
|
|
13812
|
+
pathParams: [
|
|
13813
|
+
{
|
|
13814
|
+
name: "library_id",
|
|
13815
|
+
sdkName: "library_id",
|
|
13816
|
+
description: "Library ID returned by creation."
|
|
13817
|
+
}
|
|
13818
|
+
],
|
|
13819
|
+
query: []
|
|
13820
|
+
},
|
|
13808
13821
|
{
|
|
13809
13822
|
resource: "meta.docs",
|
|
13810
13823
|
method: "search",
|
|
@@ -27611,6 +27624,24 @@ var mediaCreateDeliveryToken = (options) => (options.client ?? client).post({
|
|
|
27611
27624
|
...options.headers
|
|
27612
27625
|
}
|
|
27613
27626
|
});
|
|
27627
|
+
var mediaUnderstandingFailureSummary = (options) => (options.client ?? client).get({
|
|
27628
|
+
security: [{
|
|
27629
|
+
key: "media-BearerAuth",
|
|
27630
|
+
scheme: "bearer",
|
|
27631
|
+
type: "http"
|
|
27632
|
+
}],
|
|
27633
|
+
url: "/media/v1/libraries/{library_id}/understandings/failure_summary",
|
|
27634
|
+
...options
|
|
27635
|
+
});
|
|
27636
|
+
var mediaListUnderstandingsByLibrary = (options) => (options.client ?? client).get({
|
|
27637
|
+
security: [{
|
|
27638
|
+
key: "media-BearerAuth",
|
|
27639
|
+
scheme: "bearer",
|
|
27640
|
+
type: "http"
|
|
27641
|
+
}],
|
|
27642
|
+
url: "/media/v1/libraries/{library_id}/understandings",
|
|
27643
|
+
...options
|
|
27644
|
+
});
|
|
27614
27645
|
var getSandboxV1Sandboxes = (options) => (options?.client ?? client).get({
|
|
27615
27646
|
querySerializer: { parameters: { state: { array: { explode: false } } } },
|
|
27616
27647
|
security: [
|
|
@@ -30115,6 +30146,10 @@ function createMedia(transport) {
|
|
|
30115
30146
|
create: bind(transport, mediaVisualSearch)
|
|
30116
30147
|
}
|
|
30117
30148
|
},
|
|
30149
|
+
understandings: {
|
|
30150
|
+
list: bindPage(transport, mediaListUnderstandingsByLibrary),
|
|
30151
|
+
retrieveFailureSummary: bind(transport, mediaUnderstandingFailureSummary)
|
|
30152
|
+
},
|
|
30118
30153
|
update: bind(transport, mediaUpdateLibrary)
|
|
30119
30154
|
}
|
|
30120
30155
|
};
|
|
@@ -33494,7 +33529,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
|
|
|
33494
33529
|
}
|
|
33495
33530
|
|
|
33496
33531
|
// src/main.ts
|
|
33497
|
-
var version = "0.2.1-dev.
|
|
33532
|
+
var version = "0.2.1-dev.7d20ab6";
|
|
33498
33533
|
var commands = commandTree(operations);
|
|
33499
33534
|
var manual = [...workflows.map((w) => w.words), [API_WORD]];
|
|
33500
33535
|
function route(argv) {
|