@deepraxis/cli 0.2.1-dev.41a24b1 → 0.2.1-dev.4d394b7
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 -4
- package/dist/praxis.js +228 -135
- 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
|
+
525 HTTP operations; 527 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,16 +356,17 @@ 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
|
+
| `praxis api media library asset frame create` | `media.libraries.assets.frames.create` | POST `/media/v1/libraries/{library_id}/assets/{asset_id}/frames` | `--library`, `--asset`, `--at-micros`, `--width` |
|
|
362
363
|
| `praxis api media library asset get <asset_id>` | `media.libraries.assets.retrieve` | GET `/media/v1/libraries/{library_id}/assets/{asset_id}` | `--library` |
|
|
363
364
|
| `praxis api media library asset import` | `media.libraries.assets.import.create` | POST `/media/v1/libraries/{library_id}/assets/import` | `--library`, `--file-id`, `--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` |
|
|
364
365
|
| `praxis api media library asset list` | `media.libraries.assets.list` | GET `/media/v1/libraries/{library_id}/assets` | `--library`, `--asset-folder`, `--resource-type`, `--param-cursor`, `--param-limit` |
|
|
365
366
|
| `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
367
|
| `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
368
|
| `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` |
|
|
369
|
+
| `praxis api media library batch create` | `media.libraries.batches.create` | POST `/media/v1/libraries/{library_id}/batches` | `--library`, `--reason` |
|
|
369
370
|
| `praxis api media library batch get <job_id>` | `media.libraries.batches.retrieve` | GET `/media/v1/libraries/{library_id}/batches/{job_id}` | `--library` |
|
|
370
371
|
| `praxis api media library create` | `media.libraries.create` | POST `/media/v1/libraries` | `--name` |
|
|
371
372
|
| `praxis api media library delete <library_id>` | `media.libraries.delete` | DELETE `/media/v1/libraries/{library_id}` | |
|
|
@@ -381,6 +382,8 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
381
382
|
| `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
383
|
| `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
384
|
| `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` |
|
|
385
|
+
| `praxis api media library understanding get-failure-summary` | `media.libraries.understandings.retrieveFailureSummary` | GET `/media/v1/libraries/{library_id}/understandings/failure_summary` | `--library` |
|
|
386
|
+
| `praxis api media library understanding list` | `media.libraries.understandings.list` | GET `/media/v1/libraries/{library_id}/understandings` | `--library`, `--folder`, `--kinds`, `--param-cursor`, `--param-limit` |
|
|
384
387
|
| `praxis api media library update <library_id>` | `media.libraries.update` | PATCH `/media/v1/libraries/{library_id}` | `--hotwords`, `--name` |
|
|
385
388
|
| `praxis api meta doc get <path>` | `meta.docs.retrieve` | GET `/meta/v1/docs/{path}` | `--lang` |
|
|
386
389
|
| `praxis api meta doc search` | `meta.docs.search` | GET `/meta/v1/docs/search` | `--q`, `--param-limit`, `--lang` |
|
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
|
|
10173
|
+
description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution. The response always includes warnings; FRAME_UNAVAILABLE means a source preview could not be obtained and an offline tile was drawn. Its message identifies a timeout, delivery capacity limit, or unavailable source and contains no source URL. Decode each image's base64 payload to save it. Codemode returns at most four images per call, so request at most four times when reviewing there.",
|
|
10162
10174
|
http: "GET",
|
|
10163
10175
|
path: "/cut/v1/projects/{project_id}/frames",
|
|
10164
10176
|
streaming: "no",
|
|
@@ -10181,7 +10193,7 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10181
10193
|
name: "scale",
|
|
10182
10194
|
type: "number",
|
|
10183
10195
|
required: false,
|
|
10184
|
-
description: "
|
|
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
|
}
|
|
@@ -11957,7 +11888,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11957
11888
|
resource: "knowledge.vectorStores",
|
|
11958
11889
|
method: "create",
|
|
11959
11890
|
summary: "Create knowledge base",
|
|
11960
|
-
description: 'Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded.
|
|
11891
|
+
description: 'Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; each account holds up to 100 active/nondeleted stores. Minimal body: {"name":"Refund policies"}.',
|
|
11961
11892
|
http: "POST",
|
|
11962
11893
|
path: "/knowledge/v1/vector_stores",
|
|
11963
11894
|
streaming: "no",
|
|
@@ -11996,7 +11927,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11996
11927
|
name: "chunking_strategy",
|
|
11997
11928
|
type: "object",
|
|
11998
11929
|
required: false,
|
|
11999
|
-
description: "auto
|
|
11930
|
+
description: "Native attachment strategy. auto uses static chunks of 800 estimated tokens with 400 overlap; static supplies explicit chunk sizes; hierarchical indexes child chunks and supplies bounded parent context. Existing attachments are reused unchanged; remove and reattach a file to change its strategy."
|
|
12000
11931
|
},
|
|
12001
11932
|
{
|
|
12002
11933
|
name: "description",
|
|
@@ -12343,7 +12274,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12343
12274
|
resource: "knowledge.vectorStores.files",
|
|
12344
12275
|
method: "create",
|
|
12345
12276
|
summary: "Add file",
|
|
12346
|
-
description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching.
|
|
12277
|
+
description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; chunk sizes use estimated tokens rather than a model tokenizer. Text, Markdown, CSV, JSON, HTML, PDF, DOCX, PPTX, XLSX and PNG/JPEG/GIF/WebP images can be extracted; audio and video uploads are not knowledge documents. Images may yield generated descriptions rather than verbatim OCR. auto chunking resolves to static 800/400; explicit sizes are 100–4096 with overlap at most half the size. Each store holds at most 10000 attached files. Reattaching the same file returns its existing record without applying new attributes or chunking; inspect last_error after failure.",
|
|
12347
12278
|
http: "POST",
|
|
12348
12279
|
path: "/knowledge/v1/vector_stores/{vector_store_id}/files",
|
|
12349
12280
|
streaming: "no",
|
|
@@ -12375,7 +12306,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12375
12306
|
name: "chunking_strategy",
|
|
12376
12307
|
type: "object",
|
|
12377
12308
|
required: false,
|
|
12378
|
-
description: "auto
|
|
12309
|
+
description: "Native attachment strategy. auto uses static chunks of 800 estimated tokens with 400 overlap; static supplies explicit chunk sizes; hierarchical indexes child chunks and supplies bounded parent context. Existing attachments are reused unchanged; remove and reattach a file to change its strategy."
|
|
12379
12310
|
}
|
|
12380
12311
|
]
|
|
12381
12312
|
}
|
|
@@ -12686,7 +12617,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12686
12617
|
resource: "media.libraries",
|
|
12687
12618
|
method: "list",
|
|
12688
12619
|
summary: "List libraries",
|
|
12689
|
-
description: "
|
|
12620
|
+
description: "Read a caller-owned library’s current settings, usage and lifecycle status. A deleting library remains readable; missing, foreign or purged libraries return LIBRARY_NOT_FOUND.",
|
|
12690
12621
|
http: "GET",
|
|
12691
12622
|
path: "/media/v1/libraries",
|
|
12692
12623
|
streaming: "no",
|
|
@@ -12768,7 +12699,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12768
12699
|
resource: "media.libraries",
|
|
12769
12700
|
method: "delete",
|
|
12770
12701
|
summary: "Delete library",
|
|
12771
|
-
description: "
|
|
12702
|
+
description: "Restore a deleting library before its purge_at deadline. The library becomes active again and deleted_at and purge_at are cleared; expired or non-deleting libraries cannot be restored.",
|
|
12772
12703
|
http: "DELETE",
|
|
12773
12704
|
path: "/media/v1/libraries/{library_id}",
|
|
12774
12705
|
streaming: "no",
|
|
@@ -12786,7 +12717,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12786
12717
|
resource: "media.libraries",
|
|
12787
12718
|
method: "retrieve",
|
|
12788
12719
|
summary: "Get library",
|
|
12789
|
-
description: "
|
|
12720
|
+
description: "Update an active library’s supplied settings. Labels replace the complete map; understanding settings and model roles merge with current values. Changing the embedding model is rejected while assets exist.",
|
|
12790
12721
|
http: "GET",
|
|
12791
12722
|
path: "/media/v1/libraries/{library_id}",
|
|
12792
12723
|
streaming: "no",
|
|
@@ -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",
|
|
@@ -12858,7 +12789,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12858
12789
|
resource: "media.libraries.assets",
|
|
12859
12790
|
method: "list",
|
|
12860
12791
|
summary: "List assets",
|
|
12861
|
-
description: "
|
|
12792
|
+
description: "Upload content into an active library and return a Cloudinary-compatible resource. Use file for a multipart file, data URI, public HTTPS URL or same-owner file identifier. Reusing public_id overwrites by default; overwrite=false returns the existing resource. Chunk uploads require both chunk headers.",
|
|
12862
12793
|
http: "GET",
|
|
12863
12794
|
path: "/media/v1/libraries/{library_id}/assets",
|
|
12864
12795
|
streaming: "no",
|
|
@@ -12906,7 +12837,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12906
12837
|
resource: "media.libraries.assets",
|
|
12907
12838
|
method: "create",
|
|
12908
12839
|
summary: "Upload asset",
|
|
12909
|
-
description: "
|
|
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.",
|
|
12910
12841
|
http: "POST",
|
|
12911
12842
|
path: "/media/v1/libraries/{library_id}/assets",
|
|
12912
12843
|
streaming: "no",
|
|
@@ -12951,7 +12882,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12951
12882
|
name: "asset_folder",
|
|
12952
12883
|
type: "string",
|
|
12953
12884
|
required: false,
|
|
12954
|
-
description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
|
|
12885
|
+
description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
|
|
12955
12886
|
},
|
|
12956
12887
|
{
|
|
12957
12888
|
name: "use_filename",
|
|
@@ -13030,7 +12961,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13030
12961
|
resource: "media.libraries.assets.import",
|
|
13031
12962
|
method: "create",
|
|
13032
12963
|
summary: "Import file",
|
|
13033
|
-
description: "Copy
|
|
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.",
|
|
13034
12965
|
http: "POST",
|
|
13035
12966
|
path: "/media/v1/libraries/{library_id}/assets/import",
|
|
13036
12967
|
streaming: "no",
|
|
@@ -13050,7 +12981,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13050
12981
|
name: "file_id",
|
|
13051
12982
|
type: "string",
|
|
13052
12983
|
required: true,
|
|
13053
|
-
description: "File ID to copy into this library instead of file bytes. This independent copy defaults to
|
|
12984
|
+
description: "File ID to copy into this library instead of file bytes. This independent copy defaults to organization-private delivery (type=authenticated); explicitly set type=upload for public delivery. Deleting the source File does not delete this asset."
|
|
13054
12985
|
},
|
|
13055
12986
|
{
|
|
13056
12987
|
name: "public_id",
|
|
@@ -13074,7 +13005,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13074
13005
|
name: "asset_folder",
|
|
13075
13006
|
type: "string",
|
|
13076
13007
|
required: false,
|
|
13077
|
-
description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
|
|
13008
|
+
description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
|
|
13078
13009
|
},
|
|
13079
13010
|
{
|
|
13080
13011
|
name: "use_filename",
|
|
@@ -13153,7 +13084,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13153
13084
|
resource: "media.libraries.assets",
|
|
13154
13085
|
method: "delete",
|
|
13155
13086
|
summary: "Delete asset",
|
|
13156
|
-
description: "
|
|
13087
|
+
description: "Queue reprocessing of the asset’s current version and return its updated state immediately. Omit kinds to retry failed tasks and legacy source-size unsupported tasks; explicit kinds rerun applicable completed tasks and recoverable source-size unsupported tasks. Other unsupported causes remain unchanged. Replaced understandings become superseded, and processing finishes asynchronously.",
|
|
13157
13088
|
http: "DELETE",
|
|
13158
13089
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
|
|
13159
13090
|
streaming: "no",
|
|
@@ -13176,7 +13107,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13176
13107
|
resource: "media.libraries.assets",
|
|
13177
13108
|
method: "retrieve",
|
|
13178
13109
|
summary: "Get asset",
|
|
13179
|
-
description: "
|
|
13110
|
+
description: "Update an asset’s supplied metadata fields. Tags and context replace their current collections; an empty collection clears them. Moving asset_folder or changing display_name preserves public_id and delivery URLs.",
|
|
13180
13111
|
http: "GET",
|
|
13181
13112
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
|
|
13182
13113
|
streaming: "no",
|
|
@@ -13199,7 +13130,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13199
13130
|
resource: "media.libraries.assets",
|
|
13200
13131
|
method: "update",
|
|
13201
13132
|
summary: "Update asset",
|
|
13202
|
-
description: "
|
|
13133
|
+
description: "Delete an asset from the library so it is no longer readable, searchable or deliverable. This removes the asset rather than placing it in the library’s restoration window; a missing asset returns ASSET_NOT_FOUND.",
|
|
13203
13134
|
http: "PATCH",
|
|
13204
13135
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
|
|
13205
13136
|
streaming: "no",
|
|
@@ -13230,7 +13161,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13230
13161
|
name: "asset_folder",
|
|
13231
13162
|
type: "string",
|
|
13232
13163
|
required: false,
|
|
13233
|
-
description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
|
|
13164
|
+
description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
|
|
13234
13165
|
},
|
|
13235
13166
|
{
|
|
13236
13167
|
name: "tags",
|
|
@@ -13248,11 +13179,57 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13248
13179
|
]
|
|
13249
13180
|
}
|
|
13250
13181
|
},
|
|
13182
|
+
{
|
|
13183
|
+
resource: "media.libraries.assets.frames",
|
|
13184
|
+
method: "create",
|
|
13185
|
+
summary: "Create frame URLs",
|
|
13186
|
+
description: 'Media creates JPEG frame URLs for inspecting one or more moments in a video without downloading the original. Obtain library_id from libraries and asset_id plus duration from assets. Send 1–20 integer microsecond timestamps strictly below duration, for example {"at_micros":[0,1000000],"width":640}. Only video assets are supported; audio and images return INVALID_PARAMS. Width defaults to 640 and accepts 160, 320 or 640. This read operation does not store a new asset or rerun understanding. Fetch each returned URL to obtain the frame; delivery usage follows media pricing. Authenticated links expire after 300 seconds; upload links remain public and permanent. Reissue expired links. Foreign libraries and assets return 404 without revealing their existence.',
|
|
13187
|
+
http: "POST",
|
|
13188
|
+
path: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames",
|
|
13189
|
+
streaming: "no",
|
|
13190
|
+
pagination: false,
|
|
13191
|
+
pathParams: [
|
|
13192
|
+
{
|
|
13193
|
+
name: "library_id",
|
|
13194
|
+
sdkName: "library_id",
|
|
13195
|
+
description: "Library identifier returned by library creation or listing; must be accessible to the current credential."
|
|
13196
|
+
},
|
|
13197
|
+
{
|
|
13198
|
+
name: "asset_id",
|
|
13199
|
+
sdkName: "asset_id",
|
|
13200
|
+
description: "Video asset identifier returned by asset upload or listing in this library; read its duration before choosing timestamps."
|
|
13201
|
+
}
|
|
13202
|
+
],
|
|
13203
|
+
query: [],
|
|
13204
|
+
body: {
|
|
13205
|
+
required: true,
|
|
13206
|
+
fields: [
|
|
13207
|
+
{
|
|
13208
|
+
name: "at_micros",
|
|
13209
|
+
type: "array",
|
|
13210
|
+
itemType: "integer",
|
|
13211
|
+
required: true,
|
|
13212
|
+
description: "One to twenty timestamps in microseconds from the start of the video. Each must be a nonnegative safe integer strictly below the video duration; order and duplicates are preserved."
|
|
13213
|
+
},
|
|
13214
|
+
{
|
|
13215
|
+
name: "width",
|
|
13216
|
+
type: "integer",
|
|
13217
|
+
enum: [
|
|
13218
|
+
160,
|
|
13219
|
+
320,
|
|
13220
|
+
640
|
|
13221
|
+
],
|
|
13222
|
+
required: false,
|
|
13223
|
+
description: "Maximum JPEG width in pixels: 160 is a small thumbnail, 320 a preview and 640 a larger preview. Defaults to 640; larger widths are unavailable."
|
|
13224
|
+
}
|
|
13225
|
+
]
|
|
13226
|
+
}
|
|
13227
|
+
},
|
|
13251
13228
|
{
|
|
13252
13229
|
resource: "media.libraries.assets.reprocess",
|
|
13253
13230
|
method: "create",
|
|
13254
13231
|
summary: "Reprocess asset",
|
|
13255
|
-
description: "
|
|
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.",
|
|
13256
13233
|
http: "POST",
|
|
13257
13234
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess",
|
|
13258
13235
|
streaming: "no",
|
|
@@ -13284,7 +13261,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13284
13261
|
"embedding"
|
|
13285
13262
|
],
|
|
13286
13263
|
required: false,
|
|
13287
|
-
description: "Processing tasks to rerun. Omit to retry failed tasks
|
|
13264
|
+
description: "Processing tasks to rerun. Omit to retry failed tasks and legacy source-size unsupported tasks; explicit kinds rerun applicable ready or failed tasks and recoverable source-size unsupported tasks. Other unsupported causes remain unchanged. Pending and running tasks are unchanged; an empty array does nothing."
|
|
13288
13265
|
}
|
|
13289
13266
|
]
|
|
13290
13267
|
}
|
|
@@ -13293,7 +13270,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13293
13270
|
resource: "media.libraries.assets.understandings",
|
|
13294
13271
|
method: "list",
|
|
13295
13272
|
summary: "List understandings",
|
|
13296
|
-
description: "List an asset
|
|
13273
|
+
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.",
|
|
13297
13274
|
http: "GET",
|
|
13298
13275
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}/understandings",
|
|
13299
13276
|
streaming: "no",
|
|
@@ -13325,10 +13302,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13325
13302
|
"tags",
|
|
13326
13303
|
"ocr",
|
|
13327
13304
|
"transcript",
|
|
13328
|
-
"frame"
|
|
13305
|
+
"frame",
|
|
13306
|
+
"overview",
|
|
13307
|
+
"audio",
|
|
13308
|
+
"embedding"
|
|
13329
13309
|
],
|
|
13330
13310
|
required: false,
|
|
13331
|
-
description: "
|
|
13311
|
+
description: "Return one output kind: caption is a visual description, tags are generated labels, ocr is visible text, transcript is speech, frame is a video shot, overview is a video summary, audio is sampled audio understanding, and embedding reports a failed embedding step."
|
|
13332
13312
|
},
|
|
13333
13313
|
{
|
|
13334
13314
|
name: "cursor",
|
|
@@ -13348,7 +13328,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13348
13328
|
resource: "media.libraries.assets",
|
|
13349
13329
|
method: "batch",
|
|
13350
13330
|
summary: "Batch assets alias",
|
|
13351
|
-
description:
|
|
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.',
|
|
13352
13332
|
http: "POST",
|
|
13353
13333
|
path: "/media/v1/libraries/{library_id}/assets:batch",
|
|
13354
13334
|
streaming: "no",
|
|
@@ -13369,6 +13349,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13369
13349
|
type: "object",
|
|
13370
13350
|
required: true,
|
|
13371
13351
|
description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
|
|
13352
|
+
},
|
|
13353
|
+
{
|
|
13354
|
+
name: "reason",
|
|
13355
|
+
type: "string",
|
|
13356
|
+
required: false,
|
|
13357
|
+
description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
|
|
13372
13358
|
}
|
|
13373
13359
|
]
|
|
13374
13360
|
}
|
|
@@ -13377,7 +13363,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13377
13363
|
resource: "media.libraries.batches",
|
|
13378
13364
|
method: "create",
|
|
13379
13365
|
summary: "Create batch",
|
|
13380
|
-
description:
|
|
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.',
|
|
13381
13367
|
http: "POST",
|
|
13382
13368
|
path: "/media/v1/libraries/{library_id}/batches",
|
|
13383
13369
|
streaming: "no",
|
|
@@ -13398,6 +13384,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13398
13384
|
type: "object",
|
|
13399
13385
|
required: true,
|
|
13400
13386
|
description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
|
|
13387
|
+
},
|
|
13388
|
+
{
|
|
13389
|
+
name: "reason",
|
|
13390
|
+
type: "string",
|
|
13391
|
+
required: false,
|
|
13392
|
+
description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
|
|
13401
13393
|
}
|
|
13402
13394
|
]
|
|
13403
13395
|
}
|
|
@@ -13406,7 +13398,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13406
13398
|
resource: "media.libraries.batches",
|
|
13407
13399
|
method: "retrieve",
|
|
13408
13400
|
summary: "Get batch",
|
|
13409
|
-
description: "
|
|
13401
|
+
description: "Alias of batch creation. Apply one metadata or deletion action to ids or a frozen expression selection asynchronously; poll the returned job id to inspect completion and item failures.",
|
|
13410
13402
|
http: "GET",
|
|
13411
13403
|
path: "/media/v1/libraries/{library_id}/batches/{job_id}",
|
|
13412
13404
|
streaming: "no",
|
|
@@ -13429,7 +13421,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13429
13421
|
resource: "media.libraries.deliveryTokens",
|
|
13430
13422
|
method: "create",
|
|
13431
13423
|
summary: "Create delivery token",
|
|
13432
|
-
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
|
|
13424
|
+
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.",
|
|
13433
13425
|
http: "POST",
|
|
13434
13426
|
path: "/media/v1/libraries/{library_id}/delivery_tokens",
|
|
13435
13427
|
streaming: "no",
|
|
@@ -13455,7 +13447,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13455
13447
|
name: "expires_in",
|
|
13456
13448
|
type: "integer",
|
|
13457
13449
|
required: false,
|
|
13458
|
-
description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to
|
|
13450
|
+
description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 900."
|
|
13459
13451
|
}
|
|
13460
13452
|
]
|
|
13461
13453
|
}
|
|
@@ -13464,7 +13456,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13464
13456
|
resource: "media.libraries.events",
|
|
13465
13457
|
method: "list",
|
|
13466
13458
|
summary: "List events",
|
|
13467
|
-
description: "Read library events in sequence order
|
|
13459
|
+
description: "Read library events in sequence order for observing asset writes and understanding progress. Obtain library_id from creation or listing; continue with after_seq for asc or before_seq for desc, without combining both. Use next_cursor when supplied. Reads do not start or retry understanding.",
|
|
13468
13460
|
http: "GET",
|
|
13469
13461
|
path: "/media/v1/libraries/{library_id}/events",
|
|
13470
13462
|
streaming: "no",
|
|
@@ -13511,7 +13503,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13511
13503
|
resource: "media.libraries.folders",
|
|
13512
13504
|
method: "list",
|
|
13513
13505
|
summary: "List folders",
|
|
13514
|
-
description: "
|
|
13506
|
+
description: "undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.",
|
|
13515
13507
|
http: "GET",
|
|
13516
13508
|
path: "/media/v1/libraries/{library_id}/folders",
|
|
13517
13509
|
streaming: "no",
|
|
@@ -13536,7 +13528,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13536
13528
|
resource: "media.libraries.jobs",
|
|
13537
13529
|
method: "retrieve",
|
|
13538
13530
|
summary: "Get job alias",
|
|
13539
|
-
description: "
|
|
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.",
|
|
13540
13532
|
http: "GET",
|
|
13541
13533
|
path: "/media/v1/libraries/{library_id}/jobs/{job_id}",
|
|
13542
13534
|
streaming: "no",
|
|
@@ -13559,7 +13551,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13559
13551
|
resource: "media.libraries.purge",
|
|
13560
13552
|
method: "create",
|
|
13561
13553
|
summary: "Purge library",
|
|
13562
|
-
description: "
|
|
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.",
|
|
13563
13555
|
http: "POST",
|
|
13564
13556
|
path: "/media/v1/libraries/{library_id}/purge",
|
|
13565
13557
|
streaming: "no",
|
|
@@ -13577,7 +13569,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13577
13569
|
resource: "media.libraries",
|
|
13578
13570
|
method: "restore",
|
|
13579
13571
|
summary: "Restore library",
|
|
13580
|
-
description: "
|
|
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.",
|
|
13581
13573
|
http: "POST",
|
|
13582
13574
|
path: "/media/v1/libraries/{library_id}/restore",
|
|
13583
13575
|
streaming: "no",
|
|
@@ -13595,7 +13587,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13595
13587
|
resource: "media.libraries.search",
|
|
13596
13588
|
method: "create",
|
|
13597
13589
|
summary: "Semantic search alias",
|
|
13598
|
-
description: "
|
|
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.",
|
|
13599
13591
|
http: "POST",
|
|
13600
13592
|
path: "/media/v1/libraries/{library_id}/search",
|
|
13601
13593
|
streaming: "no",
|
|
@@ -13646,7 +13638,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13646
13638
|
resource: "media.libraries.search.expression",
|
|
13647
13639
|
method: "create",
|
|
13648
13640
|
summary: "Expression search",
|
|
13649
|
-
description: "
|
|
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.",
|
|
13650
13642
|
http: "POST",
|
|
13651
13643
|
path: "/media/v1/libraries/{library_id}/search/expression",
|
|
13652
13644
|
streaming: "no",
|
|
@@ -13666,7 +13658,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13666
13658
|
name: "expression",
|
|
13667
13659
|
type: "string",
|
|
13668
13660
|
required: false,
|
|
13669
|
-
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.'
|
|
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.'
|
|
13670
13662
|
},
|
|
13671
13663
|
{
|
|
13672
13664
|
name: "sort_by",
|
|
@@ -13718,7 +13710,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13718
13710
|
resource: "media.libraries.search.semantic",
|
|
13719
13711
|
method: "create",
|
|
13720
13712
|
summary: "Semantic search",
|
|
13721
|
-
description: "Search assets with a nonblank text query
|
|
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.",
|
|
13722
13714
|
http: "POST",
|
|
13723
13715
|
path: "/media/v1/libraries/{library_id}/search/semantic",
|
|
13724
13716
|
streaming: "no",
|
|
@@ -13769,7 +13761,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13769
13761
|
resource: "media.libraries.search.visual",
|
|
13770
13762
|
method: "create",
|
|
13771
13763
|
summary: "Visual search",
|
|
13772
|
-
description: "
|
|
13764
|
+
description: "Search assets with a nonblank text query and optional expression filter. Hybrid mode combines semantic and keyword matches; semantic mode uses vector similarity only. Results are ranked and limited by top_k.",
|
|
13773
13765
|
http: "POST",
|
|
13774
13766
|
path: "/media/v1/libraries/{library_id}/search/visual",
|
|
13775
13767
|
streaming: "no",
|
|
@@ -13812,6 +13804,67 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13812
13804
|
]
|
|
13813
13805
|
}
|
|
13814
13806
|
},
|
|
13807
|
+
{
|
|
13808
|
+
resource: "media.libraries.understandings",
|
|
13809
|
+
method: "list",
|
|
13810
|
+
summary: "List understanding results across a library",
|
|
13811
|
+
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.",
|
|
13812
|
+
http: "GET",
|
|
13813
|
+
path: "/media/v1/libraries/{library_id}/understandings",
|
|
13814
|
+
streaming: "no",
|
|
13815
|
+
pagination: true,
|
|
13816
|
+
pathParams: [
|
|
13817
|
+
{
|
|
13818
|
+
name: "library_id",
|
|
13819
|
+
sdkName: "library_id",
|
|
13820
|
+
description: "Library ID returned by creation."
|
|
13821
|
+
}
|
|
13822
|
+
],
|
|
13823
|
+
query: [
|
|
13824
|
+
{
|
|
13825
|
+
name: "folder",
|
|
13826
|
+
type: "string",
|
|
13827
|
+
required: false,
|
|
13828
|
+
description: "Folder path including all descendants; omitted or empty selects the entire library."
|
|
13829
|
+
},
|
|
13830
|
+
{
|
|
13831
|
+
name: "kinds",
|
|
13832
|
+
type: "string",
|
|
13833
|
+
required: false,
|
|
13834
|
+
description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind."
|
|
13835
|
+
},
|
|
13836
|
+
{
|
|
13837
|
+
name: "cursor",
|
|
13838
|
+
type: "string",
|
|
13839
|
+
required: false,
|
|
13840
|
+
description: "Cursor from the previous next_cursor."
|
|
13841
|
+
},
|
|
13842
|
+
{
|
|
13843
|
+
name: "limit",
|
|
13844
|
+
type: "integer",
|
|
13845
|
+
required: false,
|
|
13846
|
+
description: "Maximum entries in this page, from 1 through 100; defaults to 100."
|
|
13847
|
+
}
|
|
13848
|
+
]
|
|
13849
|
+
},
|
|
13850
|
+
{
|
|
13851
|
+
resource: "media.libraries.understandings",
|
|
13852
|
+
method: "retrieveFailureSummary",
|
|
13853
|
+
summary: "Summarize understanding failures",
|
|
13854
|
+
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.",
|
|
13855
|
+
http: "GET",
|
|
13856
|
+
path: "/media/v1/libraries/{library_id}/understandings/failure_summary",
|
|
13857
|
+
streaming: "no",
|
|
13858
|
+
pagination: false,
|
|
13859
|
+
pathParams: [
|
|
13860
|
+
{
|
|
13861
|
+
name: "library_id",
|
|
13862
|
+
sdkName: "library_id",
|
|
13863
|
+
description: "Library ID returned by creation."
|
|
13864
|
+
}
|
|
13865
|
+
],
|
|
13866
|
+
query: []
|
|
13867
|
+
},
|
|
13815
13868
|
{
|
|
13816
13869
|
resource: "meta.docs",
|
|
13817
13870
|
method: "search",
|
|
@@ -14099,25 +14152,25 @@ services (model, agent, automation…); call the operation you need and read its
|
|
|
14099
14152
|
name: "model",
|
|
14100
14153
|
type: "string",
|
|
14101
14154
|
required: true,
|
|
14102
|
-
description: "
|
|
14155
|
+
description: "Model catalog identifier declaring openai.audio.transcriptions; use it unchanged, including any creator prefix."
|
|
14103
14156
|
},
|
|
14104
14157
|
{
|
|
14105
14158
|
name: "file",
|
|
14106
14159
|
type: "string",
|
|
14107
14160
|
required: true,
|
|
14108
|
-
description: "Audio
|
|
14161
|
+
description: "Audio bytes uploaded as a multipart file; supported formats and input limits depend on the selected model."
|
|
14109
14162
|
},
|
|
14110
14163
|
{
|
|
14111
14164
|
name: "language",
|
|
14112
14165
|
type: "string",
|
|
14113
14166
|
required: false,
|
|
14114
|
-
description: "
|
|
14167
|
+
description: "Source language code when known; omit to let the model detect the language."
|
|
14115
14168
|
},
|
|
14116
14169
|
{
|
|
14117
14170
|
name: "prompt",
|
|
14118
14171
|
type: "string",
|
|
14119
14172
|
required: false,
|
|
14120
|
-
description: "
|
|
14173
|
+
description: "Optional vocabulary or contextual guidance for recognizing the audio; support depends on the selected model."
|
|
14121
14174
|
},
|
|
14122
14175
|
{
|
|
14123
14176
|
name: "response_format",
|
|
@@ -14125,20 +14178,22 @@ services (model, agent, automation…); call the operation you need and read its
|
|
|
14125
14178
|
enum: [
|
|
14126
14179
|
"json",
|
|
14127
14180
|
"text",
|
|
14128
|
-
"verbose_json"
|
|
14181
|
+
"verbose_json",
|
|
14182
|
+
"diarized_json"
|
|
14129
14183
|
],
|
|
14130
14184
|
required: false,
|
|
14131
|
-
description: "
|
|
14185
|
+
description: "Output format: json returns text in JSON; text returns plain text; verbose_json includes requested timestamps; diarized_json includes speaker-labelled segments when supported. Defaults to json."
|
|
14132
14186
|
},
|
|
14133
14187
|
{
|
|
14134
14188
|
name: "timestamp_granularities[]",
|
|
14135
14189
|
type: "array",
|
|
14136
14190
|
itemType: "string",
|
|
14137
14191
|
enum: [
|
|
14192
|
+
"word",
|
|
14138
14193
|
"segment"
|
|
14139
14194
|
],
|
|
14140
14195
|
required: false,
|
|
14141
|
-
description: "Timestamp levels to
|
|
14196
|
+
description: "Timestamp levels to request as repeated multipart fields: word returns per-word times; segment returns segment times. Omit for the model default. Use verbose_json, or diarized_json on supporting models."
|
|
14142
14197
|
},
|
|
14143
14198
|
{
|
|
14144
14199
|
name: "temperature",
|
|
@@ -19378,7 +19433,7 @@ for more details.`
|
|
|
19378
19433
|
name: "filter",
|
|
19379
19434
|
type: "string",
|
|
19380
19435
|
required: false,
|
|
19381
|
-
description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort;
|
|
19436
|
+
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."
|
|
19382
19437
|
}
|
|
19383
19438
|
]
|
|
19384
19439
|
},
|
|
@@ -27354,6 +27409,19 @@ var mediaCreateLibrary = (options) => (options.client ?? client).post({
|
|
|
27354
27409
|
...options.headers
|
|
27355
27410
|
}
|
|
27356
27411
|
});
|
|
27412
|
+
var mediaCreateFrameUrls = (options) => (options.client ?? client).post({
|
|
27413
|
+
security: [{
|
|
27414
|
+
key: "media-BearerAuth",
|
|
27415
|
+
scheme: "bearer",
|
|
27416
|
+
type: "http"
|
|
27417
|
+
}],
|
|
27418
|
+
url: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames",
|
|
27419
|
+
...options,
|
|
27420
|
+
headers: {
|
|
27421
|
+
"Content-Type": "application/json",
|
|
27422
|
+
...options.headers
|
|
27423
|
+
}
|
|
27424
|
+
});
|
|
27357
27425
|
var mediaDeleteLibrary = (options) => (options.client ?? client).delete({
|
|
27358
27426
|
security: [{
|
|
27359
27427
|
key: "media-BearerAuth",
|
|
@@ -27618,6 +27686,24 @@ var mediaCreateDeliveryToken = (options) => (options.client ?? client).post({
|
|
|
27618
27686
|
...options.headers
|
|
27619
27687
|
}
|
|
27620
27688
|
});
|
|
27689
|
+
var mediaUnderstandingFailureSummary = (options) => (options.client ?? client).get({
|
|
27690
|
+
security: [{
|
|
27691
|
+
key: "media-BearerAuth",
|
|
27692
|
+
scheme: "bearer",
|
|
27693
|
+
type: "http"
|
|
27694
|
+
}],
|
|
27695
|
+
url: "/media/v1/libraries/{library_id}/understandings/failure_summary",
|
|
27696
|
+
...options
|
|
27697
|
+
});
|
|
27698
|
+
var mediaListUnderstandingsByLibrary = (options) => (options.client ?? client).get({
|
|
27699
|
+
security: [{
|
|
27700
|
+
key: "media-BearerAuth",
|
|
27701
|
+
scheme: "bearer",
|
|
27702
|
+
type: "http"
|
|
27703
|
+
}],
|
|
27704
|
+
url: "/media/v1/libraries/{library_id}/understandings",
|
|
27705
|
+
...options
|
|
27706
|
+
});
|
|
27621
27707
|
var getSandboxV1Sandboxes = (options) => (options?.client ?? client).get({
|
|
27622
27708
|
querySerializer: { parameters: { state: { array: { explode: false } } } },
|
|
27623
27709
|
security: [
|
|
@@ -30073,6 +30159,9 @@ function createMedia(transport) {
|
|
|
30073
30159
|
batch: bind(transport, mediaBatchAssets),
|
|
30074
30160
|
create: bind(transport, (options) => mediaUploadAsset({ ...options, bodySerializer: multipartBodySerializer, headers: { "Content-Type": null, ...options.headers } })),
|
|
30075
30161
|
delete: bind(transport, mediaDeleteAsset),
|
|
30162
|
+
frames: {
|
|
30163
|
+
create: bind(transport, mediaCreateFrameUrls)
|
|
30164
|
+
},
|
|
30076
30165
|
import: {
|
|
30077
30166
|
create: bind(transport, mediaImportAsset)
|
|
30078
30167
|
},
|
|
@@ -30122,6 +30211,10 @@ function createMedia(transport) {
|
|
|
30122
30211
|
create: bind(transport, mediaVisualSearch)
|
|
30123
30212
|
}
|
|
30124
30213
|
},
|
|
30214
|
+
understandings: {
|
|
30215
|
+
list: bindPage(transport, mediaListUnderstandingsByLibrary),
|
|
30216
|
+
retrieveFailureSummary: bind(transport, mediaUnderstandingFailureSummary)
|
|
30217
|
+
},
|
|
30125
30218
|
update: bind(transport, mediaUpdateLibrary)
|
|
30126
30219
|
}
|
|
30127
30220
|
};
|
|
@@ -33501,7 +33594,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
|
|
|
33501
33594
|
}
|
|
33502
33595
|
|
|
33503
33596
|
// src/main.ts
|
|
33504
|
-
var version = "0.2.1-dev.
|
|
33597
|
+
var version = "0.2.1-dev.4d394b7";
|
|
33505
33598
|
var commands = commandTree(operations);
|
|
33506
33599
|
var manual = [...workflows.map((w) => w.words), [API_WORD]];
|
|
33507
33600
|
function route(argv) {
|