@deepraxis/sdk 0.1.1-dev.e5614a0 → 0.1.1-dev.e5db771
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 +40 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +206 -41
- package/dist/generated/sdk.gen.js +293 -40
- package/dist/generated/types.gen.d.ts +2879 -337
- package/dist/operations.generated.d.ts +384 -64
- package/dist/operations.generated.js +472 -60
- package/dist/resources.generated.d.ts +41 -0
- package/dist/resources.generated.js +25 -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: [{
|
|
@@ -1988,6 +1988,24 @@ export const countResponseInputTokens = (options) => (options.client ?? client).
|
|
|
1988
1988
|
...options.headers
|
|
1989
1989
|
}
|
|
1990
1990
|
});
|
|
1991
|
+
/**
|
|
1992
|
+
* List organization members
|
|
1993
|
+
*
|
|
1994
|
+
* Concepts follow GitHub org members: find a person's user id, for example to assign an approver to an approval task. Lists only members of the organization behind your API key or runtime token, ordered by joined_at ascending (membership id breaks ties). Ask the user who should approve, then use that member's id. Emails are visible only within this organization. The request cannot select another organization. Pass next_page unchanged as page; null means the end. Read-only; no usage charge. Example: GET /organization/v1/members?limit=20.
|
|
1995
|
+
*/
|
|
1996
|
+
export const listOrganizationMembers = (options) => (options?.client ?? client).get({
|
|
1997
|
+
security: [{
|
|
1998
|
+
key: 'BearerAuth',
|
|
1999
|
+
scheme: 'bearer',
|
|
2000
|
+
type: 'http'
|
|
2001
|
+
}, {
|
|
2002
|
+
key: 'ApiKeyAuth',
|
|
2003
|
+
name: 'X-API-Key',
|
|
2004
|
+
type: 'apiKey'
|
|
2005
|
+
}],
|
|
2006
|
+
url: '/organization/v1/members',
|
|
2007
|
+
...options
|
|
2008
|
+
});
|
|
1991
2009
|
/**
|
|
1992
2010
|
* List your organization's feedback
|
|
1993
2011
|
*
|
|
@@ -6351,13 +6369,124 @@ export const cutUndeleteProject = (options) => (options.client ?? client).post({
|
|
|
6351
6369
|
/**
|
|
6352
6370
|
* Execute editing script
|
|
6353
6371
|
*
|
|
6354
|
-
* 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.
|
|
6355
|
-
*
|
|
6356
|
-
*
|
|
6357
|
-
*
|
|
6358
|
-
* Insert(
|
|
6359
|
-
*
|
|
6372
|
+
* 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);`
|
|
6373
|
+
*
|
|
6374
|
+
* ### Script function reference
|
|
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. JoinId is the string returned by Join or read from GetTimeline().joins. Reads see earlier writes in the same script.
|
|
6377
|
+
*
|
|
6378
|
+
* ```ts
|
|
6379
|
+
* GetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;
|
|
6380
|
+
* GetItem(id: ClipId): ItemView;
|
|
6381
|
+
* FindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];
|
|
6382
|
+
* GetMedia(ref: MediaRef): MediaInfo;
|
|
6383
|
+
* GetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];
|
|
6384
|
+
* GetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];
|
|
6385
|
+
* ListTransitions(): TransitionInfo[];
|
|
6386
|
+
* 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 }[] }[];
|
|
6387
|
+
* ListFonts(): { family: string; weights: number[]; scripts: ("latin"|"cjk")[]; source: "bundled"|"catalog" }[];
|
|
6388
|
+
* Insert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;
|
|
6389
|
+
* Update(id: ClipId, patch: ItemPatchView): void;
|
|
6390
|
+
* SetSpeed(id: ClipId, rate: number, o: { keep: "source" | "duration"; ripple?: boolean }): { length: number; sourceOut: number };
|
|
6391
|
+
* Delete(id: ClipId, o?: { ripple?: boolean }): void;
|
|
6392
|
+
* Join(left: ClipId, right: ClipId, o: { length?: number; effect: TransitionInput }): JoinId;
|
|
6393
|
+
* UpdateJoin(id: JoinId, patch: { length?: number; effect?: TransitionInput }): void;
|
|
6394
|
+
* DeleteJoin(id: JoinId): void;
|
|
6395
|
+
* Split(id: ClipId, at: number): ClipId;
|
|
6396
|
+
* Trim(id: ClipId, edge: "in" | "out", delta: number, o?: { ripple?: boolean }): void;
|
|
6397
|
+
* Move(id: ClipId, start: number, track?: TrackId): void;
|
|
6398
|
+
* RippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;
|
|
6399
|
+
* AddTrack(kind: "video" | "audio" | "caption", init?: { name?: string }, index?: number): TrackId;
|
|
6400
|
+
* UpdateTrack(id: TrackId, patch: TrackPatch): void;
|
|
6401
|
+
* DeleteTrack(id: TrackId): void;
|
|
6402
|
+
* SetSettings(patch: Partial<ProjectSettingsView>): void;
|
|
6403
|
+
* AddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle>; maxChars?: number }): ClipId[];
|
|
6404
|
+
* SetMarker(at: number, label: string): string;
|
|
6405
|
+
* Print(...values: unknown[]): void;
|
|
6406
|
+
* Preview(at: number[]): void;
|
|
6360
6407
|
* ```
|
|
6408
|
+
*
|
|
6409
|
+
* | Functions | Behavior and arguments |
|
|
6410
|
+
* | --- | --- |
|
|
6411
|
+
* | 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. |
|
|
6412
|
+
* | 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. |
|
|
6413
|
+
* | 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. |
|
|
6414
|
+
* | FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |
|
|
6415
|
+
* | GetMedia | Read metadata for `{libraryId, assetId}` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |
|
|
6416
|
+
* | 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. |
|
|
6417
|
+
* | 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. |
|
|
6418
|
+
* | 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. |
|
|
6419
|
+
* | 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. |
|
|
6420
|
+
* | 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. |
|
|
6421
|
+
* | RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |
|
|
6422
|
+
* | 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. |
|
|
6423
|
+
* | SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |
|
|
6424
|
+
* | 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. |
|
|
6425
|
+
* | SetMarker | Add a label at a timeline time and return its ID. |
|
|
6426
|
+
* | 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. |
|
|
6427
|
+
*
|
|
6428
|
+
* #### Joins between clips
|
|
6429
|
+
*
|
|
6430
|
+
* 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.
|
|
6431
|
+
*
|
|
6432
|
+
* 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.
|
|
6433
|
+
*
|
|
6434
|
+
* 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.
|
|
6435
|
+
*
|
|
6436
|
+
* #### Insert fields (ItemInit)
|
|
6437
|
+
*
|
|
6438
|
+
* 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.
|
|
6439
|
+
*
|
|
6440
|
+
* | type | Required fields beyond type/start | Optional fields |
|
|
6441
|
+
* | --- | --- | --- |
|
|
6442
|
+
* | video | media | length, sourceIn, playback, volumeDb, transform, fit, animate, animation, transitionIn, transitionOut |
|
|
6443
|
+
* | image | media, length | transform, fit, animate, animation, transitionIn, transitionOut |
|
|
6444
|
+
* | text | text, length | style, transform, reveal, animate, animation, transitionIn, transitionOut |
|
|
6445
|
+
* | color | color, length | transform, fill, animate, animation, transitionIn, transitionOut |
|
|
6446
|
+
* | shape | shape, length, width, height, fill | radius, stroke, transform, animate, animation, transitionIn, transitionOut |
|
|
6447
|
+
* | audio | media | length, sourceIn, playback, volumeDb, fadeIn, fadeOut |
|
|
6448
|
+
* | caption | text, length | — |
|
|
6449
|
+
*
|
|
6450
|
+
* 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.
|
|
6451
|
+
*
|
|
6452
|
+
* | Field | Value |
|
|
6453
|
+
* | --- | --- |
|
|
6454
|
+
* | 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. |
|
|
6455
|
+
* | 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. |
|
|
6456
|
+
* | 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. |
|
|
6457
|
+
* | 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. |
|
|
6458
|
+
* | 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. |
|
|
6459
|
+
* | 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. |
|
|
6460
|
+
* | 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. |
|
|
6461
|
+
* | 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}`. |
|
|
6462
|
+
* | 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. |
|
|
6463
|
+
*
|
|
6464
|
+
* #### Update fields (ItemPatchView)
|
|
6465
|
+
*
|
|
6466
|
+
* 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, animate, reveal, animation, fill, stroke, shape, width, height, radius, transitionIn, transitionOut. Values and units match Insert. 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.
|
|
6467
|
+
*
|
|
6468
|
+
* #### Animation presets
|
|
6469
|
+
*
|
|
6470
|
+
* 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.
|
|
6471
|
+
*
|
|
6472
|
+
* 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.
|
|
6473
|
+
*
|
|
6474
|
+
* 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.
|
|
6475
|
+
*
|
|
6476
|
+
* #### Speed, reverse and freeze
|
|
6477
|
+
*
|
|
6478
|
+
* 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.
|
|
6479
|
+
*
|
|
6480
|
+
* 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.
|
|
6481
|
+
*
|
|
6482
|
+
* 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.
|
|
6483
|
+
*
|
|
6484
|
+
* #### Script names versus HTTP response names
|
|
6485
|
+
*
|
|
6486
|
+
* Use camelCase inside scripts, including nested objects. HTTP request/response JSON outside script source uses snake_case. Map media.library_id → media.libraryId, media.asset_id → media.assetId, source_in → sourceIn, volume_db → volumeDb, fade_in/fade_out → fadeIn/fadeOut, transition_in/transition_out → transitionIn/transitionOut, font_family/font_size/font_weight/max_width → fontFamily/fontSize/fontWeight/maxWidth, gain_db → gainDb, highlight_color/max_lines → highlightColor/maxLines. Fields such as animate, reveal, fill, stroke, at and length retain their spelling. GetTimeline/GetItem already return camelCase compact views; the expanded retrieveTimeline HTTP response is not an Insert object.
|
|
6487
|
+
*
|
|
6488
|
+
* Unrecognized script fields fail with OPS_REJECTED and rejection code UNKNOWN_FIELD; snake_case mistakes suggest the corresponding camelCase name. The error message lists each rejection's #opIndex, code and reason. Correct the named fields and retry the saved edit; do not assume an ignored field applied an effect.
|
|
6489
|
+
*
|
|
6361
6490
|
*/
|
|
6362
6491
|
export const cutExecute = (options) => (options.client ?? client).post({
|
|
6363
6492
|
security: [{
|
|
@@ -6415,7 +6544,7 @@ export const cutRetrieveTimeline = (options) => (options.client ?? client).get({
|
|
|
6415
6544
|
/**
|
|
6416
6545
|
* Render preview frames
|
|
6417
6546
|
*
|
|
6418
|
-
* 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.
|
|
6547
|
+
* 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.
|
|
6419
6548
|
*/
|
|
6420
6549
|
export const cutListFrames = (options) => (options.client ?? client).get({
|
|
6421
6550
|
security: [{
|
|
@@ -6433,7 +6562,7 @@ export const cutListFrames = (options) => (options.client ?? client).get({
|
|
|
6433
6562
|
/**
|
|
6434
6563
|
* Analyze project media
|
|
6435
6564
|
*
|
|
6436
|
-
* 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.
|
|
6565
|
+
* 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.
|
|
6437
6566
|
*/
|
|
6438
6567
|
export const cutCreateAnalysis = (options) => (options.client ?? client).post({
|
|
6439
6568
|
security: [{
|
|
@@ -7011,7 +7140,7 @@ export const knowledgeListVectorStores = (options) => (options?.client ?? client
|
|
|
7011
7140
|
/**
|
|
7012
7141
|
* Create knowledge base
|
|
7013
7142
|
*
|
|
7014
|
-
* 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.
|
|
7143
|
+
* 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"}.
|
|
7015
7144
|
*/
|
|
7016
7145
|
export const knowledgeCreateVectorStore = (options) => (options.client ?? client).post({
|
|
7017
7146
|
security: [{
|
|
@@ -7107,7 +7236,7 @@ export const knowledgeListFiles = (options) => (options.client ?? client).get({
|
|
|
7107
7236
|
/**
|
|
7108
7237
|
* Add file
|
|
7109
7238
|
*
|
|
7110
|
-
* Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching.
|
|
7239
|
+
* 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.
|
|
7111
7240
|
*/
|
|
7112
7241
|
export const knowledgeAttachFile = (options) => (options.client ?? client).post({
|
|
7113
7242
|
security: [{
|
|
@@ -7329,7 +7458,7 @@ export const knowledgeListEvents = (options) => (options.client ?? client).get({
|
|
|
7329
7458
|
/**
|
|
7330
7459
|
* List libraries
|
|
7331
7460
|
*
|
|
7332
|
-
*
|
|
7461
|
+
* 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.
|
|
7333
7462
|
*/
|
|
7334
7463
|
export const mediaListLibraries = (options) => (options?.client ?? client).get({
|
|
7335
7464
|
security: [{
|
|
@@ -7358,10 +7487,28 @@ export const mediaCreateLibrary = (options) => (options.client ?? client).post({
|
|
|
7358
7487
|
...options.headers
|
|
7359
7488
|
}
|
|
7360
7489
|
});
|
|
7490
|
+
/**
|
|
7491
|
+
* Create frame URLs
|
|
7492
|
+
*
|
|
7493
|
+
* 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.
|
|
7494
|
+
*/
|
|
7495
|
+
export const mediaCreateFrameUrls = (options) => (options.client ?? client).post({
|
|
7496
|
+
security: [{
|
|
7497
|
+
key: 'media-BearerAuth',
|
|
7498
|
+
scheme: 'bearer',
|
|
7499
|
+
type: 'http'
|
|
7500
|
+
}],
|
|
7501
|
+
url: '/media/v1/libraries/{library_id}/assets/{asset_id}/frames',
|
|
7502
|
+
...options,
|
|
7503
|
+
headers: {
|
|
7504
|
+
'Content-Type': 'application/json',
|
|
7505
|
+
...options.headers
|
|
7506
|
+
}
|
|
7507
|
+
});
|
|
7361
7508
|
/**
|
|
7362
7509
|
* Delete library
|
|
7363
7510
|
*
|
|
7364
|
-
*
|
|
7511
|
+
* 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.
|
|
7365
7512
|
*/
|
|
7366
7513
|
export const mediaDeleteLibrary = (options) => (options.client ?? client).delete({
|
|
7367
7514
|
security: [{
|
|
@@ -7375,7 +7522,7 @@ export const mediaDeleteLibrary = (options) => (options.client ?? client).delete
|
|
|
7375
7522
|
/**
|
|
7376
7523
|
* Get library
|
|
7377
7524
|
*
|
|
7378
|
-
*
|
|
7525
|
+
* 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.
|
|
7379
7526
|
*/
|
|
7380
7527
|
export const mediaGetLibrary = (options) => (options.client ?? client).get({
|
|
7381
7528
|
security: [{
|
|
@@ -7389,7 +7536,7 @@ export const mediaGetLibrary = (options) => (options.client ?? client).get({
|
|
|
7389
7536
|
/**
|
|
7390
7537
|
* Update library
|
|
7391
7538
|
*
|
|
7392
|
-
* Update an active library
|
|
7539
|
+
* 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.
|
|
7393
7540
|
*/
|
|
7394
7541
|
export const mediaUpdateLibrary = (options) => (options.client ?? client).patch({
|
|
7395
7542
|
security: [{
|
|
@@ -7407,7 +7554,7 @@ export const mediaUpdateLibrary = (options) => (options.client ?? client).patch(
|
|
|
7407
7554
|
/**
|
|
7408
7555
|
* Restore library
|
|
7409
7556
|
*
|
|
7410
|
-
*
|
|
7557
|
+
* 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.
|
|
7411
7558
|
*/
|
|
7412
7559
|
export const mediaRestoreLibrary = (options) => (options.client ?? client).post({
|
|
7413
7560
|
security: [{
|
|
@@ -7421,7 +7568,7 @@ export const mediaRestoreLibrary = (options) => (options.client ?? client).post(
|
|
|
7421
7568
|
/**
|
|
7422
7569
|
* Purge library
|
|
7423
7570
|
*
|
|
7424
|
-
*
|
|
7571
|
+
* 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.
|
|
7425
7572
|
*/
|
|
7426
7573
|
export const mediaPurgeLibrary = (options) => (options.client ?? client).post({
|
|
7427
7574
|
security: [{
|
|
@@ -7435,7 +7582,7 @@ export const mediaPurgeLibrary = (options) => (options.client ?? client).post({
|
|
|
7435
7582
|
/**
|
|
7436
7583
|
* List assets
|
|
7437
7584
|
*
|
|
7438
|
-
*
|
|
7585
|
+
* 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.
|
|
7439
7586
|
*/
|
|
7440
7587
|
export const mediaListAssets = (options) => (options.client ?? client).get({
|
|
7441
7588
|
security: [{
|
|
@@ -7449,7 +7596,7 @@ export const mediaListAssets = (options) => (options.client ?? client).get({
|
|
|
7449
7596
|
/**
|
|
7450
7597
|
* Upload asset
|
|
7451
7598
|
*
|
|
7452
|
-
*
|
|
7599
|
+
* 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.
|
|
7453
7600
|
*/
|
|
7454
7601
|
export const mediaUploadAsset = (options) => (options.client ?? client).post({
|
|
7455
7602
|
security: [{
|
|
@@ -7467,7 +7614,7 @@ export const mediaUploadAsset = (options) => (options.client ?? client).post({
|
|
|
7467
7614
|
/**
|
|
7468
7615
|
* Import file
|
|
7469
7616
|
*
|
|
7470
|
-
* Copy
|
|
7617
|
+
* 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.
|
|
7471
7618
|
*/
|
|
7472
7619
|
export const mediaImportAsset = (options) => (options.client ?? client).post({
|
|
7473
7620
|
security: [{
|
|
@@ -7485,7 +7632,7 @@ export const mediaImportAsset = (options) => (options.client ?? client).post({
|
|
|
7485
7632
|
/**
|
|
7486
7633
|
* Delete asset
|
|
7487
7634
|
*
|
|
7488
|
-
*
|
|
7635
|
+
* 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.
|
|
7489
7636
|
*/
|
|
7490
7637
|
export const mediaDeleteAsset = (options) => (options.client ?? client).delete({
|
|
7491
7638
|
security: [{
|
|
@@ -7499,7 +7646,7 @@ export const mediaDeleteAsset = (options) => (options.client ?? client).delete({
|
|
|
7499
7646
|
/**
|
|
7500
7647
|
* Get asset
|
|
7501
7648
|
*
|
|
7502
|
-
*
|
|
7649
|
+
* 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.
|
|
7503
7650
|
*/
|
|
7504
7651
|
export const mediaGetAsset = (options) => (options.client ?? client).get({
|
|
7505
7652
|
security: [{
|
|
@@ -7513,7 +7660,7 @@ export const mediaGetAsset = (options) => (options.client ?? client).get({
|
|
|
7513
7660
|
/**
|
|
7514
7661
|
* Update asset
|
|
7515
7662
|
*
|
|
7516
|
-
*
|
|
7663
|
+
* 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.
|
|
7517
7664
|
*/
|
|
7518
7665
|
export const mediaUpdateAsset = (options) => (options.client ?? client).patch({
|
|
7519
7666
|
security: [{
|
|
@@ -7531,7 +7678,7 @@ export const mediaUpdateAsset = (options) => (options.client ?? client).patch({
|
|
|
7531
7678
|
/**
|
|
7532
7679
|
* Reprocess asset
|
|
7533
7680
|
*
|
|
7534
|
-
*
|
|
7681
|
+
* 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.
|
|
7535
7682
|
*/
|
|
7536
7683
|
export const mediaReprocessAsset = (options) => (options.client ?? client).post({
|
|
7537
7684
|
security: [{
|
|
@@ -7549,7 +7696,7 @@ export const mediaReprocessAsset = (options) => (options.client ?? client).post(
|
|
|
7549
7696
|
/**
|
|
7550
7697
|
* List understandings
|
|
7551
7698
|
*
|
|
7552
|
-
* List an asset
|
|
7699
|
+
* 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.
|
|
7553
7700
|
*/
|
|
7554
7701
|
export const mediaListUnderstandings = (options) => (options.client ?? client).get({
|
|
7555
7702
|
security: [{
|
|
@@ -7563,7 +7710,7 @@ export const mediaListUnderstandings = (options) => (options.client ?? client).g
|
|
|
7563
7710
|
/**
|
|
7564
7711
|
* Expression search
|
|
7565
7712
|
*
|
|
7566
|
-
*
|
|
7713
|
+
* 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.
|
|
7567
7714
|
*/
|
|
7568
7715
|
export const mediaExpressionSearch = (options) => (options.client ?? client).post({
|
|
7569
7716
|
security: [{
|
|
@@ -7581,7 +7728,7 @@ export const mediaExpressionSearch = (options) => (options.client ?? client).pos
|
|
|
7581
7728
|
/**
|
|
7582
7729
|
* Visual search
|
|
7583
7730
|
*
|
|
7584
|
-
*
|
|
7731
|
+
* 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.
|
|
7585
7732
|
*/
|
|
7586
7733
|
export const mediaVisualSearch = (options) => (options.client ?? client).post({
|
|
7587
7734
|
security: [{
|
|
@@ -7599,7 +7746,7 @@ export const mediaVisualSearch = (options) => (options.client ?? client).post({
|
|
|
7599
7746
|
/**
|
|
7600
7747
|
* Semantic search
|
|
7601
7748
|
*
|
|
7602
|
-
* Search assets with a nonblank text query
|
|
7749
|
+
* 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.
|
|
7603
7750
|
*/
|
|
7604
7751
|
export const mediaSemanticSearch = (options) => (options.client ?? client).post({
|
|
7605
7752
|
security: [{
|
|
@@ -7617,7 +7764,7 @@ export const mediaSemanticSearch = (options) => (options.client ?? client).post(
|
|
|
7617
7764
|
/**
|
|
7618
7765
|
* Semantic search alias
|
|
7619
7766
|
*
|
|
7620
|
-
*
|
|
7767
|
+
* 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.
|
|
7621
7768
|
*/
|
|
7622
7769
|
export const mediaSearch = (options) => (options.client ?? client).post({
|
|
7623
7770
|
security: [{
|
|
@@ -7635,7 +7782,7 @@ export const mediaSearch = (options) => (options.client ?? client).post({
|
|
|
7635
7782
|
/**
|
|
7636
7783
|
* List folders
|
|
7637
7784
|
*
|
|
7638
|
-
*
|
|
7785
|
+
* undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.
|
|
7639
7786
|
*/
|
|
7640
7787
|
export const mediaListFolders = (options) => (options.client ?? client).get({
|
|
7641
7788
|
security: [{
|
|
@@ -7649,7 +7796,7 @@ export const mediaListFolders = (options) => (options.client ?? client).get({
|
|
|
7649
7796
|
/**
|
|
7650
7797
|
* Create batch
|
|
7651
7798
|
*
|
|
7652
|
-
*
|
|
7799
|
+
* 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.
|
|
7653
7800
|
*/
|
|
7654
7801
|
export const mediaCreateBatch = (options) => (options.client ?? client).post({
|
|
7655
7802
|
security: [{
|
|
@@ -7667,7 +7814,7 @@ export const mediaCreateBatch = (options) => (options.client ?? client).post({
|
|
|
7667
7814
|
/**
|
|
7668
7815
|
* Get batch
|
|
7669
7816
|
*
|
|
7670
|
-
*
|
|
7817
|
+
* 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.
|
|
7671
7818
|
*/
|
|
7672
7819
|
export const mediaGetBatch = (options) => (options.client ?? client).get({
|
|
7673
7820
|
security: [{
|
|
@@ -7681,7 +7828,7 @@ export const mediaGetBatch = (options) => (options.client ?? client).get({
|
|
|
7681
7828
|
/**
|
|
7682
7829
|
* Batch assets alias
|
|
7683
7830
|
*
|
|
7684
|
-
*
|
|
7831
|
+
* 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.
|
|
7685
7832
|
*/
|
|
7686
7833
|
export const mediaBatchAssets = (options) => (options.client ?? client).post({
|
|
7687
7834
|
security: [{
|
|
@@ -7697,9 +7844,9 @@ export const mediaBatchAssets = (options) => (options.client ?? client).post({
|
|
|
7697
7844
|
}
|
|
7698
7845
|
});
|
|
7699
7846
|
/**
|
|
7700
|
-
* Get job
|
|
7847
|
+
* Get job
|
|
7701
7848
|
*
|
|
7702
|
-
*
|
|
7849
|
+
* 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.
|
|
7703
7850
|
*/
|
|
7704
7851
|
export const mediaGetJob = (options) => (options.client ?? client).get({
|
|
7705
7852
|
security: [{
|
|
@@ -7713,7 +7860,7 @@ export const mediaGetJob = (options) => (options.client ?? client).get({
|
|
|
7713
7860
|
/**
|
|
7714
7861
|
* List events
|
|
7715
7862
|
*
|
|
7716
|
-
* Read library events in sequence order
|
|
7863
|
+
* 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.
|
|
7717
7864
|
*/
|
|
7718
7865
|
export const mediaListEvents = (options) => (options.client ?? client).get({
|
|
7719
7866
|
security: [{
|
|
@@ -7727,7 +7874,7 @@ export const mediaListEvents = (options) => (options.client ?? client).get({
|
|
|
7727
7874
|
/**
|
|
7728
7875
|
* Create delivery token
|
|
7729
7876
|
*
|
|
7730
|
-
* 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
|
|
7877
|
+
* 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.
|
|
7731
7878
|
*/
|
|
7732
7879
|
export const mediaCreateDeliveryToken = (options) => (options.client ?? client).post({
|
|
7733
7880
|
security: [{
|
|
@@ -7742,6 +7889,112 @@ export const mediaCreateDeliveryToken = (options) => (options.client ?? client).
|
|
|
7742
7889
|
...options.headers
|
|
7743
7890
|
}
|
|
7744
7891
|
});
|
|
7892
|
+
/**
|
|
7893
|
+
* Summarize understanding failures
|
|
7894
|
+
*
|
|
7895
|
+
* 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.
|
|
7896
|
+
*/
|
|
7897
|
+
export const mediaUnderstandingFailureSummary = (options) => (options.client ?? client).get({
|
|
7898
|
+
security: [{
|
|
7899
|
+
key: 'media-BearerAuth',
|
|
7900
|
+
scheme: 'bearer',
|
|
7901
|
+
type: 'http'
|
|
7902
|
+
}],
|
|
7903
|
+
url: '/media/v1/libraries/{library_id}/understandings/failure_summary',
|
|
7904
|
+
...options
|
|
7905
|
+
});
|
|
7906
|
+
/**
|
|
7907
|
+
* List understanding results across a library
|
|
7908
|
+
*
|
|
7909
|
+
* 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.
|
|
7910
|
+
*/
|
|
7911
|
+
export const mediaListUnderstandingsByLibrary = (options) => (options.client ?? client).get({
|
|
7912
|
+
security: [{
|
|
7913
|
+
key: 'media-BearerAuth',
|
|
7914
|
+
scheme: 'bearer',
|
|
7915
|
+
type: 'http'
|
|
7916
|
+
}],
|
|
7917
|
+
url: '/media/v1/libraries/{library_id}/understandings',
|
|
7918
|
+
...options
|
|
7919
|
+
});
|
|
7920
|
+
/**
|
|
7921
|
+
* Create video generation
|
|
7922
|
+
*
|
|
7923
|
+
* 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.
|
|
7924
|
+
*/
|
|
7925
|
+
export const mediaCreateGeneration = (options) => (options.client ?? client).post({
|
|
7926
|
+
security: [{
|
|
7927
|
+
key: 'media-BearerAuth',
|
|
7928
|
+
scheme: 'bearer',
|
|
7929
|
+
type: 'http'
|
|
7930
|
+
}],
|
|
7931
|
+
url: '/media/v1/libraries/{library_id}/generations',
|
|
7932
|
+
...options,
|
|
7933
|
+
headers: {
|
|
7934
|
+
'Content-Type': 'application/json',
|
|
7935
|
+
...options.headers
|
|
7936
|
+
}
|
|
7937
|
+
});
|
|
7938
|
+
/**
|
|
7939
|
+
* List jobs
|
|
7940
|
+
*
|
|
7941
|
+
* 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.
|
|
7942
|
+
*/
|
|
7943
|
+
export const mediaListJobs = (options) => (options.client ?? client).get({
|
|
7944
|
+
security: [{
|
|
7945
|
+
key: 'media-BearerAuth',
|
|
7946
|
+
scheme: 'bearer',
|
|
7947
|
+
type: 'http'
|
|
7948
|
+
}],
|
|
7949
|
+
url: '/media/v1/libraries/{library_id}/jobs',
|
|
7950
|
+
...options
|
|
7951
|
+
});
|
|
7952
|
+
/**
|
|
7953
|
+
* Cancel job
|
|
7954
|
+
*
|
|
7955
|
+
* Cancel a queued or running generation job. Already completed outputs remain available to save; poll or read the returned Job to confirm its status.
|
|
7956
|
+
*/
|
|
7957
|
+
export const mediaCancelJob = (options) => (options.client ?? client).post({
|
|
7958
|
+
security: [{
|
|
7959
|
+
key: 'media-BearerAuth',
|
|
7960
|
+
scheme: 'bearer',
|
|
7961
|
+
type: 'http'
|
|
7962
|
+
}],
|
|
7963
|
+
url: '/media/v1/libraries/{library_id}/jobs/{job_id}/cancel',
|
|
7964
|
+
...options
|
|
7965
|
+
});
|
|
7966
|
+
/**
|
|
7967
|
+
* Save generation output
|
|
7968
|
+
*
|
|
7969
|
+
* 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.
|
|
7970
|
+
*/
|
|
7971
|
+
export const mediaSaveGenerationOutput = (options) => (options.client ?? client).post({
|
|
7972
|
+
security: [{
|
|
7973
|
+
key: 'media-BearerAuth',
|
|
7974
|
+
scheme: 'bearer',
|
|
7975
|
+
type: 'http'
|
|
7976
|
+
}],
|
|
7977
|
+
url: '/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save',
|
|
7978
|
+
...options,
|
|
7979
|
+
headers: {
|
|
7980
|
+
'Content-Type': 'application/json',
|
|
7981
|
+
...options.headers
|
|
7982
|
+
}
|
|
7983
|
+
});
|
|
7984
|
+
/**
|
|
7985
|
+
* Get generation capabilities
|
|
7986
|
+
*
|
|
7987
|
+
* 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.
|
|
7988
|
+
*/
|
|
7989
|
+
export const mediaGetGenerationCapabilities = (options) => (options?.client ?? client).get({
|
|
7990
|
+
security: [{
|
|
7991
|
+
key: 'media-BearerAuth',
|
|
7992
|
+
scheme: 'bearer',
|
|
7993
|
+
type: 'http'
|
|
7994
|
+
}],
|
|
7995
|
+
url: '/media/v1/generation/capabilities',
|
|
7996
|
+
...options
|
|
7997
|
+
});
|
|
7745
7998
|
/**
|
|
7746
7999
|
* List sandboxes (v2)
|
|
7747
8000
|
*
|