@deepraxis/sdk 0.1.1-dev.eb022f5 → 0.1.1-dev.ec2a9a1
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/METHODS.md +34 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +150 -49
- package/dist/generated/sdk.gen.js +225 -48
- package/dist/generated/types.gen.d.ts +2117 -270
- package/dist/operations.generated.d.ts +369 -65
- package/dist/operations.generated.js +454 -61
- package/dist/resources.generated.d.ts +37 -8
- package/dist/resources.generated.js +22 -0
- package/package.json +1 -1
|
@@ -1092,7 +1092,7 @@ export const fileListFiles = (options) => (options?.client ?? client).get({
|
|
|
1092
1092
|
/**
|
|
1093
1093
|
* Upload file
|
|
1094
1094
|
*
|
|
1095
|
-
* Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File(["Return within 23 days."], "policy.txt", { type: "text/plain" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.
|
|
1095
|
+
* Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File(["Return within 23 days."], "policy.txt", { type: "text/plain" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.
|
|
1096
1096
|
*/
|
|
1097
1097
|
export const fileCreateFile = (options) => (options.client ?? client).post({
|
|
1098
1098
|
...formDataBodySerializer,
|
|
@@ -1169,7 +1169,7 @@ export const fileRetrieveFileContent = (options) => (options.client ?? client).g
|
|
|
1169
1169
|
/**
|
|
1170
1170
|
* Create an upload
|
|
1171
1171
|
*
|
|
1172
|
-
* Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.
|
|
1172
|
+
* Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data, assistants and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.
|
|
1173
1173
|
*/
|
|
1174
1174
|
export const fileCreateUpload = (options) => (options.client ?? client).post({
|
|
1175
1175
|
security: [{
|
|
@@ -1260,7 +1260,7 @@ export const fileCreateSignedUpload = (options) => (options.client ?? client).po
|
|
|
1260
1260
|
/**
|
|
1261
1261
|
* Create a download URL
|
|
1262
1262
|
*
|
|
1263
|
-
* Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to
|
|
1263
|
+
* Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to 900 seconds and is at most 604800 seconds. Issuance requires the same credential and file-read access as files.retrieveContent; a processing file returns 409 FILE_NOT_READY, so poll files.retrieve until active before retrying. A missing, expired or other-organization file returns 404. Each issuance creates a new link. OpenAI Files has no signed download URL; this follows S3 presigned GET semantics. Example body: {"ttl_seconds":3600}.
|
|
1264
1264
|
*/
|
|
1265
1265
|
export const fileCreateContentUrl = (options) => (options.client ?? client).post({
|
|
1266
1266
|
security: [{
|
|
@@ -1282,7 +1282,7 @@ export const fileCreateContentUrl = (options) => (options.client ?? client).post
|
|
|
1282
1282
|
/**
|
|
1283
1283
|
* Revoke a file content link
|
|
1284
1284
|
*
|
|
1285
|
-
* Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within
|
|
1285
|
+
* Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within 15 minutes; the file and other links remain available. Only current IAM capability tokens can be revoked; legacy content links expire at the migration deadline. Example body: {"token":"<token from /c/>"}.
|
|
1286
1286
|
*/
|
|
1287
1287
|
export const fileRevokeContentLink = (options) => (options.client ?? client).post({
|
|
1288
1288
|
security: [{
|
|
@@ -6373,7 +6373,7 @@ export const cutUndeleteProject = (options) => (options.client ?? client).post({
|
|
|
6373
6373
|
*
|
|
6374
6374
|
* ### Script function reference
|
|
6375
6375
|
*
|
|
6376
|
-
* Functions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. Reads see earlier writes in the same script.
|
|
6376
|
+
* Functions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. JoinId is the string returned by Join or read from GetTimeline().joins. Reads see earlier writes in the same script.
|
|
6377
6377
|
*
|
|
6378
6378
|
* ```ts
|
|
6379
6379
|
* GetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;
|
|
@@ -6382,18 +6382,32 @@ export const cutUndeleteProject = (options) => (options.client ?? client).post({
|
|
|
6382
6382
|
* GetMedia(ref: MediaRef): MediaInfo;
|
|
6383
6383
|
* GetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];
|
|
6384
6384
|
* GetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];
|
|
6385
|
+
* ListTransitions(): TransitionInfo[];
|
|
6386
|
+
* ListEffects(): EffectInfo[];
|
|
6387
|
+
* ListTextStyles(): TextStylePreset[];
|
|
6388
|
+
* ListTextTemplates(): TextTemplate[];
|
|
6389
|
+
* ListAnimations(): { 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 }[] }[];
|
|
6390
|
+
* ListFonts(): { family: string; weights: number[]; scripts: ("latin"|"cjk")[]; source: "bundled"|"catalog" }[];
|
|
6385
6391
|
* Insert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;
|
|
6386
6392
|
* Update(id: ClipId, patch: ItemPatchView): void;
|
|
6393
|
+
* SetSpeed(id: ClipId, rate: number | { curve: { at: number; rate: number; ease?: Ease }[]; audio?: "mute" | "resample" }, o: { keep: "source" | "duration"; ripple?: boolean }): { length: number; sourceOut: number };
|
|
6387
6394
|
* Delete(id: ClipId, o?: { ripple?: boolean }): void;
|
|
6395
|
+
* Join(left: ClipId, right: ClipId, o: { length?: number; effect: TransitionInput }): JoinId;
|
|
6396
|
+
* UpdateJoin(id: JoinId, patch: { length?: number; effect?: TransitionInput }): void;
|
|
6397
|
+
* DeleteJoin(id: JoinId): void;
|
|
6388
6398
|
* Split(id: ClipId, at: number): ClipId;
|
|
6389
6399
|
* Trim(id: ClipId, edge: "in" | "out", delta: number, o?: { ripple?: boolean }): void;
|
|
6390
6400
|
* Move(id: ClipId, start: number, track?: TrackId): void;
|
|
6391
6401
|
* RippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;
|
|
6392
|
-
* AddTrack(kind: "video" | "audio" | "caption", init?: { name?: string }, index?: number): TrackId;
|
|
6402
|
+
* AddTrack(kind: "video" | "audio" | "caption", init?: { name?: string; role?: "voice" | "music" | "sfx" }, index?: number): TrackId;
|
|
6393
6403
|
* UpdateTrack(id: TrackId, patch: TrackPatch): void;
|
|
6394
6404
|
* DeleteTrack(id: TrackId): void;
|
|
6395
6405
|
* SetSettings(patch: Partial<ProjectSettingsView>): void;
|
|
6396
|
-
* AddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle
|
|
6406
|
+
* AddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle> & { preset?: string }; maxChars?: number }): ClipId[];
|
|
6407
|
+
* InsertTemplate(track: TrackId, o: { template: string; start: number; slots?: Record<string, string> }): ClipId[];
|
|
6408
|
+
* AlignCaptions(trackId: TrackId, script: string): { replaced: number; added: number; deleted: number };
|
|
6409
|
+
* ImportCaptions(trackId: TrackId, text: string, o?: { format?: "srt" | "vtt"; offset?: number }): ClipId[];
|
|
6410
|
+
* ExportCaptions(trackId: TrackId, o: { format: "srt" | "vtt" }): string;
|
|
6397
6411
|
* SetMarker(at: number, label: string): string;
|
|
6398
6412
|
* Print(...values: unknown[]): void;
|
|
6399
6413
|
* Preview(at: number[]): void;
|
|
@@ -6401,49 +6415,88 @@ export const cutUndeleteProject = (options) => (options.client ?? client).post({
|
|
|
6401
6415
|
*
|
|
6402
6416
|
* | Functions | Behavior and arguments |
|
|
6403
6417
|
* | --- | --- |
|
|
6404
|
-
* | GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, sourceIn/sourceOut, text and offline reason. GetTimeline returns duration
|
|
6418
|
+
* | 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. |
|
|
6419
|
+
* | ListEffects | Discover the shared visual-effect catalog with parameter types, ranges, defaults, cost and bounds. Effects are supported only on visual clips. |
|
|
6420
|
+
* | 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. |
|
|
6421
|
+
* | 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. |
|
|
6405
6422
|
* | FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |
|
|
6406
6423
|
* | GetMedia | Read metadata for `{libraryId, assetId}` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |
|
|
6407
6424
|
* | 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. |
|
|
6408
6425
|
* | 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. |
|
|
6426
|
+
* | 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. |
|
|
6427
|
+
* | 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. |
|
|
6409
6428
|
* | 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. |
|
|
6410
6429
|
* | RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |
|
|
6411
|
-
* | 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. |
|
|
6430
|
+
* | 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. |
|
|
6412
6431
|
* | SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |
|
|
6413
6432
|
* | 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. |
|
|
6433
|
+
* | ImportCaptions, ExportCaptions | Import SRT or WebVTT text onto a caption track and export it back. format is inferred from a WEBVTT header when omitted. offset shifts imported cues in seconds. Import rejects more than 100000 bytes, more than 5000 cues, malformed or overlapping file cues with INVALID_CAPTION_FILE; overlap with existing timeline clips uses the normal OVERLAP rejection. Export sorts by timeline start and writes millisecond timecodes. |
|
|
6414
6434
|
* | SetMarker | Add a label at a timeline time and return its ID. |
|
|
6415
6435
|
* | 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. |
|
|
6416
6436
|
*
|
|
6437
|
+
* #### Joins between clips
|
|
6438
|
+
*
|
|
6439
|
+
* Endpoints 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.
|
|
6440
|
+
*
|
|
6441
|
+
* TransitionInput 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.
|
|
6442
|
+
*
|
|
6443
|
+
* Minimal 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.
|
|
6444
|
+
*
|
|
6417
6445
|
* #### Insert fields (ItemInit)
|
|
6418
6446
|
*
|
|
6419
6447
|
* Every item requires `type` and `start`. Times used for editing are seconds and snap to the project frame rate: start, length, sourceIn, fadeIn/fadeOut, transition length, keyframe at, reveal delay/stagger/duration. Keyframe and reveal times are relative to the clip start. Video/audio may omit length to use the remaining source duration; other types require length.
|
|
6420
6448
|
*
|
|
6421
6449
|
* | type | Required fields beyond type/start | Optional fields |
|
|
6422
6450
|
* | --- | --- | --- |
|
|
6423
|
-
* | video | media | length, sourceIn, volumeDb, transform, fit, animate, transitionIn, transitionOut |
|
|
6424
|
-
* | image | media, length | transform, fit, animate, transitionIn, transitionOut |
|
|
6425
|
-
* | text | text, length | style, transform, reveal, animate, transitionIn, transitionOut |
|
|
6426
|
-
* | color | color, length | transform, fill, animate, transitionIn, transitionOut |
|
|
6427
|
-
* | shape | shape, length, width, height, fill | radius, stroke, transform, animate, transitionIn, transitionOut |
|
|
6428
|
-
* | audio | media | length, sourceIn, volumeDb, fadeIn, fadeOut,
|
|
6451
|
+
* | video | media | length, sourceIn, playback, volumeDb, transform, fit, blend, animate, animation, effects, mask, transitionIn, transitionOut |
|
|
6452
|
+
* | image | media, length | transform, fit, blend, animate, animation, effects, mask, transitionIn, transitionOut |
|
|
6453
|
+
* | text | text, length | style, transform, blend, reveal, animate, animation, effects, mask, transitionIn, transitionOut |
|
|
6454
|
+
* | color | color, length | transform, fill, blend, animate, animation, effects, mask, transitionIn, transitionOut |
|
|
6455
|
+
* | shape | shape, length, width, height, fill | radius, stroke, transform, blend, animate, animation, effects, mask, transitionIn, transitionOut |
|
|
6456
|
+
* | audio | media | length, sourceIn, playback, volumeDb, gain, fadeIn, fadeOut, duck |
|
|
6429
6457
|
* | caption | text, length | — |
|
|
6430
6458
|
*
|
|
6431
|
-
* 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.
|
|
6459
|
+
* Visual 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.
|
|
6432
6460
|
*
|
|
6433
6461
|
* | Field | Value |
|
|
6434
6462
|
* | --- | --- |
|
|
6435
6463
|
* | 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. |
|
|
6436
|
-
* | style | Partial `{fontFamily, fontSize, fontWeight, color, stroke, background, align, maxWidth}`.
|
|
6464
|
+
* | 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. |
|
|
6437
6465
|
* | 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. |
|
|
6466
|
+
* | 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. |
|
|
6438
6467
|
* | 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. |
|
|
6439
6468
|
* | 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. |
|
|
6440
6469
|
* | 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. |
|
|
6441
6470
|
* | 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}`. |
|
|
6442
6471
|
* | 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. |
|
|
6443
6472
|
*
|
|
6473
|
+
* #### Visual effects
|
|
6474
|
+
*
|
|
6475
|
+
* `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.
|
|
6476
|
+
*
|
|
6477
|
+
* Numeric 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.
|
|
6478
|
+
*
|
|
6479
|
+
* `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.
|
|
6480
|
+
*
|
|
6444
6481
|
* #### Update fields (ItemPatchView)
|
|
6445
6482
|
*
|
|
6446
|
-
* All fields are optional; use only fields relevant to the item's type. Supported fields: start, length, sourceIn, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, animate, reveal, fill, stroke, shape, width, height, radius, transitionIn, transitionOut. Values and units match Insert. Set
|
|
6483
|
+
* All 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, duck, 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.
|
|
6484
|
+
*
|
|
6485
|
+
* #### Animation presets
|
|
6486
|
+
*
|
|
6487
|
+
* Discover 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.
|
|
6488
|
+
*
|
|
6489
|
+
* Presets 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.
|
|
6490
|
+
*
|
|
6491
|
+
* Errors: 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.
|
|
6492
|
+
*
|
|
6493
|
+
* #### Speed, reverse and freeze
|
|
6494
|
+
*
|
|
6495
|
+
* Video/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.
|
|
6496
|
+
*
|
|
6497
|
+
* Update 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.
|
|
6498
|
+
*
|
|
6499
|
+
* Example 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.
|
|
6447
6500
|
*
|
|
6448
6501
|
* #### Script names versus HTTP response names
|
|
6449
6502
|
*
|
|
@@ -6508,7 +6561,7 @@ export const cutRetrieveTimeline = (options) => (options.client ?? client).get({
|
|
|
6508
6561
|
/**
|
|
6509
6562
|
* Render preview frames
|
|
6510
6563
|
*
|
|
6511
|
-
* Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. Decode
|
|
6564
|
+
* 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.
|
|
6512
6565
|
*/
|
|
6513
6566
|
export const cutListFrames = (options) => (options.client ?? client).get({
|
|
6514
6567
|
security: [{
|
|
@@ -6526,7 +6579,7 @@ export const cutListFrames = (options) => (options.client ?? client).get({
|
|
|
6526
6579
|
/**
|
|
6527
6580
|
* Analyze project media
|
|
6528
6581
|
*
|
|
6529
|
-
* Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible.
|
|
6582
|
+
* Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible. Silence measures transcript-based speech pauses, not music or loudness. A completed transcript without words returns ready with empty segments and reason no_speech; no completed transcript returns unsupported with reason no_transcript. A failed transcription remains failed.
|
|
6530
6583
|
*/
|
|
6531
6584
|
export const cutCreateAnalysis = (options) => (options.client ?? client).post({
|
|
6532
6585
|
security: [{
|
|
@@ -7104,7 +7157,7 @@ export const knowledgeListVectorStores = (options) => (options?.client ?? client
|
|
|
7104
7157
|
/**
|
|
7105
7158
|
* Create knowledge base
|
|
7106
7159
|
*
|
|
7107
|
-
* 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.
|
|
7160
|
+
* 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"}.
|
|
7108
7161
|
*/
|
|
7109
7162
|
export const knowledgeCreateVectorStore = (options) => (options.client ?? client).post({
|
|
7110
7163
|
security: [{
|
|
@@ -7200,7 +7253,7 @@ export const knowledgeListFiles = (options) => (options.client ?? client).get({
|
|
|
7200
7253
|
/**
|
|
7201
7254
|
* Add file
|
|
7202
7255
|
*
|
|
7203
|
-
* Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching.
|
|
7256
|
+
* 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.
|
|
7204
7257
|
*/
|
|
7205
7258
|
export const knowledgeAttachFile = (options) => (options.client ?? client).post({
|
|
7206
7259
|
security: [{
|
|
@@ -7422,7 +7475,7 @@ export const knowledgeListEvents = (options) => (options.client ?? client).get({
|
|
|
7422
7475
|
/**
|
|
7423
7476
|
* List libraries
|
|
7424
7477
|
*
|
|
7425
|
-
*
|
|
7478
|
+
* 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.
|
|
7426
7479
|
*/
|
|
7427
7480
|
export const mediaListLibraries = (options) => (options?.client ?? client).get({
|
|
7428
7481
|
security: [{
|
|
@@ -7451,10 +7504,28 @@ export const mediaCreateLibrary = (options) => (options.client ?? client).post({
|
|
|
7451
7504
|
...options.headers
|
|
7452
7505
|
}
|
|
7453
7506
|
});
|
|
7507
|
+
/**
|
|
7508
|
+
* Create frame URLs
|
|
7509
|
+
*
|
|
7510
|
+
* 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.
|
|
7511
|
+
*/
|
|
7512
|
+
export const mediaCreateFrameUrls = (options) => (options.client ?? client).post({
|
|
7513
|
+
security: [{
|
|
7514
|
+
key: 'media-BearerAuth',
|
|
7515
|
+
scheme: 'bearer',
|
|
7516
|
+
type: 'http'
|
|
7517
|
+
}],
|
|
7518
|
+
url: '/media/v1/libraries/{library_id}/assets/{asset_id}/frames',
|
|
7519
|
+
...options,
|
|
7520
|
+
headers: {
|
|
7521
|
+
'Content-Type': 'application/json',
|
|
7522
|
+
...options.headers
|
|
7523
|
+
}
|
|
7524
|
+
});
|
|
7454
7525
|
/**
|
|
7455
7526
|
* Delete library
|
|
7456
7527
|
*
|
|
7457
|
-
*
|
|
7528
|
+
* 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.
|
|
7458
7529
|
*/
|
|
7459
7530
|
export const mediaDeleteLibrary = (options) => (options.client ?? client).delete({
|
|
7460
7531
|
security: [{
|
|
@@ -7468,7 +7539,7 @@ export const mediaDeleteLibrary = (options) => (options.client ?? client).delete
|
|
|
7468
7539
|
/**
|
|
7469
7540
|
* Get library
|
|
7470
7541
|
*
|
|
7471
|
-
*
|
|
7542
|
+
* 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.
|
|
7472
7543
|
*/
|
|
7473
7544
|
export const mediaGetLibrary = (options) => (options.client ?? client).get({
|
|
7474
7545
|
security: [{
|
|
@@ -7482,7 +7553,7 @@ export const mediaGetLibrary = (options) => (options.client ?? client).get({
|
|
|
7482
7553
|
/**
|
|
7483
7554
|
* Update library
|
|
7484
7555
|
*
|
|
7485
|
-
* Update an active library
|
|
7556
|
+
* 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.
|
|
7486
7557
|
*/
|
|
7487
7558
|
export const mediaUpdateLibrary = (options) => (options.client ?? client).patch({
|
|
7488
7559
|
security: [{
|
|
@@ -7500,7 +7571,7 @@ export const mediaUpdateLibrary = (options) => (options.client ?? client).patch(
|
|
|
7500
7571
|
/**
|
|
7501
7572
|
* Restore library
|
|
7502
7573
|
*
|
|
7503
|
-
*
|
|
7574
|
+
* 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.
|
|
7504
7575
|
*/
|
|
7505
7576
|
export const mediaRestoreLibrary = (options) => (options.client ?? client).post({
|
|
7506
7577
|
security: [{
|
|
@@ -7514,7 +7585,7 @@ export const mediaRestoreLibrary = (options) => (options.client ?? client).post(
|
|
|
7514
7585
|
/**
|
|
7515
7586
|
* Purge library
|
|
7516
7587
|
*
|
|
7517
|
-
*
|
|
7588
|
+
* 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.
|
|
7518
7589
|
*/
|
|
7519
7590
|
export const mediaPurgeLibrary = (options) => (options.client ?? client).post({
|
|
7520
7591
|
security: [{
|
|
@@ -7528,7 +7599,7 @@ export const mediaPurgeLibrary = (options) => (options.client ?? client).post({
|
|
|
7528
7599
|
/**
|
|
7529
7600
|
* List assets
|
|
7530
7601
|
*
|
|
7531
|
-
*
|
|
7602
|
+
* 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.
|
|
7532
7603
|
*/
|
|
7533
7604
|
export const mediaListAssets = (options) => (options.client ?? client).get({
|
|
7534
7605
|
security: [{
|
|
@@ -7542,7 +7613,7 @@ export const mediaListAssets = (options) => (options.client ?? client).get({
|
|
|
7542
7613
|
/**
|
|
7543
7614
|
* Upload asset
|
|
7544
7615
|
*
|
|
7545
|
-
*
|
|
7616
|
+
* 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.
|
|
7546
7617
|
*/
|
|
7547
7618
|
export const mediaUploadAsset = (options) => (options.client ?? client).post({
|
|
7548
7619
|
security: [{
|
|
@@ -7560,7 +7631,7 @@ export const mediaUploadAsset = (options) => (options.client ?? client).post({
|
|
|
7560
7631
|
/**
|
|
7561
7632
|
* Import file
|
|
7562
7633
|
*
|
|
7563
|
-
* Copy
|
|
7634
|
+
* 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.
|
|
7564
7635
|
*/
|
|
7565
7636
|
export const mediaImportAsset = (options) => (options.client ?? client).post({
|
|
7566
7637
|
security: [{
|
|
@@ -7578,7 +7649,7 @@ export const mediaImportAsset = (options) => (options.client ?? client).post({
|
|
|
7578
7649
|
/**
|
|
7579
7650
|
* Delete asset
|
|
7580
7651
|
*
|
|
7581
|
-
*
|
|
7652
|
+
* 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.
|
|
7582
7653
|
*/
|
|
7583
7654
|
export const mediaDeleteAsset = (options) => (options.client ?? client).delete({
|
|
7584
7655
|
security: [{
|
|
@@ -7592,7 +7663,7 @@ export const mediaDeleteAsset = (options) => (options.client ?? client).delete({
|
|
|
7592
7663
|
/**
|
|
7593
7664
|
* Get asset
|
|
7594
7665
|
*
|
|
7595
|
-
*
|
|
7666
|
+
* 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.
|
|
7596
7667
|
*/
|
|
7597
7668
|
export const mediaGetAsset = (options) => (options.client ?? client).get({
|
|
7598
7669
|
security: [{
|
|
@@ -7606,7 +7677,7 @@ export const mediaGetAsset = (options) => (options.client ?? client).get({
|
|
|
7606
7677
|
/**
|
|
7607
7678
|
* Update asset
|
|
7608
7679
|
*
|
|
7609
|
-
*
|
|
7680
|
+
* 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.
|
|
7610
7681
|
*/
|
|
7611
7682
|
export const mediaUpdateAsset = (options) => (options.client ?? client).patch({
|
|
7612
7683
|
security: [{
|
|
@@ -7624,7 +7695,7 @@ export const mediaUpdateAsset = (options) => (options.client ?? client).patch({
|
|
|
7624
7695
|
/**
|
|
7625
7696
|
* Reprocess asset
|
|
7626
7697
|
*
|
|
7627
|
-
*
|
|
7698
|
+
* 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.
|
|
7628
7699
|
*/
|
|
7629
7700
|
export const mediaReprocessAsset = (options) => (options.client ?? client).post({
|
|
7630
7701
|
security: [{
|
|
@@ -7642,7 +7713,7 @@ export const mediaReprocessAsset = (options) => (options.client ?? client).post(
|
|
|
7642
7713
|
/**
|
|
7643
7714
|
* List understandings
|
|
7644
7715
|
*
|
|
7645
|
-
* List an asset
|
|
7716
|
+
* 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.
|
|
7646
7717
|
*/
|
|
7647
7718
|
export const mediaListUnderstandings = (options) => (options.client ?? client).get({
|
|
7648
7719
|
security: [{
|
|
@@ -7656,7 +7727,7 @@ export const mediaListUnderstandings = (options) => (options.client ?? client).g
|
|
|
7656
7727
|
/**
|
|
7657
7728
|
* Expression search
|
|
7658
7729
|
*
|
|
7659
|
-
*
|
|
7730
|
+
* 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.
|
|
7660
7731
|
*/
|
|
7661
7732
|
export const mediaExpressionSearch = (options) => (options.client ?? client).post({
|
|
7662
7733
|
security: [{
|
|
@@ -7674,7 +7745,7 @@ export const mediaExpressionSearch = (options) => (options.client ?? client).pos
|
|
|
7674
7745
|
/**
|
|
7675
7746
|
* Visual search
|
|
7676
7747
|
*
|
|
7677
|
-
*
|
|
7748
|
+
* 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.
|
|
7678
7749
|
*/
|
|
7679
7750
|
export const mediaVisualSearch = (options) => (options.client ?? client).post({
|
|
7680
7751
|
security: [{
|
|
@@ -7692,7 +7763,7 @@ export const mediaVisualSearch = (options) => (options.client ?? client).post({
|
|
|
7692
7763
|
/**
|
|
7693
7764
|
* Semantic search
|
|
7694
7765
|
*
|
|
7695
|
-
* Search assets with a nonblank text query
|
|
7766
|
+
* 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.
|
|
7696
7767
|
*/
|
|
7697
7768
|
export const mediaSemanticSearch = (options) => (options.client ?? client).post({
|
|
7698
7769
|
security: [{
|
|
@@ -7710,7 +7781,7 @@ export const mediaSemanticSearch = (options) => (options.client ?? client).post(
|
|
|
7710
7781
|
/**
|
|
7711
7782
|
* Semantic search alias
|
|
7712
7783
|
*
|
|
7713
|
-
*
|
|
7784
|
+
* 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.
|
|
7714
7785
|
*/
|
|
7715
7786
|
export const mediaSearch = (options) => (options.client ?? client).post({
|
|
7716
7787
|
security: [{
|
|
@@ -7728,7 +7799,7 @@ export const mediaSearch = (options) => (options.client ?? client).post({
|
|
|
7728
7799
|
/**
|
|
7729
7800
|
* List folders
|
|
7730
7801
|
*
|
|
7731
|
-
*
|
|
7802
|
+
* undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.
|
|
7732
7803
|
*/
|
|
7733
7804
|
export const mediaListFolders = (options) => (options.client ?? client).get({
|
|
7734
7805
|
security: [{
|
|
@@ -7742,7 +7813,7 @@ export const mediaListFolders = (options) => (options.client ?? client).get({
|
|
|
7742
7813
|
/**
|
|
7743
7814
|
* Create batch
|
|
7744
7815
|
*
|
|
7745
|
-
*
|
|
7816
|
+
* 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.
|
|
7746
7817
|
*/
|
|
7747
7818
|
export const mediaCreateBatch = (options) => (options.client ?? client).post({
|
|
7748
7819
|
security: [{
|
|
@@ -7760,7 +7831,7 @@ export const mediaCreateBatch = (options) => (options.client ?? client).post({
|
|
|
7760
7831
|
/**
|
|
7761
7832
|
* Get batch
|
|
7762
7833
|
*
|
|
7763
|
-
*
|
|
7834
|
+
* 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.
|
|
7764
7835
|
*/
|
|
7765
7836
|
export const mediaGetBatch = (options) => (options.client ?? client).get({
|
|
7766
7837
|
security: [{
|
|
@@ -7774,7 +7845,7 @@ export const mediaGetBatch = (options) => (options.client ?? client).get({
|
|
|
7774
7845
|
/**
|
|
7775
7846
|
* Batch assets alias
|
|
7776
7847
|
*
|
|
7777
|
-
*
|
|
7848
|
+
* 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.
|
|
7778
7849
|
*/
|
|
7779
7850
|
export const mediaBatchAssets = (options) => (options.client ?? client).post({
|
|
7780
7851
|
security: [{
|
|
@@ -7790,9 +7861,9 @@ export const mediaBatchAssets = (options) => (options.client ?? client).post({
|
|
|
7790
7861
|
}
|
|
7791
7862
|
});
|
|
7792
7863
|
/**
|
|
7793
|
-
* Get job
|
|
7864
|
+
* Get job
|
|
7794
7865
|
*
|
|
7795
|
-
*
|
|
7866
|
+
* 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.
|
|
7796
7867
|
*/
|
|
7797
7868
|
export const mediaGetJob = (options) => (options.client ?? client).get({
|
|
7798
7869
|
security: [{
|
|
@@ -7806,7 +7877,7 @@ export const mediaGetJob = (options) => (options.client ?? client).get({
|
|
|
7806
7877
|
/**
|
|
7807
7878
|
* List events
|
|
7808
7879
|
*
|
|
7809
|
-
* Read library events in sequence order
|
|
7880
|
+
* 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.
|
|
7810
7881
|
*/
|
|
7811
7882
|
export const mediaListEvents = (options) => (options.client ?? client).get({
|
|
7812
7883
|
security: [{
|
|
@@ -7820,7 +7891,7 @@ export const mediaListEvents = (options) => (options.client ?? client).get({
|
|
|
7820
7891
|
/**
|
|
7821
7892
|
* Create delivery token
|
|
7822
7893
|
*
|
|
7823
|
-
* Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is
|
|
7894
|
+
* Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is 900 seconds; narrow acl and expires_in before sharing. Anyone holding the token can read matching paths until expires_at.
|
|
7824
7895
|
*/
|
|
7825
7896
|
export const mediaCreateDeliveryToken = (options) => (options.client ?? client).post({
|
|
7826
7897
|
security: [{
|
|
@@ -7835,6 +7906,112 @@ export const mediaCreateDeliveryToken = (options) => (options.client ?? client).
|
|
|
7835
7906
|
...options.headers
|
|
7836
7907
|
}
|
|
7837
7908
|
});
|
|
7909
|
+
/**
|
|
7910
|
+
* Summarize understanding failures
|
|
7911
|
+
*
|
|
7912
|
+
* 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.
|
|
7913
|
+
*/
|
|
7914
|
+
export const mediaUnderstandingFailureSummary = (options) => (options.client ?? client).get({
|
|
7915
|
+
security: [{
|
|
7916
|
+
key: 'media-BearerAuth',
|
|
7917
|
+
scheme: 'bearer',
|
|
7918
|
+
type: 'http'
|
|
7919
|
+
}],
|
|
7920
|
+
url: '/media/v1/libraries/{library_id}/understandings/failure_summary',
|
|
7921
|
+
...options
|
|
7922
|
+
});
|
|
7923
|
+
/**
|
|
7924
|
+
* List understanding results across a library
|
|
7925
|
+
*
|
|
7926
|
+
* 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.
|
|
7927
|
+
*/
|
|
7928
|
+
export const mediaListUnderstandingsByLibrary = (options) => (options.client ?? client).get({
|
|
7929
|
+
security: [{
|
|
7930
|
+
key: 'media-BearerAuth',
|
|
7931
|
+
scheme: 'bearer',
|
|
7932
|
+
type: 'http'
|
|
7933
|
+
}],
|
|
7934
|
+
url: '/media/v1/libraries/{library_id}/understandings',
|
|
7935
|
+
...options
|
|
7936
|
+
});
|
|
7937
|
+
/**
|
|
7938
|
+
* Create video generation
|
|
7939
|
+
*
|
|
7940
|
+
* 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.
|
|
7941
|
+
*/
|
|
7942
|
+
export const mediaCreateGeneration = (options) => (options.client ?? client).post({
|
|
7943
|
+
security: [{
|
|
7944
|
+
key: 'media-BearerAuth',
|
|
7945
|
+
scheme: 'bearer',
|
|
7946
|
+
type: 'http'
|
|
7947
|
+
}],
|
|
7948
|
+
url: '/media/v1/libraries/{library_id}/generations',
|
|
7949
|
+
...options,
|
|
7950
|
+
headers: {
|
|
7951
|
+
'Content-Type': 'application/json',
|
|
7952
|
+
...options.headers
|
|
7953
|
+
}
|
|
7954
|
+
});
|
|
7955
|
+
/**
|
|
7956
|
+
* List jobs
|
|
7957
|
+
*
|
|
7958
|
+
* 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.
|
|
7959
|
+
*/
|
|
7960
|
+
export const mediaListJobs = (options) => (options.client ?? client).get({
|
|
7961
|
+
security: [{
|
|
7962
|
+
key: 'media-BearerAuth',
|
|
7963
|
+
scheme: 'bearer',
|
|
7964
|
+
type: 'http'
|
|
7965
|
+
}],
|
|
7966
|
+
url: '/media/v1/libraries/{library_id}/jobs',
|
|
7967
|
+
...options
|
|
7968
|
+
});
|
|
7969
|
+
/**
|
|
7970
|
+
* Cancel job
|
|
7971
|
+
*
|
|
7972
|
+
* Cancel a queued or running generation job. Already completed outputs remain available to save; poll or read the returned Job to confirm its status.
|
|
7973
|
+
*/
|
|
7974
|
+
export const mediaCancelJob = (options) => (options.client ?? client).post({
|
|
7975
|
+
security: [{
|
|
7976
|
+
key: 'media-BearerAuth',
|
|
7977
|
+
scheme: 'bearer',
|
|
7978
|
+
type: 'http'
|
|
7979
|
+
}],
|
|
7980
|
+
url: '/media/v1/libraries/{library_id}/jobs/{job_id}/cancel',
|
|
7981
|
+
...options
|
|
7982
|
+
});
|
|
7983
|
+
/**
|
|
7984
|
+
* Save generation output
|
|
7985
|
+
*
|
|
7986
|
+
* 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.
|
|
7987
|
+
*/
|
|
7988
|
+
export const mediaSaveGenerationOutput = (options) => (options.client ?? client).post({
|
|
7989
|
+
security: [{
|
|
7990
|
+
key: 'media-BearerAuth',
|
|
7991
|
+
scheme: 'bearer',
|
|
7992
|
+
type: 'http'
|
|
7993
|
+
}],
|
|
7994
|
+
url: '/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save',
|
|
7995
|
+
...options,
|
|
7996
|
+
headers: {
|
|
7997
|
+
'Content-Type': 'application/json',
|
|
7998
|
+
...options.headers
|
|
7999
|
+
}
|
|
8000
|
+
});
|
|
8001
|
+
/**
|
|
8002
|
+
* Get generation capabilities
|
|
8003
|
+
*
|
|
8004
|
+
* 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.
|
|
8005
|
+
*/
|
|
8006
|
+
export const mediaGetGenerationCapabilities = (options) => (options?.client ?? client).get({
|
|
8007
|
+
security: [{
|
|
8008
|
+
key: 'media-BearerAuth',
|
|
8009
|
+
scheme: 'bearer',
|
|
8010
|
+
type: 'http'
|
|
8011
|
+
}],
|
|
8012
|
+
url: '/media/v1/generation/capabilities',
|
|
8013
|
+
...options
|
|
8014
|
+
});
|
|
7838
8015
|
/**
|
|
7839
8016
|
* List sandboxes (v2)
|
|
7840
8017
|
*
|