@deepraxis/cli 0.2.1-dev.bb2d647 → 0.2.1-dev.c7abab3
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 +11 -3
- package/dist/praxis.js +527 -50
- 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
|
+
530 HTTP operations; 532 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
|
|
|
@@ -356,24 +356,30 @@ 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
|
|
359
|
+
| `praxis api media generation capability list` | `media.generation.capabilities.list` | GET `/media/v1/generation/capabilities` | |
|
|
360
|
+
| `praxis api media library asset batch <library_id>` | `media.libraries.assets.batch` | POST `/media/v1/libraries/{library_id}/assets:batch` | `--reason` |
|
|
360
361
|
| `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
362
|
| `praxis api media library asset delete <asset_id>` | `media.libraries.assets.delete` | DELETE `/media/v1/libraries/{library_id}/assets/{asset_id}` | `--library` |
|
|
363
|
+
| `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
364
|
| `praxis api media library asset get <asset_id>` | `media.libraries.assets.retrieve` | GET `/media/v1/libraries/{library_id}/assets/{asset_id}` | `--library` |
|
|
363
365
|
| `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
366
|
| `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
367
|
| `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
368
|
| `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
369
|
| `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` |
|
|
370
|
+
| `praxis api media library batch create` | `media.libraries.batches.create` | POST `/media/v1/libraries/{library_id}/batches` | `--library`, `--reason` |
|
|
369
371
|
| `praxis api media library batch get <job_id>` | `media.libraries.batches.retrieve` | GET `/media/v1/libraries/{library_id}/batches/{job_id}` | `--library` |
|
|
370
372
|
| `praxis api media library create` | `media.libraries.create` | POST `/media/v1/libraries` | `--name` |
|
|
371
373
|
| `praxis api media library delete <library_id>` | `media.libraries.delete` | DELETE `/media/v1/libraries/{library_id}` | |
|
|
372
374
|
| `praxis api media library delivery-token create` | `media.libraries.deliveryTokens.create` | POST `/media/v1/libraries/{library_id}/delivery_tokens` | `--library`, `--acl`, `--expires-in` |
|
|
373
375
|
| `praxis api media library event list` | `media.libraries.events.list` | GET `/media/v1/libraries/{library_id}/events` | `--library`, `--after-seq`, `--before-seq`, `--order`, `--param-limit` |
|
|
374
376
|
| `praxis api media library folder list` | `media.libraries.folders.list` | GET `/media/v1/libraries/{library_id}/folders` | `--library`, `--parent` |
|
|
377
|
+
| `praxis api media library generation create` | `media.libraries.generations.create` | POST `/media/v1/libraries/{library_id}/generations` | `--library`, `--intent`, `--prompt`, `--count`, `--duration-seconds`, `--aspect-ratio`, `--model`, `--save`, `--asset-folder`, `--tags`, `--understanding` |
|
|
375
378
|
| `praxis api media library get <library_id>` | `media.libraries.retrieve` | GET `/media/v1/libraries/{library_id}` | |
|
|
379
|
+
| `praxis api media library job cancel <job_id>` | `media.libraries.jobs.cancel` | POST `/media/v1/libraries/{library_id}/jobs/{job_id}/cancel` | `--library` |
|
|
376
380
|
| `praxis api media library job get <job_id>` | `media.libraries.jobs.retrieve` | GET `/media/v1/libraries/{library_id}/jobs/{job_id}` | `--library` |
|
|
381
|
+
| `praxis api media library job list` | `media.libraries.jobs.list` | GET `/media/v1/libraries/{library_id}/jobs` | `--library`, `--status`, `--param-limit`, `--param-cursor` |
|
|
382
|
+
| `praxis api media library job output save create` | `media.libraries.jobs.outputs.save.create` | POST `/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save` | `--library`, `--job`, `--output`, `--public-id`, `--asset-folder`, `--tags`, `--understanding` |
|
|
377
383
|
| `praxis api media library list` | `media.libraries.list` | GET `/media/v1/libraries` | `--param-cursor`, `--param-limit`, `--labels`, `--status` |
|
|
378
384
|
| `praxis api media library purge <library_id>` | `media.libraries.purge.create` | POST `/media/v1/libraries/{library_id}/purge` | |
|
|
379
385
|
| `praxis api media library restore <library_id>` | `media.libraries.restore` | POST `/media/v1/libraries/{library_id}/restore` | |
|
|
@@ -381,6 +387,8 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
381
387
|
| `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
388
|
| `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
389
|
| `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` |
|
|
390
|
+
| `praxis api media library understanding get-failure-summary` | `media.libraries.understandings.retrieveFailureSummary` | GET `/media/v1/libraries/{library_id}/understandings/failure_summary` | `--library` |
|
|
391
|
+
| `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
392
|
| `praxis api media library update <library_id>` | `media.libraries.update` | PATCH `/media/v1/libraries/{library_id}` | `--hotwords`, `--name` |
|
|
385
393
|
| `praxis api meta doc get <path>` | `meta.docs.retrieve` | GET `/meta/v1/docs/{path}` | `--lang` |
|
|
386
394
|
| `praxis api meta doc search` | `meta.docs.search` | GET `/meta/v1/docs/search` | `--q`, `--param-limit`, `--lang` |
|
package/dist/praxis.js
CHANGED
|
@@ -143,7 +143,7 @@ across all toolsets allowed.`
|
|
|
143
143
|
type: "array",
|
|
144
144
|
itemType: "object",
|
|
145
145
|
required: false,
|
|
146
|
-
description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or
|
|
146
|
+
description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time."
|
|
147
147
|
},
|
|
148
148
|
{
|
|
149
149
|
name: "kind",
|
|
@@ -10162,6 +10162,12 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10162
10162
|
type: "integer",
|
|
10163
10163
|
required: false,
|
|
10164
10164
|
description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write."
|
|
10165
|
+
},
|
|
10166
|
+
{
|
|
10167
|
+
name: "loudness",
|
|
10168
|
+
type: "object",
|
|
10169
|
+
required: false,
|
|
10170
|
+
description: "Optional loudness normalization target; normalization adds analysis and rendering work."
|
|
10165
10171
|
}
|
|
10166
10172
|
]
|
|
10167
10173
|
}
|
|
@@ -10170,7 +10176,7 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10170
10176
|
resource: "cut.projects.frames",
|
|
10171
10177
|
method: "list",
|
|
10172
10178
|
summary: "Render preview frames",
|
|
10173
|
-
description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution.
|
|
10179
|
+
description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution. The response always includes warnings; FRAME_UNAVAILABLE means a source preview could not be obtained and an offline tile was drawn. Its message identifies a timeout, delivery capacity limit, or unavailable source and contains no source URL. Decode each image's base64 payload to save it. Codemode returns at most four images per call, so request at most four times when reviewing there.",
|
|
10174
10180
|
http: "GET",
|
|
10175
10181
|
path: "/cut/v1/projects/{project_id}/frames",
|
|
10176
10182
|
streaming: "no",
|
|
@@ -10385,7 +10391,7 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10385
10391
|
resource: "cut.projects",
|
|
10386
10392
|
method: "execute",
|
|
10387
10393
|
summary: "Execute editing script",
|
|
10388
|
-
description: 'Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: `const t = AddTrack("video"); Insert(t, {type: "color", color: "#123456", start: 0, length: 3}); Print(t);`\n\n### Script function reference\n\nFunctions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. JoinId is the string returned by Join or read from GetTimeline().joins. Reads see earlier writes in the same script.\n\n```ts\nGetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;\nGetItem(id: ClipId): ItemView;\nFindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];\nGetMedia(ref: MediaRef): MediaInfo;\nGetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];\nGetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];\nListTransitions(): TransitionInfo[];\nInsert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;\nUpdate(id: ClipId, patch: ItemPatchView): void;\nSetSpeed(id: ClipId, rate: number, o: { keep: "source" | "duration"; ripple?: boolean }): { length: number; sourceOut: number };\nDelete(id: ClipId, o?: { ripple?: boolean }): void;\nJoin(left: ClipId, right: ClipId, o: { length?: number; effect: TransitionInput }): JoinId;\nUpdateJoin(id: JoinId, patch: { length?: number; effect?: TransitionInput }): void;\nDeleteJoin(id: JoinId): void;\nSplit(id: ClipId, at: number): ClipId;\nTrim(id: ClipId, edge: "in" | "out", delta: number, o?: { ripple?: boolean }): void;\nMove(id: ClipId, start: number, track?: TrackId): void;\nRippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;\nAddTrack(kind: "video" | "audio" | "caption", init?: { name?: string }, index?: number): TrackId;\nUpdateTrack(id: TrackId, patch: TrackPatch): void;\nDeleteTrack(id: TrackId): void;\nSetSettings(patch: Partial<ProjectSettingsView>): void;\nAddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle>; maxChars?: number }): ClipId[];\nSetMarker(at: number, label: string): string;\nPrint(...values: unknown[]): void;\nPreview(at: number[]): void;\n```\n\n| Functions | Behavior and arguments |\n| --- | --- |\n| GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, playback, sourceIn/sourceOut, text and offline reason. GetTimeline returns duration, tracks (id, kind, name, index, locked, items), and joins (id, track, left, right, length in seconds, normalized effect). from/to and tracks narrow the items and joins; joins are selected by their overlap window. |\n| ListTransitions | Discover the shared validation catalog: each entry contains kind (effect ID), name, description and params. Each parameter has name, type (enum/number/integer), default, description, enum values or numeric min/max. Use the returned kind and parameter names inside effect. |\n| FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |\n| GetMedia | Read metadata for `{libraryId, assetId}` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |\n| GetTranscript, GetAnalysis | Read available transcript words or silence/filler/scenes segments. Transcript filter from/to is seconds; returned word and segment from/to values are source microseconds (divide by 1,000,000 for editing). Words contain text and optional speaker/filler; segments may include label/confidence. Request analysis first if unavailable. |\n| Insert, Update, Delete | Insert returns the new clip ID; Update changes supplied fields; Delete removes the clip. Optional ripple on Insert/Delete closes or opens space on the track. |\n| SetSpeed | Change video/audio rate in 0.25–4; keep is required. source preserves consumed source and changes length, duration preserves output length. Returns actual length and sourceOut in seconds. Optional ripple explicitly shifts same-track followers when keeping source; otherwise overlaps are rejected. |\n| Join, UpdateJoin, DeleteJoin | Join creates an overlap between two butt-adjacent visual clips on the same track and returns its ID. length defaults to 0.5 seconds; effect is required. The right clip and all same-track followers move left by length, shortening that track and potentially the project. UpdateJoin moves those followers by the difference in length; omitted fields are preserved. DeleteJoin moves them right to restore the butt cut. Other tracks stay in place. |\n| Split, Trim, Move | Split at a timeline position and return the new right-hand clip ID. Trim changes the in or out edge by delta seconds. Move sets the timeline start and optionally a new track. |\n| RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |\n| AddTrack, UpdateTrack, DeleteTrack | Add video/audio/caption tracks; index selects layer order (0 is top). TrackPatch supports name, locked, hidden, muted, gainDb and style as appropriate to track kind. |\n| SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |\n| AddCaptionsFromTranscript | Create captions from an audio/video clip\'s kept words. Optional maxChars is 1–1000, default 16; style updates the caption track. Returns caption IDs. |\n| SetMarker | Add a label at a timeline time and return its ID. |\n| Print, Preview | Print appends text to prints. Preview requests up to eight times total per execute and puts images in the result\'s frames. Each url is an inline PNG data URL, not an HTTP image link. Decode the base64 payload to save an image. Codemode returns at most four images per call; request at most four times there. |\n\n#### Joins between clips\n\nEndpoints may be video, image, text, color or shape; audio and caption are rejected. Require 0 < length < each endpoint\'s length. Each clip allows at most one incoming and one outgoing join; their summed lengths cannot exceed its length. Three-input overlaps, nonadjacent endpoints and cross-track joins are rejected with OPS_REJECTED. Read the rejection\'s code and message, shorten or remove conflicting joins, and retry the saved edit.\n\nTransitionInput is an object with kind plus the parameters returned by ListTransitions; omitted parameters use the catalog defaults. Unknown kinds and unknown or invalid parameters are rejected. Effects: dissolve (no parameters); dip (color black/white, default black); push and wipe (direction left/right/up/down, default left); wipe also has softness 0–1, default 0; iris has centerX/centerY 0–1, both default 0.5; blinds has integer count 2–64, default 8, and orientation vertical/horizontal, default vertical; blur has radius 0–100 pixels at 1080-pixel frame height, default 24. Join options and UpdateJoin patches accept only length and effect. Effect updates replace the effect object and apply defaults for omitted parameters.\n\nMinimal example on an existing visual track with adjacent clips left and right: `Print(ListTransitions()); const j = Join(left, right, {length: 0.5, effect: {kind: "dissolve"}}); Print(GetTimeline().joins); Preview([GetItem(right).start + 0.25]);` Use `UpdateJoin(j, {length: 0.8})` to adjust it in a later edit or `DeleteJoin(j)` to restore the cut. Preview uses server-rendered frames and includes joins. Per-clip transitionIn/transitionOut remain separate entrance/exit effects.\n\n#### Insert fields (ItemInit)\n\nEvery item requires `type` and `start`. Times used for editing are seconds and snap to the project frame rate: start, length, sourceIn, fadeIn/fadeOut, transition length, keyframe at, reveal delay/stagger/duration. Keyframe and reveal times are relative to the clip start. Video/audio may omit length to use the remaining source duration; other types require length.\n\n| type | Required fields beyond type/start | Optional fields |\n| --- | --- | --- |\n| video | media | length, sourceIn, playback, volumeDb, transform, fit, animate, transitionIn, transitionOut |\n| image | media, length | transform, fit, animate, transitionIn, transitionOut |\n| text | text, length | style, transform, reveal, animate, transitionIn, transitionOut |\n| color | color, length | transform, fill, animate, transitionIn, transitionOut |\n| shape | shape, length, width, height, fill | radius, stroke, transform, animate, transitionIn, transitionOut |\n| audio | media | length, sourceIn, playback, volumeDb, fadeIn, fadeOut |\n| caption | text, length | — |\n\nVideo tracks accept video/image/text/color/shape; audio and caption tracks accept their corresponding type. Media is `{libraryId: string, assetId: string}` from a bound library. sourceIn defaults to 0, volumeDb to 0 dB, audio fades to 0 seconds. fit defaults to contain: contain fits the whole image, cover fills and crops, fill stretches, none keeps native dimensions.\n\n| Field | Value |\n| --- | --- |\n| transform | Partial `{x, y, scale, rotation, opacity, crop, blur}`. x/y are normalized canvas center coordinates (default 0.5); scale 1 is fitted size; rotation is degrees (default 0); opacity is 0–1 (default 1). crop is `{top,right,bottom,left}`. blur is 0–100 pixels at 1080-pixel frame height. |\n| style | Partial `{fontFamily, fontSize, fontWeight, color, stroke, background, align, maxWidth, position, margin}`. fontFamily: Geist or Noto Sans SC (default); fontSize defaults to 48; fontWeight: 400 (default), 500 or 700; color defaults to #FFFFFF; align: left, center (default), right; maxWidth is a fraction of canvas width (default 0.9). stroke is `{color,width}`. Text and captions support position (top/middle/bottom; box centers at 12%/50%/85% of height without margin) and optional margin (0–0.4 of canvas height, box edge distance for top/bottom; middle ignores it). Omitted position preserves the text transform (center by default); explicit position controls vertical placement, so omit it for y animation. Caption style additionally supports highlightColor and maxLines: 2. GetItem and GetTimeline return text style and current caption track style. Caption tracks only accept captions; use AddCaptionsFromTranscript, and place text on video tracks. |\n| animate | An object keyed by x, y, scale, rotation, opacity or blur. Each value is an array of `{at: number, value: number, ease?: Ease}` sorted by at with distinct frame-snapped times. Values hold before the first and after the last keyframe, overriding the static transform. |\n| Ease | linear, in, out, inOut, `{bezier: [x1,y1,x2,y2]}` or `{spring: {stiffness, damping, mass?}}`. Easing shapes the segment arriving at that keyframe; springs may overshoot. |\n| reveal | `{by, delay?: number, stagger: number, duration: number, from: {y?, opacity?, scale?, blur?}, ease?: Ease}`. by selects char, word or line. Unit k starts at delay + k * stagger and takes duration seconds to reach its resting state; from.y is a fraction of font size. |\n| fill | A color string (#RRGGBB or #RRGGBBAA), `{linear: {angle, stops: [{at,color}, ...]}}` or `{radial: {stops: [{at,color}, ...]}}`. Stop positions are 0–1; angle is degrees, 0 left to right. On color clips, fill replaces color when supplied. |\n| shape, width, height, radius, stroke | shape is rect or ellipse. width/height are fractions of canvas width/height before scaling. radius rounds rect corners in pixels at 1080-pixel frame height. stroke is `{color: string, width: number}`. |\n| transitionIn, transitionOut | `{kind, length: number}` at the clip\'s beginning/end. length is seconds. fade changes opacity; dissolve blends; push_left/push_right move horizontally; wipe_left reveals horizontally. |\n\n#### Update fields (ItemPatchView)\n\nAll fields are optional; use only fields relevant to the item\'s type. Supported fields: start, length, sourceIn, playback, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, animate, reveal, fill, stroke, shape, width, height, radius, transitionIn, transitionOut. Values and units match Insert. Set animate, reveal, fill, stroke, transitionIn or transitionOut to null to remove that effect; omitting a field preserves it. For example: `Update(id, {volumeDb: -12})` or `Update(id, {transitionIn: null})`.\n\n#### Speed, reverse and freeze\n\nVideo/audio Insert and Update accept playback as `{kind: "rate", rate: number, direction: "forward" | "reverse", audio: "preservePitch" | "resample" | "mute"}` or `{kind: "freeze"}`. Rate is finite and inclusive 0.25–4. Omitted playback defaults to 1× forward with preservePitch; supply the complete rate object when changing playback. preservePitch keeps pitch, resample changes pitch with speed, mute removes audio. Reverse requires explicit audio: "mute"; preservePitch/resample are rejected with UNSUPPORTED_PLAYBACK rather than silently muted. Freeze holds sourceIn and is silent. GetItem/GetTimeline echo playback and the source interval in seconds; sourceOut is exclusive even for reverse and equals sourceIn for freeze.\n\nUpdate of playback keeps output length unless length is also supplied. SetSpeed preserves direction/audio, rejects frozen and non-video/audio clips, and requires keep: "source" or "duration". keep: "source" computes round(consumed source / new rate × fps) frames, falling back to floor if rounding would exceed the source end; the returned length/sourceOut are actual frame-rounded seconds. keep: "duration" keeps output length and changes source consumption. Length conflicts fail with OVERLAP; move/shorten the conflicting clip, keep duration, or explicitly use ripple: true to shift following clips on the same track. Source overflow fails with OUT_OF_SOURCE; rate limits fail with RATE_OUT_OF_RANGE. Unknown playback fields and SetSpeed options are rejected with UNKNOWN_FIELD; options only accept keep and boolean ripple.\n\nExample for an existing four-second video/audio clip id: `Print(SetSpeed(id, 0.5, {keep: "source"})); Print(SetSpeed(id, 2, {keep: "source"}));` returns lengths 8 then 2, keeping the same source interval. Reverse: `Update(id, {playback: {kind: "rate", rate: 1, direction: "reverse", audio: "mute"}})`. Freeze: `Update(id, {playback: {kind: "freeze"}})`. Ensure enough source remains for the chosen length/rate. Browser reverse playback currently displays a placeholder; server-rendered Preview/frames and exports support reverse normally. Speed-adjusted audio is generated asynchronously after the edit transaction commits; exports wait for that audio before rendering.\n\n#### Script names versus HTTP response names\n\nUse camelCase inside scripts, including nested objects. HTTP request/response JSON outside script source uses snake_case. Map media.library_id → media.libraryId, media.asset_id → media.assetId, source_in → sourceIn, volume_db → volumeDb, fade_in/fade_out → fadeIn/fadeOut, transition_in/transition_out → transitionIn/transitionOut, font_family/font_size/font_weight/max_width → fontFamily/fontSize/fontWeight/maxWidth, gain_db → gainDb, highlight_color/max_lines → highlightColor/maxLines. Fields such as animate, reveal, fill, stroke, at and length retain their spelling. GetTimeline/GetItem already return camelCase compact views; the expanded retrieveTimeline HTTP response is not an Insert object.\n\nUnrecognized script fields fail with OPS_REJECTED and rejection code UNKNOWN_FIELD; snake_case mistakes suggest the corresponding camelCase name. The error message lists each rejection\'s #opIndex, code and reason. Correct the named fields and retry the saved edit; do not assume an ignored field applied an effect.\n',
|
|
10394
|
+
description: 'Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: `const t = AddTrack("video"); Insert(t, {type: "color", color: "#123456", start: 0, length: 3}); Print(t);`\n\n### Script function reference\n\nFunctions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. JoinId is the string returned by Join or read from GetTimeline().joins. Reads see earlier writes in the same script.\n\n```ts\nGetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;\nGetItem(id: ClipId): ItemView;\nFindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];\nGetMedia(ref: MediaRef): MediaInfo;\nGetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];\nGetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];\nListTransitions(): TransitionInfo[];\nListEffects(): EffectInfo[];\nListTextStyles(): TextStylePreset[];\nListTextTemplates(): TextTemplate[];\nListAnimations(): { id: string; version: number; phase: "in" | "out" | "loop"; target: "any" | "text"; name: string; description: string; defaultDuration: number; params: { name: string; type: string; values?: string[]; default?: string | number; min?: number; max?: number; description: string }[] }[];\nListFonts(): { family: string; weights: number[]; scripts: ("latin"|"cjk")[]; source: "bundled"|"catalog" }[];\nInsert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;\nUpdate(id: ClipId, patch: ItemPatchView): void;\nSetSpeed(id: ClipId, rate: number | { curve: { at: number; rate: number; ease?: Ease }[]; audio?: "mute" | "resample" }, o: { keep: "source" | "duration"; ripple?: boolean }): { length: number; sourceOut: number };\nDelete(id: ClipId, o?: { ripple?: boolean }): void;\nJoin(left: ClipId, right: ClipId, o: { length?: number; effect: TransitionInput }): JoinId;\nUpdateJoin(id: JoinId, patch: { length?: number; effect?: TransitionInput }): void;\nDeleteJoin(id: JoinId): void;\nSplit(id: ClipId, at: number): ClipId;\nTrim(id: ClipId, edge: "in" | "out", delta: number, o?: { ripple?: boolean }): void;\nMove(id: ClipId, start: number, track?: TrackId): void;\nRippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;\nAddTrack(kind: "video" | "audio" | "caption", init?: { name?: string; role?: "voice" | "music" | "sfx" }, index?: number): TrackId;\nUpdateTrack(id: TrackId, patch: TrackPatch): void;\nDeleteTrack(id: TrackId): void;\nSetSettings(patch: Partial<ProjectSettingsView>): void;\nAddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle> & { preset?: string }; maxChars?: number }): ClipId[];\nInsertTemplate(track: TrackId, o: { template: string; start: number; slots?: Record<string, string> }): ClipId[];\nAlignCaptions(trackId: TrackId, script: string): { replaced: number; added: number; deleted: number };\nSetMarker(at: number, label: string): string;\nPrint(...values: unknown[]): void;\nPreview(at: number[]): void;\n```\n\n| Functions | Behavior and arguments |\n| --- | --- |\n| GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, playback, sourceIn/sourceOut, text, effects, blend and offline reason. GetTimeline returns duration, tracks (id, kind, name, index, locked, items), and joins (id, track, left, right, length in seconds, normalized effect). from/to and tracks narrow the items and joins; joins are selected by their overlap window. |\n| ListEffects | Discover the shared visual-effect catalog with parameter types, ranges, defaults, cost and bounds. Effects are supported only on visual clips. |\n| ListTransitions | Discover the shared validation catalog: each entry contains kind (effect ID), name, description and params. Each parameter has name, type (enum/number/integer), default, description, enum values or numeric min/max. Use the returned kind and parameter names inside effect. |\n| ListAnimations | Discover animation presets. Each entry has id, version, phase (`in`, `out`, `loop`), target (`any`, `text`), name, description, defaultDuration (seconds), and params (name, type, values/default/min/max/description as applicable). A slot use is `{preset, duration?, ...params}`; duration is seconds. |\n| FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |\n| GetMedia | Read metadata for `{libraryId, assetId}` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |\n| GetTranscript, GetAnalysis | Read available transcript words or silence/filler/scenes segments. Transcript filter from/to is seconds; returned word and segment from/to values are source microseconds (divide by 1,000,000 for editing). Words contain text and optional speaker/filler; segments may include label/confidence. Request analysis first if unavailable. |\n| Insert, Update, Delete | Insert returns the new clip ID; Update changes supplied fields; Delete removes the clip. Optional ripple on Insert/Delete closes or opens space on the track. |\n| SetSpeed | Change video/audio rate in 0.25–4; keep is required. A `{curve: [{at, rate, ease?}, ...], audio?: "mute" | "resample"}` rate is forward-only and holds output duration fixed; pitch preservation is unavailable. Scalar rates: source preserves consumed source and changes length; duration preserves output length. Returns actual length and sourceOut in seconds. Optional ripple explicitly shifts same-track followers when keeping source; otherwise overlaps are rejected. |\n| Join, UpdateJoin, DeleteJoin | Join creates an overlap between two butt-adjacent visual clips on the same track and returns its ID. length defaults to 0.5 seconds; effect is required. The right clip and all same-track followers move left by length, shortening that track and potentially the project. UpdateJoin moves those followers by the difference in length; omitted fields are preserved. DeleteJoin moves them right to restore the butt cut. Other tracks stay in place. |\n| Split, Trim, Move | Split at a timeline position and return the new right-hand clip ID. Trim changes the in or out edge by delta seconds. Move sets the timeline start and optionally a new track. |\n| RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |\n| AddTrack, UpdateTrack, DeleteTrack | Add video/audio/caption tracks; index selects layer order (0 is top). TrackPatch supports name, locked, hidden, muted, gainDb, audio role (`voice`, `music`, `sfx`) and style as appropriate to track kind. |\n| SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |\n| AddCaptionsFromTranscript | Create captions from an audio/video clip\'s kept words. Optional maxChars is 1–1000, default 16; style updates the caption track. Returns caption IDs. |\n| SetMarker | Add a label at a timeline time and return its ID. |\n| Print, Preview | Print appends text to prints. Preview requests up to eight times total per execute and puts images in the result\'s frames. Each url is an inline PNG data URL, not an HTTP image link. Decode the base64 payload to save an image. Codemode returns at most four images per call; request at most four times there. |\n\n#### Joins between clips\n\nEndpoints may be video, image, text, color or shape; audio and caption are rejected. Require 0 < length < each endpoint\'s length. Each clip allows at most one incoming and one outgoing join; their summed lengths cannot exceed its length. Three-input overlaps, nonadjacent endpoints and cross-track joins are rejected with OPS_REJECTED. Read the rejection\'s code and message, shorten or remove conflicting joins, and retry the saved edit.\n\nTransitionInput is an object with kind plus the parameters returned by ListTransitions; omitted parameters use catalog defaults. Unknown kinds and invalid parameters return INVALID_TRANSITION_PARAM with available parameters. Effects: dissolve; dip color black/white default black; push and wipe direction left/right/up/down default left; wipe softness 0–1 default 0; iris centerX/centerY 0–1 default 0.5; blinds integer count 2–64 default 8 and orientation vertical/horizontal default vertical; blur radius 0–100 pixels at 1080-pixel frame height default 24; zoom direction in/out default in, amount 0.1–3 default 1, blur 0–1 default 0.5; clock direction clockwise/counterclockwise default clockwise, startAngle 0–360 degrees default 0 (twelve o\'clock), softness 0–1 default 0; flash color white/black default white, intensity 0–1 default 1. Zoom blur uses up to eight radial samples per shot and is slower on server rendering. Join options and UpdateJoin patches accept only length and effect. Effect updates replace the effect object and apply defaults for omitted parameters.\n\nMinimal example on an existing visual track with adjacent clips left and right: `Print(ListTransitions()); const j = Join(left, right, {length: 0.5, effect: {kind: "dissolve"}}); Print(GetTimeline().joins); Preview([GetItem(right).start + 0.25]);` Use `UpdateJoin(j, {length: 0.8})` to adjust it in a later edit or `DeleteJoin(j)` to restore the cut. Preview uses server-rendered frames and includes joins. Per-clip transitionIn/transitionOut remain separate entrance/exit effects.\n\n#### Insert fields (ItemInit)\n\nEvery item requires `type` and `start`. Times used for editing are seconds and snap to the project frame rate: start, length, sourceIn, fadeIn/fadeOut, transition length, keyframe at, reveal delay/stagger/duration. Keyframe and reveal times are relative to the clip start. Video/audio may omit length to use the remaining source duration; other types require length.\n\n| type | Required fields beyond type/start | Optional fields |\n| --- | --- | --- |\n| video | media | length, sourceIn, playback, volumeDb, transform, fit, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| image | media, length | transform, fit, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| text | text, length | style, transform, blend, reveal, animate, animation, effects, mask, transitionIn, transitionOut |\n| color | color, length | transform, fill, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| shape | shape, length, width, height, fill | radius, stroke, transform, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| audio | media | length, sourceIn, playback, volumeDb, gain, fadeIn, fadeOut |\n| caption | text, length | — |\n\nVisual Insert/Update also accepts `blend`: `normal` (default), `screen`, `multiply`, `overlay`, or `add`; set it to null in Update to clear it. During a Join overlap, both inputs render with normal blending. Video tracks accept video/image/text/color/shape; audio and caption tracks accept their corresponding type. Media is `{libraryId: string, assetId: string}` from a bound library. sourceIn defaults to 0, volumeDb to 0 dB, audio fades to 0 seconds. fit defaults to contain: contain fits the whole image, cover fills and crops, fill stretches, none keeps native dimensions.\n\n| Field | Value |\n| --- | --- |\n| transform | Partial `{x, y, scale, rotation, opacity, crop, blur}`. x/y are normalized canvas center coordinates (default 0.5); scale 1 is fitted size; rotation is degrees (default 0); opacity is 0–1 (default 1). crop is `{top,right,bottom,left}`. blur is 0–100 pixels at 1080-pixel frame height. |\n| style | Partial `{fontFamily, fontSize, fontWeight, color, fill, stroke, strokes, shadows, glow, background, align, maxWidth, position, margin}`. fill accepts a color or linear/radial gradient across the entire text bounding box. strokes draw outside to inside; at most 4, width 0–40. shadows accepts at most 4 `{color,x,y,blur}` entries; blur is 0–100. glow is `{color,radius,strength}` with radius 0–100 and strength 0–1. All dimensions use pixels at 1080 frame height and scale with the text. Glow and large shadow blur increase render time. Invalid colors or ranges return actionable INVALID_STYLE errors. `ListFonts()` discovers family, available weights, scripts and bundled/catalog source. Text and captions share the style fields; caption style additionally supports highlightColor and maxLines: 2. |\n| animate | An object keyed by x, y, scale, rotation, opacity or blur. Each value is an array of `{at: number, value: number, ease?: Ease}` sorted by at with distinct frame-snapped times. Values hold before the first and after the last keyframe, overriding the static transform. |\n| animation | `{in?: AnimationUse, out?: AnimationUse, loop?: AnimationUse}` on visual clips. Each use is `{preset: string, duration?: number, ...params}`; duration and parameter units follow `ListAnimations()`. Presets replace existing animate and reveal when applied. Update accepts `animation: null` to clear the preset and its generated effects. |\n| Ease | linear, in, out, inOut, `{bezier: [x1,y1,x2,y2]}` or `{spring: {stiffness, damping, mass?}}`. Easing shapes the segment arriving at that keyframe; springs may overshoot. |\n| reveal | `{by, delay?: number, stagger: number, duration: number, from: {y?, opacity?, scale?, blur?}, ease?: Ease}`. by selects char, word or line. Unit k starts at delay + k * stagger and takes duration seconds to reach its resting state; from.y is a fraction of font size. |\n| fill | A color string (#RRGGBB or #RRGGBBAA), `{linear: {angle, stops: [{at,color}, ...]}}` or `{radial: {stops: [{at,color}, ...]}}`. Stop positions are 0–1; angle is degrees, 0 left to right. On color clips, fill replaces color when supplied. |\n| shape, width, height, radius, stroke | shape is rect or ellipse. width/height are fractions of canvas width/height before scaling. radius rounds rect corners in pixels at 1080-pixel frame height. stroke is `{color: string, width: number}`. |\n| transitionIn, transitionOut | `{kind, length: number}` at the clip\'s beginning/end. length is seconds. fade changes opacity; dissolve blends; push_left/push_right move horizontally; wipe_left reveals horizontally. |\n\n#### Visual effects\n\n`effects` is an ordered stack of at most 8 catalog entries. Call `ListEffects()` to discover the catalog; unknown kinds return `UNKNOWN_EFFECT`, invalid names/values/keyframes return `INVALID_EFFECT_PARAM`, and stacks over 8 return `TOO_MANY_EFFECTS`. Entries include blur, color adjustment, vignette, film grain, chromatic aberration, pixelate, glitch, shake, flash, light leak and built-in `lut` looks; user `.cube` LUTs are not supported. `speed` is cycles per second. Effects run on CPU during export and increase render time. Parameters are discovered with ListEffects(). Catalog entries expose their own parameters through ListEffects(), including `blur` (`radius` 0–100, default 24) and `color_adjust`: `brightness`, `contrast`, `temperature`, and `tint` each range -1–1 (default 0), while `saturation` ranges 0–2 (default 1). Disabled entries are skipped. `color_adjust` uses an SDR-only Rec.709 adjustment matrix with no color management.\n\nNumeric and integer effect parameters accept `keyframes: {parameter: [{at, value, ease?}, ...]}`; times are seconds relative to the clip, snap to frames like `animate`, must be strictly increasing and within clip duration, and values follow that parameter\'s catalog range. Omitted parameters use catalog defaults. Trim and Split preserve effect keyframes with the same clip-local behavior as `animate`. There are no custom shaders.\n\n`blend` applies to the completed visual layer after its content, effects and `transform.blur`; `add` maps to Skia Plus. The default `normal` path adds no blend layer. During Join overlaps, blending is forced to normal because each input is composed on transparency.\n\n#### Update fields (ItemPatchView)\n\nAll fields are optional; use only fields relevant to the item\'s type. Supported fields: start, length, sourceIn, playback, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, animate, reveal, animation, fill, stroke, shape, width, height, radius, transitionIn, transitionOut, effects, blend, mask, gain. Values and units match Insert; set effects or blend to null to clear them. Set animation to null to clear the preset; set animate or reveal to null to remove that effect. Applying a preset replaces existing animate/reveal. Do not set animation together with animate or reveal in one Insert/Update call. Omit a field to preserve it.\n\n#### Animation presets\n\nDiscover the catalog with `ListAnimations()`. Its entries contain id, version, phase (`in`, `out`, `loop`), target (`any` or `text`), name, description, defaultDuration in seconds, and params. Slots may combine one in, one out and one loop preset. A loop runs only in the interval between in and out; if the same property is animated by multiple slots, loop occupies only that middle interval. Text-target presets are entrances. Their duration controls the rhythm per character/word/line, not the total reveal time. Out and loop presets apply to the whole clip, not per text unit.\n\nPresets replace the clip\'s existing animate and reveal when applied. The source preset is retained, so changing clip length or transform automatically regenerates its keyframes/reveal. If a clip becomes shorter, in/out durations shrink proportionally; when it grows, the requested durations are restored. Split keeps in on the left, out on the right, and loop on both. Writing animate or reveal directly detaches the preset; setting animation to null clears both source and generated effects. Insert/Update reject a call that supplies animation together with animate or reveal.\n\nErrors: UNKNOWN_ANIMATION (unknown preset), INVALID_ANIMATION_PARAM (invalid slot/parameter or frame/keyframe limit), ANIMATION_TOO_LONG (in+out exceed clip length), ANIMATION_TARGET_MISMATCH (text-only preset on a non-text or preset on non-visual clip), ANIMATION_PHASE_MISMATCH (preset in the wrong slot). Each animated property is limited to 600 keyframes; loop duration must be at least 4 frames. `ANIMATION_TOO_LONG` is avoided during later length changes by proportional fitting.\n\n#### Speed, reverse and freeze\n\nVideo/audio Insert and Update accept playback as `{kind: "rate", rate: number, direction: "forward" | "reverse", audio: "preservePitch" | "resample" | "mute"}` or `{kind: "freeze"}`. Rate is finite and inclusive 0.25–4. Omitted playback defaults to 1× forward with preservePitch; supply the complete rate object when changing playback. preservePitch keeps pitch, resample changes pitch with speed, mute removes audio. Reverse requires explicit audio: "mute"; preservePitch/resample are rejected with UNSUPPORTED_PLAYBACK rather than silently muted. Freeze holds sourceIn and is silent. GetItem/GetTimeline echo playback and the source interval in seconds; sourceOut is exclusive even for reverse and equals sourceIn for freeze.\n\nUpdate of playback keeps output length unless length is also supplied. SetSpeed preserves direction/audio, rejects frozen and non-video/audio clips, and requires keep: "source" or "duration". keep: "source" computes round(consumed source / new rate × fps) frames, falling back to floor if rounding would exceed the source end; the returned length/sourceOut are actual frame-rounded seconds. keep: "duration" keeps output length and changes source consumption. Length conflicts fail with OVERLAP; move/shorten the conflicting clip, keep duration, or explicitly use ripple: true to shift following clips on the same track. Source overflow fails with OUT_OF_SOURCE; rate limits fail with RATE_OUT_OF_RANGE. Unknown playback fields and SetSpeed options are rejected with UNKNOWN_FIELD; options only accept keep and boolean ripple.\n\nExample for an existing four-second video/audio clip id: `Print(SetSpeed(id, 0.5, {keep: "source"})); Print(SetSpeed(id, 2, {keep: "source"}));` returns lengths 8 then 2, keeping the same source interval. Reverse: `Update(id, {playback: {kind: "rate", rate: 1, direction: "reverse", audio: "mute"}})`. Freeze: `Update(id, {playback: {kind: "freeze"}})`. Ensure enough source remains for the chosen length/rate. Browser reverse playback currently displays a placeholder; server-rendered Preview/frames and exports support reverse normally. Speed-adjusted audio is generated asynchronously after the edit transaction commits; exports wait for that audio before rendering.\n\n#### Script names versus HTTP response names\n\nUse camelCase inside scripts, including nested objects. HTTP request/response JSON outside script source uses snake_case. Map media.library_id → media.libraryId, media.asset_id → media.assetId, source_in → sourceIn, volume_db → volumeDb, fade_in/fade_out → fadeIn/fadeOut, transition_in/transition_out → transitionIn/transitionOut, font_family/font_size/font_weight/max_width → fontFamily/fontSize/fontWeight/maxWidth, gain_db → gainDb, highlight_color/max_lines → highlightColor/maxLines. Fields such as animate, reveal, fill, stroke, at and length retain their spelling. GetTimeline/GetItem already return camelCase compact views; the expanded retrieveTimeline HTTP response is not an Insert object.\n\nUnrecognized script fields fail with OPS_REJECTED and rejection code UNKNOWN_FIELD; snake_case mistakes suggest the corresponding camelCase name. The error message lists each rejection\'s #opIndex, code and reason. Correct the named fields and retry the saved edit; do not assume an ignored field applied an effect.\n',
|
|
10389
10395
|
http: "POST",
|
|
10390
10396
|
path: "/cut/v1/projects/{project_id}:execute",
|
|
10391
10397
|
streaming: "no",
|
|
@@ -11888,7 +11894,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11888
11894
|
resource: "knowledge.vectorStores",
|
|
11889
11895
|
method: "create",
|
|
11890
11896
|
summary: "Create knowledge base",
|
|
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.
|
|
11897
|
+
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"}.',
|
|
11892
11898
|
http: "POST",
|
|
11893
11899
|
path: "/knowledge/v1/vector_stores",
|
|
11894
11900
|
streaming: "no",
|
|
@@ -11927,7 +11933,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11927
11933
|
name: "chunking_strategy",
|
|
11928
11934
|
type: "object",
|
|
11929
11935
|
required: false,
|
|
11930
|
-
description: "auto
|
|
11936
|
+
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."
|
|
11931
11937
|
},
|
|
11932
11938
|
{
|
|
11933
11939
|
name: "description",
|
|
@@ -12274,7 +12280,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12274
12280
|
resource: "knowledge.vectorStores.files",
|
|
12275
12281
|
method: "create",
|
|
12276
12282
|
summary: "Add file",
|
|
12277
|
-
description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching.
|
|
12283
|
+
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.",
|
|
12278
12284
|
http: "POST",
|
|
12279
12285
|
path: "/knowledge/v1/vector_stores/{vector_store_id}/files",
|
|
12280
12286
|
streaming: "no",
|
|
@@ -12306,7 +12312,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12306
12312
|
name: "chunking_strategy",
|
|
12307
12313
|
type: "object",
|
|
12308
12314
|
required: false,
|
|
12309
|
-
description: "auto
|
|
12315
|
+
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."
|
|
12310
12316
|
}
|
|
12311
12317
|
]
|
|
12312
12318
|
}
|
|
@@ -12613,11 +12619,23 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12613
12619
|
],
|
|
12614
12620
|
query: []
|
|
12615
12621
|
},
|
|
12622
|
+
{
|
|
12623
|
+
resource: "media.generation.capabilities",
|
|
12624
|
+
method: "list",
|
|
12625
|
+
summary: "Get generation capabilities",
|
|
12626
|
+
description: "Read supported text-to-video intent, default model, duration and aspect-ratio limits, per-library concurrency and candidate retention. Generation is charged per second; unsaved candidates expire after 7 days.",
|
|
12627
|
+
http: "GET",
|
|
12628
|
+
path: "/media/v1/generation/capabilities",
|
|
12629
|
+
streaming: "no",
|
|
12630
|
+
pagination: false,
|
|
12631
|
+
pathParams: [],
|
|
12632
|
+
query: []
|
|
12633
|
+
},
|
|
12616
12634
|
{
|
|
12617
12635
|
resource: "media.libraries",
|
|
12618
12636
|
method: "list",
|
|
12619
12637
|
summary: "List libraries",
|
|
12620
|
-
description: "
|
|
12638
|
+
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.",
|
|
12621
12639
|
http: "GET",
|
|
12622
12640
|
path: "/media/v1/libraries",
|
|
12623
12641
|
streaming: "no",
|
|
@@ -12699,7 +12717,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12699
12717
|
resource: "media.libraries",
|
|
12700
12718
|
method: "delete",
|
|
12701
12719
|
summary: "Delete library",
|
|
12702
|
-
description: "
|
|
12720
|
+
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.",
|
|
12703
12721
|
http: "DELETE",
|
|
12704
12722
|
path: "/media/v1/libraries/{library_id}",
|
|
12705
12723
|
streaming: "no",
|
|
@@ -12717,7 +12735,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12717
12735
|
resource: "media.libraries",
|
|
12718
12736
|
method: "retrieve",
|
|
12719
12737
|
summary: "Get library",
|
|
12720
|
-
description: "
|
|
12738
|
+
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.",
|
|
12721
12739
|
http: "GET",
|
|
12722
12740
|
path: "/media/v1/libraries/{library_id}",
|
|
12723
12741
|
streaming: "no",
|
|
@@ -12735,7 +12753,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12735
12753
|
resource: "media.libraries",
|
|
12736
12754
|
method: "update",
|
|
12737
12755
|
summary: "Update library",
|
|
12738
|
-
description: "Update an active library
|
|
12756
|
+
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.",
|
|
12739
12757
|
http: "PATCH",
|
|
12740
12758
|
path: "/media/v1/libraries/{library_id}",
|
|
12741
12759
|
streaming: "no",
|
|
@@ -12789,7 +12807,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12789
12807
|
resource: "media.libraries.assets",
|
|
12790
12808
|
method: "list",
|
|
12791
12809
|
summary: "List assets",
|
|
12792
|
-
description: "
|
|
12810
|
+
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.",
|
|
12793
12811
|
http: "GET",
|
|
12794
12812
|
path: "/media/v1/libraries/{library_id}/assets",
|
|
12795
12813
|
streaming: "no",
|
|
@@ -12837,7 +12855,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12837
12855
|
resource: "media.libraries.assets",
|
|
12838
12856
|
method: "create",
|
|
12839
12857
|
summary: "Upload asset",
|
|
12840
|
-
description: "
|
|
12858
|
+
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.",
|
|
12841
12859
|
http: "POST",
|
|
12842
12860
|
path: "/media/v1/libraries/{library_id}/assets",
|
|
12843
12861
|
streaming: "no",
|
|
@@ -12882,7 +12900,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12882
12900
|
name: "asset_folder",
|
|
12883
12901
|
type: "string",
|
|
12884
12902
|
required: false,
|
|
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."
|
|
12903
|
+
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."
|
|
12886
12904
|
},
|
|
12887
12905
|
{
|
|
12888
12906
|
name: "use_filename",
|
|
@@ -12961,7 +12979,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12961
12979
|
resource: "media.libraries.assets.import",
|
|
12962
12980
|
method: "create",
|
|
12963
12981
|
summary: "Import file",
|
|
12964
|
-
description: "Copy
|
|
12982
|
+
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.",
|
|
12965
12983
|
http: "POST",
|
|
12966
12984
|
path: "/media/v1/libraries/{library_id}/assets/import",
|
|
12967
12985
|
streaming: "no",
|
|
@@ -12981,7 +12999,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12981
12999
|
name: "file_id",
|
|
12982
13000
|
type: "string",
|
|
12983
13001
|
required: true,
|
|
12984
|
-
description: "File ID to copy into this library instead of file bytes. This independent copy defaults to
|
|
13002
|
+
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."
|
|
12985
13003
|
},
|
|
12986
13004
|
{
|
|
12987
13005
|
name: "public_id",
|
|
@@ -13005,7 +13023,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13005
13023
|
name: "asset_folder",
|
|
13006
13024
|
type: "string",
|
|
13007
13025
|
required: false,
|
|
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."
|
|
13026
|
+
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."
|
|
13009
13027
|
},
|
|
13010
13028
|
{
|
|
13011
13029
|
name: "use_filename",
|
|
@@ -13084,7 +13102,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13084
13102
|
resource: "media.libraries.assets",
|
|
13085
13103
|
method: "delete",
|
|
13086
13104
|
summary: "Delete asset",
|
|
13087
|
-
description: "
|
|
13105
|
+
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.",
|
|
13088
13106
|
http: "DELETE",
|
|
13089
13107
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
|
|
13090
13108
|
streaming: "no",
|
|
@@ -13107,7 +13125,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13107
13125
|
resource: "media.libraries.assets",
|
|
13108
13126
|
method: "retrieve",
|
|
13109
13127
|
summary: "Get asset",
|
|
13110
|
-
description: "
|
|
13128
|
+
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.",
|
|
13111
13129
|
http: "GET",
|
|
13112
13130
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
|
|
13113
13131
|
streaming: "no",
|
|
@@ -13130,7 +13148,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13130
13148
|
resource: "media.libraries.assets",
|
|
13131
13149
|
method: "update",
|
|
13132
13150
|
summary: "Update asset",
|
|
13133
|
-
description: "
|
|
13151
|
+
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.",
|
|
13134
13152
|
http: "PATCH",
|
|
13135
13153
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
|
|
13136
13154
|
streaming: "no",
|
|
@@ -13161,7 +13179,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13161
13179
|
name: "asset_folder",
|
|
13162
13180
|
type: "string",
|
|
13163
13181
|
required: false,
|
|
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."
|
|
13182
|
+
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."
|
|
13165
13183
|
},
|
|
13166
13184
|
{
|
|
13167
13185
|
name: "tags",
|
|
@@ -13179,11 +13197,57 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13179
13197
|
]
|
|
13180
13198
|
}
|
|
13181
13199
|
},
|
|
13200
|
+
{
|
|
13201
|
+
resource: "media.libraries.assets.frames",
|
|
13202
|
+
method: "create",
|
|
13203
|
+
summary: "Create frame URLs",
|
|
13204
|
+
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.',
|
|
13205
|
+
http: "POST",
|
|
13206
|
+
path: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames",
|
|
13207
|
+
streaming: "no",
|
|
13208
|
+
pagination: false,
|
|
13209
|
+
pathParams: [
|
|
13210
|
+
{
|
|
13211
|
+
name: "library_id",
|
|
13212
|
+
sdkName: "library_id",
|
|
13213
|
+
description: "Library identifier returned by library creation or listing; must be accessible to the current credential."
|
|
13214
|
+
},
|
|
13215
|
+
{
|
|
13216
|
+
name: "asset_id",
|
|
13217
|
+
sdkName: "asset_id",
|
|
13218
|
+
description: "Video asset identifier returned by asset upload or listing in this library; read its duration before choosing timestamps."
|
|
13219
|
+
}
|
|
13220
|
+
],
|
|
13221
|
+
query: [],
|
|
13222
|
+
body: {
|
|
13223
|
+
required: true,
|
|
13224
|
+
fields: [
|
|
13225
|
+
{
|
|
13226
|
+
name: "at_micros",
|
|
13227
|
+
type: "array",
|
|
13228
|
+
itemType: "integer",
|
|
13229
|
+
required: true,
|
|
13230
|
+
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."
|
|
13231
|
+
},
|
|
13232
|
+
{
|
|
13233
|
+
name: "width",
|
|
13234
|
+
type: "integer",
|
|
13235
|
+
enum: [
|
|
13236
|
+
160,
|
|
13237
|
+
320,
|
|
13238
|
+
640
|
|
13239
|
+
],
|
|
13240
|
+
required: false,
|
|
13241
|
+
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."
|
|
13242
|
+
}
|
|
13243
|
+
]
|
|
13244
|
+
}
|
|
13245
|
+
},
|
|
13182
13246
|
{
|
|
13183
13247
|
resource: "media.libraries.assets.reprocess",
|
|
13184
13248
|
method: "create",
|
|
13185
13249
|
summary: "Reprocess asset",
|
|
13186
|
-
description: "
|
|
13250
|
+
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.",
|
|
13187
13251
|
http: "POST",
|
|
13188
13252
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess",
|
|
13189
13253
|
streaming: "no",
|
|
@@ -13215,7 +13279,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13215
13279
|
"embedding"
|
|
13216
13280
|
],
|
|
13217
13281
|
required: false,
|
|
13218
|
-
description: "Processing tasks to rerun. Omit to retry failed tasks
|
|
13282
|
+
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."
|
|
13219
13283
|
}
|
|
13220
13284
|
]
|
|
13221
13285
|
}
|
|
@@ -13224,7 +13288,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13224
13288
|
resource: "media.libraries.assets.understandings",
|
|
13225
13289
|
method: "list",
|
|
13226
13290
|
summary: "List understandings",
|
|
13227
|
-
description: "List an asset
|
|
13291
|
+
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.",
|
|
13228
13292
|
http: "GET",
|
|
13229
13293
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}/understandings",
|
|
13230
13294
|
streaming: "no",
|
|
@@ -13256,10 +13320,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13256
13320
|
"tags",
|
|
13257
13321
|
"ocr",
|
|
13258
13322
|
"transcript",
|
|
13259
|
-
"frame"
|
|
13323
|
+
"frame",
|
|
13324
|
+
"overview",
|
|
13325
|
+
"audio",
|
|
13326
|
+
"embedding"
|
|
13260
13327
|
],
|
|
13261
13328
|
required: false,
|
|
13262
|
-
description: "
|
|
13329
|
+
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."
|
|
13263
13330
|
},
|
|
13264
13331
|
{
|
|
13265
13332
|
name: "cursor",
|
|
@@ -13279,7 +13346,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13279
13346
|
resource: "media.libraries.assets",
|
|
13280
13347
|
method: "batch",
|
|
13281
13348
|
summary: "Batch assets alias",
|
|
13282
|
-
description:
|
|
13349
|
+
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.',
|
|
13283
13350
|
http: "POST",
|
|
13284
13351
|
path: "/media/v1/libraries/{library_id}/assets:batch",
|
|
13285
13352
|
streaming: "no",
|
|
@@ -13300,6 +13367,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13300
13367
|
type: "object",
|
|
13301
13368
|
required: true,
|
|
13302
13369
|
description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
|
|
13370
|
+
},
|
|
13371
|
+
{
|
|
13372
|
+
name: "reason",
|
|
13373
|
+
type: "string",
|
|
13374
|
+
required: false,
|
|
13375
|
+
description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
|
|
13303
13376
|
}
|
|
13304
13377
|
]
|
|
13305
13378
|
}
|
|
@@ -13308,7 +13381,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13308
13381
|
resource: "media.libraries.batches",
|
|
13309
13382
|
method: "create",
|
|
13310
13383
|
summary: "Create batch",
|
|
13311
|
-
description:
|
|
13384
|
+
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.',
|
|
13312
13385
|
http: "POST",
|
|
13313
13386
|
path: "/media/v1/libraries/{library_id}/batches",
|
|
13314
13387
|
streaming: "no",
|
|
@@ -13329,6 +13402,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13329
13402
|
type: "object",
|
|
13330
13403
|
required: true,
|
|
13331
13404
|
description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
|
|
13405
|
+
},
|
|
13406
|
+
{
|
|
13407
|
+
name: "reason",
|
|
13408
|
+
type: "string",
|
|
13409
|
+
required: false,
|
|
13410
|
+
description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
|
|
13332
13411
|
}
|
|
13333
13412
|
]
|
|
13334
13413
|
}
|
|
@@ -13337,7 +13416,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13337
13416
|
resource: "media.libraries.batches",
|
|
13338
13417
|
method: "retrieve",
|
|
13339
13418
|
summary: "Get batch",
|
|
13340
|
-
description: "
|
|
13419
|
+
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.",
|
|
13341
13420
|
http: "GET",
|
|
13342
13421
|
path: "/media/v1/libraries/{library_id}/batches/{job_id}",
|
|
13343
13422
|
streaming: "no",
|
|
@@ -13395,7 +13474,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13395
13474
|
resource: "media.libraries.events",
|
|
13396
13475
|
method: "list",
|
|
13397
13476
|
summary: "List events",
|
|
13398
|
-
description: "Read library events in sequence order
|
|
13477
|
+
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.",
|
|
13399
13478
|
http: "GET",
|
|
13400
13479
|
path: "/media/v1/libraries/{library_id}/events",
|
|
13401
13480
|
streaming: "no",
|
|
@@ -13442,7 +13521,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13442
13521
|
resource: "media.libraries.folders",
|
|
13443
13522
|
method: "list",
|
|
13444
13523
|
summary: "List folders",
|
|
13445
|
-
description: "
|
|
13524
|
+
description: "undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.",
|
|
13446
13525
|
http: "GET",
|
|
13447
13526
|
path: "/media/v1/libraries/{library_id}/folders",
|
|
13448
13527
|
streaming: "no",
|
|
@@ -13463,11 +13542,155 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13463
13542
|
}
|
|
13464
13543
|
]
|
|
13465
13544
|
},
|
|
13545
|
+
{
|
|
13546
|
+
resource: "media.libraries.generations",
|
|
13547
|
+
method: "create",
|
|
13548
|
+
summary: "Create video generation",
|
|
13549
|
+
description: "Create a video.generate job. Generation is charged per second. The response is 202 with a queued Job; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until terminal, then save successful outputs. Unsaved candidate Files expire after 7 days.",
|
|
13550
|
+
http: "POST",
|
|
13551
|
+
path: "/media/v1/libraries/{library_id}/generations",
|
|
13552
|
+
streaming: "no",
|
|
13553
|
+
pagination: false,
|
|
13554
|
+
pathParams: [
|
|
13555
|
+
{
|
|
13556
|
+
name: "library_id",
|
|
13557
|
+
sdkName: "library_id",
|
|
13558
|
+
description: "Library ID returned by creation."
|
|
13559
|
+
}
|
|
13560
|
+
],
|
|
13561
|
+
query: [],
|
|
13562
|
+
body: {
|
|
13563
|
+
required: true,
|
|
13564
|
+
fields: [
|
|
13565
|
+
{
|
|
13566
|
+
name: "intent",
|
|
13567
|
+
type: "string",
|
|
13568
|
+
required: true,
|
|
13569
|
+
description: "Generation operation; v1 accepts only video.generate text-to-video requests."
|
|
13570
|
+
},
|
|
13571
|
+
{
|
|
13572
|
+
name: "prompt",
|
|
13573
|
+
type: "string",
|
|
13574
|
+
required: true,
|
|
13575
|
+
description: "Text prompt describing the video to generate."
|
|
13576
|
+
},
|
|
13577
|
+
{
|
|
13578
|
+
name: "count",
|
|
13579
|
+
type: "integer",
|
|
13580
|
+
required: false,
|
|
13581
|
+
description: "Number of videos to generate; defaults to 1 and must be from 1 to 4."
|
|
13582
|
+
},
|
|
13583
|
+
{
|
|
13584
|
+
name: "duration_seconds",
|
|
13585
|
+
type: "integer",
|
|
13586
|
+
required: false,
|
|
13587
|
+
description: "Requested video duration in seconds; Router validates the model-specific supported durations."
|
|
13588
|
+
},
|
|
13589
|
+
{
|
|
13590
|
+
name: "aspect_ratio",
|
|
13591
|
+
type: "string",
|
|
13592
|
+
required: false,
|
|
13593
|
+
description: "Requested output aspect ratio; defaults to 16:9 and Router validates model support."
|
|
13594
|
+
},
|
|
13595
|
+
{
|
|
13596
|
+
name: "model",
|
|
13597
|
+
type: "string",
|
|
13598
|
+
required: false,
|
|
13599
|
+
description: "Router model with video_generation capability; defaults to wan2.7-t2v."
|
|
13600
|
+
},
|
|
13601
|
+
{
|
|
13602
|
+
name: "save",
|
|
13603
|
+
type: "string",
|
|
13604
|
+
enum: [
|
|
13605
|
+
"candidate",
|
|
13606
|
+
"library"
|
|
13607
|
+
],
|
|
13608
|
+
required: false,
|
|
13609
|
+
description: "candidate keeps outputs temporary for explicit save calls; library saves successful outputs automatically."
|
|
13610
|
+
},
|
|
13611
|
+
{
|
|
13612
|
+
name: "asset_folder",
|
|
13613
|
+
type: "string",
|
|
13614
|
+
required: false,
|
|
13615
|
+
description: "Folder for assets saved automatically or by later save calls; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
|
|
13616
|
+
},
|
|
13617
|
+
{
|
|
13618
|
+
name: "tags",
|
|
13619
|
+
type: "array",
|
|
13620
|
+
itemType: "string",
|
|
13621
|
+
required: false,
|
|
13622
|
+
description: "Tags applied when an output becomes a library asset."
|
|
13623
|
+
},
|
|
13624
|
+
{
|
|
13625
|
+
name: "understanding",
|
|
13626
|
+
type: "string",
|
|
13627
|
+
enum: [
|
|
13628
|
+
"auto",
|
|
13629
|
+
"skip"
|
|
13630
|
+
],
|
|
13631
|
+
required: false,
|
|
13632
|
+
description: "Understanding behavior when a candidate is saved as an asset; defaults to auto."
|
|
13633
|
+
},
|
|
13634
|
+
{
|
|
13635
|
+
name: "references",
|
|
13636
|
+
type: "array",
|
|
13637
|
+
itemType: "object",
|
|
13638
|
+
required: false,
|
|
13639
|
+
description: "Not supported in v1; omit this field. Only text-to-video is currently available."
|
|
13640
|
+
}
|
|
13641
|
+
]
|
|
13642
|
+
}
|
|
13643
|
+
},
|
|
13644
|
+
{
|
|
13645
|
+
resource: "media.libraries.jobs",
|
|
13646
|
+
method: "list",
|
|
13647
|
+
summary: "List jobs",
|
|
13648
|
+
description: "List batch and video-generation jobs in a library. Filter by status and continue with next_cursor. Poll a generation Job until terminal, then save successful candidate outputs before they expire after 7 days.",
|
|
13649
|
+
http: "GET",
|
|
13650
|
+
path: "/media/v1/libraries/{library_id}/jobs",
|
|
13651
|
+
streaming: "no",
|
|
13652
|
+
pagination: true,
|
|
13653
|
+
pathParams: [
|
|
13654
|
+
{
|
|
13655
|
+
name: "library_id",
|
|
13656
|
+
sdkName: "library_id",
|
|
13657
|
+
description: "Library ID returned by creation."
|
|
13658
|
+
}
|
|
13659
|
+
],
|
|
13660
|
+
query: [
|
|
13661
|
+
{
|
|
13662
|
+
name: "status",
|
|
13663
|
+
type: "string",
|
|
13664
|
+
enum: [
|
|
13665
|
+
"queued",
|
|
13666
|
+
"running",
|
|
13667
|
+
"completed",
|
|
13668
|
+
"completed_with_errors",
|
|
13669
|
+
"failed",
|
|
13670
|
+
"cancelled"
|
|
13671
|
+
],
|
|
13672
|
+
required: false,
|
|
13673
|
+
description: "Filter jobs by their current status."
|
|
13674
|
+
},
|
|
13675
|
+
{
|
|
13676
|
+
name: "limit",
|
|
13677
|
+
type: "integer",
|
|
13678
|
+
required: false,
|
|
13679
|
+
description: "Maximum entries in this page, from 1 through 100; defaults to 100."
|
|
13680
|
+
},
|
|
13681
|
+
{
|
|
13682
|
+
name: "cursor",
|
|
13683
|
+
type: "string",
|
|
13684
|
+
required: false,
|
|
13685
|
+
description: "Job id from the previous page’s next_cursor; omit for the first page."
|
|
13686
|
+
}
|
|
13687
|
+
]
|
|
13688
|
+
},
|
|
13466
13689
|
{
|
|
13467
13690
|
resource: "media.libraries.jobs",
|
|
13468
13691
|
method: "retrieve",
|
|
13469
|
-
summary: "Get job
|
|
13470
|
-
description: "
|
|
13692
|
+
summary: "Get job",
|
|
13693
|
+
description: "Read the current batch or video-generation Job status and progress. For generation, inspect outputs and failures, then save successful candidates before their preview and save window expires after 7 days.",
|
|
13471
13694
|
http: "GET",
|
|
13472
13695
|
path: "/media/v1/libraries/{library_id}/jobs/{job_id}",
|
|
13473
13696
|
streaming: "no",
|
|
@@ -13481,16 +13704,101 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13481
13704
|
{
|
|
13482
13705
|
name: "job_id",
|
|
13483
13706
|
sdkName: "job_id",
|
|
13484
|
-
description: "
|
|
13707
|
+
description: "Job identifier returned by batch creation, video-generation creation or job listing; resolved within this library."
|
|
13708
|
+
}
|
|
13709
|
+
],
|
|
13710
|
+
query: []
|
|
13711
|
+
},
|
|
13712
|
+
{
|
|
13713
|
+
resource: "media.libraries.jobs",
|
|
13714
|
+
method: "cancel",
|
|
13715
|
+
summary: "Cancel job",
|
|
13716
|
+
description: "Cancel a queued or running generation job. Already completed outputs remain available to save; poll or read the returned Job to confirm its status.",
|
|
13717
|
+
http: "POST",
|
|
13718
|
+
path: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
|
|
13719
|
+
streaming: "no",
|
|
13720
|
+
pagination: false,
|
|
13721
|
+
pathParams: [
|
|
13722
|
+
{
|
|
13723
|
+
name: "library_id",
|
|
13724
|
+
sdkName: "library_id",
|
|
13725
|
+
description: "Library ID returned by creation."
|
|
13726
|
+
},
|
|
13727
|
+
{
|
|
13728
|
+
name: "job_id",
|
|
13729
|
+
sdkName: "job_id",
|
|
13730
|
+
description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
|
|
13485
13731
|
}
|
|
13486
13732
|
],
|
|
13487
13733
|
query: []
|
|
13488
13734
|
},
|
|
13735
|
+
{
|
|
13736
|
+
resource: "media.libraries.jobs.outputs.save",
|
|
13737
|
+
method: "create",
|
|
13738
|
+
summary: "Save generation output",
|
|
13739
|
+
description: "Save a successful candidate as a library asset. Candidate outputs expire after 7 days; save before expiry. Generation is charged per second when the job runs, not when an output is saved.",
|
|
13740
|
+
http: "POST",
|
|
13741
|
+
path: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
|
|
13742
|
+
streaming: "no",
|
|
13743
|
+
pagination: false,
|
|
13744
|
+
pathParams: [
|
|
13745
|
+
{
|
|
13746
|
+
name: "library_id",
|
|
13747
|
+
sdkName: "library_id",
|
|
13748
|
+
description: "Library ID returned by creation."
|
|
13749
|
+
},
|
|
13750
|
+
{
|
|
13751
|
+
name: "job_id",
|
|
13752
|
+
sdkName: "job_id",
|
|
13753
|
+
description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
|
|
13754
|
+
},
|
|
13755
|
+
{
|
|
13756
|
+
name: "index",
|
|
13757
|
+
sdkName: "index",
|
|
13758
|
+
description: "Zero-based position of the candidate in the Job outputs array."
|
|
13759
|
+
}
|
|
13760
|
+
],
|
|
13761
|
+
query: [],
|
|
13762
|
+
body: {
|
|
13763
|
+
required: false,
|
|
13764
|
+
fields: [
|
|
13765
|
+
{
|
|
13766
|
+
name: "public_id",
|
|
13767
|
+
type: "string",
|
|
13768
|
+
required: false,
|
|
13769
|
+
description: "Delivery identifier for the saved asset; defaults to gen_<job_id>_<index> and is idempotent."
|
|
13770
|
+
},
|
|
13771
|
+
{
|
|
13772
|
+
name: "asset_folder",
|
|
13773
|
+
type: "string",
|
|
13774
|
+
required: false,
|
|
13775
|
+
description: "Destination folder for the saved asset; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
|
|
13776
|
+
},
|
|
13777
|
+
{
|
|
13778
|
+
name: "tags",
|
|
13779
|
+
type: "array",
|
|
13780
|
+
itemType: "string",
|
|
13781
|
+
required: false,
|
|
13782
|
+
description: "Tags to apply to the saved asset."
|
|
13783
|
+
},
|
|
13784
|
+
{
|
|
13785
|
+
name: "understanding",
|
|
13786
|
+
type: "string",
|
|
13787
|
+
enum: [
|
|
13788
|
+
"auto",
|
|
13789
|
+
"skip"
|
|
13790
|
+
],
|
|
13791
|
+
required: false,
|
|
13792
|
+
description: "Understanding behavior for the saved asset; defaults to auto."
|
|
13793
|
+
}
|
|
13794
|
+
]
|
|
13795
|
+
}
|
|
13796
|
+
},
|
|
13489
13797
|
{
|
|
13490
13798
|
resource: "media.libraries.purge",
|
|
13491
13799
|
method: "create",
|
|
13492
13800
|
summary: "Purge library",
|
|
13493
|
-
description: "
|
|
13801
|
+
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.",
|
|
13494
13802
|
http: "POST",
|
|
13495
13803
|
path: "/media/v1/libraries/{library_id}/purge",
|
|
13496
13804
|
streaming: "no",
|
|
@@ -13508,7 +13816,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13508
13816
|
resource: "media.libraries",
|
|
13509
13817
|
method: "restore",
|
|
13510
13818
|
summary: "Restore library",
|
|
13511
|
-
description: "
|
|
13819
|
+
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.",
|
|
13512
13820
|
http: "POST",
|
|
13513
13821
|
path: "/media/v1/libraries/{library_id}/restore",
|
|
13514
13822
|
streaming: "no",
|
|
@@ -13526,7 +13834,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13526
13834
|
resource: "media.libraries.search",
|
|
13527
13835
|
method: "create",
|
|
13528
13836
|
summary: "Semantic search alias",
|
|
13529
|
-
description: "
|
|
13837
|
+
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.",
|
|
13530
13838
|
http: "POST",
|
|
13531
13839
|
path: "/media/v1/libraries/{library_id}/search",
|
|
13532
13840
|
streaming: "no",
|
|
@@ -13577,7 +13885,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13577
13885
|
resource: "media.libraries.search.expression",
|
|
13578
13886
|
method: "create",
|
|
13579
13887
|
summary: "Expression search",
|
|
13580
|
-
description: "
|
|
13888
|
+
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.",
|
|
13581
13889
|
http: "POST",
|
|
13582
13890
|
path: "/media/v1/libraries/{library_id}/search/expression",
|
|
13583
13891
|
streaming: "no",
|
|
@@ -13597,7 +13905,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13597
13905
|
name: "expression",
|
|
13598
13906
|
type: "string",
|
|
13599
13907
|
required: false,
|
|
13600
|
-
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.'
|
|
13908
|
+
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.'
|
|
13601
13909
|
},
|
|
13602
13910
|
{
|
|
13603
13911
|
name: "sort_by",
|
|
@@ -13649,7 +13957,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13649
13957
|
resource: "media.libraries.search.semantic",
|
|
13650
13958
|
method: "create",
|
|
13651
13959
|
summary: "Semantic search",
|
|
13652
|
-
description: "Search assets with a nonblank text query
|
|
13960
|
+
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.",
|
|
13653
13961
|
http: "POST",
|
|
13654
13962
|
path: "/media/v1/libraries/{library_id}/search/semantic",
|
|
13655
13963
|
streaming: "no",
|
|
@@ -13700,7 +14008,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13700
14008
|
resource: "media.libraries.search.visual",
|
|
13701
14009
|
method: "create",
|
|
13702
14010
|
summary: "Visual search",
|
|
13703
|
-
description: "
|
|
14011
|
+
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.",
|
|
13704
14012
|
http: "POST",
|
|
13705
14013
|
path: "/media/v1/libraries/{library_id}/search/visual",
|
|
13706
14014
|
streaming: "no",
|
|
@@ -13743,6 +14051,67 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13743
14051
|
]
|
|
13744
14052
|
}
|
|
13745
14053
|
},
|
|
14054
|
+
{
|
|
14055
|
+
resource: "media.libraries.understandings",
|
|
14056
|
+
method: "list",
|
|
14057
|
+
summary: "List understanding results across a library",
|
|
14058
|
+
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.",
|
|
14059
|
+
http: "GET",
|
|
14060
|
+
path: "/media/v1/libraries/{library_id}/understandings",
|
|
14061
|
+
streaming: "no",
|
|
14062
|
+
pagination: true,
|
|
14063
|
+
pathParams: [
|
|
14064
|
+
{
|
|
14065
|
+
name: "library_id",
|
|
14066
|
+
sdkName: "library_id",
|
|
14067
|
+
description: "Library ID returned by creation."
|
|
14068
|
+
}
|
|
14069
|
+
],
|
|
14070
|
+
query: [
|
|
14071
|
+
{
|
|
14072
|
+
name: "folder",
|
|
14073
|
+
type: "string",
|
|
14074
|
+
required: false,
|
|
14075
|
+
description: "Folder path including all descendants; omitted or empty selects the entire library."
|
|
14076
|
+
},
|
|
14077
|
+
{
|
|
14078
|
+
name: "kinds",
|
|
14079
|
+
type: "string",
|
|
14080
|
+
required: false,
|
|
14081
|
+
description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind."
|
|
14082
|
+
},
|
|
14083
|
+
{
|
|
14084
|
+
name: "cursor",
|
|
14085
|
+
type: "string",
|
|
14086
|
+
required: false,
|
|
14087
|
+
description: "Cursor from the previous next_cursor."
|
|
14088
|
+
},
|
|
14089
|
+
{
|
|
14090
|
+
name: "limit",
|
|
14091
|
+
type: "integer",
|
|
14092
|
+
required: false,
|
|
14093
|
+
description: "Maximum entries in this page, from 1 through 100; defaults to 100."
|
|
14094
|
+
}
|
|
14095
|
+
]
|
|
14096
|
+
},
|
|
14097
|
+
{
|
|
14098
|
+
resource: "media.libraries.understandings",
|
|
14099
|
+
method: "retrieveFailureSummary",
|
|
14100
|
+
summary: "Summarize understanding failures",
|
|
14101
|
+
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.",
|
|
14102
|
+
http: "GET",
|
|
14103
|
+
path: "/media/v1/libraries/{library_id}/understandings/failure_summary",
|
|
14104
|
+
streaming: "no",
|
|
14105
|
+
pagination: false,
|
|
14106
|
+
pathParams: [
|
|
14107
|
+
{
|
|
14108
|
+
name: "library_id",
|
|
14109
|
+
sdkName: "library_id",
|
|
14110
|
+
description: "Library ID returned by creation."
|
|
14111
|
+
}
|
|
14112
|
+
],
|
|
14113
|
+
query: []
|
|
14114
|
+
},
|
|
13746
14115
|
{
|
|
13747
14116
|
resource: "meta.docs",
|
|
13748
14117
|
method: "search",
|
|
@@ -14030,25 +14399,25 @@ services (model, agent, automation…); call the operation you need and read its
|
|
|
14030
14399
|
name: "model",
|
|
14031
14400
|
type: "string",
|
|
14032
14401
|
required: true,
|
|
14033
|
-
description: "
|
|
14402
|
+
description: "Model catalog identifier declaring openai.audio.transcriptions; use it unchanged, including any creator prefix."
|
|
14034
14403
|
},
|
|
14035
14404
|
{
|
|
14036
14405
|
name: "file",
|
|
14037
14406
|
type: "string",
|
|
14038
14407
|
required: true,
|
|
14039
|
-
description: "Audio
|
|
14408
|
+
description: "Audio bytes uploaded as a multipart file; supported formats and input limits depend on the selected model."
|
|
14040
14409
|
},
|
|
14041
14410
|
{
|
|
14042
14411
|
name: "language",
|
|
14043
14412
|
type: "string",
|
|
14044
14413
|
required: false,
|
|
14045
|
-
description: "
|
|
14414
|
+
description: "Source language code when known; omit to let the model detect the language."
|
|
14046
14415
|
},
|
|
14047
14416
|
{
|
|
14048
14417
|
name: "prompt",
|
|
14049
14418
|
type: "string",
|
|
14050
14419
|
required: false,
|
|
14051
|
-
description: "
|
|
14420
|
+
description: "Optional vocabulary or contextual guidance for recognizing the audio; support depends on the selected model."
|
|
14052
14421
|
},
|
|
14053
14422
|
{
|
|
14054
14423
|
name: "response_format",
|
|
@@ -14056,20 +14425,22 @@ services (model, agent, automation…); call the operation you need and read its
|
|
|
14056
14425
|
enum: [
|
|
14057
14426
|
"json",
|
|
14058
14427
|
"text",
|
|
14059
|
-
"verbose_json"
|
|
14428
|
+
"verbose_json",
|
|
14429
|
+
"diarized_json"
|
|
14060
14430
|
],
|
|
14061
14431
|
required: false,
|
|
14062
|
-
description: "
|
|
14432
|
+
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."
|
|
14063
14433
|
},
|
|
14064
14434
|
{
|
|
14065
14435
|
name: "timestamp_granularities[]",
|
|
14066
14436
|
type: "array",
|
|
14067
14437
|
itemType: "string",
|
|
14068
14438
|
enum: [
|
|
14439
|
+
"word",
|
|
14069
14440
|
"segment"
|
|
14070
14441
|
],
|
|
14071
14442
|
required: false,
|
|
14072
|
-
description: "Timestamp levels to
|
|
14443
|
+
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."
|
|
14073
14444
|
},
|
|
14074
14445
|
{
|
|
14075
14446
|
name: "temperature",
|
|
@@ -19309,7 +19680,7 @@ for more details.`
|
|
|
19309
19680
|
name: "filter",
|
|
19310
19681
|
type: "string",
|
|
19311
19682
|
required: false,
|
|
19312
|
-
description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort;
|
|
19683
|
+
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."
|
|
19313
19684
|
}
|
|
19314
19685
|
]
|
|
19315
19686
|
},
|
|
@@ -27285,6 +27656,19 @@ var mediaCreateLibrary = (options) => (options.client ?? client).post({
|
|
|
27285
27656
|
...options.headers
|
|
27286
27657
|
}
|
|
27287
27658
|
});
|
|
27659
|
+
var mediaCreateFrameUrls = (options) => (options.client ?? client).post({
|
|
27660
|
+
security: [{
|
|
27661
|
+
key: "media-BearerAuth",
|
|
27662
|
+
scheme: "bearer",
|
|
27663
|
+
type: "http"
|
|
27664
|
+
}],
|
|
27665
|
+
url: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames",
|
|
27666
|
+
...options,
|
|
27667
|
+
headers: {
|
|
27668
|
+
"Content-Type": "application/json",
|
|
27669
|
+
...options.headers
|
|
27670
|
+
}
|
|
27671
|
+
});
|
|
27288
27672
|
var mediaDeleteLibrary = (options) => (options.client ?? client).delete({
|
|
27289
27673
|
security: [{
|
|
27290
27674
|
key: "media-BearerAuth",
|
|
@@ -27549,6 +27933,77 @@ var mediaCreateDeliveryToken = (options) => (options.client ?? client).post({
|
|
|
27549
27933
|
...options.headers
|
|
27550
27934
|
}
|
|
27551
27935
|
});
|
|
27936
|
+
var mediaUnderstandingFailureSummary = (options) => (options.client ?? client).get({
|
|
27937
|
+
security: [{
|
|
27938
|
+
key: "media-BearerAuth",
|
|
27939
|
+
scheme: "bearer",
|
|
27940
|
+
type: "http"
|
|
27941
|
+
}],
|
|
27942
|
+
url: "/media/v1/libraries/{library_id}/understandings/failure_summary",
|
|
27943
|
+
...options
|
|
27944
|
+
});
|
|
27945
|
+
var mediaListUnderstandingsByLibrary = (options) => (options.client ?? client).get({
|
|
27946
|
+
security: [{
|
|
27947
|
+
key: "media-BearerAuth",
|
|
27948
|
+
scheme: "bearer",
|
|
27949
|
+
type: "http"
|
|
27950
|
+
}],
|
|
27951
|
+
url: "/media/v1/libraries/{library_id}/understandings",
|
|
27952
|
+
...options
|
|
27953
|
+
});
|
|
27954
|
+
var mediaCreateGeneration = (options) => (options.client ?? client).post({
|
|
27955
|
+
security: [{
|
|
27956
|
+
key: "media-BearerAuth",
|
|
27957
|
+
scheme: "bearer",
|
|
27958
|
+
type: "http"
|
|
27959
|
+
}],
|
|
27960
|
+
url: "/media/v1/libraries/{library_id}/generations",
|
|
27961
|
+
...options,
|
|
27962
|
+
headers: {
|
|
27963
|
+
"Content-Type": "application/json",
|
|
27964
|
+
...options.headers
|
|
27965
|
+
}
|
|
27966
|
+
});
|
|
27967
|
+
var mediaListJobs = (options) => (options.client ?? client).get({
|
|
27968
|
+
security: [{
|
|
27969
|
+
key: "media-BearerAuth",
|
|
27970
|
+
scheme: "bearer",
|
|
27971
|
+
type: "http"
|
|
27972
|
+
}],
|
|
27973
|
+
url: "/media/v1/libraries/{library_id}/jobs",
|
|
27974
|
+
...options
|
|
27975
|
+
});
|
|
27976
|
+
var mediaCancelJob = (options) => (options.client ?? client).post({
|
|
27977
|
+
security: [{
|
|
27978
|
+
key: "media-BearerAuth",
|
|
27979
|
+
scheme: "bearer",
|
|
27980
|
+
type: "http"
|
|
27981
|
+
}],
|
|
27982
|
+
url: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
|
|
27983
|
+
...options
|
|
27984
|
+
});
|
|
27985
|
+
var mediaSaveGenerationOutput = (options) => (options.client ?? client).post({
|
|
27986
|
+
security: [{
|
|
27987
|
+
key: "media-BearerAuth",
|
|
27988
|
+
scheme: "bearer",
|
|
27989
|
+
type: "http"
|
|
27990
|
+
}],
|
|
27991
|
+
url: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
|
|
27992
|
+
...options,
|
|
27993
|
+
headers: {
|
|
27994
|
+
"Content-Type": "application/json",
|
|
27995
|
+
...options.headers
|
|
27996
|
+
}
|
|
27997
|
+
});
|
|
27998
|
+
var mediaGetGenerationCapabilities = (options) => (options?.client ?? client).get({
|
|
27999
|
+
security: [{
|
|
28000
|
+
key: "media-BearerAuth",
|
|
28001
|
+
scheme: "bearer",
|
|
28002
|
+
type: "http"
|
|
28003
|
+
}],
|
|
28004
|
+
url: "/media/v1/generation/capabilities",
|
|
28005
|
+
...options
|
|
28006
|
+
});
|
|
27552
28007
|
var getSandboxV1Sandboxes = (options) => (options?.client ?? client).get({
|
|
27553
28008
|
querySerializer: { parameters: { state: { array: { explode: false } } } },
|
|
27554
28009
|
security: [
|
|
@@ -29999,11 +30454,19 @@ function createKnowledge(transport) {
|
|
|
29999
30454
|
}
|
|
30000
30455
|
function createMedia(transport) {
|
|
30001
30456
|
return {
|
|
30457
|
+
generation: {
|
|
30458
|
+
capabilities: {
|
|
30459
|
+
list: bind(transport, mediaGetGenerationCapabilities)
|
|
30460
|
+
}
|
|
30461
|
+
},
|
|
30002
30462
|
libraries: {
|
|
30003
30463
|
assets: {
|
|
30004
30464
|
batch: bind(transport, mediaBatchAssets),
|
|
30005
30465
|
create: bind(transport, (options) => mediaUploadAsset({ ...options, bodySerializer: multipartBodySerializer, headers: { "Content-Type": null, ...options.headers } })),
|
|
30006
30466
|
delete: bind(transport, mediaDeleteAsset),
|
|
30467
|
+
frames: {
|
|
30468
|
+
create: bind(transport, mediaCreateFrameUrls)
|
|
30469
|
+
},
|
|
30007
30470
|
import: {
|
|
30008
30471
|
create: bind(transport, mediaImportAsset)
|
|
30009
30472
|
},
|
|
@@ -30032,7 +30495,17 @@ function createMedia(transport) {
|
|
|
30032
30495
|
folders: {
|
|
30033
30496
|
list: bind(transport, mediaListFolders)
|
|
30034
30497
|
},
|
|
30498
|
+
generations: {
|
|
30499
|
+
create: bind(transport, mediaCreateGeneration)
|
|
30500
|
+
},
|
|
30035
30501
|
jobs: {
|
|
30502
|
+
cancel: bind(transport, mediaCancelJob),
|
|
30503
|
+
list: bindPage(transport, mediaListJobs),
|
|
30504
|
+
outputs: {
|
|
30505
|
+
save: {
|
|
30506
|
+
create: bind(transport, mediaSaveGenerationOutput)
|
|
30507
|
+
}
|
|
30508
|
+
},
|
|
30036
30509
|
retrieve: bind(transport, mediaGetJob)
|
|
30037
30510
|
},
|
|
30038
30511
|
list: bindPage(transport, mediaListLibraries),
|
|
@@ -30053,6 +30526,10 @@ function createMedia(transport) {
|
|
|
30053
30526
|
create: bind(transport, mediaVisualSearch)
|
|
30054
30527
|
}
|
|
30055
30528
|
},
|
|
30529
|
+
understandings: {
|
|
30530
|
+
list: bindPage(transport, mediaListUnderstandingsByLibrary),
|
|
30531
|
+
retrieveFailureSummary: bind(transport, mediaUnderstandingFailureSummary)
|
|
30532
|
+
},
|
|
30056
30533
|
update: bind(transport, mediaUpdateLibrary)
|
|
30057
30534
|
}
|
|
30058
30535
|
};
|
|
@@ -33432,7 +33909,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
|
|
|
33432
33909
|
}
|
|
33433
33910
|
|
|
33434
33911
|
// src/main.ts
|
|
33435
|
-
var version = "0.2.1-dev.
|
|
33912
|
+
var version = "0.2.1-dev.c7abab3";
|
|
33436
33913
|
var commands = commandTree(operations);
|
|
33437
33914
|
var manual = [...workflows.map((w) => w.words), [API_WORD]];
|
|
33438
33915
|
function route(argv) {
|