@deepraxis/sdk 0.1.1-dev.e5614a0 → 0.1.1-dev.e9377c2
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 +92 -1
- package/README.md +2 -2
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +317 -45
- package/dist/generated/sdk.gen.js +556 -44
- package/dist/generated/types.gen.d.ts +5611 -1658
- package/dist/operations.generated.d.ts +876 -91
- package/dist/operations.generated.js +1475 -506
- package/dist/resources.generated.d.ts +82 -8
- package/dist/resources.generated.js +59 -0
- package/package.json +2 -2
|
@@ -107,7 +107,7 @@ export declare const operations: readonly [{
|
|
|
107
107
|
readonly type: "array";
|
|
108
108
|
readonly itemType: "object";
|
|
109
109
|
readonly required: false;
|
|
110
|
-
readonly description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or
|
|
110
|
+
readonly description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.";
|
|
111
111
|
}, {
|
|
112
112
|
readonly name: "kind";
|
|
113
113
|
readonly type: "string";
|
|
@@ -4845,7 +4845,7 @@ export declare const operations: readonly [{
|
|
|
4845
4845
|
readonly type: "string";
|
|
4846
4846
|
readonly enum: readonly ["skip", "allow"];
|
|
4847
4847
|
readonly required: false;
|
|
4848
|
-
readonly description: "skip
|
|
4848
|
+
readonly description: "skip skips while a previous run is still active; allow permits overlapping runs. When omitted, schedule triggers use skip and webhook triggers use allow.";
|
|
4849
4849
|
}, {
|
|
4850
4850
|
readonly name: "catchup_window_seconds";
|
|
4851
4851
|
readonly type: "integer";
|
|
@@ -4986,7 +4986,7 @@ export declare const operations: readonly [{
|
|
|
4986
4986
|
readonly type: "string";
|
|
4987
4987
|
readonly enum: readonly ["skip", "allow"];
|
|
4988
4988
|
readonly required: false;
|
|
4989
|
-
readonly description: "skip
|
|
4989
|
+
readonly description: "skip skips while a previous run is still active; allow permits overlapping runs. When omitted, schedule triggers use skip and webhook triggers use allow.";
|
|
4990
4990
|
}, {
|
|
4991
4991
|
readonly name: "catchup_window_seconds";
|
|
4992
4992
|
readonly type: "integer";
|
|
@@ -7935,7 +7935,7 @@ export declare const operations: readonly [{
|
|
|
7935
7935
|
readonly resource: "cut.projects.analysis";
|
|
7936
7936
|
readonly method: "create";
|
|
7937
7937
|
readonly summary: "Analyze project media";
|
|
7938
|
-
readonly description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible.";
|
|
7938
|
+
readonly description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible. Silence measures transcript-based speech pauses, not music or loudness. A completed transcript without words returns ready with empty segments and reason no_speech; no completed transcript returns unsupported with reason no_transcript. A failed transcription remains failed.";
|
|
7939
7939
|
readonly http: "POST";
|
|
7940
7940
|
readonly path: "/cut/v1/projects/{project_id}/analysis";
|
|
7941
7941
|
readonly streaming: "no";
|
|
@@ -8074,6 +8074,16 @@ export declare const operations: readonly [{
|
|
|
8074
8074
|
readonly body: {
|
|
8075
8075
|
readonly required: true;
|
|
8076
8076
|
readonly fields: readonly [{
|
|
8077
|
+
readonly name: "folder";
|
|
8078
|
+
readonly type: "string";
|
|
8079
|
+
readonly required: false;
|
|
8080
|
+
readonly description: "Optional destination path within the bound media library; omitted uses its default folder.";
|
|
8081
|
+
}, {
|
|
8082
|
+
readonly name: "name";
|
|
8083
|
+
readonly type: "string";
|
|
8084
|
+
readonly required: false;
|
|
8085
|
+
readonly description: "Nonempty display name, frozen with the export. Path separators and control characters become hyphens; limited to 200 characters. Omitted uses project name and timestamp.";
|
|
8086
|
+
}, {
|
|
8077
8087
|
readonly name: "output";
|
|
8078
8088
|
readonly type: "object";
|
|
8079
8089
|
readonly required: false;
|
|
@@ -8088,13 +8098,18 @@ export declare const operations: readonly [{
|
|
|
8088
8098
|
readonly type: "integer";
|
|
8089
8099
|
readonly required: false;
|
|
8090
8100
|
readonly description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write.";
|
|
8101
|
+
}, {
|
|
8102
|
+
readonly name: "loudness";
|
|
8103
|
+
readonly type: "object";
|
|
8104
|
+
readonly required: false;
|
|
8105
|
+
readonly description: "Optional loudness normalization target; normalization adds analysis and rendering work.";
|
|
8091
8106
|
}];
|
|
8092
8107
|
};
|
|
8093
8108
|
}, {
|
|
8094
8109
|
readonly resource: "cut.projects.frames";
|
|
8095
8110
|
readonly method: "list";
|
|
8096
8111
|
readonly summary: "Render preview frames";
|
|
8097
|
-
readonly description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision.
|
|
8112
|
+
readonly description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution. The response always includes warnings; FRAME_UNAVAILABLE means a source preview could not be obtained and an offline tile was drawn. Its message identifies a timeout, delivery capacity limit, or unavailable source and contains no source URL. Decode each image's base64 payload to save it. Codemode returns at most four images per call, so request at most four times when reviewing there.";
|
|
8098
8113
|
readonly http: "GET";
|
|
8099
8114
|
readonly path: "/cut/v1/projects/{project_id}/frames";
|
|
8100
8115
|
readonly streaming: "no";
|
|
@@ -8113,7 +8128,7 @@ export declare const operations: readonly [{
|
|
|
8113
8128
|
readonly name: "scale";
|
|
8114
8129
|
readonly type: "number";
|
|
8115
8130
|
readonly required: false;
|
|
8116
|
-
readonly description: "
|
|
8131
|
+
readonly description: "Image size multiplier, default 0.25, greater than zero and at most 0.5. Larger values return INVALID_PARAMS; pixel-area limits may reduce actual dimensions, reported as width and height.";
|
|
8117
8132
|
}, {
|
|
8118
8133
|
readonly name: "revision";
|
|
8119
8134
|
readonly type: "integer";
|
|
@@ -8268,7 +8283,7 @@ export declare const operations: readonly [{
|
|
|
8268
8283
|
readonly resource: "cut.projects";
|
|
8269
8284
|
readonly method: "execute";
|
|
8270
8285
|
readonly summary: "Execute editing script";
|
|
8271
|
-
readonly description: "Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Use AddTrack, Insert, Update, Delete, Split, Trim, Move, RippleDeleteRange, UpdateTrack, DeleteTrack, SetSettings, AddCaptionsFromTranscript and SetMarker for writes; GetTimeline, GetItem, FindItems, GetMedia, GetTranscript and GetAnalysis read editing context; Print emits text and Preview requests frame previews. All script times are seconds; script object fields use camelCase, for example `media: {libraryId, assetId}`. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project:\n\n```js\nconst t = AddTrack(\"video\");\nInsert(t, {type: \"color\", color: \"#123456\", start: 0, length: 3});\nPrint(t);\n```";
|
|
8286
|
+
readonly description: "Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: `const t = AddTrack(\"video\"); Insert(t, {type: \"color\", color: \"#123456\", start: 0, length: 3}); Print(t);`\n\n### Script function reference\n\nFunctions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. JoinId is the string returned by Join or read from GetTimeline().joins. Reads see earlier writes in the same script.\n\n```ts\nGetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;\nGetItem(id: ClipId): ItemView;\nFindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];\nGetMedia(ref: MediaRef): MediaInfo;\nGetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];\nGetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];\nListTransitions(): TransitionInfo[];\nListEffects(): EffectInfo[];\nListTextStyles(): TextStylePreset[];\nListTextTemplates(): TextTemplate[];\nListAnimations(): { id: string; version: number; phase: \"in\" | \"out\" | \"loop\"; target: \"any\" | \"text\"; name: string; description: string; defaultDuration: number; params: { name: string; type: string; values?: string[]; default?: string | number; min?: number; max?: number; description: string }[] }[];\nListFonts(): { family: string; weights: number[]; scripts: (\"latin\"|\"cjk\")[]; source: \"bundled\"|\"catalog\" }[];\nInsert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;\nUpdate(id: ClipId, patch: ItemPatchView): void;\nSetSpeed(id: ClipId, rate: number | { curve: { at: number; rate: number; ease?: Ease }[]; audio?: \"mute\" | \"resample\" }, o: { keep: \"source\" | \"duration\"; ripple?: boolean }): { length: number; sourceOut: number };\nDelete(id: ClipId, o?: { ripple?: boolean }): void;\nJoin(left: ClipId, right: ClipId, o: { length?: number; effect: TransitionInput }): JoinId;\nUpdateJoin(id: JoinId, patch: { length?: number; effect?: TransitionInput }): void;\nDeleteJoin(id: JoinId): void;\nSplit(id: ClipId, at: number): ClipId;\nTrim(id: ClipId, edge: \"in\" | \"out\", delta: number, o?: { ripple?: boolean }): void;\nMove(id: ClipId, start: number, track?: TrackId): void;\nRippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;\nAddTrack(kind: \"video\" | \"audio\" | \"caption\", init?: { name?: string; role?: \"voice\" | \"music\" | \"sfx\" }, index?: number): TrackId;\nUpdateTrack(id: TrackId, patch: TrackPatch): void;\nDeleteTrack(id: TrackId): void;\nSetSettings(patch: Partial<ProjectSettingsView>): void;\nAddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle> & { preset?: string }; maxChars?: number }): ClipId[];\nInsertTemplate(track: TrackId, o: { template: string; start: number; slots?: Record<string, string> }): ClipId[];\nAlignCaptions(trackId: TrackId, script: string, options?: { resplit?: boolean; maxChars?: number }): { replaced: number; added: number; deleted: number };\nImportCaptions(trackId: TrackId, text: string, o?: { format?: \"srt\" | \"vtt\"; offset?: number }): ClipId[];\nExportCaptions(trackId: TrackId, o: { format: \"srt\" | \"vtt\" }): string;\nSetMarker(at: number, label: string): string;\nPrint(...values: unknown[]): void;\nPreview(at: number[]): void;\n```\n\n| Functions | Behavior and arguments |\n| --- | --- |\n| GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, playback, sourceIn/sourceOut, text, effects, blend and offline reason. GetTimeline returns duration, tracks (id, kind, name, index, locked, items), and joins (id, track, left, right, length in seconds, normalized effect). from/to and tracks narrow the items and joins; joins are selected by their overlap window. |\n| ListEffects | Discover the shared visual-effect catalog with parameter types, ranges, defaults, cost and bounds. Effects are supported only on visual clips. |\n| ListTransitions | Discover the shared validation catalog: each entry contains kind (effect ID), name, description and params. Each parameter has name, type (enum/number/integer), default, description, enum values or numeric min/max. Use the returned kind and parameter names inside effect. |\n| ListAnimations | Discover animation presets. Each entry has id, version, phase (`in`, `out`, `loop`), target (`any`, `text`), name, description, defaultDuration (seconds), and params (name, type, values/default/min/max/description as applicable). A slot use is `{preset, duration?, ...params}`; duration is seconds. |\n| FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |\n| GetMedia | Read metadata for `{libraryId, assetId}` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |\n| GetTranscript, GetAnalysis | Read available transcript words or silence/filler/scenes segments. Transcript filter from/to is seconds; returned word and segment from/to values are source microseconds (divide by 1,000,000 for editing). Words contain text and optional speaker/filler; segments may include label/confidence. Request analysis first if unavailable. |\n| Insert, Update, Delete | Insert returns the new clip ID; Update changes supplied fields; Delete removes the clip. Optional ripple on Insert/Delete closes or opens space on the track. |\n| SetSpeed | Change video/audio rate in 0.25–4; keep is required. A `{curve: [{at, rate, ease?}, ...], audio?: \"mute\" | \"resample\"}` rate is forward-only and holds output duration fixed; pitch preservation is unavailable. Scalar rates: source preserves consumed source and changes length; duration preserves output length. Returns actual length and sourceOut in seconds. Optional ripple explicitly shifts same-track followers when keeping source; otherwise overlaps are rejected. |\n| Join, UpdateJoin, DeleteJoin | Join creates an overlap between two butt-adjacent visual clips on the same track and returns its ID. length defaults to 0.5 seconds; effect is required. The right clip and all same-track followers move left by length, shortening that track and potentially the project. UpdateJoin moves those followers by the difference in length; omitted fields are preserved. DeleteJoin moves them right to restore the butt cut. Other tracks stay in place. |\n| Split, Trim, Move | Split at a timeline position and return the new right-hand clip ID. Trim changes the in or out edge by delta seconds. Move sets the timeline start and optionally a new track. |\n| RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |\n| AddTrack, UpdateTrack, DeleteTrack | Add video/audio/caption tracks; index selects layer order (0 is top). TrackPatch supports name, locked, hidden, muted, gainDb, audio role (`voice`, `music`, `sfx`) and style as appropriate to track kind. |\n| SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |\n| AddCaptionsFromTranscript | Create captions from an audio/video clip's kept words. Optional maxChars is 1–1000, default 16; style updates the caption track. Returns caption IDs. |\n| 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. |\n| SetMarker | Add a label at a timeline time and return its ID. |\n| Print, Preview | Print appends text to prints. Preview requests up to eight times total per execute and puts images in the result's frames. Each url is an inline PNG data URL, not an HTTP image link. Decode the base64 payload to save an image. Codemode returns at most four images per call; request at most four times there. |\n\n#### Joins between clips\n\nEndpoints may be video, image, text, color or shape; audio and caption are rejected. Require 0 < length < each endpoint's length. Each clip allows at most one incoming and one outgoing join; their summed lengths cannot exceed its length. Three-input overlaps, nonadjacent endpoints and cross-track joins are rejected with OPS_REJECTED. Read the rejection's code and message, shorten or remove conflicting joins, and retry the saved edit.\n\nTransitionInput is an object with kind plus the parameters returned by ListTransitions; omitted parameters use catalog defaults. Unknown kinds and invalid parameters return INVALID_TRANSITION_PARAM with available parameters. Effects: dissolve; dip color black/white default black; push and wipe direction left/right/up/down default left; wipe softness 0–1 default 0; iris centerX/centerY 0–1 default 0.5; blinds integer count 2–64 default 8 and orientation vertical/horizontal default vertical; blur radius 0–100 pixels at 1080-pixel frame height default 24; zoom direction in/out default in, amount 0.1–3 default 1, blur 0–1 default 0.5; clock direction clockwise/counterclockwise default clockwise, startAngle 0–360 degrees default 0 (twelve o'clock), softness 0–1 default 0; flash color white/black default white, intensity 0–1 default 1. Zoom blur uses up to eight radial samples per shot and is slower on server rendering. Join options and UpdateJoin patches accept only length and effect. Effect updates replace the effect object and apply defaults for omitted parameters.\n\nMinimal example on an existing visual track with adjacent clips left and right: `Print(ListTransitions()); const j = Join(left, right, {length: 0.5, effect: {kind: \"dissolve\"}}); Print(GetTimeline().joins); Preview([GetItem(right).start + 0.25]);` Use `UpdateJoin(j, {length: 0.8})` to adjust it in a later edit or `DeleteJoin(j)` to restore the cut. Preview uses server-rendered frames and includes joins. Per-clip transitionIn/transitionOut remain separate entrance/exit effects.\n\n#### Insert fields (ItemInit)\n\nEvery item requires `type` and `start`. Times used for editing are seconds and snap to the project frame rate: start, length, sourceIn, fadeIn/fadeOut, transition length, keyframe at, reveal delay/stagger/duration. Keyframe and reveal times are relative to the clip start. Video/audio may omit length to use the remaining source duration; other types require length.\n\n| type | Required fields beyond type/start | Optional fields |\n| --- | --- | --- |\n| video | media | length, sourceIn, playback, volumeDb, transform, fit, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| image | media, length | transform, fit, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| text | text, length | style, transform, blend, reveal, animate, animation, effects, mask, transitionIn, transitionOut |\n| color | color, length | transform, fill, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| shape | shape, length, width, height, fill | radius, stroke, transform, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| audio | media | length, sourceIn, playback, volumeDb, gain, fadeIn, fadeOut, duck |\n| caption | text, length | — |\n\nVisual Insert/Update also accepts `blend`: `normal` (default), `screen`, `multiply`, `overlay`, or `add`; set it to null in Update to clear it. During a Join overlap, both inputs render with normal blending. Video tracks accept video/image/text/color/shape; audio and caption tracks accept their corresponding type. Media is `{libraryId: string, assetId: string}` from a bound library. sourceIn defaults to 0, volumeDb to 0 dB, audio fades to 0 seconds. fit defaults to contain: contain fits the whole image, cover fills and crops, fill stretches, none keeps native dimensions.\n\n| Field | Value |\n| --- | --- |\n| transform | Partial `{x, y, scale, rotation, opacity, crop, blur}`. x/y are normalized canvas center coordinates (default 0.5); scale 1 is fitted size; rotation is degrees (default 0); opacity is 0–1 (default 1). crop is `{top,right,bottom,left}`. blur is 0–100 pixels at 1080-pixel frame height. |\n| style | Partial `{fontFamily, fontSize, fontWeight, color, fill, stroke, strokes, shadows, glow, background, align, maxWidth, position, margin}`. fill accepts a color or linear/radial gradient across the entire text bounding box. strokes draw outside to inside; at most 4, width 0–40. shadows accepts at most 4 `{color,x,y,blur}` entries; blur is 0–100. glow is `{color,radius,strength}` with radius 0–100 and strength 0–1. All dimensions use pixels at 1080 frame height and scale with the text. Glow and large shadow blur increase render time. Invalid colors or ranges return actionable INVALID_STYLE errors. `ListFonts()` discovers family, available weights, scripts and bundled/catalog source. Text and captions share the style fields; caption style additionally supports highlightColor and maxLines: 2. |\n| animate | An object keyed by x, y, scale, rotation, opacity or blur. Each value is an array of `{at: number, value: number, ease?: Ease}` sorted by at with distinct frame-snapped times. Values hold before the first and after the last keyframe, overriding the static transform. |\n| animation | `{in?: AnimationUse, out?: AnimationUse, loop?: AnimationUse}` on visual clips. Each use is `{preset: string, duration?: number, ...params}`; duration and parameter units follow `ListAnimations()`. Presets replace existing animate and reveal when applied. Update accepts `animation: null` to clear the preset and its generated effects. |\n| Ease | linear, in, out, inOut, `{bezier: [x1,y1,x2,y2]}` or `{spring: {stiffness, damping, mass?}}`. Easing shapes the segment arriving at that keyframe; springs may overshoot. |\n| reveal | `{by, delay?: number, stagger: number, duration: number, from: {y?, opacity?, scale?, blur?}, ease?: Ease}`. by selects char, word or line. Unit k starts at delay + k * stagger and takes duration seconds to reach its resting state; from.y is a fraction of font size. |\n| fill | A color string (#RRGGBB or #RRGGBBAA), `{linear: {angle, stops: [{at,color}, ...]}}` or `{radial: {stops: [{at,color}, ...]}}`. Stop positions are 0–1; angle is degrees, 0 left to right. On color clips, fill replaces color when supplied. |\n| shape, width, height, radius, stroke | shape is rect or ellipse. width/height are fractions of canvas width/height before scaling. radius rounds rect corners in pixels at 1080-pixel frame height. stroke is `{color: string, width: number}`. |\n| transitionIn, transitionOut | `{kind, length: number}` at the clip's beginning/end. length is seconds. fade changes opacity; dissolve blends; push_left/push_right move horizontally; wipe_left reveals horizontally. |\n\n#### Visual effects\n\n`effects` is an ordered stack of at most 8 catalog entries. Call `ListEffects()` to discover the catalog; unknown kinds return `UNKNOWN_EFFECT`, invalid names/values/keyframes return `INVALID_EFFECT_PARAM`, and stacks over 8 return `TOO_MANY_EFFECTS`. Entries include blur, color adjustment, vignette, film grain, chromatic aberration, pixelate, glitch, shake, flash, light leak and built-in `lut` looks; user `.cube` LUTs are not supported. `speed` is cycles per second. Effects run on CPU during export and increase render time. Parameters are discovered with ListEffects(). Catalog entries expose their own parameters through ListEffects(), including `blur` (`radius` 0–100, default 24) and `color_adjust`: `brightness`, `contrast`, `temperature`, and `tint` each range -1–1 (default 0), while `saturation` ranges 0–2 (default 1). Disabled entries are skipped. `color_adjust` uses an SDR-only Rec.709 adjustment matrix with no color management.\n\nNumeric and integer effect parameters accept `keyframes: {parameter: [{at, value, ease?}, ...]}`; times are seconds relative to the clip, snap to frames like `animate`, must be strictly increasing and within clip duration, and values follow that parameter's catalog range. Omitted parameters use catalog defaults. Trim and Split preserve effect keyframes with the same clip-local behavior as `animate`. There are no custom shaders.\n\n`blend` applies to the completed visual layer after its content, effects and `transform.blur`; `add` maps to Skia Plus. The default `normal` path adds no blend layer. During Join overlaps, blending is forced to normal because each input is composed on transparency.\n\n#### Update fields (ItemPatchView)\n\nAll fields are optional; use only fields relevant to the item's type. Supported fields: start, length, sourceIn, playback, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, 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.\n\n#### Animation presets\n\nDiscover the catalog with `ListAnimations()`. Its entries contain id, version, phase (`in`, `out`, `loop`), target (`any` or `text`), name, description, defaultDuration in seconds, and params. Slots may combine one in, one out and one loop preset. A loop runs only in the interval between in and out; if the same property is animated by multiple slots, loop occupies only that middle interval. Text-target presets are entrances. Their duration controls the rhythm per character/word/line, not the total reveal time. Out and loop presets apply to the whole clip, not per text unit.\n\nPresets replace the clip's existing animate and reveal when applied. The source preset is retained, so changing clip length or transform automatically regenerates its keyframes/reveal. If a clip becomes shorter, in/out durations shrink proportionally; when it grows, the requested durations are restored. Split keeps in on the left, out on the right, and loop on both. Writing animate or reveal directly detaches the preset; setting animation to null clears both source and generated effects. Insert/Update reject a call that supplies animation together with animate or reveal.\n\nErrors: UNKNOWN_ANIMATION (unknown preset), INVALID_ANIMATION_PARAM (invalid slot/parameter or frame/keyframe limit), ANIMATION_TOO_LONG (in+out exceed clip length), ANIMATION_TARGET_MISMATCH (text-only preset on a non-text or preset on non-visual clip), ANIMATION_PHASE_MISMATCH (preset in the wrong slot). Each animated property is limited to 600 keyframes; loop duration must be at least 4 frames. `ANIMATION_TOO_LONG` is avoided during later length changes by proportional fitting.\n\n#### Speed, reverse and freeze\n\nVideo/audio Insert and Update accept playback as `{kind: \"rate\", rate: number, direction: \"forward\" | \"reverse\", audio: \"preservePitch\" | \"resample\" | \"mute\"}` or `{kind: \"freeze\"}`. Rate is finite and inclusive 0.25–4. Omitted playback defaults to 1× forward with preservePitch; supply the complete rate object when changing playback. preservePitch keeps pitch, resample changes pitch with speed, mute removes audio. Reverse requires explicit audio: \"mute\"; preservePitch/resample are rejected with UNSUPPORTED_PLAYBACK rather than silently muted. Freeze holds sourceIn and is silent. GetItem/GetTimeline echo playback and the source interval in seconds; sourceOut is exclusive even for reverse and equals sourceIn for freeze.\n\nUpdate of playback keeps output length unless length is also supplied. SetSpeed preserves direction/audio, rejects frozen and non-video/audio clips, and requires keep: \"source\" or \"duration\". keep: \"source\" computes round(consumed source / new rate × fps) frames, falling back to floor if rounding would exceed the source end; the returned length/sourceOut are actual frame-rounded seconds. keep: \"duration\" keeps output length and changes source consumption. Length conflicts fail with OVERLAP; move/shorten the conflicting clip, keep duration, or explicitly use ripple: true to shift following clips on the same track. Source overflow fails with OUT_OF_SOURCE; rate limits fail with RATE_OUT_OF_RANGE. Unknown playback fields and SetSpeed options are rejected with UNKNOWN_FIELD; options only accept keep and boolean ripple.\n\nExample for an existing four-second video/audio clip id: `Print(SetSpeed(id, 0.5, {keep: \"source\"})); Print(SetSpeed(id, 2, {keep: \"source\"}));` returns lengths 8 then 2, keeping the same source interval. Reverse: `Update(id, {playback: {kind: \"rate\", rate: 1, direction: \"reverse\", audio: \"mute\"}})`. Freeze: `Update(id, {playback: {kind: \"freeze\"}})`. Ensure enough source remains for the chosen length/rate. Browser reverse playback currently displays a placeholder; server-rendered Preview/frames and exports support reverse normally. Speed-adjusted audio is generated asynchronously after the edit transaction commits; exports wait for that audio before rendering.\n\n#### Script names versus HTTP response names\n\nUse camelCase inside scripts, including nested objects. HTTP request/response JSON outside script source uses snake_case. Map media.library_id → media.libraryId, media.asset_id → media.assetId, source_in → sourceIn, volume_db → volumeDb, fade_in/fade_out → fadeIn/fadeOut, transition_in/transition_out → transitionIn/transitionOut, font_family/font_size/font_weight/max_width → fontFamily/fontSize/fontWeight/maxWidth, gain_db → gainDb, highlight_color/max_lines → highlightColor/maxLines. Fields such as animate, reveal, fill, stroke, at and length retain their spelling. GetTimeline/GetItem already return camelCase compact views; the expanded retrieveTimeline HTTP response is not an Insert object.\n\nUnrecognized script fields fail with OPS_REJECTED and rejection code UNKNOWN_FIELD; snake_case mistakes suggest the corresponding camelCase name. The error message lists each rejection's #opIndex, code and reason. Correct the named fields and retry the saved edit; do not assume an ignored field applied an effect.\n";
|
|
8272
8287
|
readonly http: "POST";
|
|
8273
8288
|
readonly path: "/cut/v1/projects/{project_id}:execute";
|
|
8274
8289
|
readonly streaming: "no";
|
|
@@ -9164,7 +9179,7 @@ export declare const operations: readonly [{
|
|
|
9164
9179
|
readonly resource: "file.files";
|
|
9165
9180
|
readonly method: "create";
|
|
9166
9181
|
readonly summary: "Upload file";
|
|
9167
|
-
readonly description: "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.";
|
|
9182
|
+
readonly description: "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.";
|
|
9168
9183
|
readonly http: "POST";
|
|
9169
9184
|
readonly path: "/file/v1/files";
|
|
9170
9185
|
readonly streaming: "no";
|
|
@@ -9182,9 +9197,9 @@ export declare const operations: readonly [{
|
|
|
9182
9197
|
}, {
|
|
9183
9198
|
readonly name: "purpose";
|
|
9184
9199
|
readonly type: "string";
|
|
9185
|
-
readonly enum: readonly ["user_data", "vision"];
|
|
9200
|
+
readonly enum: readonly ["user_data", "assistants", "vision"];
|
|
9186
9201
|
readonly required: true;
|
|
9187
|
-
readonly description: "Purpose label stored with the file: user_data or vision. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data.";
|
|
9202
|
+
readonly description: "Purpose label stored with the file: user_data, assistants or vision. The label is stored and returned unchanged; assistants follows the same rules as user_data. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data.";
|
|
9188
9203
|
}, {
|
|
9189
9204
|
readonly name: "expires_after";
|
|
9190
9205
|
readonly type: "object";
|
|
@@ -9241,7 +9256,7 @@ export declare const operations: readonly [{
|
|
|
9241
9256
|
readonly resource: "file.files.contentLinks";
|
|
9242
9257
|
readonly method: "revoke";
|
|
9243
9258
|
readonly summary: "Revoke a file content link";
|
|
9244
|
-
readonly description: "Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within
|
|
9259
|
+
readonly description: "Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within 15 minutes; the file and other links remain available. Only current IAM capability tokens can be revoked; legacy content links expire at the migration deadline. Example body: {\"token\":\"<token from /c/>\"}.";
|
|
9245
9260
|
readonly http: "POST";
|
|
9246
9261
|
readonly path: "/file/v1/files/{file_id}/content_links:revoke";
|
|
9247
9262
|
readonly streaming: "no";
|
|
@@ -9265,7 +9280,7 @@ export declare const operations: readonly [{
|
|
|
9265
9280
|
readonly resource: "file.files.contentUrl";
|
|
9266
9281
|
readonly method: "create";
|
|
9267
9282
|
readonly summary: "Create a download URL";
|
|
9268
|
-
readonly description: "Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to
|
|
9283
|
+
readonly description: "Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to 900 seconds and is at most 604800 seconds. Issuance requires the same credential and file-read access as files.retrieveContent; a processing file returns 409 FILE_NOT_READY, so poll files.retrieve until active before retrying. A missing, expired or other-organization file returns 404. Each issuance creates a new link. OpenAI Files has no signed download URL; this follows S3 presigned GET semantics. Example body: {\"ttl_seconds\":3600}.";
|
|
9269
9284
|
readonly http: "POST";
|
|
9270
9285
|
readonly path: "/file/v1/files/{file_id}/content_url";
|
|
9271
9286
|
readonly streaming: "no";
|
|
@@ -9282,14 +9297,14 @@ export declare const operations: readonly [{
|
|
|
9282
9297
|
readonly name: "ttl_seconds";
|
|
9283
9298
|
readonly type: "integer";
|
|
9284
9299
|
readonly required: false;
|
|
9285
|
-
readonly description: "Download link lifetime in seconds, from 1 through 604800; omitted means
|
|
9300
|
+
readonly description: "Download link lifetime in seconds, from 1 through 604800; omitted means 900. This does not change the file's own expiry.";
|
|
9286
9301
|
}];
|
|
9287
9302
|
};
|
|
9288
9303
|
}, {
|
|
9289
9304
|
readonly resource: "file.uploads";
|
|
9290
9305
|
readonly method: "create";
|
|
9291
9306
|
readonly summary: "Create an upload";
|
|
9292
|
-
readonly description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most
|
|
9307
|
+
readonly description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 20 GiB (21474836480 bytes) and only user_data, assistants and vision purposes. Send parts of at most 64000000 bytes; an unfinished upload waits for them for 7 days, so a client can create → send parts → query GET /file/v1/uploads/{upload_id} → resend only the missing parts → complete. Optional part_size fixes every part length and makes each numbered part retryable with identical bytes. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.";
|
|
9293
9308
|
readonly http: "POST";
|
|
9294
9309
|
readonly path: "/file/v1/uploads";
|
|
9295
9310
|
readonly streaming: "no";
|
|
@@ -9302,7 +9317,7 @@ export declare const operations: readonly [{
|
|
|
9302
9317
|
readonly name: "bytes";
|
|
9303
9318
|
readonly type: "integer";
|
|
9304
9319
|
readonly required: true;
|
|
9305
|
-
readonly description: "Exact complete file length in bytes, from 1 through
|
|
9320
|
+
readonly description: "Exact complete file length in bytes, from 1 through 21474836480 (20 GiB); the sum of completed parts must match.";
|
|
9306
9321
|
}, {
|
|
9307
9322
|
readonly name: "filename";
|
|
9308
9323
|
readonly type: "string";
|
|
@@ -9316,9 +9331,9 @@ export declare const operations: readonly [{
|
|
|
9316
9331
|
}, {
|
|
9317
9332
|
readonly name: "purpose";
|
|
9318
9333
|
readonly type: "string";
|
|
9319
|
-
readonly enum: readonly ["user_data", "vision"];
|
|
9334
|
+
readonly enum: readonly ["user_data", "assistants", "vision"];
|
|
9320
9335
|
readonly required: true;
|
|
9321
|
-
readonly description: "Use user_data for conversation attachments, or vision for PNG, JPEG, GIF and WebP images.";
|
|
9336
|
+
readonly description: "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images.";
|
|
9322
9337
|
}, {
|
|
9323
9338
|
readonly name: "expires_after";
|
|
9324
9339
|
readonly type: "object";
|
|
@@ -9335,7 +9350,7 @@ export declare const operations: readonly [{
|
|
|
9335
9350
|
readonly resource: "file.uploads";
|
|
9336
9351
|
readonly method: "createSigned";
|
|
9337
9352
|
readonly summary: "Create a one-time upload URL";
|
|
9338
|
-
readonly description: "Upload a local file of up to
|
|
9353
|
+
readonly description: "Upload a local file of up to 20 GiB from a coding agent without sending bytes through the model. Provide basename, exact byte count and MIME type. Up to 104857600 bytes, PUT the file to url with curl -T photo.png -H 'Content-Type: image/png' '<url>'; success returns 201 with the file object, and reuse returns 410 CAPABILITY_USED. Above that threshold, split the file into part_size chunks (default 64000000 bytes) and PUT each chunk to its numbered parts[].url in any order; an interrupted client GETs status_url to see the received parts and resends only what is missing, then POSTs complete_url without a body. Part PUTs return 200; completion returns 201 with the file object, including its state, or 400 if a part is missing. A processing file can be polled with files.retrieve until active. Identical part bytes may be retried; changed bytes at the same number return 400. Completion reuse returns 410 CAPABILITY_USED. Each PUT requires the exact signed Content-Length; single-PUT Content-Type must match content_type or be omitted. Expired, revoked, invalid, wrong-action or cross-organization URLs return 404. URL lifetime defaults to 900 seconds for single PUT or 604800 (7 days) for multipart, at most 604800; all multipart URLs, including status_url, share an expiry. Multipart creation reserves storage quota. Issuance requires the same unscoped credential as direct file creation. Each issuance creates a new upload and is not idempotent. Example body: {\"filename\":\"photo.png\",\"bytes\":2048,\"content_type\":\"image/png\"}.";
|
|
9339
9354
|
readonly http: "POST";
|
|
9340
9355
|
readonly path: "/file/v1/uploads/signed";
|
|
9341
9356
|
readonly streaming: "no";
|
|
@@ -9353,7 +9368,7 @@ export declare const operations: readonly [{
|
|
|
9353
9368
|
readonly name: "bytes";
|
|
9354
9369
|
readonly type: "integer";
|
|
9355
9370
|
readonly required: true;
|
|
9356
|
-
readonly description: "Exact local file size in bytes, from 1 through
|
|
9371
|
+
readonly description: "Exact local file size in bytes, from 1 through 21474836480 (20 GiB). Up to 104857600 bytes returns one PUT URL; larger files return numbered part URLs, a completion URL and a status URL. Every PUT requires its exact signed Content-Length.";
|
|
9357
9372
|
}, {
|
|
9358
9373
|
readonly name: "content_type";
|
|
9359
9374
|
readonly type: "string";
|
|
@@ -9362,14 +9377,14 @@ export declare const operations: readonly [{
|
|
|
9362
9377
|
}, {
|
|
9363
9378
|
readonly name: "purpose";
|
|
9364
9379
|
readonly type: "string";
|
|
9365
|
-
readonly enum: readonly ["user_data", "vision"];
|
|
9380
|
+
readonly enum: readonly ["user_data", "assistants", "vision"];
|
|
9366
9381
|
readonly required: false;
|
|
9367
|
-
readonly description: "user_data
|
|
9382
|
+
readonly description: "user_data and assistants store ordinary files and conversation images with their original purpose label; vision accepts PNG, JPEG, GIF or WebP images only. Omitted means user_data.";
|
|
9368
9383
|
}, {
|
|
9369
9384
|
readonly name: "expires_in";
|
|
9370
9385
|
readonly type: "integer";
|
|
9371
9386
|
readonly required: false;
|
|
9372
|
-
readonly description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or
|
|
9387
|
+
readonly description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or 604800 (7 days) for multipart. All part URLs, the status URL and the completion URL share one expiry. This does not set the resulting file's lifetime.";
|
|
9373
9388
|
}, {
|
|
9374
9389
|
readonly name: "part_size";
|
|
9375
9390
|
readonly type: "integer";
|
|
@@ -9377,6 +9392,21 @@ export declare const operations: readonly [{
|
|
|
9377
9392
|
readonly description: "Fixed multipart chunk size in bytes, from 5242880 through 64000000; defaults to 64000000. Used only above 104857600 total bytes. The final part contains the remaining bytes; single-PUT mode keeps its existing response.";
|
|
9378
9393
|
}];
|
|
9379
9394
|
};
|
|
9395
|
+
}, {
|
|
9396
|
+
readonly resource: "file.uploads";
|
|
9397
|
+
readonly method: "retrieve";
|
|
9398
|
+
readonly summary: "Retrieve an upload";
|
|
9399
|
+
readonly description: "Read the state of an unfinished upload — its status, declared bytes, fixed part_size and the parts it already holds (received_parts, each with part_number, bytes and sha256). After a break or a failed part, call it to resend only the missing numbers, then complete. A cancelled or expired upload is refused; a completed one returns its file. A missing or other-organization upload returns 404.";
|
|
9400
|
+
readonly http: "GET";
|
|
9401
|
+
readonly path: "/file/v1/uploads/{upload_id}";
|
|
9402
|
+
readonly streaming: "no";
|
|
9403
|
+
readonly pagination: false;
|
|
9404
|
+
readonly pathParams: readonly [{
|
|
9405
|
+
readonly name: "upload_id";
|
|
9406
|
+
readonly sdkName: "upload_id";
|
|
9407
|
+
readonly description: "Upload identifier returned by create; the upload must belong to your organization.";
|
|
9408
|
+
}];
|
|
9409
|
+
readonly query: readonly [];
|
|
9380
9410
|
}, {
|
|
9381
9411
|
readonly resource: "file.uploads";
|
|
9382
9412
|
readonly method: "cancel";
|
|
@@ -9396,7 +9426,7 @@ export declare const operations: readonly [{
|
|
|
9396
9426
|
readonly resource: "file.uploads";
|
|
9397
9427
|
readonly method: "complete";
|
|
9398
9428
|
readonly summary: "Complete an upload";
|
|
9399
|
-
readonly description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.";
|
|
9429
|
+
readonly description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. When parts were lost, query GET /file/v1/uploads/{upload_id} and resend them before completing. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.";
|
|
9400
9430
|
readonly http: "POST";
|
|
9401
9431
|
readonly path: "/file/v1/uploads/{upload_id}/complete";
|
|
9402
9432
|
readonly streaming: "no";
|
|
@@ -9426,7 +9456,7 @@ export declare const operations: readonly [{
|
|
|
9426
9456
|
readonly resource: "file.uploads.parts";
|
|
9427
9457
|
readonly method: "create";
|
|
9428
9458
|
readonly summary: "Add an upload part";
|
|
9429
|
-
readonly description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.";
|
|
9459
|
+
readonly description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID, and query GET /file/v1/uploads/{upload_id} to see which numbers already arrived. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.";
|
|
9430
9460
|
readonly http: "POST";
|
|
9431
9461
|
readonly path: "/file/v1/uploads/{upload_id}/parts";
|
|
9432
9462
|
readonly streaming: "no";
|
|
@@ -9494,7 +9524,7 @@ export declare const operations: readonly [{
|
|
|
9494
9524
|
readonly resource: "knowledge.vectorStores";
|
|
9495
9525
|
readonly method: "create";
|
|
9496
9526
|
readonly summary: "Create knowledge base";
|
|
9497
|
-
readonly description: "Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded.
|
|
9527
|
+
readonly description: "Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; each account holds up to 100 active/nondeleted stores. Minimal body: {\"name\":\"Refund policies\"}.";
|
|
9498
9528
|
readonly http: "POST";
|
|
9499
9529
|
readonly path: "/knowledge/v1/vector_stores";
|
|
9500
9530
|
readonly streaming: "no";
|
|
@@ -9528,7 +9558,7 @@ export declare const operations: readonly [{
|
|
|
9528
9558
|
readonly name: "chunking_strategy";
|
|
9529
9559
|
readonly type: "object";
|
|
9530
9560
|
readonly required: false;
|
|
9531
|
-
readonly description: "auto
|
|
9561
|
+
readonly description: "Native attachment strategy. auto uses static chunks of 800 estimated tokens with 400 overlap; static supplies explicit chunk sizes; hierarchical indexes child chunks and supplies bounded parent context. Existing attachments are reused unchanged; remove and reattach a file to change its strategy.";
|
|
9532
9562
|
}, {
|
|
9533
9563
|
readonly name: "description";
|
|
9534
9564
|
readonly type: "string";
|
|
@@ -9798,7 +9828,7 @@ export declare const operations: readonly [{
|
|
|
9798
9828
|
readonly resource: "knowledge.vectorStores.files";
|
|
9799
9829
|
readonly method: "create";
|
|
9800
9830
|
readonly summary: "Add file";
|
|
9801
|
-
readonly description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching.
|
|
9831
|
+
readonly description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; chunk sizes use estimated tokens rather than a model tokenizer. Text, Markdown, CSV, JSON, HTML, PDF, DOCX, PPTX, XLSX and PNG/JPEG/GIF/WebP images can be extracted; audio and video uploads are not knowledge documents. Images may yield generated descriptions rather than verbatim OCR. auto chunking resolves to static 800/400; explicit sizes are 100–4096 with overlap at most half the size. Each store holds at most 10000 attached files. Reattaching the same file returns its existing record without applying new attributes or chunking; inspect last_error after failure.";
|
|
9802
9832
|
readonly http: "POST";
|
|
9803
9833
|
readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files";
|
|
9804
9834
|
readonly streaming: "no";
|
|
@@ -9825,7 +9855,7 @@ export declare const operations: readonly [{
|
|
|
9825
9855
|
readonly name: "chunking_strategy";
|
|
9826
9856
|
readonly type: "object";
|
|
9827
9857
|
readonly required: false;
|
|
9828
|
-
readonly description: "auto
|
|
9858
|
+
readonly description: "Native attachment strategy. auto uses static chunks of 800 estimated tokens with 400 overlap; static supplies explicit chunk sizes; hierarchical indexes child chunks and supplies bounded parent context. Existing attachments are reused unchanged; remove and reattach a file to change its strategy.";
|
|
9829
9859
|
}];
|
|
9830
9860
|
};
|
|
9831
9861
|
}, {
|
|
@@ -10075,11 +10105,22 @@ export declare const operations: readonly [{
|
|
|
10075
10105
|
readonly description: "Chunk ID returned by segment listing or native search content.";
|
|
10076
10106
|
}];
|
|
10077
10107
|
readonly query: readonly [];
|
|
10108
|
+
}, {
|
|
10109
|
+
readonly resource: "media.generation.capabilities";
|
|
10110
|
+
readonly method: "list";
|
|
10111
|
+
readonly summary: "Get generation capabilities";
|
|
10112
|
+
readonly description: "Read supported text-to-video intent, default model, duration and aspect-ratio limits, per-library concurrency and candidate retention. Generation is charged per second; unsaved candidates expire after 7 days.";
|
|
10113
|
+
readonly http: "GET";
|
|
10114
|
+
readonly path: "/media/v1/generation/capabilities";
|
|
10115
|
+
readonly streaming: "no";
|
|
10116
|
+
readonly pagination: false;
|
|
10117
|
+
readonly pathParams: readonly [];
|
|
10118
|
+
readonly query: readonly [];
|
|
10078
10119
|
}, {
|
|
10079
10120
|
readonly resource: "media.libraries";
|
|
10080
10121
|
readonly method: "list";
|
|
10081
10122
|
readonly summary: "List libraries";
|
|
10082
|
-
readonly description: "
|
|
10123
|
+
readonly description: "Read a caller-owned library’s current settings, usage and lifecycle status. A deleting library remains readable; missing, foreign or purged libraries return LIBRARY_NOT_FOUND.";
|
|
10083
10124
|
readonly http: "GET";
|
|
10084
10125
|
readonly path: "/media/v1/libraries";
|
|
10085
10126
|
readonly streaming: "no";
|
|
@@ -10146,7 +10187,7 @@ export declare const operations: readonly [{
|
|
|
10146
10187
|
readonly resource: "media.libraries";
|
|
10147
10188
|
readonly method: "delete";
|
|
10148
10189
|
readonly summary: "Delete library";
|
|
10149
|
-
readonly description: "
|
|
10190
|
+
readonly description: "Restore a deleting library before its purge_at deadline. The library becomes active again and deleted_at and purge_at are cleared; expired or non-deleting libraries cannot be restored.";
|
|
10150
10191
|
readonly http: "DELETE";
|
|
10151
10192
|
readonly path: "/media/v1/libraries/{library_id}";
|
|
10152
10193
|
readonly streaming: "no";
|
|
@@ -10161,7 +10202,7 @@ export declare const operations: readonly [{
|
|
|
10161
10202
|
readonly resource: "media.libraries";
|
|
10162
10203
|
readonly method: "retrieve";
|
|
10163
10204
|
readonly summary: "Get library";
|
|
10164
|
-
readonly description: "
|
|
10205
|
+
readonly description: "Update an active library’s supplied settings. Labels replace the complete map; understanding settings and model roles merge with current values. Changing the embedding model is rejected while assets exist.";
|
|
10165
10206
|
readonly http: "GET";
|
|
10166
10207
|
readonly path: "/media/v1/libraries/{library_id}";
|
|
10167
10208
|
readonly streaming: "no";
|
|
@@ -10176,7 +10217,7 @@ export declare const operations: readonly [{
|
|
|
10176
10217
|
readonly resource: "media.libraries";
|
|
10177
10218
|
readonly method: "update";
|
|
10178
10219
|
readonly summary: "Update library";
|
|
10179
|
-
readonly description: "Update an active library
|
|
10220
|
+
readonly description: "Update an active library. Set hotwords for spelling evidence in subsequent transcripts; [] disables inferred vocabulary. Transcript understanding calls the timestamped ASR, optional reference ASR and correction model through the existing metered model path. Reprocess assets to apply new settings to existing transcripts.";
|
|
10180
10221
|
readonly http: "PATCH";
|
|
10181
10222
|
readonly path: "/media/v1/libraries/{library_id}";
|
|
10182
10223
|
readonly streaming: "no";
|
|
@@ -10190,6 +10231,12 @@ export declare const operations: readonly [{
|
|
|
10190
10231
|
readonly body: {
|
|
10191
10232
|
readonly required: true;
|
|
10192
10233
|
readonly fields: readonly [{
|
|
10234
|
+
readonly name: "hotwords";
|
|
10235
|
+
readonly type: "array";
|
|
10236
|
+
readonly itemType: "string";
|
|
10237
|
+
readonly required: false;
|
|
10238
|
+
readonly description: "Correction vocabulary, at most 200 nonblank terms of at most 32 Unicode characters each. Omitted on an unconfigured library: correction derives up to 200 distinct names from the library name and every folder level, excluding generic names such as 原始素材 and 混剪成品. An explicit empty array disables this vocabulary. Updating affects subsequent understanding and explicit reprocessing, not existing results.";
|
|
10239
|
+
}, {
|
|
10193
10240
|
readonly name: "models";
|
|
10194
10241
|
readonly type: "object";
|
|
10195
10242
|
readonly required: false;
|
|
@@ -10215,7 +10262,7 @@ export declare const operations: readonly [{
|
|
|
10215
10262
|
readonly resource: "media.libraries.assets";
|
|
10216
10263
|
readonly method: "list";
|
|
10217
10264
|
readonly summary: "List assets";
|
|
10218
|
-
readonly description: "
|
|
10265
|
+
readonly description: "Upload content into an active library and return a Cloudinary-compatible resource. Use file for a multipart file, data URI, public HTTPS URL or same-owner file identifier. Reusing public_id overwrites by default; overwrite=false returns the existing resource. Chunk uploads require both chunk headers.";
|
|
10219
10266
|
readonly http: "GET";
|
|
10220
10267
|
readonly path: "/media/v1/libraries/{library_id}/assets";
|
|
10221
10268
|
readonly streaming: "no";
|
|
@@ -10251,7 +10298,7 @@ export declare const operations: readonly [{
|
|
|
10251
10298
|
readonly resource: "media.libraries.assets";
|
|
10252
10299
|
readonly method: "create";
|
|
10253
10300
|
readonly summary: "Upload asset";
|
|
10254
|
-
readonly description: "
|
|
10301
|
+
readonly description: " For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
|
|
10255
10302
|
readonly http: "POST";
|
|
10256
10303
|
readonly path: "/media/v1/libraries/{library_id}/assets";
|
|
10257
10304
|
readonly streaming: "no";
|
|
@@ -10289,7 +10336,7 @@ export declare const operations: readonly [{
|
|
|
10289
10336
|
readonly name: "asset_folder";
|
|
10290
10337
|
readonly type: "string";
|
|
10291
10338
|
readonly required: false;
|
|
10292
|
-
readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected.";
|
|
10339
|
+
readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.";
|
|
10293
10340
|
}, {
|
|
10294
10341
|
readonly name: "use_filename";
|
|
10295
10342
|
readonly type: "boolean";
|
|
@@ -10348,7 +10395,7 @@ export declare const operations: readonly [{
|
|
|
10348
10395
|
readonly resource: "media.libraries.assets.import";
|
|
10349
10396
|
readonly method: "create";
|
|
10350
10397
|
readonly summary: "Import file";
|
|
10351
|
-
readonly description: "Copy
|
|
10398
|
+
readonly description: "Copy a File into an independent Media asset. New assets default to organization-private delivery (type=authenticated); explicitly set type=upload for public originals and derivatives. Omitting type on overwrite preserves the current type. Deleting the source File does not delete this copy. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
|
|
10352
10399
|
readonly http: "POST";
|
|
10353
10400
|
readonly path: "/media/v1/libraries/{library_id}/assets/import";
|
|
10354
10401
|
readonly streaming: "no";
|
|
@@ -10365,7 +10412,7 @@ export declare const operations: readonly [{
|
|
|
10365
10412
|
readonly name: "file_id";
|
|
10366
10413
|
readonly type: "string";
|
|
10367
10414
|
readonly required: true;
|
|
10368
|
-
readonly description: "File ID to copy into this library instead of file bytes. This independent copy defaults to
|
|
10415
|
+
readonly description: "File ID to copy into this library instead of file bytes. This independent copy defaults to organization-private delivery (type=authenticated); explicitly set type=upload for public delivery. Deleting the source File does not delete this asset.";
|
|
10369
10416
|
}, {
|
|
10370
10417
|
readonly name: "public_id";
|
|
10371
10418
|
readonly type: "string";
|
|
@@ -10385,7 +10432,7 @@ export declare const operations: readonly [{
|
|
|
10385
10432
|
readonly name: "asset_folder";
|
|
10386
10433
|
readonly type: "string";
|
|
10387
10434
|
readonly required: false;
|
|
10388
|
-
readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected.";
|
|
10435
|
+
readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.";
|
|
10389
10436
|
}, {
|
|
10390
10437
|
readonly name: "use_filename";
|
|
10391
10438
|
readonly type: "boolean";
|
|
@@ -10444,7 +10491,7 @@ export declare const operations: readonly [{
|
|
|
10444
10491
|
readonly resource: "media.libraries.assets";
|
|
10445
10492
|
readonly method: "delete";
|
|
10446
10493
|
readonly summary: "Delete asset";
|
|
10447
|
-
readonly description: "
|
|
10494
|
+
readonly description: "Queue reprocessing of the asset’s current version and return its updated state immediately. Omit kinds to retry failed tasks and legacy source-size unsupported tasks; explicit kinds rerun applicable completed tasks and recoverable source-size unsupported tasks. Other unsupported causes remain unchanged. Replaced understandings become superseded, and processing finishes asynchronously.";
|
|
10448
10495
|
readonly http: "DELETE";
|
|
10449
10496
|
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}";
|
|
10450
10497
|
readonly streaming: "no";
|
|
@@ -10463,7 +10510,7 @@ export declare const operations: readonly [{
|
|
|
10463
10510
|
readonly resource: "media.libraries.assets";
|
|
10464
10511
|
readonly method: "retrieve";
|
|
10465
10512
|
readonly summary: "Get asset";
|
|
10466
|
-
readonly description: "
|
|
10513
|
+
readonly description: "Update an asset’s supplied metadata fields. Tags and context replace their current collections; an empty collection clears them. Moving asset_folder or changing display_name preserves public_id and delivery URLs.";
|
|
10467
10514
|
readonly http: "GET";
|
|
10468
10515
|
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}";
|
|
10469
10516
|
readonly streaming: "no";
|
|
@@ -10482,7 +10529,7 @@ export declare const operations: readonly [{
|
|
|
10482
10529
|
readonly resource: "media.libraries.assets";
|
|
10483
10530
|
readonly method: "update";
|
|
10484
10531
|
readonly summary: "Update asset";
|
|
10485
|
-
readonly description: "
|
|
10532
|
+
readonly description: "Delete an asset from the library so it is no longer readable, searchable or deliverable. This removes the asset rather than placing it in the library’s restoration window; a missing asset returns ASSET_NOT_FOUND.";
|
|
10486
10533
|
readonly http: "PATCH";
|
|
10487
10534
|
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}";
|
|
10488
10535
|
readonly streaming: "no";
|
|
@@ -10508,7 +10555,7 @@ export declare const operations: readonly [{
|
|
|
10508
10555
|
readonly name: "asset_folder";
|
|
10509
10556
|
readonly type: "string";
|
|
10510
10557
|
readonly required: false;
|
|
10511
|
-
readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected.";
|
|
10558
|
+
readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.";
|
|
10512
10559
|
}, {
|
|
10513
10560
|
readonly name: "tags";
|
|
10514
10561
|
readonly type: "array";
|
|
@@ -10522,11 +10569,46 @@ export declare const operations: readonly [{
|
|
|
10522
10569
|
readonly description: "Replacement custom string-metadata map. Nonempty keys are required and serialized JSON must fit within 1024 UTF-8 bytes; an empty object clears the metadata.";
|
|
10523
10570
|
}];
|
|
10524
10571
|
};
|
|
10572
|
+
}, {
|
|
10573
|
+
readonly resource: "media.libraries.assets.frames";
|
|
10574
|
+
readonly method: "create";
|
|
10575
|
+
readonly summary: "Create frame URLs";
|
|
10576
|
+
readonly description: "Media creates JPEG frame URLs for inspecting one or more moments in a video without downloading the original. Obtain library_id from libraries and asset_id plus duration from assets. Send 1–20 integer microsecond timestamps strictly below duration, for example {\"at_micros\":[0,1000000],\"width\":640}. Only video assets are supported; audio and images return INVALID_PARAMS. Width defaults to 640 and accepts 160, 320 or 640. This read operation does not store a new asset or rerun understanding. Fetch each returned URL to obtain the frame; delivery usage follows media pricing. Authenticated links expire after 300 seconds; upload links remain public and permanent. Reissue expired links. Foreign libraries and assets return 404 without revealing their existence.";
|
|
10577
|
+
readonly http: "POST";
|
|
10578
|
+
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames";
|
|
10579
|
+
readonly streaming: "no";
|
|
10580
|
+
readonly pagination: false;
|
|
10581
|
+
readonly pathParams: readonly [{
|
|
10582
|
+
readonly name: "library_id";
|
|
10583
|
+
readonly sdkName: "library_id";
|
|
10584
|
+
readonly description: "Library identifier returned by library creation or listing; must be accessible to the current credential.";
|
|
10585
|
+
}, {
|
|
10586
|
+
readonly name: "asset_id";
|
|
10587
|
+
readonly sdkName: "asset_id";
|
|
10588
|
+
readonly description: "Video asset identifier returned by asset upload or listing in this library; read its duration before choosing timestamps.";
|
|
10589
|
+
}];
|
|
10590
|
+
readonly query: readonly [];
|
|
10591
|
+
readonly body: {
|
|
10592
|
+
readonly required: true;
|
|
10593
|
+
readonly fields: readonly [{
|
|
10594
|
+
readonly name: "at_micros";
|
|
10595
|
+
readonly type: "array";
|
|
10596
|
+
readonly itemType: "integer";
|
|
10597
|
+
readonly required: true;
|
|
10598
|
+
readonly description: "One to twenty timestamps in microseconds from the start of the video. Each must be a nonnegative safe integer strictly below the video duration; order and duplicates are preserved.";
|
|
10599
|
+
}, {
|
|
10600
|
+
readonly name: "width";
|
|
10601
|
+
readonly type: "integer";
|
|
10602
|
+
readonly enum: readonly [160, 320, 640];
|
|
10603
|
+
readonly required: false;
|
|
10604
|
+
readonly description: "Maximum JPEG width in pixels: 160 is a small thumbnail, 320 a preview and 640 a larger preview. Defaults to 640; larger widths are unavailable.";
|
|
10605
|
+
}];
|
|
10606
|
+
};
|
|
10525
10607
|
}, {
|
|
10526
10608
|
readonly resource: "media.libraries.assets.reprocess";
|
|
10527
10609
|
readonly method: "create";
|
|
10528
10610
|
readonly summary: "Reprocess asset";
|
|
10529
|
-
readonly description: "
|
|
10611
|
+
readonly description: " For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
|
|
10530
10612
|
readonly http: "POST";
|
|
10531
10613
|
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess";
|
|
10532
10614
|
readonly streaming: "no";
|
|
@@ -10549,14 +10631,14 @@ export declare const operations: readonly [{
|
|
|
10549
10631
|
readonly itemType: "string";
|
|
10550
10632
|
readonly enum: readonly ["visual", "frames", "transcript", "embedding"];
|
|
10551
10633
|
readonly required: false;
|
|
10552
|
-
readonly description: "Processing tasks to rerun. Omit to retry failed tasks
|
|
10634
|
+
readonly description: "Processing tasks to rerun. Omit to retry failed tasks and legacy source-size unsupported tasks; explicit kinds rerun applicable ready or failed tasks and recoverable source-size unsupported tasks. Other unsupported causes remain unchanged. Pending and running tasks are unchanged; an empty array does nothing.";
|
|
10553
10635
|
}];
|
|
10554
10636
|
};
|
|
10555
10637
|
}, {
|
|
10556
10638
|
readonly resource: "media.libraries.assets.understandings";
|
|
10557
10639
|
readonly method: "list";
|
|
10558
10640
|
readonly summary: "List understandings";
|
|
10559
|
-
readonly description: "List an asset
|
|
10641
|
+
readonly description: "List understanding results for an asset, ordered by creation time. Use the cursor to continue; include_superseded also returns replaced records. The optional shots array contains current-version shot boundaries and per-shot captions, scene, location guesses, visible text and confidence flags; it is absent on legacy records. Location guesses and folder mismatch are unverified hints. Correction-enabled transcripts expose text_original, corrected text and a correction audit. Their timed data array remains suitable for subtitles. Reference failure is marked missing; correction failure returns the original verbatim. Model inference uses the existing metered model path.";
|
|
10560
10642
|
readonly http: "GET";
|
|
10561
10643
|
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/understandings";
|
|
10562
10644
|
readonly streaming: "no";
|
|
@@ -10578,9 +10660,9 @@ export declare const operations: readonly [{
|
|
|
10578
10660
|
}, {
|
|
10579
10661
|
readonly name: "kind";
|
|
10580
10662
|
readonly type: "string";
|
|
10581
|
-
readonly enum: readonly ["caption", "tags", "ocr", "transcript", "frame"];
|
|
10663
|
+
readonly enum: readonly ["caption", "tags", "ocr", "transcript", "frame", "overview", "audio", "embedding"];
|
|
10582
10664
|
readonly required: false;
|
|
10583
|
-
readonly description: "
|
|
10665
|
+
readonly description: "Return one output kind: caption is a visual description, tags are generated labels, ocr is visible text, transcript is speech, frame is a video shot, overview is a video summary, audio is sampled audio understanding, and embedding reports a failed embedding step.";
|
|
10584
10666
|
}, {
|
|
10585
10667
|
readonly name: "cursor";
|
|
10586
10668
|
readonly type: "string";
|
|
@@ -10596,7 +10678,7 @@ export declare const operations: readonly [{
|
|
|
10596
10678
|
readonly resource: "media.libraries.assets";
|
|
10597
10679
|
readonly method: "batch";
|
|
10598
10680
|
readonly summary: "Batch assets alias";
|
|
10599
|
-
readonly description: "
|
|
10681
|
+
readonly description: "Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {\"action\":\"reprocess\",\"selector\":{\"expression\":\"processing_state=failed AND failure_code=UPSTREAM_FAILED\"}}. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
|
|
10600
10682
|
readonly http: "POST";
|
|
10601
10683
|
readonly path: "/media/v1/libraries/{library_id}/assets:batch";
|
|
10602
10684
|
readonly streaming: "no";
|
|
@@ -10614,13 +10696,18 @@ export declare const operations: readonly [{
|
|
|
10614
10696
|
readonly type: "object";
|
|
10615
10697
|
readonly required: true;
|
|
10616
10698
|
readonly description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created.";
|
|
10699
|
+
}, {
|
|
10700
|
+
readonly name: "reason";
|
|
10701
|
+
readonly type: "string";
|
|
10702
|
+
readonly required: false;
|
|
10703
|
+
readonly description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters.";
|
|
10617
10704
|
}];
|
|
10618
10705
|
};
|
|
10619
10706
|
}, {
|
|
10620
10707
|
readonly resource: "media.libraries.batches";
|
|
10621
10708
|
readonly method: "create";
|
|
10622
10709
|
readonly summary: "Create batch";
|
|
10623
|
-
readonly description: "
|
|
10710
|
+
readonly description: "Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {\"action\":\"reprocess\",\"selector\":{\"expression\":\"processing_state=failed AND failure_code=UPSTREAM_FAILED\"}}. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
|
|
10624
10711
|
readonly http: "POST";
|
|
10625
10712
|
readonly path: "/media/v1/libraries/{library_id}/batches";
|
|
10626
10713
|
readonly streaming: "no";
|
|
@@ -10638,13 +10725,18 @@ export declare const operations: readonly [{
|
|
|
10638
10725
|
readonly type: "object";
|
|
10639
10726
|
readonly required: true;
|
|
10640
10727
|
readonly description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created.";
|
|
10728
|
+
}, {
|
|
10729
|
+
readonly name: "reason";
|
|
10730
|
+
readonly type: "string";
|
|
10731
|
+
readonly required: false;
|
|
10732
|
+
readonly description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters.";
|
|
10641
10733
|
}];
|
|
10642
10734
|
};
|
|
10643
10735
|
}, {
|
|
10644
10736
|
readonly resource: "media.libraries.batches";
|
|
10645
10737
|
readonly method: "retrieve";
|
|
10646
10738
|
readonly summary: "Get batch";
|
|
10647
|
-
readonly description: "
|
|
10739
|
+
readonly description: "Alias of batch creation. Apply one metadata or deletion action to ids or a frozen expression selection asynchronously; poll the returned job id to inspect completion and item failures.";
|
|
10648
10740
|
readonly http: "GET";
|
|
10649
10741
|
readonly path: "/media/v1/libraries/{library_id}/batches/{job_id}";
|
|
10650
10742
|
readonly streaming: "no";
|
|
@@ -10663,7 +10755,7 @@ export declare const operations: readonly [{
|
|
|
10663
10755
|
readonly resource: "media.libraries.deliveryTokens";
|
|
10664
10756
|
readonly method: "create";
|
|
10665
10757
|
readonly summary: "Create delivery token";
|
|
10666
|
-
readonly description: "Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is
|
|
10758
|
+
readonly description: "Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is 900 seconds; narrow acl and expires_in before sharing. Anyone holding the token can read matching paths until expires_at.";
|
|
10667
10759
|
readonly http: "POST";
|
|
10668
10760
|
readonly path: "/media/v1/libraries/{library_id}/delivery_tokens";
|
|
10669
10761
|
readonly streaming: "no";
|
|
@@ -10685,14 +10777,14 @@ export declare const operations: readonly [{
|
|
|
10685
10777
|
readonly name: "expires_in";
|
|
10686
10778
|
readonly type: "integer";
|
|
10687
10779
|
readonly required: false;
|
|
10688
|
-
readonly description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to
|
|
10780
|
+
readonly description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 900.";
|
|
10689
10781
|
}];
|
|
10690
10782
|
};
|
|
10691
10783
|
}, {
|
|
10692
10784
|
readonly resource: "media.libraries.events";
|
|
10693
10785
|
readonly method: "list";
|
|
10694
10786
|
readonly summary: "List events";
|
|
10695
|
-
readonly description: "Read library events in sequence order
|
|
10787
|
+
readonly description: "Read library events in sequence order for observing asset writes and understanding progress. Obtain library_id from creation or listing; continue with after_seq for asc or before_seq for desc, without combining both. Use next_cursor when supplied. Reads do not start or retry understanding.";
|
|
10696
10788
|
readonly http: "GET";
|
|
10697
10789
|
readonly path: "/media/v1/libraries/{library_id}/events";
|
|
10698
10790
|
readonly streaming: "no";
|
|
@@ -10728,7 +10820,7 @@ export declare const operations: readonly [{
|
|
|
10728
10820
|
readonly resource: "media.libraries.folders";
|
|
10729
10821
|
readonly method: "list";
|
|
10730
10822
|
readonly summary: "List folders";
|
|
10731
|
-
readonly description: "
|
|
10823
|
+
readonly description: "undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.";
|
|
10732
10824
|
readonly http: "GET";
|
|
10733
10825
|
readonly path: "/media/v1/libraries/{library_id}/folders";
|
|
10734
10826
|
readonly streaming: "no";
|
|
@@ -10744,11 +10836,120 @@ export declare const operations: readonly [{
|
|
|
10744
10836
|
readonly required: false;
|
|
10745
10837
|
readonly description: "Folder whose immediate children are returned. Omit or use an empty string for the library root; invalid folder paths are rejected.";
|
|
10746
10838
|
}];
|
|
10839
|
+
}, {
|
|
10840
|
+
readonly resource: "media.libraries.generations";
|
|
10841
|
+
readonly method: "create";
|
|
10842
|
+
readonly summary: "Create video generation";
|
|
10843
|
+
readonly description: "Create a video.generate job. Generation is charged per second. The response is 202 with a queued Job; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until terminal, then save successful outputs. Unsaved candidate Files expire after 7 days.";
|
|
10844
|
+
readonly http: "POST";
|
|
10845
|
+
readonly path: "/media/v1/libraries/{library_id}/generations";
|
|
10846
|
+
readonly streaming: "no";
|
|
10847
|
+
readonly pagination: false;
|
|
10848
|
+
readonly pathParams: readonly [{
|
|
10849
|
+
readonly name: "library_id";
|
|
10850
|
+
readonly sdkName: "library_id";
|
|
10851
|
+
readonly description: "Library ID returned by creation.";
|
|
10852
|
+
}];
|
|
10853
|
+
readonly query: readonly [];
|
|
10854
|
+
readonly body: {
|
|
10855
|
+
readonly required: true;
|
|
10856
|
+
readonly fields: readonly [{
|
|
10857
|
+
readonly name: "intent";
|
|
10858
|
+
readonly type: "string";
|
|
10859
|
+
readonly required: true;
|
|
10860
|
+
readonly description: "Generation operation; v1 accepts only video.generate text-to-video requests.";
|
|
10861
|
+
}, {
|
|
10862
|
+
readonly name: "prompt";
|
|
10863
|
+
readonly type: "string";
|
|
10864
|
+
readonly required: true;
|
|
10865
|
+
readonly description: "Text prompt describing the video to generate.";
|
|
10866
|
+
}, {
|
|
10867
|
+
readonly name: "count";
|
|
10868
|
+
readonly type: "integer";
|
|
10869
|
+
readonly required: false;
|
|
10870
|
+
readonly description: "Number of videos to generate; defaults to 1 and must be from 1 to 4.";
|
|
10871
|
+
}, {
|
|
10872
|
+
readonly name: "duration_seconds";
|
|
10873
|
+
readonly type: "integer";
|
|
10874
|
+
readonly required: false;
|
|
10875
|
+
readonly description: "Requested video duration in seconds; Router validates the model-specific supported durations.";
|
|
10876
|
+
}, {
|
|
10877
|
+
readonly name: "aspect_ratio";
|
|
10878
|
+
readonly type: "string";
|
|
10879
|
+
readonly required: false;
|
|
10880
|
+
readonly description: "Requested output aspect ratio; defaults to 16:9 and Router validates model support.";
|
|
10881
|
+
}, {
|
|
10882
|
+
readonly name: "model";
|
|
10883
|
+
readonly type: "string";
|
|
10884
|
+
readonly required: false;
|
|
10885
|
+
readonly description: "Router model with video_generation capability; defaults to wan2.7-t2v.";
|
|
10886
|
+
}, {
|
|
10887
|
+
readonly name: "save";
|
|
10888
|
+
readonly type: "string";
|
|
10889
|
+
readonly enum: readonly ["candidate", "library"];
|
|
10890
|
+
readonly required: false;
|
|
10891
|
+
readonly description: "candidate keeps outputs temporary for explicit save calls; library saves successful outputs automatically.";
|
|
10892
|
+
}, {
|
|
10893
|
+
readonly name: "asset_folder";
|
|
10894
|
+
readonly type: "string";
|
|
10895
|
+
readonly required: false;
|
|
10896
|
+
readonly description: "Folder for assets saved automatically or by later save calls; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.";
|
|
10897
|
+
}, {
|
|
10898
|
+
readonly name: "tags";
|
|
10899
|
+
readonly type: "array";
|
|
10900
|
+
readonly itemType: "string";
|
|
10901
|
+
readonly required: false;
|
|
10902
|
+
readonly description: "Tags applied when an output becomes a library asset.";
|
|
10903
|
+
}, {
|
|
10904
|
+
readonly name: "understanding";
|
|
10905
|
+
readonly type: "string";
|
|
10906
|
+
readonly enum: readonly ["auto", "skip"];
|
|
10907
|
+
readonly required: false;
|
|
10908
|
+
readonly description: "Understanding behavior when a candidate is saved as an asset; defaults to auto.";
|
|
10909
|
+
}, {
|
|
10910
|
+
readonly name: "references";
|
|
10911
|
+
readonly type: "array";
|
|
10912
|
+
readonly itemType: "object";
|
|
10913
|
+
readonly required: false;
|
|
10914
|
+
readonly description: "Not supported in v1; omit this field. Only text-to-video is currently available.";
|
|
10915
|
+
}];
|
|
10916
|
+
};
|
|
10917
|
+
}, {
|
|
10918
|
+
readonly resource: "media.libraries.jobs";
|
|
10919
|
+
readonly method: "list";
|
|
10920
|
+
readonly summary: "List jobs";
|
|
10921
|
+
readonly description: "List batch and video-generation jobs in a library. Filter by status and continue with next_cursor. Poll a generation Job until terminal, then save successful candidate outputs before they expire after 7 days.";
|
|
10922
|
+
readonly http: "GET";
|
|
10923
|
+
readonly path: "/media/v1/libraries/{library_id}/jobs";
|
|
10924
|
+
readonly streaming: "no";
|
|
10925
|
+
readonly pagination: true;
|
|
10926
|
+
readonly pathParams: readonly [{
|
|
10927
|
+
readonly name: "library_id";
|
|
10928
|
+
readonly sdkName: "library_id";
|
|
10929
|
+
readonly description: "Library ID returned by creation.";
|
|
10930
|
+
}];
|
|
10931
|
+
readonly query: readonly [{
|
|
10932
|
+
readonly name: "status";
|
|
10933
|
+
readonly type: "string";
|
|
10934
|
+
readonly enum: readonly ["queued", "running", "completed", "completed_with_errors", "failed", "cancelled"];
|
|
10935
|
+
readonly required: false;
|
|
10936
|
+
readonly description: "Filter jobs by their current status.";
|
|
10937
|
+
}, {
|
|
10938
|
+
readonly name: "limit";
|
|
10939
|
+
readonly type: "integer";
|
|
10940
|
+
readonly required: false;
|
|
10941
|
+
readonly description: "Maximum entries in this page, from 1 through 100; defaults to 100.";
|
|
10942
|
+
}, {
|
|
10943
|
+
readonly name: "cursor";
|
|
10944
|
+
readonly type: "string";
|
|
10945
|
+
readonly required: false;
|
|
10946
|
+
readonly description: "Job id from the previous page’s next_cursor; omit for the first page.";
|
|
10947
|
+
}];
|
|
10747
10948
|
}, {
|
|
10748
10949
|
readonly resource: "media.libraries.jobs";
|
|
10749
10950
|
readonly method: "retrieve";
|
|
10750
|
-
readonly summary: "Get job
|
|
10751
|
-
readonly description: "
|
|
10951
|
+
readonly summary: "Get job";
|
|
10952
|
+
readonly description: "Read the current batch or video-generation Job status and progress. For generation, inspect outputs and failures, then save successful candidates before their preview and save window expires after 7 days.";
|
|
10752
10953
|
readonly http: "GET";
|
|
10753
10954
|
readonly path: "/media/v1/libraries/{library_id}/jobs/{job_id}";
|
|
10754
10955
|
readonly streaming: "no";
|
|
@@ -10760,14 +10961,82 @@ export declare const operations: readonly [{
|
|
|
10760
10961
|
}, {
|
|
10761
10962
|
readonly name: "job_id";
|
|
10762
10963
|
readonly sdkName: "job_id";
|
|
10763
|
-
readonly description: "
|
|
10964
|
+
readonly description: "Job identifier returned by batch creation, video-generation creation or job listing; resolved within this library.";
|
|
10965
|
+
}];
|
|
10966
|
+
readonly query: readonly [];
|
|
10967
|
+
}, {
|
|
10968
|
+
readonly resource: "media.libraries.jobs";
|
|
10969
|
+
readonly method: "cancel";
|
|
10970
|
+
readonly summary: "Cancel job";
|
|
10971
|
+
readonly description: "Cancel a queued or running generation job. Already completed outputs remain available to save; poll or read the returned Job to confirm its status.";
|
|
10972
|
+
readonly http: "POST";
|
|
10973
|
+
readonly path: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel";
|
|
10974
|
+
readonly streaming: "no";
|
|
10975
|
+
readonly pagination: false;
|
|
10976
|
+
readonly pathParams: readonly [{
|
|
10977
|
+
readonly name: "library_id";
|
|
10978
|
+
readonly sdkName: "library_id";
|
|
10979
|
+
readonly description: "Library ID returned by creation.";
|
|
10980
|
+
}, {
|
|
10981
|
+
readonly name: "job_id";
|
|
10982
|
+
readonly sdkName: "job_id";
|
|
10983
|
+
readonly description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library.";
|
|
10984
|
+
}];
|
|
10985
|
+
readonly query: readonly [];
|
|
10986
|
+
}, {
|
|
10987
|
+
readonly resource: "media.libraries.jobs.outputs.save";
|
|
10988
|
+
readonly method: "create";
|
|
10989
|
+
readonly summary: "Save generation output";
|
|
10990
|
+
readonly description: "Save a successful candidate as a library asset. Candidate outputs expire after 7 days; save before expiry. Generation is charged per second when the job runs, not when an output is saved.";
|
|
10991
|
+
readonly http: "POST";
|
|
10992
|
+
readonly path: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save";
|
|
10993
|
+
readonly streaming: "no";
|
|
10994
|
+
readonly pagination: false;
|
|
10995
|
+
readonly pathParams: readonly [{
|
|
10996
|
+
readonly name: "library_id";
|
|
10997
|
+
readonly sdkName: "library_id";
|
|
10998
|
+
readonly description: "Library ID returned by creation.";
|
|
10999
|
+
}, {
|
|
11000
|
+
readonly name: "job_id";
|
|
11001
|
+
readonly sdkName: "job_id";
|
|
11002
|
+
readonly description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library.";
|
|
11003
|
+
}, {
|
|
11004
|
+
readonly name: "index";
|
|
11005
|
+
readonly sdkName: "index";
|
|
11006
|
+
readonly description: "Zero-based position of the candidate in the Job outputs array.";
|
|
10764
11007
|
}];
|
|
10765
11008
|
readonly query: readonly [];
|
|
11009
|
+
readonly body: {
|
|
11010
|
+
readonly required: false;
|
|
11011
|
+
readonly fields: readonly [{
|
|
11012
|
+
readonly name: "public_id";
|
|
11013
|
+
readonly type: "string";
|
|
11014
|
+
readonly required: false;
|
|
11015
|
+
readonly description: "Delivery identifier for the saved asset; defaults to gen_<job_id>_<index> and is idempotent.";
|
|
11016
|
+
}, {
|
|
11017
|
+
readonly name: "asset_folder";
|
|
11018
|
+
readonly type: "string";
|
|
11019
|
+
readonly required: false;
|
|
11020
|
+
readonly description: "Destination folder for the saved asset; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.";
|
|
11021
|
+
}, {
|
|
11022
|
+
readonly name: "tags";
|
|
11023
|
+
readonly type: "array";
|
|
11024
|
+
readonly itemType: "string";
|
|
11025
|
+
readonly required: false;
|
|
11026
|
+
readonly description: "Tags to apply to the saved asset.";
|
|
11027
|
+
}, {
|
|
11028
|
+
readonly name: "understanding";
|
|
11029
|
+
readonly type: "string";
|
|
11030
|
+
readonly enum: readonly ["auto", "skip"];
|
|
11031
|
+
readonly required: false;
|
|
11032
|
+
readonly description: "Understanding behavior for the saved asset; defaults to auto.";
|
|
11033
|
+
}];
|
|
11034
|
+
};
|
|
10766
11035
|
}, {
|
|
10767
11036
|
readonly resource: "media.libraries.purge";
|
|
10768
11037
|
readonly method: "create";
|
|
10769
11038
|
readonly summary: "Purge library";
|
|
10770
|
-
readonly description: "
|
|
11039
|
+
readonly description: "List assets in an active library, newest first, optionally filtering by exact folder and stored resource type. Continue using next_cursor; video includes audio-only assets.";
|
|
10771
11040
|
readonly http: "POST";
|
|
10772
11041
|
readonly path: "/media/v1/libraries/{library_id}/purge";
|
|
10773
11042
|
readonly streaming: "no";
|
|
@@ -10782,7 +11051,7 @@ export declare const operations: readonly [{
|
|
|
10782
11051
|
readonly resource: "media.libraries";
|
|
10783
11052
|
readonly method: "restore";
|
|
10784
11053
|
readonly summary: "Restore library";
|
|
10785
|
-
readonly description: "
|
|
11054
|
+
readonly description: "Permanently remove a library that is already deleting, without waiting for purge_at. Its assets and related resources are removed and cannot be restored; first soft-delete an active library.";
|
|
10786
11055
|
readonly http: "POST";
|
|
10787
11056
|
readonly path: "/media/v1/libraries/{library_id}/restore";
|
|
10788
11057
|
readonly streaming: "no";
|
|
@@ -10797,7 +11066,7 @@ export declare const operations: readonly [{
|
|
|
10797
11066
|
readonly resource: "media.libraries.search";
|
|
10798
11067
|
readonly method: "create";
|
|
10799
11068
|
readonly summary: "Semantic search alias";
|
|
10800
|
-
readonly description: "
|
|
11069
|
+
readonly description: "List all immediate child folders under parent, or under the root when parent is omitted. Counts include descendant assets. The result is unpaginated; limit and cursor are rejected.";
|
|
10801
11070
|
readonly http: "POST";
|
|
10802
11071
|
readonly path: "/media/v1/libraries/{library_id}/search";
|
|
10803
11072
|
readonly streaming: "no";
|
|
@@ -10837,7 +11106,7 @@ export declare const operations: readonly [{
|
|
|
10837
11106
|
readonly resource: "media.libraries.search.expression";
|
|
10838
11107
|
readonly method: "create";
|
|
10839
11108
|
readonly summary: "Expression search";
|
|
10840
|
-
readonly description: "
|
|
11109
|
+
readonly description: "Find visually similar assets using exactly one of asset_id or an inline base64 image. The library must support image search; an asset query needs a current image embedding and excludes that source asset from results.";
|
|
10841
11110
|
readonly http: "POST";
|
|
10842
11111
|
readonly path: "/media/v1/libraries/{library_id}/search/expression";
|
|
10843
11112
|
readonly streaming: "no";
|
|
@@ -10854,7 +11123,7 @@ export declare const operations: readonly [{
|
|
|
10854
11123
|
readonly name: "expression";
|
|
10855
11124
|
readonly type: "string";
|
|
10856
11125
|
readonly required: false;
|
|
10857
|
-
readonly description: "Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets. For business metadata use context.sku=KETTLE-RED AND context.revision=2; request with_field: [\"context\"] to include context.";
|
|
11126
|
+
readonly description: "Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets. For business metadata use context.sku=KETTLE-RED AND context.revision=2; request with_field: [\"context\"] to include context. Quality filters: flags:watermark matches any current shot with a watermark; flags.watermark:false requires an assessed video with no positive watermark judgment. The same syntax supports slideshow, hand_frame, text_sticker and low_quality. folder_mismatch:true selects lexical folder/location hints. Geometry filters support width, height, resolution:1920x1080, numeric aspect_ratio (width/height), and orientation:landscape, portrait or square. Missing geometry or unassessed legacy flags do not match positive filters. has_music:true AND audio_genre:jazz AND audio_mood:calm selects current-version audio profiles with music and matching model labels; has_music:false applies only to sampled ranges, not the entire source. failure_code=UPSTREAM_FAILED selects assets with a current failed understanding carrying that code; combine with processing_state=failed or processing_state=partial.";
|
|
10858
11127
|
}, {
|
|
10859
11128
|
readonly name: "sort_by";
|
|
10860
11129
|
readonly type: "array";
|
|
@@ -10891,7 +11160,7 @@ export declare const operations: readonly [{
|
|
|
10891
11160
|
readonly resource: "media.libraries.search.semantic";
|
|
10892
11161
|
readonly method: "create";
|
|
10893
11162
|
readonly summary: "Semantic search";
|
|
10894
|
-
readonly description: "Search assets with a nonblank text query
|
|
11163
|
+
readonly description: "Alias of semantic search. Search assets with a nonblank text query, optional expression filter and top_k; hybrid combines semantic and keyword matches, while semantic uses vector similarity only.";
|
|
10895
11164
|
readonly http: "POST";
|
|
10896
11165
|
readonly path: "/media/v1/libraries/{library_id}/search/semantic";
|
|
10897
11166
|
readonly streaming: "no";
|
|
@@ -10931,7 +11200,7 @@ export declare const operations: readonly [{
|
|
|
10931
11200
|
readonly resource: "media.libraries.search.visual";
|
|
10932
11201
|
readonly method: "create";
|
|
10933
11202
|
readonly summary: "Visual search";
|
|
10934
|
-
readonly description: "
|
|
11203
|
+
readonly description: "Search assets with a nonblank text query and optional expression filter. Hybrid mode combines semantic and keyword matches; semantic mode uses vector similarity only. Results are ranked and limited by top_k.";
|
|
10935
11204
|
readonly http: "POST";
|
|
10936
11205
|
readonly path: "/media/v1/libraries/{library_id}/search/visual";
|
|
10937
11206
|
readonly streaming: "no";
|
|
@@ -10967,34 +11236,84 @@ export declare const operations: readonly [{
|
|
|
10967
11236
|
}];
|
|
10968
11237
|
};
|
|
10969
11238
|
}, {
|
|
10970
|
-
readonly resource: "
|
|
10971
|
-
readonly method: "
|
|
10972
|
-
readonly summary: "
|
|
10973
|
-
readonly description: "
|
|
11239
|
+
readonly resource: "media.libraries.understandings";
|
|
11240
|
+
readonly method: "list";
|
|
11241
|
+
readonly summary: "List understanding results across a library";
|
|
11242
|
+
readonly description: "Read current understanding entries across one library without fetching every asset separately. Use library_id from creation or listing. folder includes descendants; kinds is a comma-separated list of output kinds. Entries are ordered by asset_id and then understanding id. Continue with next_cursor and the same folder and kinds; limit defaults to 100 and cannot exceed 100. Superseded, deleted and old-version entries are excluded. During historical backfill, this method returns 503 CAPACITY rather than incomplete pages; poll failureSummary until counts_complete is true, then start pagination. Example: GET /media/v1/libraries/lib_example/understandings?folder=travel&kinds=caption,transcript&limit=100.";
|
|
10974
11243
|
readonly http: "GET";
|
|
10975
|
-
readonly path: "/
|
|
11244
|
+
readonly path: "/media/v1/libraries/{library_id}/understandings";
|
|
10976
11245
|
readonly streaming: "no";
|
|
10977
|
-
readonly pagination:
|
|
10978
|
-
readonly pathParams: readonly [
|
|
11246
|
+
readonly pagination: true;
|
|
11247
|
+
readonly pathParams: readonly [{
|
|
11248
|
+
readonly name: "library_id";
|
|
11249
|
+
readonly sdkName: "library_id";
|
|
11250
|
+
readonly description: "Library ID returned by creation.";
|
|
11251
|
+
}];
|
|
10979
11252
|
readonly query: readonly [{
|
|
10980
|
-
readonly name: "
|
|
11253
|
+
readonly name: "folder";
|
|
10981
11254
|
readonly type: "string";
|
|
10982
|
-
readonly required:
|
|
10983
|
-
readonly description: "
|
|
11255
|
+
readonly required: false;
|
|
11256
|
+
readonly description: "Folder path including all descendants; omitted or empty selects the entire library.";
|
|
10984
11257
|
}, {
|
|
10985
|
-
readonly name: "
|
|
10986
|
-
readonly type: "
|
|
11258
|
+
readonly name: "kinds";
|
|
11259
|
+
readonly type: "string";
|
|
10987
11260
|
readonly required: false;
|
|
10988
|
-
readonly description: "
|
|
11261
|
+
readonly description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind.";
|
|
10989
11262
|
}, {
|
|
10990
|
-
readonly name: "
|
|
11263
|
+
readonly name: "cursor";
|
|
10991
11264
|
readonly type: "string";
|
|
10992
|
-
readonly enum: readonly ["zh", "en"];
|
|
10993
11265
|
readonly required: false;
|
|
10994
|
-
readonly description: "
|
|
11266
|
+
readonly description: "Cursor from the previous next_cursor.";
|
|
11267
|
+
}, {
|
|
11268
|
+
readonly name: "limit";
|
|
11269
|
+
readonly type: "integer";
|
|
11270
|
+
readonly required: false;
|
|
11271
|
+
readonly description: "Maximum entries in this page, from 1 through 100; defaults to 100.";
|
|
10995
11272
|
}];
|
|
10996
11273
|
}, {
|
|
10997
|
-
readonly resource: "
|
|
11274
|
+
readonly resource: "media.libraries.understandings";
|
|
11275
|
+
readonly method: "retrieveFailureSummary";
|
|
11276
|
+
readonly summary: "Summarize understanding failures";
|
|
11277
|
+
readonly description: "Inspect current understanding failures before retrying. Use library_id from library creation or listing. Groups include code, output kind, actual producer model, retryability and up to five sample asset IDs. At most 1024 detailed groups plus two overflow groups are returned; overflow groups separate retryable and unrecoverable entries and mark overflow=true. Unknown failure codes remain retryable. Historical counts are provisional while counts_complete is false. Example: GET /media/v1/libraries/lib_example/understandings/failure_summary.";
|
|
11278
|
+
readonly http: "GET";
|
|
11279
|
+
readonly path: "/media/v1/libraries/{library_id}/understandings/failure_summary";
|
|
11280
|
+
readonly streaming: "no";
|
|
11281
|
+
readonly pagination: false;
|
|
11282
|
+
readonly pathParams: readonly [{
|
|
11283
|
+
readonly name: "library_id";
|
|
11284
|
+
readonly sdkName: "library_id";
|
|
11285
|
+
readonly description: "Library ID returned by creation.";
|
|
11286
|
+
}];
|
|
11287
|
+
readonly query: readonly [];
|
|
11288
|
+
}, {
|
|
11289
|
+
readonly resource: "meta.docs";
|
|
11290
|
+
readonly method: "search";
|
|
11291
|
+
readonly summary: "Search platform documentation";
|
|
11292
|
+
readonly description: "Find guides and references by keyword before reading them with praxis.meta.docs.retrieve. Public; no API key required. Matches documentation titles, headings and page text without case sensitivity; all query words must occur. q is required; limit defaults to 20 and accepts 1–50. lang defaults to zh or use en for English. Returns paths, page titles, canonical URLs and short matching snippets; no matches returns an empty array.";
|
|
11293
|
+
readonly http: "GET";
|
|
11294
|
+
readonly path: "/meta/v1/docs/search";
|
|
11295
|
+
readonly streaming: "no";
|
|
11296
|
+
readonly pagination: false;
|
|
11297
|
+
readonly pathParams: readonly [];
|
|
11298
|
+
readonly query: readonly [{
|
|
11299
|
+
readonly name: "q";
|
|
11300
|
+
readonly type: "string";
|
|
11301
|
+
readonly required: true;
|
|
11302
|
+
readonly description: "Keywords describing the syntax or guide needed, for example export or workflow.";
|
|
11303
|
+
}, {
|
|
11304
|
+
readonly name: "limit";
|
|
11305
|
+
readonly type: "integer";
|
|
11306
|
+
readonly required: false;
|
|
11307
|
+
readonly description: "Maximum number of matching pages returned; integer 1–50, default 20.";
|
|
11308
|
+
}, {
|
|
11309
|
+
readonly name: "lang";
|
|
11310
|
+
readonly type: "string";
|
|
11311
|
+
readonly enum: readonly ["zh", "en"];
|
|
11312
|
+
readonly required: false;
|
|
11313
|
+
readonly description: "Documentation language: zh for Chinese (default), en for English.";
|
|
11314
|
+
}];
|
|
11315
|
+
}, {
|
|
11316
|
+
readonly resource: "meta.docs";
|
|
10998
11317
|
readonly method: "retrieve";
|
|
10999
11318
|
readonly summary: "Read documentation Markdown";
|
|
11000
11319
|
readonly description: "Read a platform guide or reference before implementing an unfamiliar capability. Public; no API key required. Take path from praxis.meta.docs.search, or use developers/automation/guides/write-workflow. Append #heading-id to path to read only that section, including its subsections. Encode the hash as %23 over HTTP; SDK callers pass it in the path string. lang defaults to zh; en selects the English page. Unknown pages or anchors return DOC_NOT_FOUND; search again for a valid path.";
|
|
@@ -11179,35 +11498,35 @@ export declare const operations: readonly [{
|
|
|
11179
11498
|
readonly name: "model";
|
|
11180
11499
|
readonly type: "string";
|
|
11181
11500
|
readonly required: true;
|
|
11182
|
-
readonly description: "
|
|
11501
|
+
readonly description: "Model catalog identifier declaring openai.audio.transcriptions; use it unchanged, including any creator prefix.";
|
|
11183
11502
|
}, {
|
|
11184
11503
|
readonly name: "file";
|
|
11185
11504
|
readonly type: "string";
|
|
11186
11505
|
readonly required: true;
|
|
11187
|
-
readonly description: "Audio
|
|
11506
|
+
readonly description: "Audio bytes uploaded as a multipart file; supported formats and input limits depend on the selected model.";
|
|
11188
11507
|
}, {
|
|
11189
11508
|
readonly name: "language";
|
|
11190
11509
|
readonly type: "string";
|
|
11191
11510
|
readonly required: false;
|
|
11192
|
-
readonly description: "
|
|
11511
|
+
readonly description: "Source language code when known; omit to let the model detect the language.";
|
|
11193
11512
|
}, {
|
|
11194
11513
|
readonly name: "prompt";
|
|
11195
11514
|
readonly type: "string";
|
|
11196
11515
|
readonly required: false;
|
|
11197
|
-
readonly description: "
|
|
11516
|
+
readonly description: "Optional vocabulary or contextual guidance for recognizing the audio; support depends on the selected model.";
|
|
11198
11517
|
}, {
|
|
11199
11518
|
readonly name: "response_format";
|
|
11200
11519
|
readonly type: "string";
|
|
11201
|
-
readonly enum: readonly ["json", "text", "verbose_json"];
|
|
11520
|
+
readonly enum: readonly ["json", "text", "verbose_json", "diarized_json"];
|
|
11202
11521
|
readonly required: false;
|
|
11203
|
-
readonly description: "
|
|
11522
|
+
readonly description: "Output format: json returns text in JSON; text returns plain text; verbose_json includes requested timestamps; diarized_json includes speaker-labelled segments when supported. Defaults to json.";
|
|
11204
11523
|
}, {
|
|
11205
11524
|
readonly name: "timestamp_granularities[]";
|
|
11206
11525
|
readonly type: "array";
|
|
11207
11526
|
readonly itemType: "string";
|
|
11208
|
-
readonly enum: readonly ["segment"];
|
|
11527
|
+
readonly enum: readonly ["word", "segment"];
|
|
11209
11528
|
readonly required: false;
|
|
11210
|
-
readonly description: "Timestamp levels to
|
|
11529
|
+
readonly description: "Timestamp levels to request as repeated multipart fields: word returns per-word times; segment returns segment times. Omit for the model default. Use verbose_json, or diarized_json on supporting models.";
|
|
11211
11530
|
}, {
|
|
11212
11531
|
readonly name: "temperature";
|
|
11213
11532
|
readonly type: "number";
|
|
@@ -12772,6 +13091,451 @@ export declare const operations: readonly [{
|
|
|
12772
13091
|
readonly description: "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400.";
|
|
12773
13092
|
}];
|
|
12774
13093
|
readonly query: readonly [];
|
|
13094
|
+
}, {
|
|
13095
|
+
readonly resource: "ontology.changesets";
|
|
13096
|
+
readonly method: "create";
|
|
13097
|
+
readonly summary: "Apply changeset";
|
|
13098
|
+
readonly description: "Apply a batch of node, relation and invalidation operations as one transaction, when a mirror has several records to write together and a partial write would leave the graph inconsistent. Every operation succeeds or none is applied. Send an Idempotency-Key header; the same key with the same content replays the first result, and the same key with different content is ONTOLOGY_CONFLICT.";
|
|
13099
|
+
readonly http: "POST";
|
|
13100
|
+
readonly path: "/ontology/v1/changesets";
|
|
13101
|
+
readonly streaming: "no";
|
|
13102
|
+
readonly pagination: false;
|
|
13103
|
+
readonly pathParams: readonly [];
|
|
13104
|
+
readonly query: readonly [];
|
|
13105
|
+
readonly body: {
|
|
13106
|
+
readonly required: true;
|
|
13107
|
+
readonly fields: readonly [{
|
|
13108
|
+
readonly name: "at";
|
|
13109
|
+
readonly type: "string";
|
|
13110
|
+
readonly required: true;
|
|
13111
|
+
readonly description: "World time the batch describes, in ISO 8601 UTC; operations without their own time are dated by it.";
|
|
13112
|
+
}, {
|
|
13113
|
+
readonly name: "scope";
|
|
13114
|
+
readonly type: "string";
|
|
13115
|
+
readonly required: false;
|
|
13116
|
+
readonly description: "Scope the batch came from, normally the session id it was observed in; it is stored with the operations for later reading.";
|
|
13117
|
+
}, {
|
|
13118
|
+
readonly name: "ops";
|
|
13119
|
+
readonly type: "array";
|
|
13120
|
+
readonly itemType: "object";
|
|
13121
|
+
readonly required: true;
|
|
13122
|
+
readonly description: "At most 500 operations, applied in order; each names its kind in op and the fields that kind requires.";
|
|
13123
|
+
}];
|
|
13124
|
+
};
|
|
13125
|
+
}, {
|
|
13126
|
+
readonly resource: "ontology.nodes";
|
|
13127
|
+
readonly method: "list";
|
|
13128
|
+
readonly summary: "List nodes";
|
|
13129
|
+
readonly description: "Discover the entities in this organization's graph and obtain node ids for retrieval, updates and relations. Filter by type, by free text over names, aliases, descriptions and facts, or by owner; limit is 1–100 and defaults to 50. Omit cursor for the first page, then copy next_cursor into the next request until it is null. A node whose content belongs to somebody else comes back as a restricted entry carrying only its id, type and name.";
|
|
13130
|
+
readonly http: "GET";
|
|
13131
|
+
readonly path: "/ontology/v1/nodes";
|
|
13132
|
+
readonly streaming: "no";
|
|
13133
|
+
readonly pagination: true;
|
|
13134
|
+
readonly pathParams: readonly [];
|
|
13135
|
+
readonly query: readonly [{
|
|
13136
|
+
readonly name: "type";
|
|
13137
|
+
readonly type: "array";
|
|
13138
|
+
readonly itemType: "string";
|
|
13139
|
+
readonly required: false;
|
|
13140
|
+
readonly description: "Repeat to filter to any of several registered node type names, for example type=file&type=ticket; omit to list every type.";
|
|
13141
|
+
}, {
|
|
13142
|
+
readonly name: "q";
|
|
13143
|
+
readonly type: "string";
|
|
13144
|
+
readonly required: false;
|
|
13145
|
+
readonly description: "Free text matched against node names, aliases and descriptions; omit to list without a text filter.";
|
|
13146
|
+
}, {
|
|
13147
|
+
readonly name: "owner";
|
|
13148
|
+
readonly type: "string";
|
|
13149
|
+
readonly required: false;
|
|
13150
|
+
readonly description: "Filter to nodes owned by this member id, or omit to list nodes of every owner; organization-wide nodes carry no owner.";
|
|
13151
|
+
}, {
|
|
13152
|
+
readonly name: "as_of";
|
|
13153
|
+
readonly type: "string";
|
|
13154
|
+
readonly required: false;
|
|
13155
|
+
readonly description: "ISO 8601 timestamp; return the graph as it was then, so a node recorded later is absent. Omit to read current state.";
|
|
13156
|
+
}, {
|
|
13157
|
+
readonly name: "limit";
|
|
13158
|
+
readonly type: "integer";
|
|
13159
|
+
readonly required: false;
|
|
13160
|
+
readonly description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100.";
|
|
13161
|
+
}, {
|
|
13162
|
+
readonly name: "cursor";
|
|
13163
|
+
readonly type: "string";
|
|
13164
|
+
readonly required: false;
|
|
13165
|
+
readonly description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null.";
|
|
13166
|
+
}];
|
|
13167
|
+
}, {
|
|
13168
|
+
readonly resource: "ontology.nodes";
|
|
13169
|
+
readonly method: "create";
|
|
13170
|
+
readonly summary: "Create node";
|
|
13171
|
+
readonly description: "Record one entity in the graph, for a system mirroring a record it owns. type must already be registered and ref, when given, must match that type's ref_prefix. Send an Idempotency-Key header; repeating the same key with the same content returns the first result instead of creating a second node. This writes structure only — to give an agent something to remember, use POST /agent/v1/agents/{agent_id}/consolidations.";
|
|
13172
|
+
readonly http: "POST";
|
|
13173
|
+
readonly path: "/ontology/v1/nodes";
|
|
13174
|
+
readonly streaming: "no";
|
|
13175
|
+
readonly pagination: false;
|
|
13176
|
+
readonly pathParams: readonly [];
|
|
13177
|
+
readonly query: readonly [];
|
|
13178
|
+
readonly body: {
|
|
13179
|
+
readonly required: true;
|
|
13180
|
+
readonly fields: readonly [{
|
|
13181
|
+
readonly name: "type";
|
|
13182
|
+
readonly type: "string";
|
|
13183
|
+
readonly required: true;
|
|
13184
|
+
readonly description: "Registered node type name from types.list; an unregistered name is refused and nothing is written.";
|
|
13185
|
+
}, {
|
|
13186
|
+
readonly name: "ref";
|
|
13187
|
+
readonly type: "string";
|
|
13188
|
+
readonly required: false;
|
|
13189
|
+
readonly description: "Id of the mirrored record in the owning service, which must start with the type's ref_prefix; omit or null for a concept with no external record.";
|
|
13190
|
+
}, {
|
|
13191
|
+
readonly name: "name";
|
|
13192
|
+
readonly type: "string";
|
|
13193
|
+
readonly required: true;
|
|
13194
|
+
readonly description: "Display name of the entity, at most 200 characters.";
|
|
13195
|
+
}, {
|
|
13196
|
+
readonly name: "aliases";
|
|
13197
|
+
readonly type: "array";
|
|
13198
|
+
readonly itemType: "string";
|
|
13199
|
+
readonly required: false;
|
|
13200
|
+
readonly description: "Other names this entity is known by; they are matched by search alongside the name.";
|
|
13201
|
+
}, {
|
|
13202
|
+
readonly name: "description";
|
|
13203
|
+
readonly type: "string";
|
|
13204
|
+
readonly required: false;
|
|
13205
|
+
readonly description: "Profile of the entity, at most 500 characters; omit or null for none.";
|
|
13206
|
+
}, {
|
|
13207
|
+
readonly name: "owner";
|
|
13208
|
+
readonly type: "string";
|
|
13209
|
+
readonly required: false;
|
|
13210
|
+
readonly description: "Member id whose content this is, restricting it to that member; omit or null to make it readable organization-wide.";
|
|
13211
|
+
}];
|
|
13212
|
+
};
|
|
13213
|
+
}, {
|
|
13214
|
+
readonly resource: "ontology.nodes";
|
|
13215
|
+
readonly method: "retrieve";
|
|
13216
|
+
readonly summary: "Retrieve node";
|
|
13217
|
+
readonly description: "Read one node's content and, with expand=relations, every relation on and around it. as_of reads the node as it was at that time. A node id from another organization, or one that never existed, answers ONTOLOGY_NODE_NOT_FOUND; a node you may reach but not read returns restricted true with its name only.";
|
|
13218
|
+
readonly http: "GET";
|
|
13219
|
+
readonly path: "/ontology/v1/nodes/{node_id}";
|
|
13220
|
+
readonly streaming: "no";
|
|
13221
|
+
readonly pagination: false;
|
|
13222
|
+
readonly pathParams: readonly [{
|
|
13223
|
+
readonly name: "node_id";
|
|
13224
|
+
readonly sdkName: "node_id";
|
|
13225
|
+
readonly description: "Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted.";
|
|
13226
|
+
}];
|
|
13227
|
+
readonly query: readonly [{
|
|
13228
|
+
readonly name: "expand";
|
|
13229
|
+
readonly type: "string";
|
|
13230
|
+
readonly enum: readonly ["relations"];
|
|
13231
|
+
readonly required: false;
|
|
13232
|
+
readonly description: "Set to relations to include the node's incoming and outgoing relations in the same response; omit for the node alone.";
|
|
13233
|
+
}, {
|
|
13234
|
+
readonly name: "as_of";
|
|
13235
|
+
readonly type: "string";
|
|
13236
|
+
readonly required: false;
|
|
13237
|
+
readonly description: "ISO 8601 timestamp; read the node and its relations as they were then, including relations invalidated since. Omit to read current state.";
|
|
13238
|
+
}];
|
|
13239
|
+
}, {
|
|
13240
|
+
readonly resource: "ontology.nodes";
|
|
13241
|
+
readonly method: "update";
|
|
13242
|
+
readonly summary: "Update node";
|
|
13243
|
+
readonly description: "Change a node's name, aliases or description when the mirrored record was renamed, without touching its type or identity. Send only the fields to change; omitted fields keep their current values and an explicitly null description clears it. Repeating the same edit converges on the same node, so this needs no Idempotency-Key.";
|
|
13244
|
+
readonly http: "PATCH";
|
|
13245
|
+
readonly path: "/ontology/v1/nodes/{node_id}";
|
|
13246
|
+
readonly streaming: "no";
|
|
13247
|
+
readonly pagination: false;
|
|
13248
|
+
readonly pathParams: readonly [{
|
|
13249
|
+
readonly name: "node_id";
|
|
13250
|
+
readonly sdkName: "node_id";
|
|
13251
|
+
readonly description: "Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted.";
|
|
13252
|
+
}];
|
|
13253
|
+
readonly query: readonly [];
|
|
13254
|
+
readonly body: {
|
|
13255
|
+
readonly required: true;
|
|
13256
|
+
readonly fields: readonly [{
|
|
13257
|
+
readonly name: "name";
|
|
13258
|
+
readonly type: "string";
|
|
13259
|
+
readonly required: false;
|
|
13260
|
+
readonly description: "New display name, at most 200 characters; omit to keep the current name.";
|
|
13261
|
+
}, {
|
|
13262
|
+
readonly name: "aliases";
|
|
13263
|
+
readonly type: "array";
|
|
13264
|
+
readonly itemType: "string";
|
|
13265
|
+
readonly required: false;
|
|
13266
|
+
readonly description: "Replacement alias list; an empty array clears the aliases and omitting the field keeps them.";
|
|
13267
|
+
}, {
|
|
13268
|
+
readonly name: "description";
|
|
13269
|
+
readonly type: "string";
|
|
13270
|
+
readonly required: false;
|
|
13271
|
+
readonly description: "Replacement profile, at most 500 characters; an explicit null clears it and omitting the field keeps it.";
|
|
13272
|
+
}];
|
|
13273
|
+
};
|
|
13274
|
+
}, {
|
|
13275
|
+
readonly resource: "ontology.nodes.merge";
|
|
13276
|
+
readonly method: "create";
|
|
13277
|
+
readonly summary: "Merge node";
|
|
13278
|
+
readonly description: "Fold a duplicate node into the node that should survive, when two records are discovered to be the same entity. The merged node's relations and aliases move to the survivor and later reads of the duplicate resolve to it. Send an Idempotency-Key header; repeating the same key replays the first result. Reversal is a staff operation, not available here.";
|
|
13279
|
+
readonly http: "POST";
|
|
13280
|
+
readonly path: "/ontology/v1/nodes/{node_id}/merge";
|
|
13281
|
+
readonly streaming: "no";
|
|
13282
|
+
readonly pagination: false;
|
|
13283
|
+
readonly pathParams: readonly [{
|
|
13284
|
+
readonly name: "node_id";
|
|
13285
|
+
readonly sdkName: "node_id";
|
|
13286
|
+
readonly description: "Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted.";
|
|
13287
|
+
}];
|
|
13288
|
+
readonly query: readonly [];
|
|
13289
|
+
readonly body: {
|
|
13290
|
+
readonly required: true;
|
|
13291
|
+
readonly fields: readonly [{
|
|
13292
|
+
readonly name: "into";
|
|
13293
|
+
readonly type: "string";
|
|
13294
|
+
readonly required: true;
|
|
13295
|
+
readonly description: "Node id that should survive, from nodes.list or search; the merged node's relations and aliases move to it.";
|
|
13296
|
+
}];
|
|
13297
|
+
};
|
|
13298
|
+
}, {
|
|
13299
|
+
readonly resource: "ontology.relations";
|
|
13300
|
+
readonly method: "list";
|
|
13301
|
+
readonly summary: "List relations";
|
|
13302
|
+
readonly description: "Read the facts in the graph and obtain relation ids for retrieval, invalidation or spreading. Filter by endpoint node, by type and by direction; as_of reads the relations as they were then. Invalidated relations are omitted unless include_invalid is true. limit is 1–100 and defaults to 50; follow next_cursor until it is null.";
|
|
13303
|
+
readonly http: "GET";
|
|
13304
|
+
readonly path: "/ontology/v1/relations";
|
|
13305
|
+
readonly streaming: "no";
|
|
13306
|
+
readonly pagination: true;
|
|
13307
|
+
readonly pathParams: readonly [];
|
|
13308
|
+
readonly query: readonly [{
|
|
13309
|
+
readonly name: "node";
|
|
13310
|
+
readonly type: "string";
|
|
13311
|
+
readonly required: false;
|
|
13312
|
+
readonly description: "A node id from nodes.list or nodes.create; returns the relations this node takes part in, narrowed by direction. Omit to list relations between every node.";
|
|
13313
|
+
}, {
|
|
13314
|
+
readonly name: "type";
|
|
13315
|
+
readonly type: "array";
|
|
13316
|
+
readonly itemType: "string";
|
|
13317
|
+
readonly required: false;
|
|
13318
|
+
readonly description: "Repeat to filter to any of several registered relation type names, for example type=references&type=serves; omit to list every type.";
|
|
13319
|
+
}, {
|
|
13320
|
+
readonly name: "direction";
|
|
13321
|
+
readonly type: "string";
|
|
13322
|
+
readonly enum: readonly ["out", "in", "both"];
|
|
13323
|
+
readonly required: false;
|
|
13324
|
+
readonly description: "Which side of node to follow; out returns relations the node is the source of, in returns those it is the target of. Only meaningful together with node.";
|
|
13325
|
+
}, {
|
|
13326
|
+
readonly name: "as_of";
|
|
13327
|
+
readonly type: "string";
|
|
13328
|
+
readonly required: false;
|
|
13329
|
+
readonly description: "ISO 8601 timestamp; read relations as they were then, so one recorded or invalidated later is judged by that time. Omit to read current state.";
|
|
13330
|
+
}, {
|
|
13331
|
+
readonly name: "include_invalid";
|
|
13332
|
+
readonly type: "boolean";
|
|
13333
|
+
readonly required: false;
|
|
13334
|
+
readonly description: "Set true to include relations whose invalid_at has passed, which is how a relation that stopped being true stays readable. Omit or false for currently valid relations only.";
|
|
13335
|
+
}, {
|
|
13336
|
+
readonly name: "limit";
|
|
13337
|
+
readonly type: "integer";
|
|
13338
|
+
readonly required: false;
|
|
13339
|
+
readonly description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100.";
|
|
13340
|
+
}, {
|
|
13341
|
+
readonly name: "cursor";
|
|
13342
|
+
readonly type: "string";
|
|
13343
|
+
readonly required: false;
|
|
13344
|
+
readonly description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null.";
|
|
13345
|
+
}];
|
|
13346
|
+
}, {
|
|
13347
|
+
readonly resource: "ontology.relations";
|
|
13348
|
+
readonly method: "create";
|
|
13349
|
+
readonly summary: "Create relation";
|
|
13350
|
+
readonly description: "Record one fact between two existing nodes, for a system mirroring a relationship it owns. type must be registered and must admit these endpoints; fact states the relationship in one sentence. Send an Idempotency-Key header; repeating the same key returns the first result instead of writing a second relation. This writes structure only — to give an agent something to remember, use POST /agent/v1/agents/{agent_id}/consolidations.";
|
|
13351
|
+
readonly http: "POST";
|
|
13352
|
+
readonly path: "/ontology/v1/relations";
|
|
13353
|
+
readonly streaming: "no";
|
|
13354
|
+
readonly pagination: false;
|
|
13355
|
+
readonly pathParams: readonly [];
|
|
13356
|
+
readonly query: readonly [];
|
|
13357
|
+
readonly body: {
|
|
13358
|
+
readonly required: true;
|
|
13359
|
+
readonly fields: readonly [{
|
|
13360
|
+
readonly name: "type";
|
|
13361
|
+
readonly type: "string";
|
|
13362
|
+
readonly required: true;
|
|
13363
|
+
readonly description: "Registered relation type name from types.list; it must admit both endpoints or the write is refused.";
|
|
13364
|
+
}, {
|
|
13365
|
+
readonly name: "source";
|
|
13366
|
+
readonly type: "string";
|
|
13367
|
+
readonly required: true;
|
|
13368
|
+
readonly description: "Node id the fact starts from, from nodes.list or nodes.create.";
|
|
13369
|
+
}, {
|
|
13370
|
+
readonly name: "target";
|
|
13371
|
+
readonly type: "string";
|
|
13372
|
+
readonly required: true;
|
|
13373
|
+
readonly description: "Node id the fact points at, from nodes.list or nodes.create.";
|
|
13374
|
+
}, {
|
|
13375
|
+
readonly name: "fact";
|
|
13376
|
+
readonly type: "string";
|
|
13377
|
+
readonly required: true;
|
|
13378
|
+
readonly description: "The relationship in one sentence, at most 280 characters, written to read back on its own.";
|
|
13379
|
+
}, {
|
|
13380
|
+
readonly name: "valid_at";
|
|
13381
|
+
readonly type: "string";
|
|
13382
|
+
readonly required: false;
|
|
13383
|
+
readonly description: "World time the fact became true, when the mirrored record dates it; omit to leave it undated.";
|
|
13384
|
+
}, {
|
|
13385
|
+
readonly name: "owner";
|
|
13386
|
+
readonly type: "string";
|
|
13387
|
+
readonly required: false;
|
|
13388
|
+
readonly description: "Member id whose content this fact is, restricting it to that member; omit or null for organization-wide.";
|
|
13389
|
+
}];
|
|
13390
|
+
};
|
|
13391
|
+
}, {
|
|
13392
|
+
readonly resource: "ontology.relations";
|
|
13393
|
+
readonly method: "retrieve";
|
|
13394
|
+
readonly summary: "Retrieve relation";
|
|
13395
|
+
readonly description: "Read one relation's fact and both of its clocks — valid_at and invalid_at for when it was true in the world, created_at and expired_at for when it was recorded and retired. An id from another organization, or one that never existed, answers ONTOLOGY_EDGE_NOT_FOUND.";
|
|
13396
|
+
readonly http: "GET";
|
|
13397
|
+
readonly path: "/ontology/v1/relations/{relation_id}";
|
|
13398
|
+
readonly streaming: "no";
|
|
13399
|
+
readonly pagination: false;
|
|
13400
|
+
readonly pathParams: readonly [{
|
|
13401
|
+
readonly name: "relation_id";
|
|
13402
|
+
readonly sdkName: "relation_id";
|
|
13403
|
+
readonly description: "Relation id returned by relations.list, relations.create or a changeset, in the form oed_ followed by 32 lowercase letters or digits; a node id is not accepted.";
|
|
13404
|
+
}];
|
|
13405
|
+
readonly query: readonly [];
|
|
13406
|
+
}, {
|
|
13407
|
+
readonly resource: "ontology.relations.invalidate";
|
|
13408
|
+
readonly method: "create";
|
|
13409
|
+
readonly summary: "Invalidate relation";
|
|
13410
|
+
readonly description: "Mark a relation as no longer true from a world time, when the mirrored record changed. The relation is kept — invalid_at moves and the relation still reads at an earlier as_of, so history stays answerable. Send an Idempotency-Key header; repeating the same key replays the first result. There is no delete.";
|
|
13411
|
+
readonly http: "POST";
|
|
13412
|
+
readonly path: "/ontology/v1/relations/{relation_id}/invalidate";
|
|
13413
|
+
readonly streaming: "no";
|
|
13414
|
+
readonly pagination: false;
|
|
13415
|
+
readonly pathParams: readonly [{
|
|
13416
|
+
readonly name: "relation_id";
|
|
13417
|
+
readonly sdkName: "relation_id";
|
|
13418
|
+
readonly description: "Relation id returned by relations.list, relations.create or a changeset, in the form oed_ followed by 32 lowercase letters or digits; a node id is not accepted.";
|
|
13419
|
+
}];
|
|
13420
|
+
readonly query: readonly [];
|
|
13421
|
+
readonly body: {
|
|
13422
|
+
readonly required: true;
|
|
13423
|
+
readonly fields: readonly [{
|
|
13424
|
+
readonly name: "invalid_at";
|
|
13425
|
+
readonly type: "string";
|
|
13426
|
+
readonly required: true;
|
|
13427
|
+
readonly description: "World time the fact stopped being true, in ISO 8601 UTC; reads at an earlier as_of still return the relation.";
|
|
13428
|
+
}, {
|
|
13429
|
+
readonly name: "superseded_by";
|
|
13430
|
+
readonly type: "string";
|
|
13431
|
+
readonly required: false;
|
|
13432
|
+
readonly description: "Relation id that replaces this one, when a successor was recorded; omit or null when nothing replaced it.";
|
|
13433
|
+
}, {
|
|
13434
|
+
readonly name: "reason";
|
|
13435
|
+
readonly type: "string";
|
|
13436
|
+
readonly required: false;
|
|
13437
|
+
readonly description: "Why it stopped being true, for people reading the history later; not enforced and safe to omit.";
|
|
13438
|
+
}];
|
|
13439
|
+
};
|
|
13440
|
+
}, {
|
|
13441
|
+
readonly resource: "ontology.search";
|
|
13442
|
+
readonly method: "create";
|
|
13443
|
+
readonly summary: "Search nodes";
|
|
13444
|
+
readonly description: "Resolve text to the nodes it most likely names, when a mirror holds a name and needs the node id it corresponds to. Results are ranked candidates, not an answer, each reporting whether the match came from the node's name, an alias, its description or a relation's fact. Narrow with types, and cap the result count with limit (1–50, default 20). This reads structure; it is not an agent recall — agents recall through POST /agent/v1/agents/{agent_id}/consolidations.";
|
|
13445
|
+
readonly http: "POST";
|
|
13446
|
+
readonly path: "/ontology/v1/search";
|
|
13447
|
+
readonly streaming: "no";
|
|
13448
|
+
readonly pagination: false;
|
|
13449
|
+
readonly pathParams: readonly [];
|
|
13450
|
+
readonly query: readonly [];
|
|
13451
|
+
readonly body: {
|
|
13452
|
+
readonly required: true;
|
|
13453
|
+
readonly fields: readonly [{
|
|
13454
|
+
readonly name: "text";
|
|
13455
|
+
readonly type: "string";
|
|
13456
|
+
readonly required: true;
|
|
13457
|
+
readonly description: "Text to find nodes for, matched against names, aliases, descriptions and relation facts; an empty string is refused.";
|
|
13458
|
+
}, {
|
|
13459
|
+
readonly name: "types";
|
|
13460
|
+
readonly type: "array";
|
|
13461
|
+
readonly itemType: "string";
|
|
13462
|
+
readonly required: false;
|
|
13463
|
+
readonly description: "Registered node type names to search within; omit to search every type.";
|
|
13464
|
+
}, {
|
|
13465
|
+
readonly name: "window";
|
|
13466
|
+
readonly type: "object";
|
|
13467
|
+
readonly required: false;
|
|
13468
|
+
readonly description: "Restrict matches to facts recorded within a period; omit to search all time.";
|
|
13469
|
+
}, {
|
|
13470
|
+
readonly name: "limit";
|
|
13471
|
+
readonly type: "integer";
|
|
13472
|
+
readonly required: false;
|
|
13473
|
+
readonly description: "Maximum candidate nodes to return, from 1 to 50; defaults to 20 when omitted.";
|
|
13474
|
+
}];
|
|
13475
|
+
};
|
|
13476
|
+
}, {
|
|
13477
|
+
readonly resource: "ontology.types";
|
|
13478
|
+
readonly method: "list";
|
|
13479
|
+
readonly summary: "List types";
|
|
13480
|
+
readonly description: "Read the node and relation types registered for this organization before writing, so a create names a type the graph accepts. Each entry is one registrant's registration with its owner, version and definitions. Types cannot be created at runtime; they are registered by the owning service at deploy time, so a type missing here is not available to write.";
|
|
13481
|
+
readonly http: "GET";
|
|
13482
|
+
readonly path: "/ontology/v1/types";
|
|
13483
|
+
readonly streaming: "no";
|
|
13484
|
+
readonly pagination: false;
|
|
13485
|
+
readonly pathParams: readonly [];
|
|
13486
|
+
readonly query: readonly [];
|
|
13487
|
+
}, {
|
|
13488
|
+
readonly resource: "ontology.types";
|
|
13489
|
+
readonly method: "create";
|
|
13490
|
+
readonly summary: "Register type";
|
|
13491
|
+
readonly description: "Register a node or relation type for this organization. Not open yet — this call currently answers 501 NOT_IMPLEMENTED and writes nothing, because a registration is checked and stored by the deploy gate that ships the registering service, not by a runtime call. Until it opens, read the types already in force with praxis.ontology.types.list and create records only of those types.";
|
|
13492
|
+
readonly http: "POST";
|
|
13493
|
+
readonly path: "/ontology/v1/types";
|
|
13494
|
+
readonly streaming: "no";
|
|
13495
|
+
readonly pagination: false;
|
|
13496
|
+
readonly pathParams: readonly [];
|
|
13497
|
+
readonly query: readonly [];
|
|
13498
|
+
readonly body: {
|
|
13499
|
+
readonly required: true;
|
|
13500
|
+
readonly fields: readonly [{
|
|
13501
|
+
readonly name: "owner";
|
|
13502
|
+
readonly type: "string";
|
|
13503
|
+
readonly required: true;
|
|
13504
|
+
readonly description: "Service that registered these types, for example file or ticket; it is the registrant a later change to a type is checked against.";
|
|
13505
|
+
}, {
|
|
13506
|
+
readonly name: "version";
|
|
13507
|
+
readonly type: "integer";
|
|
13508
|
+
readonly required: true;
|
|
13509
|
+
readonly description: "Monotonic version of this owner's registration; a later registration must extend this one without removing or narrowing anything.";
|
|
13510
|
+
}, {
|
|
13511
|
+
readonly name: "nodes";
|
|
13512
|
+
readonly type: "array";
|
|
13513
|
+
readonly itemType: "object";
|
|
13514
|
+
readonly required: true;
|
|
13515
|
+
readonly description: "Node types this owner registers.";
|
|
13516
|
+
}, {
|
|
13517
|
+
readonly name: "edges";
|
|
13518
|
+
readonly type: "array";
|
|
13519
|
+
readonly itemType: "object";
|
|
13520
|
+
readonly required: true;
|
|
13521
|
+
readonly description: "Relation types this owner registers.";
|
|
13522
|
+
}];
|
|
13523
|
+
};
|
|
13524
|
+
}, {
|
|
13525
|
+
readonly resource: "ontology.types";
|
|
13526
|
+
readonly method: "retrieve";
|
|
13527
|
+
readonly summary: "Retrieve type";
|
|
13528
|
+
readonly description: "Read one registered type's definition before writing a record of it, to learn whether it is a node or an edge, which endpoints an edge type admits, and which origins it accepts. The name comes from types.list; a name that is not registered answers ONTOLOGY_TYPE_UNKNOWN, and writes of that type are refused.";
|
|
13529
|
+
readonly http: "GET";
|
|
13530
|
+
readonly path: "/ontology/v1/types/{name}";
|
|
13531
|
+
readonly streaming: "no";
|
|
13532
|
+
readonly pagination: false;
|
|
13533
|
+
readonly pathParams: readonly [{
|
|
13534
|
+
readonly name: "name";
|
|
13535
|
+
readonly sdkName: "name";
|
|
13536
|
+
readonly description: "A type name from types.list, with its dots preserved — a display label is not accepted.";
|
|
13537
|
+
}];
|
|
13538
|
+
readonly query: readonly [];
|
|
12775
13539
|
}, {
|
|
12776
13540
|
readonly resource: "organization.charges";
|
|
12777
13541
|
readonly method: "list";
|
|
@@ -13067,6 +13831,27 @@ export declare const operations: readonly [{
|
|
|
13067
13831
|
readonly description: "Up to five attachments; decoded bytes must not exceed 10 MiB each or 20 MiB in total.";
|
|
13068
13832
|
}];
|
|
13069
13833
|
};
|
|
13834
|
+
}, {
|
|
13835
|
+
readonly resource: "organization.members";
|
|
13836
|
+
readonly method: "list";
|
|
13837
|
+
readonly summary: "List organization members";
|
|
13838
|
+
readonly description: "Concepts follow GitHub org members: find a person's user id, for example to assign an approver to an approval task. Lists only members of the organization behind your API key or runtime token, ordered by joined_at ascending (membership id breaks ties). Ask the user who should approve, then use that member's id. Emails are visible only within this organization. The request cannot select another organization. Pass next_page unchanged as page; null means the end. Read-only; no usage charge. Example: GET /organization/v1/members?limit=20.";
|
|
13839
|
+
readonly http: "GET";
|
|
13840
|
+
readonly path: "/organization/v1/members";
|
|
13841
|
+
readonly streaming: "no";
|
|
13842
|
+
readonly pagination: false;
|
|
13843
|
+
readonly pathParams: readonly [];
|
|
13844
|
+
readonly query: readonly [{
|
|
13845
|
+
readonly name: "limit";
|
|
13846
|
+
readonly type: "integer";
|
|
13847
|
+
readonly required: false;
|
|
13848
|
+
readonly description: "Maximum members per page, from 1 to 100; defaults to 20.";
|
|
13849
|
+
}, {
|
|
13850
|
+
readonly name: "page";
|
|
13851
|
+
readonly type: "string";
|
|
13852
|
+
readonly required: false;
|
|
13853
|
+
readonly description: "Opaque next_page cursor returned by the previous response; omit for the first page.";
|
|
13854
|
+
}];
|
|
13070
13855
|
}, {
|
|
13071
13856
|
readonly resource: "organization.usage";
|
|
13072
13857
|
readonly method: "list";
|
|
@@ -15098,7 +15883,7 @@ export declare const operations: readonly [{
|
|
|
15098
15883
|
readonly name: "filter";
|
|
15099
15884
|
readonly type: "string";
|
|
15100
15885
|
readonly required: false;
|
|
15101
|
-
readonly description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort;
|
|
15886
|
+
readonly description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort; write each qualifier as field:value (for example, is:open milestone:5), never field=value. Unknown qualifiers return INVALID_PARAMS. Passed unchanged to the service.";
|
|
15102
15887
|
}];
|
|
15103
15888
|
}, {
|
|
15104
15889
|
readonly resource: "ticket.tickets";
|
|
@@ -15992,7 +16777,7 @@ export declare const operations: readonly [{
|
|
|
15992
16777
|
readonly resource: "vault.vaults";
|
|
15993
16778
|
readonly method: "create";
|
|
15994
16779
|
readonly summary: "Create vault";
|
|
15995
|
-
readonly description: "Create an empty, active vault to hold credentials for your account, with a display name and optional metadata. Use its returned id as vault_id when creating secrets or OAuth authorizations.
|
|
16780
|
+
readonly description: "Create an empty, active vault to hold credentials for your account, with a display name and optional metadata. Use its returned id as vault_id when creating secrets or OAuth authorizations. Agent sessions and deployments accept up to 50 vault_ids and match their credentials against the session's MCP servers, so a stored static or oauth credential does serve as vault-backed MCP authentication; only environment_variable credentials are not yet placed, because the egress proxy ADR-058 §6 gives them is not built. Application vault references are also unavailable; praxis_vault_ref version bindings and secret writes with a vault source return 501, so creating a vault does not yet enable either consumer.";
|
|
15996
16781
|
readonly http: "POST";
|
|
15997
16782
|
readonly path: "/vault/v1/vaults";
|
|
15998
16783
|
readonly streaming: "no";
|