@deepraxis/cli 0.2.1-dev.cc34a92 → 0.2.1-dev.d54e526
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 +9 -5
- package/dist/praxis.js +283 -58
- 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,7 +382,9 @@ 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` |
|
|
384
|
-
| `praxis api media library
|
|
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` |
|
|
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` |
|
|
387
390
|
| `praxis api meta health get` | `meta.health.retrieve` | GET `/meta/v1/health` | |
|
|
@@ -432,6 +435,7 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
432
435
|
| `praxis api organization feedback list` | `organization.feedback.list` | GET `/organization/v1/feedback` | `--phase`, `--query`, `--param-limit`, `--page` |
|
|
433
436
|
| `praxis api organization feedback message create` | `organization.feedback.messages.create` | POST `/organization/v1/feedback/{id}/messages` | `--feedback`, `--body` |
|
|
434
437
|
| `praxis api organization feedback message list` | `organization.feedback.messages.list` | GET `/organization/v1/feedback/{id}/messages` | `--feedback`, `--param-limit`, `--page` |
|
|
438
|
+
| `praxis api organization member list` | `organization.members.list` | GET `/organization/v1/members` | `--param-limit`, `--page` |
|
|
435
439
|
| `praxis api organization usage list` | `organization.usage.list` | GET `/organization/v1/usage` | `--starting-at`, `--ending-at`, `--bucket-width`, `--time-zone`, `--group-by`, `--page` |
|
|
436
440
|
| `praxis api sandbox command run <sandbox_id>` | `sandbox.sandboxes.commands.run` | POST `/sandbox/v1/sandboxes/{sandbox_id}/commands` | `--cmd`, `--background`, `--cwd`, `--timeout-ms` |
|
|
437
441
|
| `praxis api sandbox connect <sandboxID>` | `sandbox.sandboxes.connect` | POST `/sandbox/v1/sandboxes/{sandboxID}/connect` | `--timeout`, `--memory` |
|
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.
|
|
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,7 +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. Use AddTrack, Insert, Update, Delete, Split, Trim, Move, RippleDeleteRange, UpdateTrack, DeleteTrack, SetSettings, AddCaptionsFromTranscript and SetMarker for writes; GetTimeline, GetItem, FindItems, GetMedia, GetTranscript and GetAnalysis read editing context; Print emits text and Preview requests frame previews. All script times are seconds; script object fields use camelCase, for example `media: {libraryId, assetId}`. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project:\n\n```js\nconst t = AddTrack("video");\nInsert(t, {type: "color", color: "#123456", start: 0, length: 3});\nPrint(t);\n```',
|
|
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',
|
|
10377
10389
|
http: "POST",
|
|
10378
10390
|
path: "/cut/v1/projects/{project_id}:execute",
|
|
10379
10391
|
streaming: "no",
|
|
@@ -11465,7 +11477,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11465
11477
|
resource: "file.files",
|
|
11466
11478
|
method: "create",
|
|
11467
11479
|
summary: "Upload file",
|
|
11468
|
-
description: 'Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File(["Return within 23 days."], "policy.txt", { type: "text/plain" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.',
|
|
11480
|
+
description: 'Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File(["Return within 23 days."], "policy.txt", { type: "text/plain" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.',
|
|
11469
11481
|
http: "POST",
|
|
11470
11482
|
path: "/file/v1/files",
|
|
11471
11483
|
streaming: "no",
|
|
@@ -11487,10 +11499,11 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11487
11499
|
type: "string",
|
|
11488
11500
|
enum: [
|
|
11489
11501
|
"user_data",
|
|
11502
|
+
"assistants",
|
|
11490
11503
|
"vision"
|
|
11491
11504
|
],
|
|
11492
11505
|
required: true,
|
|
11493
|
-
description: "Purpose label stored with the file: user_data or vision. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data."
|
|
11506
|
+
description: "Purpose label stored with the file: user_data, assistants or vision. The label is stored and returned unchanged; assistants follows the same rules as user_data. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data."
|
|
11494
11507
|
},
|
|
11495
11508
|
{
|
|
11496
11509
|
name: "expires_after",
|
|
@@ -11559,7 +11572,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11559
11572
|
resource: "file.files.contentLinks",
|
|
11560
11573
|
method: "revoke",
|
|
11561
11574
|
summary: "Revoke a file content link",
|
|
11562
|
-
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/>"}.',
|
|
11563
11576
|
http: "POST",
|
|
11564
11577
|
path: "/file/v1/files/{file_id}/content_links:revoke",
|
|
11565
11578
|
streaming: "no",
|
|
@@ -11588,7 +11601,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11588
11601
|
resource: "file.files.contentUrl",
|
|
11589
11602
|
method: "create",
|
|
11590
11603
|
summary: "Create a download URL",
|
|
11591
|
-
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}.`,
|
|
11592
11605
|
http: "POST",
|
|
11593
11606
|
path: "/file/v1/files/{file_id}/content_url",
|
|
11594
11607
|
streaming: "no",
|
|
@@ -11608,7 +11621,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11608
11621
|
name: "ttl_seconds",
|
|
11609
11622
|
type: "integer",
|
|
11610
11623
|
required: false,
|
|
11611
|
-
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."
|
|
11612
11625
|
}
|
|
11613
11626
|
]
|
|
11614
11627
|
}
|
|
@@ -11617,7 +11630,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11617
11630
|
resource: "file.uploads",
|
|
11618
11631
|
method: "create",
|
|
11619
11632
|
summary: "Create an upload",
|
|
11620
|
-
description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.",
|
|
11633
|
+
description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data, assistants and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.",
|
|
11621
11634
|
http: "POST",
|
|
11622
11635
|
path: "/file/v1/uploads",
|
|
11623
11636
|
streaming: "no",
|
|
@@ -11650,10 +11663,11 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11650
11663
|
type: "string",
|
|
11651
11664
|
enum: [
|
|
11652
11665
|
"user_data",
|
|
11666
|
+
"assistants",
|
|
11653
11667
|
"vision"
|
|
11654
11668
|
],
|
|
11655
11669
|
required: true,
|
|
11656
|
-
description: "Use user_data for conversation attachments, or vision for PNG, JPEG, GIF and WebP images."
|
|
11670
|
+
description: "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images."
|
|
11657
11671
|
},
|
|
11658
11672
|
{
|
|
11659
11673
|
name: "expires_after",
|
|
@@ -11707,10 +11721,11 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11707
11721
|
type: "string",
|
|
11708
11722
|
enum: [
|
|
11709
11723
|
"user_data",
|
|
11724
|
+
"assistants",
|
|
11710
11725
|
"vision"
|
|
11711
11726
|
],
|
|
11712
11727
|
required: false,
|
|
11713
|
-
description: "user_data
|
|
11728
|
+
description: "user_data and assistants store ordinary files and conversation images with their original purpose label; vision accepts PNG, JPEG, GIF or WebP images only. Omitted means user_data."
|
|
11714
11729
|
},
|
|
11715
11730
|
{
|
|
11716
11731
|
name: "expires_in",
|
|
@@ -11873,7 +11888,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11873
11888
|
resource: "knowledge.vectorStores",
|
|
11874
11889
|
method: "create",
|
|
11875
11890
|
summary: "Create knowledge base",
|
|
11876
|
-
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"}.',
|
|
11877
11892
|
http: "POST",
|
|
11878
11893
|
path: "/knowledge/v1/vector_stores",
|
|
11879
11894
|
streaming: "no",
|
|
@@ -11912,7 +11927,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11912
11927
|
name: "chunking_strategy",
|
|
11913
11928
|
type: "object",
|
|
11914
11929
|
required: false,
|
|
11915
|
-
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."
|
|
11916
11931
|
},
|
|
11917
11932
|
{
|
|
11918
11933
|
name: "description",
|
|
@@ -12259,7 +12274,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12259
12274
|
resource: "knowledge.vectorStores.files",
|
|
12260
12275
|
method: "create",
|
|
12261
12276
|
summary: "Add file",
|
|
12262
|
-
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.",
|
|
12263
12278
|
http: "POST",
|
|
12264
12279
|
path: "/knowledge/v1/vector_stores/{vector_store_id}/files",
|
|
12265
12280
|
streaming: "no",
|
|
@@ -12291,7 +12306,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12291
12306
|
name: "chunking_strategy",
|
|
12292
12307
|
type: "object",
|
|
12293
12308
|
required: false,
|
|
12294
|
-
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."
|
|
12295
12310
|
}
|
|
12296
12311
|
]
|
|
12297
12312
|
}
|
|
@@ -12602,7 +12617,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12602
12617
|
resource: "media.libraries",
|
|
12603
12618
|
method: "list",
|
|
12604
12619
|
summary: "List libraries",
|
|
12605
|
-
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.",
|
|
12606
12621
|
http: "GET",
|
|
12607
12622
|
path: "/media/v1/libraries",
|
|
12608
12623
|
streaming: "no",
|
|
@@ -12684,7 +12699,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12684
12699
|
resource: "media.libraries",
|
|
12685
12700
|
method: "delete",
|
|
12686
12701
|
summary: "Delete library",
|
|
12687
|
-
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.",
|
|
12688
12703
|
http: "DELETE",
|
|
12689
12704
|
path: "/media/v1/libraries/{library_id}",
|
|
12690
12705
|
streaming: "no",
|
|
@@ -12702,7 +12717,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12702
12717
|
resource: "media.libraries",
|
|
12703
12718
|
method: "retrieve",
|
|
12704
12719
|
summary: "Get library",
|
|
12705
|
-
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.",
|
|
12706
12721
|
http: "GET",
|
|
12707
12722
|
path: "/media/v1/libraries/{library_id}",
|
|
12708
12723
|
streaming: "no",
|
|
@@ -12720,7 +12735,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12720
12735
|
resource: "media.libraries",
|
|
12721
12736
|
method: "update",
|
|
12722
12737
|
summary: "Update library",
|
|
12723
|
-
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.",
|
|
12724
12739
|
http: "PATCH",
|
|
12725
12740
|
path: "/media/v1/libraries/{library_id}",
|
|
12726
12741
|
streaming: "no",
|
|
@@ -12736,6 +12751,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12736
12751
|
body: {
|
|
12737
12752
|
required: true,
|
|
12738
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
|
+
},
|
|
12739
12761
|
{
|
|
12740
12762
|
name: "models",
|
|
12741
12763
|
type: "object",
|
|
@@ -12767,7 +12789,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12767
12789
|
resource: "media.libraries.assets",
|
|
12768
12790
|
method: "list",
|
|
12769
12791
|
summary: "List assets",
|
|
12770
|
-
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.",
|
|
12771
12793
|
http: "GET",
|
|
12772
12794
|
path: "/media/v1/libraries/{library_id}/assets",
|
|
12773
12795
|
streaming: "no",
|
|
@@ -12815,7 +12837,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12815
12837
|
resource: "media.libraries.assets",
|
|
12816
12838
|
method: "create",
|
|
12817
12839
|
summary: "Upload asset",
|
|
12818
|
-
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.",
|
|
12819
12841
|
http: "POST",
|
|
12820
12842
|
path: "/media/v1/libraries/{library_id}/assets",
|
|
12821
12843
|
streaming: "no",
|
|
@@ -12860,7 +12882,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12860
12882
|
name: "asset_folder",
|
|
12861
12883
|
type: "string",
|
|
12862
12884
|
required: false,
|
|
12863
|
-
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."
|
|
12864
12886
|
},
|
|
12865
12887
|
{
|
|
12866
12888
|
name: "use_filename",
|
|
@@ -12939,7 +12961,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12939
12961
|
resource: "media.libraries.assets.import",
|
|
12940
12962
|
method: "create",
|
|
12941
12963
|
summary: "Import file",
|
|
12942
|
-
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.",
|
|
12943
12965
|
http: "POST",
|
|
12944
12966
|
path: "/media/v1/libraries/{library_id}/assets/import",
|
|
12945
12967
|
streaming: "no",
|
|
@@ -12959,7 +12981,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12959
12981
|
name: "file_id",
|
|
12960
12982
|
type: "string",
|
|
12961
12983
|
required: true,
|
|
12962
|
-
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."
|
|
12963
12985
|
},
|
|
12964
12986
|
{
|
|
12965
12987
|
name: "public_id",
|
|
@@ -12983,7 +13005,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12983
13005
|
name: "asset_folder",
|
|
12984
13006
|
type: "string",
|
|
12985
13007
|
required: false,
|
|
12986
|
-
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."
|
|
12987
13009
|
},
|
|
12988
13010
|
{
|
|
12989
13011
|
name: "use_filename",
|
|
@@ -13062,7 +13084,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13062
13084
|
resource: "media.libraries.assets",
|
|
13063
13085
|
method: "delete",
|
|
13064
13086
|
summary: "Delete asset",
|
|
13065
|
-
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.",
|
|
13066
13088
|
http: "DELETE",
|
|
13067
13089
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
|
|
13068
13090
|
streaming: "no",
|
|
@@ -13085,7 +13107,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13085
13107
|
resource: "media.libraries.assets",
|
|
13086
13108
|
method: "retrieve",
|
|
13087
13109
|
summary: "Get asset",
|
|
13088
|
-
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.",
|
|
13089
13111
|
http: "GET",
|
|
13090
13112
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
|
|
13091
13113
|
streaming: "no",
|
|
@@ -13108,7 +13130,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13108
13130
|
resource: "media.libraries.assets",
|
|
13109
13131
|
method: "update",
|
|
13110
13132
|
summary: "Update asset",
|
|
13111
|
-
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.",
|
|
13112
13134
|
http: "PATCH",
|
|
13113
13135
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
|
|
13114
13136
|
streaming: "no",
|
|
@@ -13139,7 +13161,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13139
13161
|
name: "asset_folder",
|
|
13140
13162
|
type: "string",
|
|
13141
13163
|
required: false,
|
|
13142
|
-
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."
|
|
13143
13165
|
},
|
|
13144
13166
|
{
|
|
13145
13167
|
name: "tags",
|
|
@@ -13157,11 +13179,57 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13157
13179
|
]
|
|
13158
13180
|
}
|
|
13159
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
|
+
},
|
|
13160
13228
|
{
|
|
13161
13229
|
resource: "media.libraries.assets.reprocess",
|
|
13162
13230
|
method: "create",
|
|
13163
13231
|
summary: "Reprocess asset",
|
|
13164
|
-
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.",
|
|
13165
13233
|
http: "POST",
|
|
13166
13234
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess",
|
|
13167
13235
|
streaming: "no",
|
|
@@ -13193,7 +13261,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13193
13261
|
"embedding"
|
|
13194
13262
|
],
|
|
13195
13263
|
required: false,
|
|
13196
|
-
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."
|
|
13197
13265
|
}
|
|
13198
13266
|
]
|
|
13199
13267
|
}
|
|
@@ -13202,7 +13270,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13202
13270
|
resource: "media.libraries.assets.understandings",
|
|
13203
13271
|
method: "list",
|
|
13204
13272
|
summary: "List understandings",
|
|
13205
|
-
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.",
|
|
13206
13274
|
http: "GET",
|
|
13207
13275
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}/understandings",
|
|
13208
13276
|
streaming: "no",
|
|
@@ -13234,10 +13302,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13234
13302
|
"tags",
|
|
13235
13303
|
"ocr",
|
|
13236
13304
|
"transcript",
|
|
13237
|
-
"frame"
|
|
13305
|
+
"frame",
|
|
13306
|
+
"overview",
|
|
13307
|
+
"audio",
|
|
13308
|
+
"embedding"
|
|
13238
13309
|
],
|
|
13239
13310
|
required: false,
|
|
13240
|
-
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."
|
|
13241
13312
|
},
|
|
13242
13313
|
{
|
|
13243
13314
|
name: "cursor",
|
|
@@ -13257,7 +13328,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13257
13328
|
resource: "media.libraries.assets",
|
|
13258
13329
|
method: "batch",
|
|
13259
13330
|
summary: "Batch assets alias",
|
|
13260
|
-
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.',
|
|
13261
13332
|
http: "POST",
|
|
13262
13333
|
path: "/media/v1/libraries/{library_id}/assets:batch",
|
|
13263
13334
|
streaming: "no",
|
|
@@ -13278,6 +13349,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13278
13349
|
type: "object",
|
|
13279
13350
|
required: true,
|
|
13280
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."
|
|
13281
13358
|
}
|
|
13282
13359
|
]
|
|
13283
13360
|
}
|
|
@@ -13286,7 +13363,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13286
13363
|
resource: "media.libraries.batches",
|
|
13287
13364
|
method: "create",
|
|
13288
13365
|
summary: "Create batch",
|
|
13289
|
-
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.',
|
|
13290
13367
|
http: "POST",
|
|
13291
13368
|
path: "/media/v1/libraries/{library_id}/batches",
|
|
13292
13369
|
streaming: "no",
|
|
@@ -13307,6 +13384,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13307
13384
|
type: "object",
|
|
13308
13385
|
required: true,
|
|
13309
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."
|
|
13310
13393
|
}
|
|
13311
13394
|
]
|
|
13312
13395
|
}
|
|
@@ -13315,7 +13398,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13315
13398
|
resource: "media.libraries.batches",
|
|
13316
13399
|
method: "retrieve",
|
|
13317
13400
|
summary: "Get batch",
|
|
13318
|
-
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.",
|
|
13319
13402
|
http: "GET",
|
|
13320
13403
|
path: "/media/v1/libraries/{library_id}/batches/{job_id}",
|
|
13321
13404
|
streaming: "no",
|
|
@@ -13338,7 +13421,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13338
13421
|
resource: "media.libraries.deliveryTokens",
|
|
13339
13422
|
method: "create",
|
|
13340
13423
|
summary: "Create delivery token",
|
|
13341
|
-
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.",
|
|
13342
13425
|
http: "POST",
|
|
13343
13426
|
path: "/media/v1/libraries/{library_id}/delivery_tokens",
|
|
13344
13427
|
streaming: "no",
|
|
@@ -13364,7 +13447,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13364
13447
|
name: "expires_in",
|
|
13365
13448
|
type: "integer",
|
|
13366
13449
|
required: false,
|
|
13367
|
-
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."
|
|
13368
13451
|
}
|
|
13369
13452
|
]
|
|
13370
13453
|
}
|
|
@@ -13373,7 +13456,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13373
13456
|
resource: "media.libraries.events",
|
|
13374
13457
|
method: "list",
|
|
13375
13458
|
summary: "List events",
|
|
13376
|
-
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.",
|
|
13377
13460
|
http: "GET",
|
|
13378
13461
|
path: "/media/v1/libraries/{library_id}/events",
|
|
13379
13462
|
streaming: "no",
|
|
@@ -13420,7 +13503,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13420
13503
|
resource: "media.libraries.folders",
|
|
13421
13504
|
method: "list",
|
|
13422
13505
|
summary: "List folders",
|
|
13423
|
-
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.",
|
|
13424
13507
|
http: "GET",
|
|
13425
13508
|
path: "/media/v1/libraries/{library_id}/folders",
|
|
13426
13509
|
streaming: "no",
|
|
@@ -13445,7 +13528,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13445
13528
|
resource: "media.libraries.jobs",
|
|
13446
13529
|
method: "retrieve",
|
|
13447
13530
|
summary: "Get job alias",
|
|
13448
|
-
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.",
|
|
13449
13532
|
http: "GET",
|
|
13450
13533
|
path: "/media/v1/libraries/{library_id}/jobs/{job_id}",
|
|
13451
13534
|
streaming: "no",
|
|
@@ -13468,7 +13551,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13468
13551
|
resource: "media.libraries.purge",
|
|
13469
13552
|
method: "create",
|
|
13470
13553
|
summary: "Purge library",
|
|
13471
|
-
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.",
|
|
13472
13555
|
http: "POST",
|
|
13473
13556
|
path: "/media/v1/libraries/{library_id}/purge",
|
|
13474
13557
|
streaming: "no",
|
|
@@ -13486,7 +13569,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13486
13569
|
resource: "media.libraries",
|
|
13487
13570
|
method: "restore",
|
|
13488
13571
|
summary: "Restore library",
|
|
13489
|
-
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.",
|
|
13490
13573
|
http: "POST",
|
|
13491
13574
|
path: "/media/v1/libraries/{library_id}/restore",
|
|
13492
13575
|
streaming: "no",
|
|
@@ -13504,7 +13587,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13504
13587
|
resource: "media.libraries.search",
|
|
13505
13588
|
method: "create",
|
|
13506
13589
|
summary: "Semantic search alias",
|
|
13507
|
-
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.",
|
|
13508
13591
|
http: "POST",
|
|
13509
13592
|
path: "/media/v1/libraries/{library_id}/search",
|
|
13510
13593
|
streaming: "no",
|
|
@@ -13555,7 +13638,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13555
13638
|
resource: "media.libraries.search.expression",
|
|
13556
13639
|
method: "create",
|
|
13557
13640
|
summary: "Expression search",
|
|
13558
|
-
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.",
|
|
13559
13642
|
http: "POST",
|
|
13560
13643
|
path: "/media/v1/libraries/{library_id}/search/expression",
|
|
13561
13644
|
streaming: "no",
|
|
@@ -13575,7 +13658,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13575
13658
|
name: "expression",
|
|
13576
13659
|
type: "string",
|
|
13577
13660
|
required: false,
|
|
13578
|
-
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.'
|
|
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.'
|
|
13579
13662
|
},
|
|
13580
13663
|
{
|
|
13581
13664
|
name: "sort_by",
|
|
@@ -13627,7 +13710,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13627
13710
|
resource: "media.libraries.search.semantic",
|
|
13628
13711
|
method: "create",
|
|
13629
13712
|
summary: "Semantic search",
|
|
13630
|
-
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.",
|
|
13631
13714
|
http: "POST",
|
|
13632
13715
|
path: "/media/v1/libraries/{library_id}/search/semantic",
|
|
13633
13716
|
streaming: "no",
|
|
@@ -13678,7 +13761,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13678
13761
|
resource: "media.libraries.search.visual",
|
|
13679
13762
|
method: "create",
|
|
13680
13763
|
summary: "Visual search",
|
|
13681
|
-
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.",
|
|
13682
13765
|
http: "POST",
|
|
13683
13766
|
path: "/media/v1/libraries/{library_id}/search/visual",
|
|
13684
13767
|
streaming: "no",
|
|
@@ -13721,6 +13804,67 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13721
13804
|
]
|
|
13722
13805
|
}
|
|
13723
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
|
+
},
|
|
13724
13868
|
{
|
|
13725
13869
|
resource: "meta.docs",
|
|
13726
13870
|
method: "search",
|
|
@@ -14008,25 +14152,25 @@ services (model, agent, automation…); call the operation you need and read its
|
|
|
14008
14152
|
name: "model",
|
|
14009
14153
|
type: "string",
|
|
14010
14154
|
required: true,
|
|
14011
|
-
description: "
|
|
14155
|
+
description: "Model catalog identifier declaring openai.audio.transcriptions; use it unchanged, including any creator prefix."
|
|
14012
14156
|
},
|
|
14013
14157
|
{
|
|
14014
14158
|
name: "file",
|
|
14015
14159
|
type: "string",
|
|
14016
14160
|
required: true,
|
|
14017
|
-
description: "Audio
|
|
14161
|
+
description: "Audio bytes uploaded as a multipart file; supported formats and input limits depend on the selected model."
|
|
14018
14162
|
},
|
|
14019
14163
|
{
|
|
14020
14164
|
name: "language",
|
|
14021
14165
|
type: "string",
|
|
14022
14166
|
required: false,
|
|
14023
|
-
description: "
|
|
14167
|
+
description: "Source language code when known; omit to let the model detect the language."
|
|
14024
14168
|
},
|
|
14025
14169
|
{
|
|
14026
14170
|
name: "prompt",
|
|
14027
14171
|
type: "string",
|
|
14028
14172
|
required: false,
|
|
14029
|
-
description: "
|
|
14173
|
+
description: "Optional vocabulary or contextual guidance for recognizing the audio; support depends on the selected model."
|
|
14030
14174
|
},
|
|
14031
14175
|
{
|
|
14032
14176
|
name: "response_format",
|
|
@@ -14034,20 +14178,22 @@ services (model, agent, automation…); call the operation you need and read its
|
|
|
14034
14178
|
enum: [
|
|
14035
14179
|
"json",
|
|
14036
14180
|
"text",
|
|
14037
|
-
"verbose_json"
|
|
14181
|
+
"verbose_json",
|
|
14182
|
+
"diarized_json"
|
|
14038
14183
|
],
|
|
14039
14184
|
required: false,
|
|
14040
|
-
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."
|
|
14041
14186
|
},
|
|
14042
14187
|
{
|
|
14043
14188
|
name: "timestamp_granularities[]",
|
|
14044
14189
|
type: "array",
|
|
14045
14190
|
itemType: "string",
|
|
14046
14191
|
enum: [
|
|
14192
|
+
"word",
|
|
14047
14193
|
"segment"
|
|
14048
14194
|
],
|
|
14049
14195
|
required: false,
|
|
14050
|
-
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."
|
|
14051
14197
|
},
|
|
14052
14198
|
{
|
|
14053
14199
|
name: "temperature",
|
|
@@ -16569,6 +16715,31 @@ for more details.`
|
|
|
16569
16715
|
]
|
|
16570
16716
|
}
|
|
16571
16717
|
},
|
|
16718
|
+
{
|
|
16719
|
+
resource: "organization.members",
|
|
16720
|
+
method: "list",
|
|
16721
|
+
summary: "List organization members",
|
|
16722
|
+
description: "Concepts follow GitHub org members: find a person's user id, for example to assign an approver to an approval task. Lists only members of the organization behind your API key or runtime token, ordered by joined_at ascending (membership id breaks ties). Ask the user who should approve, then use that member's id. Emails are visible only within this organization. The request cannot select another organization. Pass next_page unchanged as page; null means the end. Read-only; no usage charge. Example: GET /organization/v1/members?limit=20.",
|
|
16723
|
+
http: "GET",
|
|
16724
|
+
path: "/organization/v1/members",
|
|
16725
|
+
streaming: "no",
|
|
16726
|
+
pagination: false,
|
|
16727
|
+
pathParams: [],
|
|
16728
|
+
query: [
|
|
16729
|
+
{
|
|
16730
|
+
name: "limit",
|
|
16731
|
+
type: "integer",
|
|
16732
|
+
required: false,
|
|
16733
|
+
description: "Maximum members per page, from 1 to 100; defaults to 20."
|
|
16734
|
+
},
|
|
16735
|
+
{
|
|
16736
|
+
name: "page",
|
|
16737
|
+
type: "string",
|
|
16738
|
+
required: false,
|
|
16739
|
+
description: "Opaque next_page cursor returned by the previous response; omit for the first page."
|
|
16740
|
+
}
|
|
16741
|
+
]
|
|
16742
|
+
},
|
|
16572
16743
|
{
|
|
16573
16744
|
resource: "organization.usage",
|
|
16574
16745
|
method: "list",
|
|
@@ -23355,6 +23526,19 @@ var countResponseInputTokens = (options) => (options.client ?? client).post({
|
|
|
23355
23526
|
...options.headers
|
|
23356
23527
|
}
|
|
23357
23528
|
});
|
|
23529
|
+
var listOrganizationMembers = (options) => (options?.client ?? client).get({
|
|
23530
|
+
security: [{
|
|
23531
|
+
key: "BearerAuth",
|
|
23532
|
+
scheme: "bearer",
|
|
23533
|
+
type: "http"
|
|
23534
|
+
}, {
|
|
23535
|
+
key: "ApiKeyAuth",
|
|
23536
|
+
name: "X-API-Key",
|
|
23537
|
+
type: "apiKey"
|
|
23538
|
+
}],
|
|
23539
|
+
url: "/organization/v1/members",
|
|
23540
|
+
...options
|
|
23541
|
+
});
|
|
23358
23542
|
var listOrganizationFeedback = (options) => (options?.client ?? client).get({
|
|
23359
23543
|
security: [{
|
|
23360
23544
|
key: "BearerAuth",
|
|
@@ -27225,6 +27409,19 @@ var mediaCreateLibrary = (options) => (options.client ?? client).post({
|
|
|
27225
27409
|
...options.headers
|
|
27226
27410
|
}
|
|
27227
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
|
+
});
|
|
27228
27425
|
var mediaDeleteLibrary = (options) => (options.client ?? client).delete({
|
|
27229
27426
|
security: [{
|
|
27230
27427
|
key: "media-BearerAuth",
|
|
@@ -27489,6 +27686,24 @@ var mediaCreateDeliveryToken = (options) => (options.client ?? client).post({
|
|
|
27489
27686
|
...options.headers
|
|
27490
27687
|
}
|
|
27491
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
|
+
});
|
|
27492
27707
|
var getSandboxV1Sandboxes = (options) => (options?.client ?? client).get({
|
|
27493
27708
|
querySerializer: { parameters: { state: { array: { explode: false } } } },
|
|
27494
27709
|
security: [
|
|
@@ -29944,6 +30159,9 @@ function createMedia(transport) {
|
|
|
29944
30159
|
batch: bind(transport, mediaBatchAssets),
|
|
29945
30160
|
create: bind(transport, (options) => mediaUploadAsset({ ...options, bodySerializer: multipartBodySerializer, headers: { "Content-Type": null, ...options.headers } })),
|
|
29946
30161
|
delete: bind(transport, mediaDeleteAsset),
|
|
30162
|
+
frames: {
|
|
30163
|
+
create: bind(transport, mediaCreateFrameUrls)
|
|
30164
|
+
},
|
|
29947
30165
|
import: {
|
|
29948
30166
|
create: bind(transport, mediaImportAsset)
|
|
29949
30167
|
},
|
|
@@ -29993,6 +30211,10 @@ function createMedia(transport) {
|
|
|
29993
30211
|
create: bind(transport, mediaVisualSearch)
|
|
29994
30212
|
}
|
|
29995
30213
|
},
|
|
30214
|
+
understandings: {
|
|
30215
|
+
list: bindPage(transport, mediaListUnderstandingsByLibrary),
|
|
30216
|
+
retrieveFailureSummary: bind(transport, mediaUnderstandingFailureSummary)
|
|
30217
|
+
},
|
|
29996
30218
|
update: bind(transport, mediaUpdateLibrary)
|
|
29997
30219
|
}
|
|
29998
30220
|
};
|
|
@@ -30117,6 +30339,9 @@ function createOrganization(transport) {
|
|
|
30117
30339
|
},
|
|
30118
30340
|
retrieve: bind(transport, getOrganizationFeedback)
|
|
30119
30341
|
},
|
|
30342
|
+
members: {
|
|
30343
|
+
list: bind(transport, listOrganizationMembers)
|
|
30344
|
+
},
|
|
30120
30345
|
usage: {
|
|
30121
30346
|
list: bind(transport, listOrganizationUsage)
|
|
30122
30347
|
}
|
|
@@ -33369,7 +33594,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
|
|
|
33369
33594
|
}
|
|
33370
33595
|
|
|
33371
33596
|
// src/main.ts
|
|
33372
|
-
var version = "0.2.1-dev.
|
|
33597
|
+
var version = "0.2.1-dev.d54e526";
|
|
33373
33598
|
var commands = commandTree(operations);
|
|
33374
33599
|
var manual = [...workflows.map((w) => w.words), [API_WORD]];
|
|
33375
33600
|
function route(argv) {
|