@deepraxis/cli 0.2.1-dev.7fcfb44 → 0.2.1-dev.8b0bba1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/COMMANDS.md +21 -1
- package/dist/praxis.js +1186 -119
- package/package.json +1 -1
package/dist/praxis.js
CHANGED
|
@@ -143,7 +143,7 @@ across all toolsets allowed.`
|
|
|
143
143
|
type: "array",
|
|
144
144
|
itemType: "object",
|
|
145
145
|
required: false,
|
|
146
|
-
description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or
|
|
146
|
+
description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time."
|
|
147
147
|
},
|
|
148
148
|
{
|
|
149
149
|
name: "kind",
|
|
@@ -10162,6 +10162,12 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10162
10162
|
type: "integer",
|
|
10163
10163
|
required: false,
|
|
10164
10164
|
description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write."
|
|
10165
|
+
},
|
|
10166
|
+
{
|
|
10167
|
+
name: "loudness",
|
|
10168
|
+
type: "object",
|
|
10169
|
+
required: false,
|
|
10170
|
+
description: "Optional loudness normalization target; normalization adds analysis and rendering work."
|
|
10165
10171
|
}
|
|
10166
10172
|
]
|
|
10167
10173
|
}
|
|
@@ -10170,7 +10176,7 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10170
10176
|
resource: "cut.projects.frames",
|
|
10171
10177
|
method: "list",
|
|
10172
10178
|
summary: "Render preview frames",
|
|
10173
|
-
description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution.
|
|
10179
|
+
description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution. The response always includes warnings; FRAME_UNAVAILABLE means a source preview could not be obtained and an offline tile was drawn. Its message identifies a timeout, delivery capacity limit, or unavailable source and contains no source URL. Decode each image's base64 payload to save it. Codemode returns at most four images per call, so request at most four times when reviewing there.",
|
|
10174
10180
|
http: "GET",
|
|
10175
10181
|
path: "/cut/v1/projects/{project_id}/frames",
|
|
10176
10182
|
streaming: "no",
|
|
@@ -10385,7 +10391,7 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10385
10391
|
resource: "cut.projects",
|
|
10386
10392
|
method: "execute",
|
|
10387
10393
|
summary: "Execute editing script",
|
|
10388
|
-
description: 'Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: `const t = AddTrack("video"); Insert(t, {type: "color", color: "#123456", start: 0, length: 3}); Print(t);`\n\n### Script function reference\n\nFunctions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. JoinId is the string returned by Join or read from GetTimeline().joins. Reads see earlier writes in the same script.\n\n```ts\nGetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;\nGetItem(id: ClipId): ItemView;\nFindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];\nGetMedia(ref: MediaRef): MediaInfo;\nGetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];\nGetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];\nListTransitions(): TransitionInfo[];\nInsert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;\nUpdate(id: ClipId, patch: ItemPatchView): void;\nSetSpeed(id: ClipId, rate: number, o: { keep: "source" | "duration"; ripple?: boolean }): { length: number; sourceOut: number };\nDelete(id: ClipId, o?: { ripple?: boolean }): void;\nJoin(left: ClipId, right: ClipId, o: { length?: number; effect: TransitionInput }): JoinId;\nUpdateJoin(id: JoinId, patch: { length?: number; effect?: TransitionInput }): void;\nDeleteJoin(id: JoinId): void;\nSplit(id: ClipId, at: number): ClipId;\nTrim(id: ClipId, edge: "in" | "out", delta: number, o?: { ripple?: boolean }): void;\nMove(id: ClipId, start: number, track?: TrackId): void;\nRippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;\nAddTrack(kind: "video" | "audio" | "caption", init?: { name?: string }, index?: number): TrackId;\nUpdateTrack(id: TrackId, patch: TrackPatch): void;\nDeleteTrack(id: TrackId): void;\nSetSettings(patch: Partial<ProjectSettingsView>): void;\nAddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle>; maxChars?: number }): ClipId[];\nSetMarker(at: number, label: string): string;\nPrint(...values: unknown[]): void;\nPreview(at: number[]): void;\n```\n\n| Functions | Behavior and arguments |\n| --- | --- |\n| GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, playback, sourceIn/sourceOut, text and offline reason. GetTimeline returns duration, tracks (id, kind, name, index, locked, items), and joins (id, track, left, right, length in seconds, normalized effect). from/to and tracks narrow the items and joins; joins are selected by their overlap window. |\n| ListTransitions | Discover the shared validation catalog: each entry contains kind (effect ID), name, description and params. Each parameter has name, type (enum/number/integer), default, description, enum values or numeric min/max. Use the returned kind and parameter names inside effect. |\n| FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |\n| GetMedia | Read metadata for `{libraryId, assetId}` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |\n| GetTranscript, GetAnalysis | Read available transcript words or silence/filler/scenes segments. Transcript filter from/to is seconds; returned word and segment from/to values are source microseconds (divide by 1,000,000 for editing). Words contain text and optional speaker/filler; segments may include label/confidence. Request analysis first if unavailable. |\n| Insert, Update, Delete | Insert returns the new clip ID; Update changes supplied fields; Delete removes the clip. Optional ripple on Insert/Delete closes or opens space on the track. |\n| SetSpeed | Change video/audio rate in 0.25–4; keep is required. source preserves consumed source and changes length, duration preserves output length. Returns actual length and sourceOut in seconds. Optional ripple explicitly shifts same-track followers when keeping source; otherwise overlaps are rejected. |\n| Join, UpdateJoin, DeleteJoin | Join creates an overlap between two butt-adjacent visual clips on the same track and returns its ID. length defaults to 0.5 seconds; effect is required. The right clip and all same-track followers move left by length, shortening that track and potentially the project. UpdateJoin moves those followers by the difference in length; omitted fields are preserved. DeleteJoin moves them right to restore the butt cut. Other tracks stay in place. |\n| Split, Trim, Move | Split at a timeline position and return the new right-hand clip ID. Trim changes the in or out edge by delta seconds. Move sets the timeline start and optionally a new track. |\n| RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |\n| AddTrack, UpdateTrack, DeleteTrack | Add video/audio/caption tracks; index selects layer order (0 is top). TrackPatch supports name, locked, hidden, muted, gainDb and style as appropriate to track kind. |\n| SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |\n| AddCaptionsFromTranscript | Create captions from an audio/video clip\'s kept words. Optional maxChars is 1–1000, default 16; style updates the caption track. Returns caption IDs. |\n| SetMarker | Add a label at a timeline time and return its ID. |\n| Print, Preview | Print appends text to prints. Preview requests up to eight times total per execute and puts images in the result\'s frames. Each url is an inline PNG data URL, not an HTTP image link. Decode the base64 payload to save an image. Codemode returns at most four images per call; request at most four times there. |\n\n#### Joins between clips\n\nEndpoints may be video, image, text, color or shape; audio and caption are rejected. Require 0 < length < each endpoint\'s length. Each clip allows at most one incoming and one outgoing join; their summed lengths cannot exceed its length. Three-input overlaps, nonadjacent endpoints and cross-track joins are rejected with OPS_REJECTED. Read the rejection\'s code and message, shorten or remove conflicting joins, and retry the saved edit.\n\nTransitionInput is an object with kind plus the parameters returned by ListTransitions; omitted parameters use the catalog defaults. Unknown kinds and unknown or invalid parameters are rejected. Effects: dissolve (no parameters); dip (color black/white, default black); push and wipe (direction left/right/up/down, default left); wipe also has softness 0–1, default 0; iris has centerX/centerY 0–1, both default 0.5; blinds has integer count 2–64, default 8, and orientation vertical/horizontal, default vertical; blur has radius 0–100 pixels at 1080-pixel frame height, default 24. Join options and UpdateJoin patches accept only length and effect. Effect updates replace the effect object and apply defaults for omitted parameters.\n\nMinimal example on an existing visual track with adjacent clips left and right: `Print(ListTransitions()); const j = Join(left, right, {length: 0.5, effect: {kind: "dissolve"}}); Print(GetTimeline().joins); Preview([GetItem(right).start + 0.25]);` Use `UpdateJoin(j, {length: 0.8})` to adjust it in a later edit or `DeleteJoin(j)` to restore the cut. Preview uses server-rendered frames and includes joins. Per-clip transitionIn/transitionOut remain separate entrance/exit effects.\n\n#### Insert fields (ItemInit)\n\nEvery item requires `type` and `start`. Times used for editing are seconds and snap to the project frame rate: start, length, sourceIn, fadeIn/fadeOut, transition length, keyframe at, reveal delay/stagger/duration. Keyframe and reveal times are relative to the clip start. Video/audio may omit length to use the remaining source duration; other types require length.\n\n| type | Required fields beyond type/start | Optional fields |\n| --- | --- | --- |\n| video | media | length, sourceIn, playback, volumeDb, transform, fit, animate, transitionIn, transitionOut |\n| image | media, length | transform, fit, animate, transitionIn, transitionOut |\n| text | text, length | style, transform, reveal, animate, transitionIn, transitionOut |\n| color | color, length | transform, fill, animate, transitionIn, transitionOut |\n| shape | shape, length, width, height, fill | radius, stroke, transform, animate, transitionIn, transitionOut |\n| audio | media | length, sourceIn, playback, volumeDb, fadeIn, fadeOut |\n| caption | text, length | — |\n\nVideo tracks accept video/image/text/color/shape; audio and caption tracks accept their corresponding type. Media is `{libraryId: string, assetId: string}` from a bound library. sourceIn defaults to 0, volumeDb to 0 dB, audio fades to 0 seconds. fit defaults to contain: contain fits the whole image, cover fills and crops, fill stretches, none keeps native dimensions.\n\n| Field | Value |\n| --- | --- |\n| transform | Partial `{x, y, scale, rotation, opacity, crop, blur}`. x/y are normalized canvas center coordinates (default 0.5); scale 1 is fitted size; rotation is degrees (default 0); opacity is 0–1 (default 1). crop is `{top,right,bottom,left}`. blur is 0–100 pixels at 1080-pixel frame height. |\n| style | Partial `{fontFamily, fontSize, fontWeight, color, stroke, background, align, maxWidth, position, margin}`. fontFamily: Geist or Noto Sans SC (default); fontSize defaults to 48; fontWeight: 400 (default), 500 or 700; color defaults to #FFFFFF; align: left, center (default), right; maxWidth is a fraction of canvas width (default 0.9). stroke is `{color,width}`. Text and captions support position (top/middle/bottom; box centers at 12%/50%/85% of height without margin) and optional margin (0–0.4 of canvas height, box edge distance for top/bottom; middle ignores it). Omitted position preserves the text transform (center by default); explicit position controls vertical placement, so omit it for y animation. Caption style additionally supports highlightColor and maxLines: 2. GetItem and GetTimeline return text style and current caption track style. Caption tracks only accept captions; use AddCaptionsFromTranscript, and place text on video tracks. |\n| animate | An object keyed by x, y, scale, rotation, opacity or blur. Each value is an array of `{at: number, value: number, ease?: Ease}` sorted by at with distinct frame-snapped times. Values hold before the first and after the last keyframe, overriding the static transform. |\n| Ease | linear, in, out, inOut, `{bezier: [x1,y1,x2,y2]}` or `{spring: {stiffness, damping, mass?}}`. Easing shapes the segment arriving at that keyframe; springs may overshoot. |\n| reveal | `{by, delay?: number, stagger: number, duration: number, from: {y?, opacity?, scale?, blur?}, ease?: Ease}`. by selects char, word or line. Unit k starts at delay + k * stagger and takes duration seconds to reach its resting state; from.y is a fraction of font size. |\n| fill | A color string (#RRGGBB or #RRGGBBAA), `{linear: {angle, stops: [{at,color}, ...]}}` or `{radial: {stops: [{at,color}, ...]}}`. Stop positions are 0–1; angle is degrees, 0 left to right. On color clips, fill replaces color when supplied. |\n| shape, width, height, radius, stroke | shape is rect or ellipse. width/height are fractions of canvas width/height before scaling. radius rounds rect corners in pixels at 1080-pixel frame height. stroke is `{color: string, width: number}`. |\n| transitionIn, transitionOut | `{kind, length: number}` at the clip\'s beginning/end. length is seconds. fade changes opacity; dissolve blends; push_left/push_right move horizontally; wipe_left reveals horizontally. |\n\n#### Update fields (ItemPatchView)\n\nAll fields are optional; use only fields relevant to the item\'s type. Supported fields: start, length, sourceIn, playback, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, animate, reveal, fill, stroke, shape, width, height, radius, transitionIn, transitionOut. Values and units match Insert. Set animate, reveal, fill, stroke, transitionIn or transitionOut to null to remove that effect; omitting a field preserves it. For example: `Update(id, {volumeDb: -12})` or `Update(id, {transitionIn: null})`.\n\n#### Speed, reverse and freeze\n\nVideo/audio Insert and Update accept playback as `{kind: "rate", rate: number, direction: "forward" | "reverse", audio: "preservePitch" | "resample" | "mute"}` or `{kind: "freeze"}`. Rate is finite and inclusive 0.25–4. Omitted playback defaults to 1× forward with preservePitch; supply the complete rate object when changing playback. preservePitch keeps pitch, resample changes pitch with speed, mute removes audio. Reverse requires explicit audio: "mute"; preservePitch/resample are rejected with UNSUPPORTED_PLAYBACK rather than silently muted. Freeze holds sourceIn and is silent. GetItem/GetTimeline echo playback and the source interval in seconds; sourceOut is exclusive even for reverse and equals sourceIn for freeze.\n\nUpdate of playback keeps output length unless length is also supplied. SetSpeed preserves direction/audio, rejects frozen and non-video/audio clips, and requires keep: "source" or "duration". keep: "source" computes round(consumed source / new rate × fps) frames, falling back to floor if rounding would exceed the source end; the returned length/sourceOut are actual frame-rounded seconds. keep: "duration" keeps output length and changes source consumption. Length conflicts fail with OVERLAP; move/shorten the conflicting clip, keep duration, or explicitly use ripple: true to shift following clips on the same track. Source overflow fails with OUT_OF_SOURCE; rate limits fail with RATE_OUT_OF_RANGE. Unknown playback fields and SetSpeed options are rejected with UNKNOWN_FIELD; options only accept keep and boolean ripple.\n\nExample for an existing four-second video/audio clip id: `Print(SetSpeed(id, 0.5, {keep: "source"})); Print(SetSpeed(id, 2, {keep: "source"}));` returns lengths 8 then 2, keeping the same source interval. Reverse: `Update(id, {playback: {kind: "rate", rate: 1, direction: "reverse", audio: "mute"}})`. Freeze: `Update(id, {playback: {kind: "freeze"}})`. Ensure enough source remains for the chosen length/rate. Browser reverse playback currently displays a placeholder; server-rendered Preview/frames and exports support reverse normally. Speed-adjusted audio is generated asynchronously after the edit transaction commits; exports wait for that audio before rendering.\n\n#### Script names versus HTTP response names\n\nUse camelCase inside scripts, including nested objects. HTTP request/response JSON outside script source uses snake_case. Map media.library_id → media.libraryId, media.asset_id → media.assetId, source_in → sourceIn, volume_db → volumeDb, fade_in/fade_out → fadeIn/fadeOut, transition_in/transition_out → transitionIn/transitionOut, font_family/font_size/font_weight/max_width → fontFamily/fontSize/fontWeight/maxWidth, gain_db → gainDb, highlight_color/max_lines → highlightColor/maxLines. Fields such as animate, reveal, fill, stroke, at and length retain their spelling. GetTimeline/GetItem already return camelCase compact views; the expanded retrieveTimeline HTTP response is not an Insert object.\n\nUnrecognized script fields fail with OPS_REJECTED and rejection code UNKNOWN_FIELD; snake_case mistakes suggest the corresponding camelCase name. The error message lists each rejection\'s #opIndex, code and reason. Correct the named fields and retry the saved edit; do not assume an ignored field applied an effect.\n',
|
|
10394
|
+
description: 'Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: `const t = AddTrack("video"); Insert(t, {type: "color", color: "#123456", start: 0, length: 3}); Print(t);`\n\n### Script function reference\n\nFunctions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. JoinId is the string returned by Join or read from GetTimeline().joins. Reads see earlier writes in the same script.\n\n```ts\nGetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;\nGetItem(id: ClipId): ItemView;\nFindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];\nGetMedia(ref: MediaRef): MediaInfo;\nGetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];\nGetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];\nListTransitions(): TransitionInfo[];\nListEffects(): EffectInfo[];\nListTextStyles(): TextStylePreset[];\nListTextTemplates(): TextTemplate[];\nListAnimations(): { id: string; version: number; phase: "in" | "out" | "loop"; target: "any" | "text"; name: string; description: string; defaultDuration: number; params: { name: string; type: string; values?: string[]; default?: string | number; min?: number; max?: number; description: string }[] }[];\nListFonts(): { family: string; weights: number[]; scripts: ("latin"|"cjk")[]; source: "bundled"|"catalog" }[];\nInsert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;\nUpdate(id: ClipId, patch: ItemPatchView): void;\nSetSpeed(id: ClipId, rate: number | { curve: { at: number; rate: number; ease?: Ease }[]; audio?: "mute" | "resample" }, o: { keep: "source" | "duration"; ripple?: boolean }): { length: number; sourceOut: number };\nDelete(id: ClipId, o?: { ripple?: boolean }): void;\nJoin(left: ClipId, right: ClipId, o: { length?: number; effect: TransitionInput }): JoinId;\nUpdateJoin(id: JoinId, patch: { length?: number; effect?: TransitionInput }): void;\nDeleteJoin(id: JoinId): void;\nSplit(id: ClipId, at: number): ClipId;\nTrim(id: ClipId, edge: "in" | "out", delta: number, o?: { ripple?: boolean }): void;\nMove(id: ClipId, start: number, track?: TrackId): void;\nRippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;\nAddTrack(kind: "video" | "audio" | "caption", init?: { name?: string; role?: "voice" | "music" | "sfx" }, index?: number): TrackId;\nUpdateTrack(id: TrackId, patch: TrackPatch): void;\nDeleteTrack(id: TrackId): void;\nSetSettings(patch: Partial<ProjectSettingsView>): void;\nAddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle> & { preset?: string }; maxChars?: number }): ClipId[];\nInsertTemplate(track: TrackId, o: { template: string; start: number; slots?: Record<string, string> }): ClipId[];\nAlignCaptions(trackId: TrackId, script: string, 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',
|
|
10389
10395
|
http: "POST",
|
|
10390
10396
|
path: "/cut/v1/projects/{project_id}:execute",
|
|
10391
10397
|
streaming: "no",
|
|
@@ -11630,7 +11636,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11630
11636
|
resource: "file.uploads",
|
|
11631
11637
|
method: "create",
|
|
11632
11638
|
summary: "Create an upload",
|
|
11633
|
-
description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most
|
|
11639
|
+
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.",
|
|
11634
11640
|
http: "POST",
|
|
11635
11641
|
path: "/file/v1/uploads",
|
|
11636
11642
|
streaming: "no",
|
|
@@ -11644,7 +11650,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11644
11650
|
name: "bytes",
|
|
11645
11651
|
type: "integer",
|
|
11646
11652
|
required: true,
|
|
11647
|
-
description: "Exact complete file length in bytes, from 1 through
|
|
11653
|
+
description: "Exact complete file length in bytes, from 1 through 21474836480 (20 GiB); the sum of completed parts must match."
|
|
11648
11654
|
},
|
|
11649
11655
|
{
|
|
11650
11656
|
name: "filename",
|
|
@@ -11688,7 +11694,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11688
11694
|
resource: "file.uploads",
|
|
11689
11695
|
method: "createSigned",
|
|
11690
11696
|
summary: "Create a one-time upload URL",
|
|
11691
|
-
description: "Upload a local file of up to
|
|
11697
|
+
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\"}.",
|
|
11692
11698
|
http: "POST",
|
|
11693
11699
|
path: "/file/v1/uploads/signed",
|
|
11694
11700
|
streaming: "no",
|
|
@@ -11708,7 +11714,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11708
11714
|
name: "bytes",
|
|
11709
11715
|
type: "integer",
|
|
11710
11716
|
required: true,
|
|
11711
|
-
description: "Exact local file size in bytes, from 1 through
|
|
11717
|
+
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."
|
|
11712
11718
|
},
|
|
11713
11719
|
{
|
|
11714
11720
|
name: "content_type",
|
|
@@ -11731,7 +11737,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11731
11737
|
name: "expires_in",
|
|
11732
11738
|
type: "integer",
|
|
11733
11739
|
required: false,
|
|
11734
|
-
description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or
|
|
11740
|
+
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."
|
|
11735
11741
|
},
|
|
11736
11742
|
{
|
|
11737
11743
|
name: "part_size",
|
|
@@ -11742,6 +11748,24 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11742
11748
|
]
|
|
11743
11749
|
}
|
|
11744
11750
|
},
|
|
11751
|
+
{
|
|
11752
|
+
resource: "file.uploads",
|
|
11753
|
+
method: "retrieve",
|
|
11754
|
+
summary: "Retrieve an upload",
|
|
11755
|
+
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.",
|
|
11756
|
+
http: "GET",
|
|
11757
|
+
path: "/file/v1/uploads/{upload_id}",
|
|
11758
|
+
streaming: "no",
|
|
11759
|
+
pagination: false,
|
|
11760
|
+
pathParams: [
|
|
11761
|
+
{
|
|
11762
|
+
name: "upload_id",
|
|
11763
|
+
sdkName: "upload_id",
|
|
11764
|
+
description: "Upload identifier returned by create; the upload must belong to your organization."
|
|
11765
|
+
}
|
|
11766
|
+
],
|
|
11767
|
+
query: []
|
|
11768
|
+
},
|
|
11745
11769
|
{
|
|
11746
11770
|
resource: "file.uploads",
|
|
11747
11771
|
method: "cancel",
|
|
@@ -11764,7 +11788,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11764
11788
|
resource: "file.uploads",
|
|
11765
11789
|
method: "complete",
|
|
11766
11790
|
summary: "Complete an upload",
|
|
11767
|
-
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.",
|
|
11791
|
+
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.",
|
|
11768
11792
|
http: "POST",
|
|
11769
11793
|
path: "/file/v1/uploads/{upload_id}/complete",
|
|
11770
11794
|
streaming: "no",
|
|
@@ -11800,7 +11824,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11800
11824
|
resource: "file.uploads.parts",
|
|
11801
11825
|
method: "create",
|
|
11802
11826
|
summary: "Add an upload part",
|
|
11803
|
-
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.",
|
|
11827
|
+
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.",
|
|
11804
11828
|
http: "POST",
|
|
11805
11829
|
path: "/file/v1/uploads/{upload_id}/parts",
|
|
11806
11830
|
streaming: "no",
|
|
@@ -12613,6 +12637,18 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12613
12637
|
],
|
|
12614
12638
|
query: []
|
|
12615
12639
|
},
|
|
12640
|
+
{
|
|
12641
|
+
resource: "media.generation.capabilities",
|
|
12642
|
+
method: "list",
|
|
12643
|
+
summary: "Get generation capabilities",
|
|
12644
|
+
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.",
|
|
12645
|
+
http: "GET",
|
|
12646
|
+
path: "/media/v1/generation/capabilities",
|
|
12647
|
+
streaming: "no",
|
|
12648
|
+
pagination: false,
|
|
12649
|
+
pathParams: [],
|
|
12650
|
+
query: []
|
|
12651
|
+
},
|
|
12616
12652
|
{
|
|
12617
12653
|
resource: "media.libraries",
|
|
12618
12654
|
method: "list",
|
|
@@ -12837,7 +12873,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12837
12873
|
resource: "media.libraries.assets",
|
|
12838
12874
|
method: "create",
|
|
12839
12875
|
summary: "Upload asset",
|
|
12840
|
-
description: " For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
12876
|
+
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.",
|
|
12841
12877
|
http: "POST",
|
|
12842
12878
|
path: "/media/v1/libraries/{library_id}/assets",
|
|
12843
12879
|
streaming: "no",
|
|
@@ -12961,7 +12997,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12961
12997
|
resource: "media.libraries.assets.import",
|
|
12962
12998
|
method: "create",
|
|
12963
12999
|
summary: "Import file",
|
|
12964
|
-
description: "Copy a File into an independent Media asset. New assets default to organization-private delivery (type=authenticated); explicitly set type=upload for public originals and derivatives. Omitting type on overwrite preserves the current type. Deleting the source File does not delete this copy. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
13000
|
+
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.",
|
|
12965
13001
|
http: "POST",
|
|
12966
13002
|
path: "/media/v1/libraries/{library_id}/assets/import",
|
|
12967
13003
|
streaming: "no",
|
|
@@ -13229,7 +13265,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13229
13265
|
resource: "media.libraries.assets.reprocess",
|
|
13230
13266
|
method: "create",
|
|
13231
13267
|
summary: "Reprocess asset",
|
|
13232
|
-
description: " For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
13268
|
+
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.",
|
|
13233
13269
|
http: "POST",
|
|
13234
13270
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess",
|
|
13235
13271
|
streaming: "no",
|
|
@@ -13328,7 +13364,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13328
13364
|
resource: "media.libraries.assets",
|
|
13329
13365
|
method: "batch",
|
|
13330
13366
|
summary: "Batch assets alias",
|
|
13331
|
-
description: 'Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
13367
|
+
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.',
|
|
13332
13368
|
http: "POST",
|
|
13333
13369
|
path: "/media/v1/libraries/{library_id}/assets:batch",
|
|
13334
13370
|
streaming: "no",
|
|
@@ -13363,7 +13399,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13363
13399
|
resource: "media.libraries.batches",
|
|
13364
13400
|
method: "create",
|
|
13365
13401
|
summary: "Create batch",
|
|
13366
|
-
description: 'Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
13402
|
+
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.',
|
|
13367
13403
|
http: "POST",
|
|
13368
13404
|
path: "/media/v1/libraries/{library_id}/batches",
|
|
13369
13405
|
streaming: "no",
|
|
@@ -13524,36 +13560,157 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13524
13560
|
}
|
|
13525
13561
|
]
|
|
13526
13562
|
},
|
|
13563
|
+
{
|
|
13564
|
+
resource: "media.libraries.generations",
|
|
13565
|
+
method: "create",
|
|
13566
|
+
summary: "Create video generation",
|
|
13567
|
+
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.",
|
|
13568
|
+
http: "POST",
|
|
13569
|
+
path: "/media/v1/libraries/{library_id}/generations",
|
|
13570
|
+
streaming: "no",
|
|
13571
|
+
pagination: false,
|
|
13572
|
+
pathParams: [
|
|
13573
|
+
{
|
|
13574
|
+
name: "library_id",
|
|
13575
|
+
sdkName: "library_id",
|
|
13576
|
+
description: "Library ID returned by creation."
|
|
13577
|
+
}
|
|
13578
|
+
],
|
|
13579
|
+
query: [],
|
|
13580
|
+
body: {
|
|
13581
|
+
required: true,
|
|
13582
|
+
fields: [
|
|
13583
|
+
{
|
|
13584
|
+
name: "intent",
|
|
13585
|
+
type: "string",
|
|
13586
|
+
required: true,
|
|
13587
|
+
description: "Generation operation; v1 accepts only video.generate text-to-video requests."
|
|
13588
|
+
},
|
|
13589
|
+
{
|
|
13590
|
+
name: "prompt",
|
|
13591
|
+
type: "string",
|
|
13592
|
+
required: true,
|
|
13593
|
+
description: "Text prompt describing the video to generate."
|
|
13594
|
+
},
|
|
13595
|
+
{
|
|
13596
|
+
name: "count",
|
|
13597
|
+
type: "integer",
|
|
13598
|
+
required: false,
|
|
13599
|
+
description: "Number of videos to generate; defaults to 1 and must be from 1 to 4."
|
|
13600
|
+
},
|
|
13601
|
+
{
|
|
13602
|
+
name: "duration_seconds",
|
|
13603
|
+
type: "integer",
|
|
13604
|
+
required: false,
|
|
13605
|
+
description: "Requested video duration in seconds; Router validates the model-specific supported durations."
|
|
13606
|
+
},
|
|
13607
|
+
{
|
|
13608
|
+
name: "aspect_ratio",
|
|
13609
|
+
type: "string",
|
|
13610
|
+
required: false,
|
|
13611
|
+
description: "Requested output aspect ratio; defaults to 16:9 and Router validates model support."
|
|
13612
|
+
},
|
|
13613
|
+
{
|
|
13614
|
+
name: "model",
|
|
13615
|
+
type: "string",
|
|
13616
|
+
required: false,
|
|
13617
|
+
description: "Router model with video_generation capability; defaults to wan2.7-t2v."
|
|
13618
|
+
},
|
|
13619
|
+
{
|
|
13620
|
+
name: "save",
|
|
13621
|
+
type: "string",
|
|
13622
|
+
enum: [
|
|
13623
|
+
"candidate",
|
|
13624
|
+
"library"
|
|
13625
|
+
],
|
|
13626
|
+
required: false,
|
|
13627
|
+
description: "candidate keeps outputs temporary for explicit save calls; library saves successful outputs automatically."
|
|
13628
|
+
},
|
|
13629
|
+
{
|
|
13630
|
+
name: "asset_folder",
|
|
13631
|
+
type: "string",
|
|
13632
|
+
required: false,
|
|
13633
|
+
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."
|
|
13634
|
+
},
|
|
13635
|
+
{
|
|
13636
|
+
name: "tags",
|
|
13637
|
+
type: "array",
|
|
13638
|
+
itemType: "string",
|
|
13639
|
+
required: false,
|
|
13640
|
+
description: "Tags applied when an output becomes a library asset."
|
|
13641
|
+
},
|
|
13642
|
+
{
|
|
13643
|
+
name: "understanding",
|
|
13644
|
+
type: "string",
|
|
13645
|
+
enum: [
|
|
13646
|
+
"auto",
|
|
13647
|
+
"skip"
|
|
13648
|
+
],
|
|
13649
|
+
required: false,
|
|
13650
|
+
description: "Understanding behavior when a candidate is saved as an asset; defaults to auto."
|
|
13651
|
+
},
|
|
13652
|
+
{
|
|
13653
|
+
name: "references",
|
|
13654
|
+
type: "array",
|
|
13655
|
+
itemType: "object",
|
|
13656
|
+
required: false,
|
|
13657
|
+
description: "Not supported in v1; omit this field. Only text-to-video is currently available."
|
|
13658
|
+
}
|
|
13659
|
+
]
|
|
13660
|
+
}
|
|
13661
|
+
},
|
|
13527
13662
|
{
|
|
13528
13663
|
resource: "media.libraries.jobs",
|
|
13529
|
-
method: "
|
|
13530
|
-
summary: "
|
|
13531
|
-
description: "
|
|
13664
|
+
method: "list",
|
|
13665
|
+
summary: "List jobs",
|
|
13666
|
+
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.",
|
|
13532
13667
|
http: "GET",
|
|
13533
|
-
path: "/media/v1/libraries/{library_id}/jobs
|
|
13668
|
+
path: "/media/v1/libraries/{library_id}/jobs",
|
|
13534
13669
|
streaming: "no",
|
|
13535
|
-
pagination:
|
|
13670
|
+
pagination: true,
|
|
13536
13671
|
pathParams: [
|
|
13537
13672
|
{
|
|
13538
13673
|
name: "library_id",
|
|
13539
13674
|
sdkName: "library_id",
|
|
13540
13675
|
description: "Library ID returned by creation."
|
|
13676
|
+
}
|
|
13677
|
+
],
|
|
13678
|
+
query: [
|
|
13679
|
+
{
|
|
13680
|
+
name: "status",
|
|
13681
|
+
type: "string",
|
|
13682
|
+
enum: [
|
|
13683
|
+
"queued",
|
|
13684
|
+
"running",
|
|
13685
|
+
"completed",
|
|
13686
|
+
"completed_with_errors",
|
|
13687
|
+
"failed",
|
|
13688
|
+
"cancelled"
|
|
13689
|
+
],
|
|
13690
|
+
required: false,
|
|
13691
|
+
description: "Filter jobs by their current status."
|
|
13541
13692
|
},
|
|
13542
13693
|
{
|
|
13543
|
-
name: "
|
|
13544
|
-
|
|
13545
|
-
|
|
13694
|
+
name: "limit",
|
|
13695
|
+
type: "integer",
|
|
13696
|
+
required: false,
|
|
13697
|
+
description: "Maximum entries in this page, from 1 through 100; defaults to 100."
|
|
13698
|
+
},
|
|
13699
|
+
{
|
|
13700
|
+
name: "cursor",
|
|
13701
|
+
type: "string",
|
|
13702
|
+
required: false,
|
|
13703
|
+
description: "Job id from the previous page’s next_cursor; omit for the first page."
|
|
13546
13704
|
}
|
|
13547
|
-
]
|
|
13548
|
-
query: []
|
|
13705
|
+
]
|
|
13549
13706
|
},
|
|
13550
13707
|
{
|
|
13551
|
-
resource: "media.libraries.
|
|
13552
|
-
method: "
|
|
13553
|
-
summary: "
|
|
13554
|
-
description: "
|
|
13555
|
-
http: "
|
|
13556
|
-
path: "/media/v1/libraries/{library_id}/
|
|
13708
|
+
resource: "media.libraries.jobs",
|
|
13709
|
+
method: "retrieve",
|
|
13710
|
+
summary: "Get job",
|
|
13711
|
+
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.",
|
|
13712
|
+
http: "GET",
|
|
13713
|
+
path: "/media/v1/libraries/{library_id}/jobs/{job_id}",
|
|
13557
13714
|
streaming: "no",
|
|
13558
13715
|
pagination: false,
|
|
13559
13716
|
pathParams: [
|
|
@@ -13561,17 +13718,22 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13561
13718
|
name: "library_id",
|
|
13562
13719
|
sdkName: "library_id",
|
|
13563
13720
|
description: "Library ID returned by creation."
|
|
13721
|
+
},
|
|
13722
|
+
{
|
|
13723
|
+
name: "job_id",
|
|
13724
|
+
sdkName: "job_id",
|
|
13725
|
+
description: "Job identifier returned by batch creation, video-generation creation or job listing; resolved within this library."
|
|
13564
13726
|
}
|
|
13565
13727
|
],
|
|
13566
13728
|
query: []
|
|
13567
13729
|
},
|
|
13568
13730
|
{
|
|
13569
|
-
resource: "media.libraries",
|
|
13570
|
-
method: "
|
|
13571
|
-
summary: "
|
|
13572
|
-
description: "
|
|
13731
|
+
resource: "media.libraries.jobs",
|
|
13732
|
+
method: "cancel",
|
|
13733
|
+
summary: "Cancel job",
|
|
13734
|
+
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.",
|
|
13573
13735
|
http: "POST",
|
|
13574
|
-
path: "/media/v1/libraries/{library_id}/
|
|
13736
|
+
path: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
|
|
13575
13737
|
streaming: "no",
|
|
13576
13738
|
pagination: false,
|
|
13577
13739
|
pathParams: [
|
|
@@ -13579,17 +13741,22 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13579
13741
|
name: "library_id",
|
|
13580
13742
|
sdkName: "library_id",
|
|
13581
13743
|
description: "Library ID returned by creation."
|
|
13744
|
+
},
|
|
13745
|
+
{
|
|
13746
|
+
name: "job_id",
|
|
13747
|
+
sdkName: "job_id",
|
|
13748
|
+
description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
|
|
13582
13749
|
}
|
|
13583
13750
|
],
|
|
13584
13751
|
query: []
|
|
13585
13752
|
},
|
|
13586
13753
|
{
|
|
13587
|
-
resource: "media.libraries.
|
|
13754
|
+
resource: "media.libraries.jobs.outputs.save",
|
|
13588
13755
|
method: "create",
|
|
13589
|
-
summary: "
|
|
13590
|
-
description: "
|
|
13756
|
+
summary: "Save generation output",
|
|
13757
|
+
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.",
|
|
13591
13758
|
http: "POST",
|
|
13592
|
-
path: "/media/v1/libraries/{library_id}/
|
|
13759
|
+
path: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
|
|
13593
13760
|
streaming: "no",
|
|
13594
13761
|
pagination: false,
|
|
13595
13762
|
pathParams: [
|
|
@@ -13597,50 +13764,61 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13597
13764
|
name: "library_id",
|
|
13598
13765
|
sdkName: "library_id",
|
|
13599
13766
|
description: "Library ID returned by creation."
|
|
13767
|
+
},
|
|
13768
|
+
{
|
|
13769
|
+
name: "job_id",
|
|
13770
|
+
sdkName: "job_id",
|
|
13771
|
+
description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
|
|
13772
|
+
},
|
|
13773
|
+
{
|
|
13774
|
+
name: "index",
|
|
13775
|
+
sdkName: "index",
|
|
13776
|
+
description: "Zero-based position of the candidate in the Job outputs array."
|
|
13600
13777
|
}
|
|
13601
13778
|
],
|
|
13602
13779
|
query: [],
|
|
13603
13780
|
body: {
|
|
13604
|
-
required:
|
|
13781
|
+
required: false,
|
|
13605
13782
|
fields: [
|
|
13606
13783
|
{
|
|
13607
|
-
name: "
|
|
13784
|
+
name: "public_id",
|
|
13608
13785
|
type: "string",
|
|
13609
|
-
required:
|
|
13610
|
-
description: "
|
|
13786
|
+
required: false,
|
|
13787
|
+
description: "Delivery identifier for the saved asset; defaults to gen_<job_id>_<index> and is idempotent."
|
|
13611
13788
|
},
|
|
13612
13789
|
{
|
|
13613
|
-
name: "
|
|
13790
|
+
name: "asset_folder",
|
|
13614
13791
|
type: "string",
|
|
13615
13792
|
required: false,
|
|
13616
|
-
description: "
|
|
13793
|
+
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."
|
|
13617
13794
|
},
|
|
13618
13795
|
{
|
|
13619
|
-
name: "
|
|
13620
|
-
type: "
|
|
13796
|
+
name: "tags",
|
|
13797
|
+
type: "array",
|
|
13798
|
+
itemType: "string",
|
|
13621
13799
|
required: false,
|
|
13622
|
-
description: "
|
|
13800
|
+
description: "Tags to apply to the saved asset."
|
|
13623
13801
|
},
|
|
13624
13802
|
{
|
|
13625
|
-
name: "
|
|
13803
|
+
name: "understanding",
|
|
13626
13804
|
type: "string",
|
|
13627
13805
|
enum: [
|
|
13628
|
-
"
|
|
13629
|
-
"
|
|
13806
|
+
"auto",
|
|
13807
|
+
"skip"
|
|
13630
13808
|
],
|
|
13631
13809
|
required: false,
|
|
13632
|
-
description: "
|
|
13810
|
+
description: "Understanding behavior for the saved asset; defaults to auto."
|
|
13633
13811
|
}
|
|
13634
13812
|
]
|
|
13635
13813
|
}
|
|
13636
13814
|
},
|
|
13637
13815
|
{
|
|
13638
|
-
resource: "media.libraries.
|
|
13816
|
+
resource: "media.libraries.purge",
|
|
13639
13817
|
method: "create",
|
|
13640
|
-
summary: "
|
|
13641
|
-
description: "
|
|
13818
|
+
summary: "Purge library",
|
|
13819
|
+
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.",
|
|
13642
13820
|
http: "POST",
|
|
13643
|
-
path: "/media/v1/libraries/{library_id}/
|
|
13821
|
+
path: "/media/v1/libraries/{library_id}/purge",
|
|
13644
13822
|
streaming: "no",
|
|
13645
13823
|
pagination: false,
|
|
13646
13824
|
pathParams: [
|
|
@@ -13650,69 +13828,156 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13650
13828
|
description: "Library ID returned by creation."
|
|
13651
13829
|
}
|
|
13652
13830
|
],
|
|
13653
|
-
query: []
|
|
13654
|
-
body: {
|
|
13655
|
-
required: true,
|
|
13656
|
-
fields: [
|
|
13657
|
-
{
|
|
13658
|
-
name: "expression",
|
|
13659
|
-
type: "string",
|
|
13660
|
-
required: false,
|
|
13661
|
-
description: 'Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets. For business metadata use context.sku=KETTLE-RED AND context.revision=2; request with_field: ["context"] to include context. Quality filters: flags:watermark matches any current shot with a watermark; flags.watermark:false requires an assessed video with no positive watermark judgment. The same syntax supports slideshow, hand_frame, text_sticker and low_quality. folder_mismatch:true selects lexical folder/location hints. Geometry filters support width, height, resolution:1920x1080, numeric aspect_ratio (width/height), and orientation:landscape, portrait or square. Missing geometry or unassessed legacy flags do not match positive filters. has_music:true AND audio_genre:jazz AND audio_mood:calm selects current-version audio profiles with music and matching model labels; has_music:false applies only to sampled ranges, not the entire source. failure_code=UPSTREAM_FAILED selects assets with a current failed understanding carrying that code; combine with processing_state=failed or processing_state=partial.'
|
|
13662
|
-
},
|
|
13663
|
-
{
|
|
13664
|
-
name: "sort_by",
|
|
13665
|
-
type: "array",
|
|
13666
|
-
itemType: "object",
|
|
13667
|
-
required: false,
|
|
13668
|
-
description: "Ordered list of single-field sort objects. Allowed fields are created_at, public_id, display_name, bytes and uploaded_at; directions are asc or desc. Fields cannot repeat. Defaults to created_at descending."
|
|
13669
|
-
},
|
|
13670
|
-
{
|
|
13671
|
-
name: "max_results",
|
|
13672
|
-
type: "integer",
|
|
13673
|
-
required: false,
|
|
13674
|
-
description: "Maximum assets per page, from 1 to 500; defaults to 100."
|
|
13675
|
-
},
|
|
13676
|
-
{
|
|
13677
|
-
name: "next_cursor",
|
|
13678
|
-
type: "string",
|
|
13679
|
-
required: false,
|
|
13680
|
-
description: "Continuation token returned by the previous expression-search page. Keep sort_by unchanged when continuing."
|
|
13681
|
-
},
|
|
13682
|
-
{
|
|
13683
|
-
name: "with_field",
|
|
13684
|
-
type: "array",
|
|
13685
|
-
itemType: "string",
|
|
13686
|
-
enum: [
|
|
13687
|
-
"tags",
|
|
13688
|
-
"context"
|
|
13689
|
-
],
|
|
13690
|
-
required: false,
|
|
13691
|
-
description: "Additional resource fields to include: tags adds asset labels and context adds custom metadata. Both are omitted unless requested."
|
|
13692
|
-
},
|
|
13693
|
-
{
|
|
13694
|
-
name: "aggregate",
|
|
13695
|
-
type: "array",
|
|
13696
|
-
itemType: "string",
|
|
13697
|
-
enum: [
|
|
13698
|
-
"resource_type",
|
|
13699
|
-
"format",
|
|
13700
|
-
"asset_folder",
|
|
13701
|
-
"processing_state"
|
|
13702
|
-
],
|
|
13703
|
-
required: false,
|
|
13704
|
-
description: "Facets to count over matching assets, returned under aggregations."
|
|
13705
|
-
}
|
|
13706
|
-
]
|
|
13707
|
-
}
|
|
13831
|
+
query: []
|
|
13708
13832
|
},
|
|
13709
13833
|
{
|
|
13710
|
-
resource: "media.libraries
|
|
13834
|
+
resource: "media.libraries",
|
|
13835
|
+
method: "restore",
|
|
13836
|
+
summary: "Restore library",
|
|
13837
|
+
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.",
|
|
13838
|
+
http: "POST",
|
|
13839
|
+
path: "/media/v1/libraries/{library_id}/restore",
|
|
13840
|
+
streaming: "no",
|
|
13841
|
+
pagination: false,
|
|
13842
|
+
pathParams: [
|
|
13843
|
+
{
|
|
13844
|
+
name: "library_id",
|
|
13845
|
+
sdkName: "library_id",
|
|
13846
|
+
description: "Library ID returned by creation."
|
|
13847
|
+
}
|
|
13848
|
+
],
|
|
13849
|
+
query: []
|
|
13850
|
+
},
|
|
13851
|
+
{
|
|
13852
|
+
resource: "media.libraries.search",
|
|
13711
13853
|
method: "create",
|
|
13712
|
-
summary: "Semantic search",
|
|
13713
|
-
description: "
|
|
13854
|
+
summary: "Semantic search alias",
|
|
13855
|
+
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.",
|
|
13714
13856
|
http: "POST",
|
|
13715
|
-
path: "/media/v1/libraries/{library_id}/search
|
|
13857
|
+
path: "/media/v1/libraries/{library_id}/search",
|
|
13858
|
+
streaming: "no",
|
|
13859
|
+
pagination: false,
|
|
13860
|
+
pathParams: [
|
|
13861
|
+
{
|
|
13862
|
+
name: "library_id",
|
|
13863
|
+
sdkName: "library_id",
|
|
13864
|
+
description: "Library ID returned by creation."
|
|
13865
|
+
}
|
|
13866
|
+
],
|
|
13867
|
+
query: [],
|
|
13868
|
+
body: {
|
|
13869
|
+
required: true,
|
|
13870
|
+
fields: [
|
|
13871
|
+
{
|
|
13872
|
+
name: "query",
|
|
13873
|
+
type: "string",
|
|
13874
|
+
required: true,
|
|
13875
|
+
description: "Nonblank text to search against asset content and metadata."
|
|
13876
|
+
},
|
|
13877
|
+
{
|
|
13878
|
+
name: "filter",
|
|
13879
|
+
type: "string",
|
|
13880
|
+
required: false,
|
|
13881
|
+
description: "Optional expression filter restricting eligible assets; uses the expression-search syntax."
|
|
13882
|
+
},
|
|
13883
|
+
{
|
|
13884
|
+
name: "top_k",
|
|
13885
|
+
type: "integer",
|
|
13886
|
+
required: false,
|
|
13887
|
+
description: "Maximum search hits, from 1 to 50; defaults to 20."
|
|
13888
|
+
},
|
|
13889
|
+
{
|
|
13890
|
+
name: "mode",
|
|
13891
|
+
type: "string",
|
|
13892
|
+
enum: [
|
|
13893
|
+
"hybrid",
|
|
13894
|
+
"semantic"
|
|
13895
|
+
],
|
|
13896
|
+
required: false,
|
|
13897
|
+
description: "Ranking mode: hybrid combines semantic and keyword matches; semantic uses vector similarity only. Defaults to hybrid."
|
|
13898
|
+
}
|
|
13899
|
+
]
|
|
13900
|
+
}
|
|
13901
|
+
},
|
|
13902
|
+
{
|
|
13903
|
+
resource: "media.libraries.search.expression",
|
|
13904
|
+
method: "create",
|
|
13905
|
+
summary: "Expression search",
|
|
13906
|
+
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.",
|
|
13907
|
+
http: "POST",
|
|
13908
|
+
path: "/media/v1/libraries/{library_id}/search/expression",
|
|
13909
|
+
streaming: "no",
|
|
13910
|
+
pagination: false,
|
|
13911
|
+
pathParams: [
|
|
13912
|
+
{
|
|
13913
|
+
name: "library_id",
|
|
13914
|
+
sdkName: "library_id",
|
|
13915
|
+
description: "Library ID returned by creation."
|
|
13916
|
+
}
|
|
13917
|
+
],
|
|
13918
|
+
query: [],
|
|
13919
|
+
body: {
|
|
13920
|
+
required: true,
|
|
13921
|
+
fields: [
|
|
13922
|
+
{
|
|
13923
|
+
name: "expression",
|
|
13924
|
+
type: "string",
|
|
13925
|
+
required: false,
|
|
13926
|
+
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.'
|
|
13927
|
+
},
|
|
13928
|
+
{
|
|
13929
|
+
name: "sort_by",
|
|
13930
|
+
type: "array",
|
|
13931
|
+
itemType: "object",
|
|
13932
|
+
required: false,
|
|
13933
|
+
description: "Ordered list of single-field sort objects. Allowed fields are created_at, public_id, display_name, bytes and uploaded_at; directions are asc or desc. Fields cannot repeat. Defaults to created_at descending."
|
|
13934
|
+
},
|
|
13935
|
+
{
|
|
13936
|
+
name: "max_results",
|
|
13937
|
+
type: "integer",
|
|
13938
|
+
required: false,
|
|
13939
|
+
description: "Maximum assets per page, from 1 to 500; defaults to 100."
|
|
13940
|
+
},
|
|
13941
|
+
{
|
|
13942
|
+
name: "next_cursor",
|
|
13943
|
+
type: "string",
|
|
13944
|
+
required: false,
|
|
13945
|
+
description: "Continuation token returned by the previous expression-search page. Keep sort_by unchanged when continuing."
|
|
13946
|
+
},
|
|
13947
|
+
{
|
|
13948
|
+
name: "with_field",
|
|
13949
|
+
type: "array",
|
|
13950
|
+
itemType: "string",
|
|
13951
|
+
enum: [
|
|
13952
|
+
"tags",
|
|
13953
|
+
"context"
|
|
13954
|
+
],
|
|
13955
|
+
required: false,
|
|
13956
|
+
description: "Additional resource fields to include: tags adds asset labels and context adds custom metadata. Both are omitted unless requested."
|
|
13957
|
+
},
|
|
13958
|
+
{
|
|
13959
|
+
name: "aggregate",
|
|
13960
|
+
type: "array",
|
|
13961
|
+
itemType: "string",
|
|
13962
|
+
enum: [
|
|
13963
|
+
"resource_type",
|
|
13964
|
+
"format",
|
|
13965
|
+
"asset_folder",
|
|
13966
|
+
"processing_state"
|
|
13967
|
+
],
|
|
13968
|
+
required: false,
|
|
13969
|
+
description: "Facets to count over matching assets, returned under aggregations."
|
|
13970
|
+
}
|
|
13971
|
+
]
|
|
13972
|
+
}
|
|
13973
|
+
},
|
|
13974
|
+
{
|
|
13975
|
+
resource: "media.libraries.search.semantic",
|
|
13976
|
+
method: "create",
|
|
13977
|
+
summary: "Semantic search",
|
|
13978
|
+
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.",
|
|
13979
|
+
http: "POST",
|
|
13980
|
+
path: "/media/v1/libraries/{library_id}/search/semantic",
|
|
13716
13981
|
streaming: "no",
|
|
13717
13982
|
pagination: false,
|
|
13718
13983
|
pathParams: [
|
|
@@ -16347,6 +16612,539 @@ for more details.`
|
|
|
16347
16612
|
],
|
|
16348
16613
|
query: []
|
|
16349
16614
|
},
|
|
16615
|
+
{
|
|
16616
|
+
resource: "ontology.changesets",
|
|
16617
|
+
method: "create",
|
|
16618
|
+
summary: "Apply changeset",
|
|
16619
|
+
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.",
|
|
16620
|
+
http: "POST",
|
|
16621
|
+
path: "/ontology/v1/changesets",
|
|
16622
|
+
streaming: "no",
|
|
16623
|
+
pagination: false,
|
|
16624
|
+
pathParams: [],
|
|
16625
|
+
query: [],
|
|
16626
|
+
body: {
|
|
16627
|
+
required: true,
|
|
16628
|
+
fields: [
|
|
16629
|
+
{
|
|
16630
|
+
name: "at",
|
|
16631
|
+
type: "string",
|
|
16632
|
+
required: true,
|
|
16633
|
+
description: "World time the batch describes, in ISO 8601 UTC; operations without their own time are dated by it."
|
|
16634
|
+
},
|
|
16635
|
+
{
|
|
16636
|
+
name: "scope",
|
|
16637
|
+
type: "string",
|
|
16638
|
+
required: false,
|
|
16639
|
+
description: "Scope the batch came from, normally the session id it was observed in; it is stored with the operations for later reading."
|
|
16640
|
+
},
|
|
16641
|
+
{
|
|
16642
|
+
name: "ops",
|
|
16643
|
+
type: "array",
|
|
16644
|
+
itemType: "object",
|
|
16645
|
+
required: true,
|
|
16646
|
+
description: "At most 500 operations, applied in order; each names its kind in op and the fields that kind requires."
|
|
16647
|
+
}
|
|
16648
|
+
]
|
|
16649
|
+
}
|
|
16650
|
+
},
|
|
16651
|
+
{
|
|
16652
|
+
resource: "ontology.nodes",
|
|
16653
|
+
method: "list",
|
|
16654
|
+
summary: "List nodes",
|
|
16655
|
+
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.",
|
|
16656
|
+
http: "GET",
|
|
16657
|
+
path: "/ontology/v1/nodes",
|
|
16658
|
+
streaming: "no",
|
|
16659
|
+
pagination: true,
|
|
16660
|
+
pathParams: [],
|
|
16661
|
+
query: [
|
|
16662
|
+
{
|
|
16663
|
+
name: "type",
|
|
16664
|
+
type: "array",
|
|
16665
|
+
itemType: "string",
|
|
16666
|
+
required: false,
|
|
16667
|
+
description: "Repeat to filter to any of several registered node type names, for example type=file&type=ticket; omit to list every type."
|
|
16668
|
+
},
|
|
16669
|
+
{
|
|
16670
|
+
name: "q",
|
|
16671
|
+
type: "string",
|
|
16672
|
+
required: false,
|
|
16673
|
+
description: "Free text matched against node names, aliases and descriptions; omit to list without a text filter."
|
|
16674
|
+
},
|
|
16675
|
+
{
|
|
16676
|
+
name: "owner",
|
|
16677
|
+
type: "string",
|
|
16678
|
+
required: false,
|
|
16679
|
+
description: "Filter to nodes owned by this member id, or omit to list nodes of every owner; organization-wide nodes carry no owner."
|
|
16680
|
+
},
|
|
16681
|
+
{
|
|
16682
|
+
name: "as_of",
|
|
16683
|
+
type: "string",
|
|
16684
|
+
required: false,
|
|
16685
|
+
description: "ISO 8601 timestamp; return the graph as it was then, so a node recorded later is absent. Omit to read current state."
|
|
16686
|
+
},
|
|
16687
|
+
{
|
|
16688
|
+
name: "limit",
|
|
16689
|
+
type: "integer",
|
|
16690
|
+
required: false,
|
|
16691
|
+
description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100."
|
|
16692
|
+
},
|
|
16693
|
+
{
|
|
16694
|
+
name: "cursor",
|
|
16695
|
+
type: "string",
|
|
16696
|
+
required: false,
|
|
16697
|
+
description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
|
|
16698
|
+
}
|
|
16699
|
+
]
|
|
16700
|
+
},
|
|
16701
|
+
{
|
|
16702
|
+
resource: "ontology.nodes",
|
|
16703
|
+
method: "create",
|
|
16704
|
+
summary: "Create node",
|
|
16705
|
+
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.",
|
|
16706
|
+
http: "POST",
|
|
16707
|
+
path: "/ontology/v1/nodes",
|
|
16708
|
+
streaming: "no",
|
|
16709
|
+
pagination: false,
|
|
16710
|
+
pathParams: [],
|
|
16711
|
+
query: [],
|
|
16712
|
+
body: {
|
|
16713
|
+
required: true,
|
|
16714
|
+
fields: [
|
|
16715
|
+
{
|
|
16716
|
+
name: "type",
|
|
16717
|
+
type: "string",
|
|
16718
|
+
required: true,
|
|
16719
|
+
description: "Registered node type name from types.list; an unregistered name is refused and nothing is written."
|
|
16720
|
+
},
|
|
16721
|
+
{
|
|
16722
|
+
name: "ref",
|
|
16723
|
+
type: "string",
|
|
16724
|
+
required: false,
|
|
16725
|
+
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."
|
|
16726
|
+
},
|
|
16727
|
+
{
|
|
16728
|
+
name: "name",
|
|
16729
|
+
type: "string",
|
|
16730
|
+
required: true,
|
|
16731
|
+
description: "Display name of the entity, at most 200 characters."
|
|
16732
|
+
},
|
|
16733
|
+
{
|
|
16734
|
+
name: "aliases",
|
|
16735
|
+
type: "array",
|
|
16736
|
+
itemType: "string",
|
|
16737
|
+
required: false,
|
|
16738
|
+
description: "Other names this entity is known by; they are matched by search alongside the name."
|
|
16739
|
+
},
|
|
16740
|
+
{
|
|
16741
|
+
name: "description",
|
|
16742
|
+
type: "string",
|
|
16743
|
+
required: false,
|
|
16744
|
+
description: "Profile of the entity, at most 500 characters; omit or null for none."
|
|
16745
|
+
},
|
|
16746
|
+
{
|
|
16747
|
+
name: "owner",
|
|
16748
|
+
type: "string",
|
|
16749
|
+
required: false,
|
|
16750
|
+
description: "Member id whose content this is, restricting it to that member; omit or null to make it readable organization-wide."
|
|
16751
|
+
}
|
|
16752
|
+
]
|
|
16753
|
+
}
|
|
16754
|
+
},
|
|
16755
|
+
{
|
|
16756
|
+
resource: "ontology.nodes",
|
|
16757
|
+
method: "retrieve",
|
|
16758
|
+
summary: "Retrieve node",
|
|
16759
|
+
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.",
|
|
16760
|
+
http: "GET",
|
|
16761
|
+
path: "/ontology/v1/nodes/{node_id}",
|
|
16762
|
+
streaming: "no",
|
|
16763
|
+
pagination: false,
|
|
16764
|
+
pathParams: [
|
|
16765
|
+
{
|
|
16766
|
+
name: "node_id",
|
|
16767
|
+
sdkName: "node_id",
|
|
16768
|
+
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."
|
|
16769
|
+
}
|
|
16770
|
+
],
|
|
16771
|
+
query: [
|
|
16772
|
+
{
|
|
16773
|
+
name: "expand",
|
|
16774
|
+
type: "string",
|
|
16775
|
+
enum: [
|
|
16776
|
+
"relations"
|
|
16777
|
+
],
|
|
16778
|
+
required: false,
|
|
16779
|
+
description: "Set to relations to include the node's incoming and outgoing relations in the same response; omit for the node alone."
|
|
16780
|
+
},
|
|
16781
|
+
{
|
|
16782
|
+
name: "as_of",
|
|
16783
|
+
type: "string",
|
|
16784
|
+
required: false,
|
|
16785
|
+
description: "ISO 8601 timestamp; read the node and its relations as they were then, including relations invalidated since. Omit to read current state."
|
|
16786
|
+
}
|
|
16787
|
+
]
|
|
16788
|
+
},
|
|
16789
|
+
{
|
|
16790
|
+
resource: "ontology.nodes",
|
|
16791
|
+
method: "update",
|
|
16792
|
+
summary: "Update node",
|
|
16793
|
+
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.",
|
|
16794
|
+
http: "PATCH",
|
|
16795
|
+
path: "/ontology/v1/nodes/{node_id}",
|
|
16796
|
+
streaming: "no",
|
|
16797
|
+
pagination: false,
|
|
16798
|
+
pathParams: [
|
|
16799
|
+
{
|
|
16800
|
+
name: "node_id",
|
|
16801
|
+
sdkName: "node_id",
|
|
16802
|
+
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."
|
|
16803
|
+
}
|
|
16804
|
+
],
|
|
16805
|
+
query: [],
|
|
16806
|
+
body: {
|
|
16807
|
+
required: true,
|
|
16808
|
+
fields: [
|
|
16809
|
+
{
|
|
16810
|
+
name: "name",
|
|
16811
|
+
type: "string",
|
|
16812
|
+
required: false,
|
|
16813
|
+
description: "New display name, at most 200 characters; omit to keep the current name."
|
|
16814
|
+
},
|
|
16815
|
+
{
|
|
16816
|
+
name: "aliases",
|
|
16817
|
+
type: "array",
|
|
16818
|
+
itemType: "string",
|
|
16819
|
+
required: false,
|
|
16820
|
+
description: "Replacement alias list; an empty array clears the aliases and omitting the field keeps them."
|
|
16821
|
+
},
|
|
16822
|
+
{
|
|
16823
|
+
name: "description",
|
|
16824
|
+
type: "string",
|
|
16825
|
+
required: false,
|
|
16826
|
+
description: "Replacement profile, at most 500 characters; an explicit null clears it and omitting the field keeps it."
|
|
16827
|
+
}
|
|
16828
|
+
]
|
|
16829
|
+
}
|
|
16830
|
+
},
|
|
16831
|
+
{
|
|
16832
|
+
resource: "ontology.nodes.merge",
|
|
16833
|
+
method: "create",
|
|
16834
|
+
summary: "Merge node",
|
|
16835
|
+
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.",
|
|
16836
|
+
http: "POST",
|
|
16837
|
+
path: "/ontology/v1/nodes/{node_id}/merge",
|
|
16838
|
+
streaming: "no",
|
|
16839
|
+
pagination: false,
|
|
16840
|
+
pathParams: [
|
|
16841
|
+
{
|
|
16842
|
+
name: "node_id",
|
|
16843
|
+
sdkName: "node_id",
|
|
16844
|
+
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."
|
|
16845
|
+
}
|
|
16846
|
+
],
|
|
16847
|
+
query: [],
|
|
16848
|
+
body: {
|
|
16849
|
+
required: true,
|
|
16850
|
+
fields: [
|
|
16851
|
+
{
|
|
16852
|
+
name: "into",
|
|
16853
|
+
type: "string",
|
|
16854
|
+
required: true,
|
|
16855
|
+
description: "Node id that should survive, from nodes.list or search; the merged node's relations and aliases move to it."
|
|
16856
|
+
}
|
|
16857
|
+
]
|
|
16858
|
+
}
|
|
16859
|
+
},
|
|
16860
|
+
{
|
|
16861
|
+
resource: "ontology.relations",
|
|
16862
|
+
method: "list",
|
|
16863
|
+
summary: "List relations",
|
|
16864
|
+
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.",
|
|
16865
|
+
http: "GET",
|
|
16866
|
+
path: "/ontology/v1/relations",
|
|
16867
|
+
streaming: "no",
|
|
16868
|
+
pagination: true,
|
|
16869
|
+
pathParams: [],
|
|
16870
|
+
query: [
|
|
16871
|
+
{
|
|
16872
|
+
name: "node",
|
|
16873
|
+
type: "string",
|
|
16874
|
+
required: false,
|
|
16875
|
+
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."
|
|
16876
|
+
},
|
|
16877
|
+
{
|
|
16878
|
+
name: "type",
|
|
16879
|
+
type: "array",
|
|
16880
|
+
itemType: "string",
|
|
16881
|
+
required: false,
|
|
16882
|
+
description: "Repeat to filter to any of several registered relation type names, for example type=references&type=serves; omit to list every type."
|
|
16883
|
+
},
|
|
16884
|
+
{
|
|
16885
|
+
name: "direction",
|
|
16886
|
+
type: "string",
|
|
16887
|
+
enum: [
|
|
16888
|
+
"out",
|
|
16889
|
+
"in",
|
|
16890
|
+
"both"
|
|
16891
|
+
],
|
|
16892
|
+
required: false,
|
|
16893
|
+
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."
|
|
16894
|
+
},
|
|
16895
|
+
{
|
|
16896
|
+
name: "as_of",
|
|
16897
|
+
type: "string",
|
|
16898
|
+
required: false,
|
|
16899
|
+
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."
|
|
16900
|
+
},
|
|
16901
|
+
{
|
|
16902
|
+
name: "include_invalid",
|
|
16903
|
+
type: "boolean",
|
|
16904
|
+
required: false,
|
|
16905
|
+
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."
|
|
16906
|
+
},
|
|
16907
|
+
{
|
|
16908
|
+
name: "limit",
|
|
16909
|
+
type: "integer",
|
|
16910
|
+
required: false,
|
|
16911
|
+
description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100."
|
|
16912
|
+
},
|
|
16913
|
+
{
|
|
16914
|
+
name: "cursor",
|
|
16915
|
+
type: "string",
|
|
16916
|
+
required: false,
|
|
16917
|
+
description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
|
|
16918
|
+
}
|
|
16919
|
+
]
|
|
16920
|
+
},
|
|
16921
|
+
{
|
|
16922
|
+
resource: "ontology.relations",
|
|
16923
|
+
method: "create",
|
|
16924
|
+
summary: "Create relation",
|
|
16925
|
+
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.",
|
|
16926
|
+
http: "POST",
|
|
16927
|
+
path: "/ontology/v1/relations",
|
|
16928
|
+
streaming: "no",
|
|
16929
|
+
pagination: false,
|
|
16930
|
+
pathParams: [],
|
|
16931
|
+
query: [],
|
|
16932
|
+
body: {
|
|
16933
|
+
required: true,
|
|
16934
|
+
fields: [
|
|
16935
|
+
{
|
|
16936
|
+
name: "type",
|
|
16937
|
+
type: "string",
|
|
16938
|
+
required: true,
|
|
16939
|
+
description: "Registered relation type name from types.list; it must admit both endpoints or the write is refused."
|
|
16940
|
+
},
|
|
16941
|
+
{
|
|
16942
|
+
name: "source",
|
|
16943
|
+
type: "string",
|
|
16944
|
+
required: true,
|
|
16945
|
+
description: "Node id the fact starts from, from nodes.list or nodes.create."
|
|
16946
|
+
},
|
|
16947
|
+
{
|
|
16948
|
+
name: "target",
|
|
16949
|
+
type: "string",
|
|
16950
|
+
required: true,
|
|
16951
|
+
description: "Node id the fact points at, from nodes.list or nodes.create."
|
|
16952
|
+
},
|
|
16953
|
+
{
|
|
16954
|
+
name: "fact",
|
|
16955
|
+
type: "string",
|
|
16956
|
+
required: true,
|
|
16957
|
+
description: "The relationship in one sentence, at most 280 characters, written to read back on its own."
|
|
16958
|
+
},
|
|
16959
|
+
{
|
|
16960
|
+
name: "valid_at",
|
|
16961
|
+
type: "string",
|
|
16962
|
+
required: false,
|
|
16963
|
+
description: "World time the fact became true, when the mirrored record dates it; omit to leave it undated."
|
|
16964
|
+
},
|
|
16965
|
+
{
|
|
16966
|
+
name: "owner",
|
|
16967
|
+
type: "string",
|
|
16968
|
+
required: false,
|
|
16969
|
+
description: "Member id whose content this fact is, restricting it to that member; omit or null for organization-wide."
|
|
16970
|
+
}
|
|
16971
|
+
]
|
|
16972
|
+
}
|
|
16973
|
+
},
|
|
16974
|
+
{
|
|
16975
|
+
resource: "ontology.relations",
|
|
16976
|
+
method: "retrieve",
|
|
16977
|
+
summary: "Retrieve relation",
|
|
16978
|
+
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.",
|
|
16979
|
+
http: "GET",
|
|
16980
|
+
path: "/ontology/v1/relations/{relation_id}",
|
|
16981
|
+
streaming: "no",
|
|
16982
|
+
pagination: false,
|
|
16983
|
+
pathParams: [
|
|
16984
|
+
{
|
|
16985
|
+
name: "relation_id",
|
|
16986
|
+
sdkName: "relation_id",
|
|
16987
|
+
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."
|
|
16988
|
+
}
|
|
16989
|
+
],
|
|
16990
|
+
query: []
|
|
16991
|
+
},
|
|
16992
|
+
{
|
|
16993
|
+
resource: "ontology.relations.invalidate",
|
|
16994
|
+
method: "create",
|
|
16995
|
+
summary: "Invalidate relation",
|
|
16996
|
+
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.",
|
|
16997
|
+
http: "POST",
|
|
16998
|
+
path: "/ontology/v1/relations/{relation_id}/invalidate",
|
|
16999
|
+
streaming: "no",
|
|
17000
|
+
pagination: false,
|
|
17001
|
+
pathParams: [
|
|
17002
|
+
{
|
|
17003
|
+
name: "relation_id",
|
|
17004
|
+
sdkName: "relation_id",
|
|
17005
|
+
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."
|
|
17006
|
+
}
|
|
17007
|
+
],
|
|
17008
|
+
query: [],
|
|
17009
|
+
body: {
|
|
17010
|
+
required: true,
|
|
17011
|
+
fields: [
|
|
17012
|
+
{
|
|
17013
|
+
name: "invalid_at",
|
|
17014
|
+
type: "string",
|
|
17015
|
+
required: true,
|
|
17016
|
+
description: "World time the fact stopped being true, in ISO 8601 UTC; reads at an earlier as_of still return the relation."
|
|
17017
|
+
},
|
|
17018
|
+
{
|
|
17019
|
+
name: "superseded_by",
|
|
17020
|
+
type: "string",
|
|
17021
|
+
required: false,
|
|
17022
|
+
description: "Relation id that replaces this one, when a successor was recorded; omit or null when nothing replaced it."
|
|
17023
|
+
},
|
|
17024
|
+
{
|
|
17025
|
+
name: "reason",
|
|
17026
|
+
type: "string",
|
|
17027
|
+
required: false,
|
|
17028
|
+
description: "Why it stopped being true, for people reading the history later; not enforced and safe to omit."
|
|
17029
|
+
}
|
|
17030
|
+
]
|
|
17031
|
+
}
|
|
17032
|
+
},
|
|
17033
|
+
{
|
|
17034
|
+
resource: "ontology.search",
|
|
17035
|
+
method: "create",
|
|
17036
|
+
summary: "Search nodes",
|
|
17037
|
+
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.",
|
|
17038
|
+
http: "POST",
|
|
17039
|
+
path: "/ontology/v1/search",
|
|
17040
|
+
streaming: "no",
|
|
17041
|
+
pagination: false,
|
|
17042
|
+
pathParams: [],
|
|
17043
|
+
query: [],
|
|
17044
|
+
body: {
|
|
17045
|
+
required: true,
|
|
17046
|
+
fields: [
|
|
17047
|
+
{
|
|
17048
|
+
name: "text",
|
|
17049
|
+
type: "string",
|
|
17050
|
+
required: true,
|
|
17051
|
+
description: "Text to find nodes for, matched against names, aliases, descriptions and relation facts; an empty string is refused."
|
|
17052
|
+
},
|
|
17053
|
+
{
|
|
17054
|
+
name: "types",
|
|
17055
|
+
type: "array",
|
|
17056
|
+
itemType: "string",
|
|
17057
|
+
required: false,
|
|
17058
|
+
description: "Registered node type names to search within; omit to search every type."
|
|
17059
|
+
},
|
|
17060
|
+
{
|
|
17061
|
+
name: "window",
|
|
17062
|
+
type: "object",
|
|
17063
|
+
required: false,
|
|
17064
|
+
description: "Restrict matches to facts recorded within a period; omit to search all time."
|
|
17065
|
+
},
|
|
17066
|
+
{
|
|
17067
|
+
name: "limit",
|
|
17068
|
+
type: "integer",
|
|
17069
|
+
required: false,
|
|
17070
|
+
description: "Maximum candidate nodes to return, from 1 to 50; defaults to 20 when omitted."
|
|
17071
|
+
}
|
|
17072
|
+
]
|
|
17073
|
+
}
|
|
17074
|
+
},
|
|
17075
|
+
{
|
|
17076
|
+
resource: "ontology.types",
|
|
17077
|
+
method: "list",
|
|
17078
|
+
summary: "List types",
|
|
17079
|
+
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.",
|
|
17080
|
+
http: "GET",
|
|
17081
|
+
path: "/ontology/v1/types",
|
|
17082
|
+
streaming: "no",
|
|
17083
|
+
pagination: false,
|
|
17084
|
+
pathParams: [],
|
|
17085
|
+
query: []
|
|
17086
|
+
},
|
|
17087
|
+
{
|
|
17088
|
+
resource: "ontology.types",
|
|
17089
|
+
method: "create",
|
|
17090
|
+
summary: "Register type",
|
|
17091
|
+
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.",
|
|
17092
|
+
http: "POST",
|
|
17093
|
+
path: "/ontology/v1/types",
|
|
17094
|
+
streaming: "no",
|
|
17095
|
+
pagination: false,
|
|
17096
|
+
pathParams: [],
|
|
17097
|
+
query: [],
|
|
17098
|
+
body: {
|
|
17099
|
+
required: true,
|
|
17100
|
+
fields: [
|
|
17101
|
+
{
|
|
17102
|
+
name: "owner",
|
|
17103
|
+
type: "string",
|
|
17104
|
+
required: true,
|
|
17105
|
+
description: "Service that registered these types, for example file or ticket; it is the registrant a later change to a type is checked against."
|
|
17106
|
+
},
|
|
17107
|
+
{
|
|
17108
|
+
name: "version",
|
|
17109
|
+
type: "integer",
|
|
17110
|
+
required: true,
|
|
17111
|
+
description: "Monotonic version of this owner's registration; a later registration must extend this one without removing or narrowing anything."
|
|
17112
|
+
},
|
|
17113
|
+
{
|
|
17114
|
+
name: "nodes",
|
|
17115
|
+
type: "array",
|
|
17116
|
+
itemType: "object",
|
|
17117
|
+
required: true,
|
|
17118
|
+
description: "Node types this owner registers."
|
|
17119
|
+
},
|
|
17120
|
+
{
|
|
17121
|
+
name: "edges",
|
|
17122
|
+
type: "array",
|
|
17123
|
+
itemType: "object",
|
|
17124
|
+
required: true,
|
|
17125
|
+
description: "Relation types this owner registers."
|
|
17126
|
+
}
|
|
17127
|
+
]
|
|
17128
|
+
}
|
|
17129
|
+
},
|
|
17130
|
+
{
|
|
17131
|
+
resource: "ontology.types",
|
|
17132
|
+
method: "retrieve",
|
|
17133
|
+
summary: "Retrieve type",
|
|
17134
|
+
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.",
|
|
17135
|
+
http: "GET",
|
|
17136
|
+
path: "/ontology/v1/types/{name}",
|
|
17137
|
+
streaming: "no",
|
|
17138
|
+
pagination: false,
|
|
17139
|
+
pathParams: [
|
|
17140
|
+
{
|
|
17141
|
+
name: "name",
|
|
17142
|
+
sdkName: "name",
|
|
17143
|
+
description: "A type name from types.list, with its dots preserved — a display label is not accepted."
|
|
17144
|
+
}
|
|
17145
|
+
],
|
|
17146
|
+
query: []
|
|
17147
|
+
},
|
|
16350
17148
|
{
|
|
16351
17149
|
resource: "organization.charges",
|
|
16352
17150
|
method: "list",
|
|
@@ -20539,7 +21337,7 @@ for more details.`
|
|
|
20539
21337
|
resource: "vault.vaults",
|
|
20540
21338
|
method: "create",
|
|
20541
21339
|
summary: "Create vault",
|
|
20542
|
-
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.
|
|
21340
|
+
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.",
|
|
20543
21341
|
http: "POST",
|
|
20544
21342
|
path: "/vault/v1/vaults",
|
|
20545
21343
|
streaming: "no",
|
|
@@ -22999,6 +23797,15 @@ var fileCancelUpload = (options) => (options.client ?? client).post({
|
|
|
22999
23797
|
url: "/file/v1/uploads/{upload_id}/cancel",
|
|
23000
23798
|
...options
|
|
23001
23799
|
});
|
|
23800
|
+
var fileRetrieveUpload = (options) => (options.client ?? client).get({
|
|
23801
|
+
security: [{
|
|
23802
|
+
key: "BearerAuth",
|
|
23803
|
+
scheme: "bearer",
|
|
23804
|
+
type: "http"
|
|
23805
|
+
}],
|
|
23806
|
+
url: "/file/v1/uploads/{upload_id}",
|
|
23807
|
+
...options
|
|
23808
|
+
});
|
|
23002
23809
|
var fileCreateSignedUpload = (options) => (options.client ?? client).post({
|
|
23003
23810
|
security: [{
|
|
23004
23811
|
key: "BearerAuth",
|
|
@@ -27704,6 +28511,217 @@ var mediaListUnderstandingsByLibrary = (options) => (options.client ?? client).g
|
|
|
27704
28511
|
url: "/media/v1/libraries/{library_id}/understandings",
|
|
27705
28512
|
...options
|
|
27706
28513
|
});
|
|
28514
|
+
var mediaCreateGeneration = (options) => (options.client ?? client).post({
|
|
28515
|
+
security: [{
|
|
28516
|
+
key: "media-BearerAuth",
|
|
28517
|
+
scheme: "bearer",
|
|
28518
|
+
type: "http"
|
|
28519
|
+
}],
|
|
28520
|
+
url: "/media/v1/libraries/{library_id}/generations",
|
|
28521
|
+
...options,
|
|
28522
|
+
headers: {
|
|
28523
|
+
"Content-Type": "application/json",
|
|
28524
|
+
...options.headers
|
|
28525
|
+
}
|
|
28526
|
+
});
|
|
28527
|
+
var mediaListJobs = (options) => (options.client ?? client).get({
|
|
28528
|
+
security: [{
|
|
28529
|
+
key: "media-BearerAuth",
|
|
28530
|
+
scheme: "bearer",
|
|
28531
|
+
type: "http"
|
|
28532
|
+
}],
|
|
28533
|
+
url: "/media/v1/libraries/{library_id}/jobs",
|
|
28534
|
+
...options
|
|
28535
|
+
});
|
|
28536
|
+
var mediaCancelJob = (options) => (options.client ?? client).post({
|
|
28537
|
+
security: [{
|
|
28538
|
+
key: "media-BearerAuth",
|
|
28539
|
+
scheme: "bearer",
|
|
28540
|
+
type: "http"
|
|
28541
|
+
}],
|
|
28542
|
+
url: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
|
|
28543
|
+
...options
|
|
28544
|
+
});
|
|
28545
|
+
var mediaSaveGenerationOutput = (options) => (options.client ?? client).post({
|
|
28546
|
+
security: [{
|
|
28547
|
+
key: "media-BearerAuth",
|
|
28548
|
+
scheme: "bearer",
|
|
28549
|
+
type: "http"
|
|
28550
|
+
}],
|
|
28551
|
+
url: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
|
|
28552
|
+
...options,
|
|
28553
|
+
headers: {
|
|
28554
|
+
"Content-Type": "application/json",
|
|
28555
|
+
...options.headers
|
|
28556
|
+
}
|
|
28557
|
+
});
|
|
28558
|
+
var mediaGetGenerationCapabilities = (options) => (options?.client ?? client).get({
|
|
28559
|
+
security: [{
|
|
28560
|
+
key: "media-BearerAuth",
|
|
28561
|
+
scheme: "bearer",
|
|
28562
|
+
type: "http"
|
|
28563
|
+
}],
|
|
28564
|
+
url: "/media/v1/generation/capabilities",
|
|
28565
|
+
...options
|
|
28566
|
+
});
|
|
28567
|
+
var ontologyListTypes = (options) => (options?.client ?? client).get({
|
|
28568
|
+
security: [{
|
|
28569
|
+
key: "ontology-bearerAuth",
|
|
28570
|
+
scheme: "bearer",
|
|
28571
|
+
type: "http"
|
|
28572
|
+
}],
|
|
28573
|
+
url: "/ontology/v1/types",
|
|
28574
|
+
...options
|
|
28575
|
+
});
|
|
28576
|
+
var ontologyRegisterType = (options) => (options.client ?? client).post({
|
|
28577
|
+
security: [{
|
|
28578
|
+
key: "ontology-bearerAuth",
|
|
28579
|
+
scheme: "bearer",
|
|
28580
|
+
type: "http"
|
|
28581
|
+
}],
|
|
28582
|
+
url: "/ontology/v1/types",
|
|
28583
|
+
...options,
|
|
28584
|
+
headers: {
|
|
28585
|
+
"Content-Type": "application/json",
|
|
28586
|
+
...options.headers
|
|
28587
|
+
}
|
|
28588
|
+
});
|
|
28589
|
+
var ontologyRetrieveType = (options) => (options.client ?? client).get({
|
|
28590
|
+
security: [{
|
|
28591
|
+
key: "ontology-bearerAuth",
|
|
28592
|
+
scheme: "bearer",
|
|
28593
|
+
type: "http"
|
|
28594
|
+
}],
|
|
28595
|
+
url: "/ontology/v1/types/{name}",
|
|
28596
|
+
...options
|
|
28597
|
+
});
|
|
28598
|
+
var ontologyListNodes = (options) => (options?.client ?? client).get({
|
|
28599
|
+
security: [{
|
|
28600
|
+
key: "ontology-bearerAuth",
|
|
28601
|
+
scheme: "bearer",
|
|
28602
|
+
type: "http"
|
|
28603
|
+
}],
|
|
28604
|
+
url: "/ontology/v1/nodes",
|
|
28605
|
+
...options
|
|
28606
|
+
});
|
|
28607
|
+
var ontologyCreateNode = (options) => (options.client ?? client).post({
|
|
28608
|
+
security: [{
|
|
28609
|
+
key: "ontology-bearerAuth",
|
|
28610
|
+
scheme: "bearer",
|
|
28611
|
+
type: "http"
|
|
28612
|
+
}],
|
|
28613
|
+
url: "/ontology/v1/nodes",
|
|
28614
|
+
...options,
|
|
28615
|
+
headers: {
|
|
28616
|
+
"Content-Type": "application/json",
|
|
28617
|
+
...options.headers
|
|
28618
|
+
}
|
|
28619
|
+
});
|
|
28620
|
+
var ontologyRetrieveNode = (options) => (options.client ?? client).get({
|
|
28621
|
+
security: [{
|
|
28622
|
+
key: "ontology-bearerAuth",
|
|
28623
|
+
scheme: "bearer",
|
|
28624
|
+
type: "http"
|
|
28625
|
+
}],
|
|
28626
|
+
url: "/ontology/v1/nodes/{node_id}",
|
|
28627
|
+
...options
|
|
28628
|
+
});
|
|
28629
|
+
var ontologyUpdateNode = (options) => (options.client ?? client).patch({
|
|
28630
|
+
security: [{
|
|
28631
|
+
key: "ontology-bearerAuth",
|
|
28632
|
+
scheme: "bearer",
|
|
28633
|
+
type: "http"
|
|
28634
|
+
}],
|
|
28635
|
+
url: "/ontology/v1/nodes/{node_id}",
|
|
28636
|
+
...options,
|
|
28637
|
+
headers: {
|
|
28638
|
+
"Content-Type": "application/json",
|
|
28639
|
+
...options.headers
|
|
28640
|
+
}
|
|
28641
|
+
});
|
|
28642
|
+
var ontologyMergeNode = (options) => (options.client ?? client).post({
|
|
28643
|
+
security: [{
|
|
28644
|
+
key: "ontology-bearerAuth",
|
|
28645
|
+
scheme: "bearer",
|
|
28646
|
+
type: "http"
|
|
28647
|
+
}],
|
|
28648
|
+
url: "/ontology/v1/nodes/{node_id}/merge",
|
|
28649
|
+
...options,
|
|
28650
|
+
headers: {
|
|
28651
|
+
"Content-Type": "application/json",
|
|
28652
|
+
...options.headers
|
|
28653
|
+
}
|
|
28654
|
+
});
|
|
28655
|
+
var ontologyListRelations = (options) => (options?.client ?? client).get({
|
|
28656
|
+
security: [{
|
|
28657
|
+
key: "ontology-bearerAuth",
|
|
28658
|
+
scheme: "bearer",
|
|
28659
|
+
type: "http"
|
|
28660
|
+
}],
|
|
28661
|
+
url: "/ontology/v1/relations",
|
|
28662
|
+
...options
|
|
28663
|
+
});
|
|
28664
|
+
var ontologyCreateRelation = (options) => (options.client ?? client).post({
|
|
28665
|
+
security: [{
|
|
28666
|
+
key: "ontology-bearerAuth",
|
|
28667
|
+
scheme: "bearer",
|
|
28668
|
+
type: "http"
|
|
28669
|
+
}],
|
|
28670
|
+
url: "/ontology/v1/relations",
|
|
28671
|
+
...options,
|
|
28672
|
+
headers: {
|
|
28673
|
+
"Content-Type": "application/json",
|
|
28674
|
+
...options.headers
|
|
28675
|
+
}
|
|
28676
|
+
});
|
|
28677
|
+
var ontologyRetrieveRelation = (options) => (options.client ?? client).get({
|
|
28678
|
+
security: [{
|
|
28679
|
+
key: "ontology-bearerAuth",
|
|
28680
|
+
scheme: "bearer",
|
|
28681
|
+
type: "http"
|
|
28682
|
+
}],
|
|
28683
|
+
url: "/ontology/v1/relations/{relation_id}",
|
|
28684
|
+
...options
|
|
28685
|
+
});
|
|
28686
|
+
var ontologyInvalidateRelation = (options) => (options.client ?? client).post({
|
|
28687
|
+
security: [{
|
|
28688
|
+
key: "ontology-bearerAuth",
|
|
28689
|
+
scheme: "bearer",
|
|
28690
|
+
type: "http"
|
|
28691
|
+
}],
|
|
28692
|
+
url: "/ontology/v1/relations/{relation_id}/invalidate",
|
|
28693
|
+
...options,
|
|
28694
|
+
headers: {
|
|
28695
|
+
"Content-Type": "application/json",
|
|
28696
|
+
...options.headers
|
|
28697
|
+
}
|
|
28698
|
+
});
|
|
28699
|
+
var ontologyApplyChangeset = (options) => (options.client ?? client).post({
|
|
28700
|
+
security: [{
|
|
28701
|
+
key: "ontology-bearerAuth",
|
|
28702
|
+
scheme: "bearer",
|
|
28703
|
+
type: "http"
|
|
28704
|
+
}],
|
|
28705
|
+
url: "/ontology/v1/changesets",
|
|
28706
|
+
...options,
|
|
28707
|
+
headers: {
|
|
28708
|
+
"Content-Type": "application/json",
|
|
28709
|
+
...options.headers
|
|
28710
|
+
}
|
|
28711
|
+
});
|
|
28712
|
+
var ontologySearch = (options) => (options.client ?? client).post({
|
|
28713
|
+
security: [{
|
|
28714
|
+
key: "ontology-bearerAuth",
|
|
28715
|
+
scheme: "bearer",
|
|
28716
|
+
type: "http"
|
|
28717
|
+
}],
|
|
28718
|
+
url: "/ontology/v1/search",
|
|
28719
|
+
...options,
|
|
28720
|
+
headers: {
|
|
28721
|
+
"Content-Type": "application/json",
|
|
28722
|
+
...options.headers
|
|
28723
|
+
}
|
|
28724
|
+
});
|
|
27707
28725
|
var getSandboxV1Sandboxes = (options) => (options?.client ?? client).get({
|
|
27708
28726
|
querySerializer: { parameters: { state: { array: { explode: false } } } },
|
|
27709
28727
|
security: [
|
|
@@ -30102,7 +31120,8 @@ function createFile(transport) {
|
|
|
30102
31120
|
createSigned: bind(transport, fileCreateSignedUpload),
|
|
30103
31121
|
parts: {
|
|
30104
31122
|
create: bind(transport, (options) => fileAddUploadPart({ ...options, bodySerializer: multipartBodySerializer, headers: { "Content-Type": null, ...options.headers } }))
|
|
30105
|
-
}
|
|
31123
|
+
},
|
|
31124
|
+
retrieve: bind(transport, fileRetrieveUpload)
|
|
30106
31125
|
}
|
|
30107
31126
|
};
|
|
30108
31127
|
}
|
|
@@ -30154,6 +31173,11 @@ function createKnowledge(transport) {
|
|
|
30154
31173
|
}
|
|
30155
31174
|
function createMedia(transport) {
|
|
30156
31175
|
return {
|
|
31176
|
+
generation: {
|
|
31177
|
+
capabilities: {
|
|
31178
|
+
list: bind(transport, mediaGetGenerationCapabilities)
|
|
31179
|
+
}
|
|
31180
|
+
},
|
|
30157
31181
|
libraries: {
|
|
30158
31182
|
assets: {
|
|
30159
31183
|
batch: bind(transport, mediaBatchAssets),
|
|
@@ -30190,7 +31214,17 @@ function createMedia(transport) {
|
|
|
30190
31214
|
folders: {
|
|
30191
31215
|
list: bind(transport, mediaListFolders)
|
|
30192
31216
|
},
|
|
31217
|
+
generations: {
|
|
31218
|
+
create: bind(transport, mediaCreateGeneration)
|
|
31219
|
+
},
|
|
30193
31220
|
jobs: {
|
|
31221
|
+
cancel: bind(transport, mediaCancelJob),
|
|
31222
|
+
list: bindPage(transport, mediaListJobs),
|
|
31223
|
+
outputs: {
|
|
31224
|
+
save: {
|
|
31225
|
+
create: bind(transport, mediaSaveGenerationOutput)
|
|
31226
|
+
}
|
|
31227
|
+
},
|
|
30194
31228
|
retrieve: bind(transport, mediaGetJob)
|
|
30195
31229
|
},
|
|
30196
31230
|
list: bindPage(transport, mediaListLibraries),
|
|
@@ -30315,6 +31349,38 @@ function createModel(transport) {
|
|
|
30315
31349
|
}
|
|
30316
31350
|
};
|
|
30317
31351
|
}
|
|
31352
|
+
function createOntology(transport) {
|
|
31353
|
+
return {
|
|
31354
|
+
changesets: {
|
|
31355
|
+
create: bind(transport, ontologyApplyChangeset)
|
|
31356
|
+
},
|
|
31357
|
+
nodes: {
|
|
31358
|
+
create: bind(transport, ontologyCreateNode),
|
|
31359
|
+
list: bindPage(transport, ontologyListNodes),
|
|
31360
|
+
merge: {
|
|
31361
|
+
create: bind(transport, ontologyMergeNode)
|
|
31362
|
+
},
|
|
31363
|
+
retrieve: bind(transport, ontologyRetrieveNode),
|
|
31364
|
+
update: bind(transport, ontologyUpdateNode)
|
|
31365
|
+
},
|
|
31366
|
+
relations: {
|
|
31367
|
+
create: bind(transport, ontologyCreateRelation),
|
|
31368
|
+
invalidate: {
|
|
31369
|
+
create: bind(transport, ontologyInvalidateRelation)
|
|
31370
|
+
},
|
|
31371
|
+
list: bindPage(transport, ontologyListRelations),
|
|
31372
|
+
retrieve: bind(transport, ontologyRetrieveRelation)
|
|
31373
|
+
},
|
|
31374
|
+
search: {
|
|
31375
|
+
create: bind(transport, ontologySearch)
|
|
31376
|
+
},
|
|
31377
|
+
types: {
|
|
31378
|
+
create: bind(transport, ontologyRegisterType),
|
|
31379
|
+
list: bind(transport, ontologyListTypes),
|
|
31380
|
+
retrieve: bind(transport, ontologyRetrieveType)
|
|
31381
|
+
}
|
|
31382
|
+
};
|
|
31383
|
+
}
|
|
30318
31384
|
function createOrganization(transport) {
|
|
30319
31385
|
return {
|
|
30320
31386
|
charges: {
|
|
@@ -30581,6 +31647,7 @@ var resourceFactories = {
|
|
|
30581
31647
|
media: createMedia,
|
|
30582
31648
|
meta: createMeta,
|
|
30583
31649
|
model: createModel,
|
|
31650
|
+
ontology: createOntology,
|
|
30584
31651
|
organization: createOrganization,
|
|
30585
31652
|
sandbox: createSandbox,
|
|
30586
31653
|
search: createSearch,
|
|
@@ -33594,7 +34661,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
|
|
|
33594
34661
|
}
|
|
33595
34662
|
|
|
33596
34663
|
// src/main.ts
|
|
33597
|
-
var version = "0.2.1-dev.
|
|
34664
|
+
var version = "0.2.1-dev.8b0bba1";
|
|
33598
34665
|
var commands = commandTree(operations);
|
|
33599
34666
|
var manual = [...workflows.map((w) => w.words), [API_WORD]];
|
|
33600
34667
|
function route(argv) {
|