@deepraxis/sdk 0.1.1-dev.da4893e → 0.1.1-dev.daf3004
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/METHODS.md +91 -1
- package/README.md +2 -2
- package/dist/core/errors.d.ts +6 -0
- package/dist/core/errors.js +8 -0
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +303 -117
- package/dist/generated/sdk.gen.js +546 -116
- package/dist/generated/types.gen.d.ts +3044 -270
- package/dist/operations.generated.d.ts +760 -28
- package/dist/operations.generated.js +1318 -419
- package/dist/resources.generated.d.ts +76 -8
- package/dist/resources.generated.js +58 -0
- package/package.json +2 -2
|
@@ -107,7 +107,7 @@ export declare const operations: readonly [{
|
|
|
107
107
|
readonly type: "array";
|
|
108
108
|
readonly itemType: "object";
|
|
109
109
|
readonly required: false;
|
|
110
|
-
readonly description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or
|
|
110
|
+
readonly description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.";
|
|
111
111
|
}, {
|
|
112
112
|
readonly name: "kind";
|
|
113
113
|
readonly type: "string";
|
|
@@ -938,6 +938,30 @@ export declare const operations: readonly [{
|
|
|
938
938
|
readonly required: true;
|
|
939
939
|
readonly description: "Absolute path of the file whose content to download, as returned in the path field of computers.files.list.";
|
|
940
940
|
}];
|
|
941
|
+
}, {
|
|
942
|
+
readonly resource: "agent.computers.files.convert";
|
|
943
|
+
readonly method: "create";
|
|
944
|
+
readonly summary: "Convert a Computer Document to PDF";
|
|
945
|
+
readonly description: "Convert an Office document (docx, doc, ppt, pptx, rtf, odt; up to 16 MiB) to PDF inside a platform-owned ephemeral document sandbox, whatever machine family the computer itself runs on. Returns base64 PDF bytes.\n\nPraxis extension: the preview conversion endpoint. The browser never parses an untrusted document — LibreOffice runs only inside an ephemeral document-family sandbox and the converter instance is killed after use. The file stays tenant-owned; non-convertible types answer EXTENSION_NOT_CONVERTIBLE and a failed conversion answers CONVERSION_FAILED.";
|
|
946
|
+
readonly http: "POST";
|
|
947
|
+
readonly path: "/agent/v1/computers/{computer_id}/files/convert";
|
|
948
|
+
readonly streaming: "no";
|
|
949
|
+
readonly pagination: false;
|
|
950
|
+
readonly pathParams: readonly [{
|
|
951
|
+
readonly name: "computer_id";
|
|
952
|
+
readonly sdkName: "computer_id";
|
|
953
|
+
readonly description: "Computer id (cmp_...), as returned by computers.create or computers.list.";
|
|
954
|
+
}];
|
|
955
|
+
readonly query: readonly [];
|
|
956
|
+
readonly body: {
|
|
957
|
+
readonly required: true;
|
|
958
|
+
readonly fields: readonly [{
|
|
959
|
+
readonly name: "name";
|
|
960
|
+
readonly type: "string";
|
|
961
|
+
readonly required: true;
|
|
962
|
+
readonly description: "Name of the entry or object.";
|
|
963
|
+
}];
|
|
964
|
+
};
|
|
941
965
|
}, {
|
|
942
966
|
readonly resource: "agent.computers.leases";
|
|
943
967
|
readonly method: "delete";
|
|
@@ -4845,7 +4869,7 @@ export declare const operations: readonly [{
|
|
|
4845
4869
|
readonly type: "string";
|
|
4846
4870
|
readonly enum: readonly ["skip", "allow"];
|
|
4847
4871
|
readonly required: false;
|
|
4848
|
-
readonly description: "skip
|
|
4872
|
+
readonly description: "skip skips while a previous run is still active; allow permits overlapping runs. When omitted, schedule triggers use skip and webhook triggers use allow.";
|
|
4849
4873
|
}, {
|
|
4850
4874
|
readonly name: "catchup_window_seconds";
|
|
4851
4875
|
readonly type: "integer";
|
|
@@ -4986,7 +5010,7 @@ export declare const operations: readonly [{
|
|
|
4986
5010
|
readonly type: "string";
|
|
4987
5011
|
readonly enum: readonly ["skip", "allow"];
|
|
4988
5012
|
readonly required: false;
|
|
4989
|
-
readonly description: "skip
|
|
5013
|
+
readonly description: "skip skips while a previous run is still active; allow permits overlapping runs. When omitted, schedule triggers use skip and webhook triggers use allow.";
|
|
4990
5014
|
}, {
|
|
4991
5015
|
readonly name: "catchup_window_seconds";
|
|
4992
5016
|
readonly type: "integer";
|
|
@@ -8098,13 +8122,18 @@ export declare const operations: readonly [{
|
|
|
8098
8122
|
readonly type: "integer";
|
|
8099
8123
|
readonly required: false;
|
|
8100
8124
|
readonly description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write.";
|
|
8125
|
+
}, {
|
|
8126
|
+
readonly name: "loudness";
|
|
8127
|
+
readonly type: "object";
|
|
8128
|
+
readonly required: false;
|
|
8129
|
+
readonly description: "Loudness normalization target. Omitted, the export is normalized to -14 LUFS integrated and -1 dBTP true peak, the level short-video and streaming platforms play at; null renders without normalization. Normalization adds analysis and rendering work.";
|
|
8101
8130
|
}];
|
|
8102
8131
|
};
|
|
8103
8132
|
}, {
|
|
8104
8133
|
readonly resource: "cut.projects.frames";
|
|
8105
8134
|
readonly method: "list";
|
|
8106
8135
|
readonly summary: "Render preview frames";
|
|
8107
|
-
readonly description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution.
|
|
8136
|
+
readonly description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution. The response always includes warnings; FRAME_UNAVAILABLE means a source preview could not be obtained and an offline tile was drawn. Its message identifies a timeout, delivery capacity limit, or unavailable source and contains no source URL. Decode each image's base64 payload to save it. Codemode returns at most four images per call, so request at most four times when reviewing there.";
|
|
8108
8137
|
readonly http: "GET";
|
|
8109
8138
|
readonly path: "/cut/v1/projects/{project_id}/frames";
|
|
8110
8139
|
readonly streaming: "no";
|
|
@@ -8164,6 +8193,46 @@ export declare const operations: readonly [{
|
|
|
8164
8193
|
readonly description: "Optional human-readable display name for the new media asset.";
|
|
8165
8194
|
}];
|
|
8166
8195
|
};
|
|
8196
|
+
}, {
|
|
8197
|
+
readonly resource: "cut.projects.renders";
|
|
8198
|
+
readonly method: "create";
|
|
8199
|
+
readonly summary: "Create draft range render";
|
|
8200
|
+
readonly description: "Render one interval of the timeline so you can hear or look at how that passage comes out, without publishing anything to a media library. Choose kind audio for the mixed soundtrack as an .m4a file, or kind video for a draft-quality .mp4 with picture and sound. from and to are seconds on the project clock and must satisfy 0 <= from < to, to <= the timeline duration, and to - from <= 120; a longer passage is requested in several 分段请求 ranges and joined by the caller. The result is a temporary file (purpose user_data) that expires 24 hours after it is stored and is never imported into a library, so it is not a deliverable and carries no cut-export tag. HTTP 202 only accepts the job; poll praxis.cut.renders.retrieve using the returned id until status is done or failed, then read url while it lasts. A draft also bills like a draft export, by rendered seconds. Each project runs at most 2 draft renders at a time, a budget separate from its exports; a third answers HTTP 429 CUT_BUSY and the same call succeeds once one finishes.";
|
|
8201
|
+
readonly http: "POST";
|
|
8202
|
+
readonly path: "/cut/v1/projects/{project_id}/renders";
|
|
8203
|
+
readonly streaming: "no";
|
|
8204
|
+
readonly pagination: false;
|
|
8205
|
+
readonly pathParams: readonly [{
|
|
8206
|
+
readonly name: "project_id";
|
|
8207
|
+
readonly sdkName: "project_id";
|
|
8208
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
8209
|
+
}];
|
|
8210
|
+
readonly query: readonly [];
|
|
8211
|
+
readonly body: {
|
|
8212
|
+
readonly required: true;
|
|
8213
|
+
readonly fields: readonly [{
|
|
8214
|
+
readonly name: "kind";
|
|
8215
|
+
readonly type: "string";
|
|
8216
|
+
readonly enum: readonly ["audio", "video"];
|
|
8217
|
+
readonly required: true;
|
|
8218
|
+
readonly description: "audio renders the mixed soundtrack alone as an .m4a file for listening; video renders a draft-quality .mp4 with picture and sound for looking at. An audio draft is the cheaper of the two and is what a loudness or mix measurement asks for.";
|
|
8219
|
+
}, {
|
|
8220
|
+
readonly name: "from";
|
|
8221
|
+
readonly type: "number";
|
|
8222
|
+
readonly required: true;
|
|
8223
|
+
readonly description: "Start of the interval in seconds on the project clock, inclusive. Must be less than to.";
|
|
8224
|
+
}, {
|
|
8225
|
+
readonly name: "to";
|
|
8226
|
+
readonly type: "number";
|
|
8227
|
+
readonly required: true;
|
|
8228
|
+
readonly description: "End of the interval in seconds on the project clock, exclusive. At most 120 seconds after from, and never beyond the timeline duration; a longer passage is requested as several ranges.";
|
|
8229
|
+
}, {
|
|
8230
|
+
readonly name: "revision";
|
|
8231
|
+
readonly type: "integer";
|
|
8232
|
+
readonly required: false;
|
|
8233
|
+
readonly description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write.";
|
|
8234
|
+
}];
|
|
8235
|
+
};
|
|
8167
8236
|
}, {
|
|
8168
8237
|
readonly resource: "cut.projects";
|
|
8169
8238
|
readonly method: "retrieveState";
|
|
@@ -8278,7 +8347,7 @@ export declare const operations: readonly [{
|
|
|
8278
8347
|
readonly resource: "cut.projects";
|
|
8279
8348
|
readonly method: "execute";
|
|
8280
8349
|
readonly summary: "Execute editing script";
|
|
8281
|
-
readonly description: "Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: `const t = AddTrack(\"video\"); Insert(t, {type: \"color\", color: \"#123456\", start: 0, length: 3}); Print(t);`\n\n### Script function reference\n\nFunctions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. JoinId is the string returned by Join or read from GetTimeline().joins. Reads see earlier writes in the same script.\n\n```ts\nGetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;\nGetItem(id: ClipId): ItemView;\nFindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];\nGetMedia(ref: MediaRef): MediaInfo;\nGetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];\nGetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];\nListTransitions(): TransitionInfo[];\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";
|
|
8350
|
+
readonly description: "Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: `const t = AddTrack(\"video\"); Insert(t, {type: \"color\", color: \"#123456\", start: 0, length: 3}); Print(t);`\n\n<!-- cut-reference:start -->\n### Script function, field and error reference\n\nEvery script function, clip field and error code has its own section, read one at a time:\n\n```\ncodemode.describe(\"praxis.cut.script.<Name>\") // one function: signature, arguments, return, errors, example\ncodemode.describe(\"praxis.cut.fields.<name>\") // one field: type, unit, range, default, where writable\ncodemode.describe(\"praxis.cut.errors.<CODE>\") // one code: meaning, causes, fix\ncodemode.describe(\"praxis.cut.script\") // names, one page at a time\n```\n\nPublished at https://docs.deepraxis.com/docs/developers/cut/script-reference with one anchor per entry. Names below omit the `praxis.cut.<kind>.` prefix.\n\n#### Script functions (script)\n\n- `GetTimeline` — Duration, tracks, joins; clips are under `items`.\n- `GetItem` — One clip's compact view, by id.\n- `FindItems` — Visit every clip with its track; collect results.\n- `GetMedia` — Media metadata; `durationUs` is microseconds.\n- `GetTranscript` — Transcript words in source microseconds.\n- `GetAnalysis` — Silence, filler or scene segments.\n- `ListTransitions` — Join transition kinds and parameters.\n- `ListEffects` — Visual-effect catalog and parameters.\n- `ListAnimations` — Animation presets by phase and target.\n- `ListFonts` — Font families, weights and scripts.\n- `ListTextStyles` — Text style presets for `style.preset`.\n- `ListTextTemplates` — Multi-layer templates and their slots.\n- `Insert` — Add a clip; a track never overlaps itself.\n- `Append` — Add a clip at the end of a track.\n- `Update` — Change named fields; the rest stay.\n- `SetSpeed` — Change rate, keeping source or duration.\n- `Delete` — Remove a clip. There is no `Remove`.\n- `Join` — Overlap clips; followers shift, track shortens.\n- `UpdateJoin` — Change a join's length or effect.\n- `DeleteJoin` — Remove a join; restore the butt cut.\n- `Split` — Cut a clip in two at a time.\n- `Trim` — Move one clip edge by seconds.\n- `Move` — Set a clip's start or track.\n- `RippleDeleteRange` — Cut a time range and close the gap.\n- `AddTrack` — Add a video, audio or caption track.\n- `UpdateTrack` — Change a track's name, lock, gain or role.\n- `DeleteTrack` — Remove a track and its clips.\n- `SetSettings` — Change canvas, frame rate or background.\n- `AddCaptionsFromTranscript` — Captions from a clip's kept words.\n- `InsertTemplate` — Insert a template and fill its slots.\n- `AlignCaptions` — Rebuild captions from text punctuation.\n- `ImportCaptions` — Import SRT or WebVTT onto captions.\n- `ExportCaptions` — Export captions as SRT or WebVTT.\n- `SetMarker` — Label a timeline position.\n- `Print` — Append values to the result's `prints`.\n- `Preview` — Up to 8 frames as inline PNG data URLs.\n\n#### Fields (fields)\n\n- `type` — Clip kind; decides which fields apply.\n- `start` — Clip start in seconds; snaps to frames.\n- `length` — Duration; optional for video and audio.\n- `media` — Source `{ libraryId, assetId }`.\n- `sourceIn` — First source second kept; default 0.\n- `sourceOut` — Exclusive source end; read-only.\n- `text` — Text of a text or caption clip.\n- `color` — Solid colour of a color clip.\n- `shape` — Shape clip kind: `rect` or `ellipse`.\n- `width` — Shape width, a fraction of canvas width.\n- `height` — Shape height, a fraction of canvas height.\n- `radius` — Rect corner rounding, in 1080-height px.\n- `fill` — Shape or text paint: colour or gradient.\n- `stroke` — Shape outline: colour and width.\n- `transform` — Position, scale, rotation, opacity, crop, blur.\n- `fit` — contain, cover, fill or none.\n- `blend` — Layer blend mode; null clears.\n- `style` — Text styling: font, fill, strokes, glow, position.\n- `style.position` — top, middle or bottom; omit it, never null.\n- `playback` — Rate, direction, audio policy, or freeze.\n- `volumeDb` — Audio level in dB; 0 is source level.\n- `gain` — Keyframed audio level in dB.\n- `fadeIn` — Fade-in seconds at the clip's start.\n- `fadeOut` — Fade-out seconds at the clip's end.\n- `duck` — Lower this clip while another track plays.\n- `animate` — Transform keyframes; `at` is clip-relative seconds.\n- `reveal` — Per-character, word or line reveal timing.\n- `animation` — Preset slots `{ in, out, loop }`; null clears.\n- `effects` — Effect stack, at most 8; null clears.\n- `transitionIn` — Entrance effect: kind plus seconds.\n- `transitionOut` — Exit effect: kind plus seconds.\n- `mask` — Shape, path or track matte.\n- `words` — Caption words with clip-local times.\n\n#### Error codes (errors)\n\n- `JOIN_CONFLICT` — A join is invalid or blocks this edit.\n- `INVALID_TRANSITION` — Bad transition kind, parameter or length.\n- `INVALID_STYLE` — A style value is out of range.\n- `INVALID_MASK` — A mask definition is malformed.\n- `MASK_IN_USE` — The edit would break a live mask.\n- `TOO_MANY_MASKS` — At most 16 masks per project.\n- `RATE_OUT_OF_RANGE` — A rate is outside 0.25-4.\n- `UNSUPPORTED_PLAYBACK` — Reverse without an explicit mute.\n- `INVALID_PLAYBACK` — A playback object is partial or malformed.\n- `UNKNOWN_FONT` — The family is not in `ListFonts()`.\n- `UNKNOWN_FIELD` — The field name is not accepted here.\n- `UNKNOWN_TEXT_STYLE` — `style.preset` is not in the catalog.\n- `TEXT_STYLE_TARGET_MISMATCH` — Preset on the wrong clip type.\n- `CAPTION_ALIGN_LOW_CONFIDENCE` — Alignment confidence too low; nothing changed.\n- `OVERLAP` — Two clips on one track would share time.\n- `OUT_OF_SOURCE` — The clip would read past its source.\n- `LOCKED_TRACK` — The edit targets a locked track.\n- `UNBOUND_LIBRARY` — The library is not bound to the project.\n- `TRACK_KIND_MISMATCH` — The clip type does not fit the track.\n- `NOT_FOUND` — The named id is not in this project.\n- `TOO_SHORT` — The result would be under one frame.\n- `INVALID_DUCK` — Bad `duck` level or a missing track.\n- `UNKNOWN_ANIMATION` — The preset is not in `ListAnimations()`.\n- `INVALID_ANIMATION_PARAM` — Bad slot, parameter or keyframe limit.\n- `ANIMATION_TOO_LONG` — In plus out exceed the clip length.\n- `ANIMATION_TARGET_MISMATCH` — The preset does not match the clip type.\n- `ANIMATION_PHASE_MISMATCH` — The preset is in the wrong slot.\n- `UNKNOWN_EFFECT` — The effect is not in `ListEffects()`.\n- `INVALID_EFFECT_PARAM` — Bad effect parameter or keyframe.\n- `TOO_MANY_EFFECTS` — More than 8 effects on one clip.\n- `PROJECT_NOT_FOUND` — No visible project has this id.\n- `EXPORT_NOT_FOUND` — No such export in this project.\n- `VERSION_NOT_FOUND` — No saved version has this revision.\n- `LIBRARY_NOT_FOUND` — The library is missing or invisible.\n- `BINDING_INVALID` — The binding request is malformed.\n- `BINDING_IN_USE` — Clips still use this library's assets.\n- `NOTHING_TO_UNDO` — No earlier revision to return to.\n- `NOTHING_TO_REDO` — No undone revision is waiting.\n- `UNDO_CONFLICT` — The revision to undo is no longer head.\n- `REVISION_CONFLICT` — The project moved; your revision is stale.\n- `CUT_BUSY` — The project is busy; retry.\n- `INVALID_CAPTION_FILE` — The subtitle file is malformed or too big.\n- `SCRIPT_ERROR` — The script threw or did not parse.\n- `SCRIPT_LIMIT` — An execute budget was exceeded.\n- `OPS_REJECTED` — An op failed; the whole edit rolled back.\n- `EDIT_EXPIRED` — The saved edit id is over ten minutes old.\n- `MEDIA_OFFLINE` — The asset cannot be fetched right now.\n- `MEDIA_UNAVAILABLE` — The asset is not usable for rendering.\n- `MEDIA_IMPORT_FAILED` — Importing media failed.\n- `FRAME_OUT_OF_RANGE` — The preview time is outside the project.\n- `PROJECT_TOO_LARGE` — The project exceeds the size limit.\n- `RESPONSE_TOO_LARGE` — The response would exceed its budget.\n- `EXPORT_FAILED` — The render failed; read `error.cause`.\n- `INVALID_PARAMS` — The request is malformed.\n- `PERMISSION_DENIED` — This credential may not do that here.\n- `NOT_IMPLEMENTED` — Not available on this platform yet.\n- `INTERNAL` — Unexpected failure; retry with the request id.\n<!-- cut-reference:end -->\n";
|
|
8282
8351
|
readonly http: "POST";
|
|
8283
8352
|
readonly path: "/cut/v1/projects/{project_id}:execute";
|
|
8284
8353
|
readonly streaming: "no";
|
|
@@ -8329,6 +8398,21 @@ export declare const operations: readonly [{
|
|
|
8329
8398
|
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
8330
8399
|
}];
|
|
8331
8400
|
readonly query: readonly [];
|
|
8401
|
+
}, {
|
|
8402
|
+
readonly resource: "cut.renders";
|
|
8403
|
+
readonly method: "retrieve";
|
|
8404
|
+
readonly summary: "Retrieve draft range render";
|
|
8405
|
+
readonly description: "Poll a draft render id returned by projects.renders.create to see whether the interval is ready, then read url while it lasts. queued and rendering are in progress; done provides file_id and a short-lived url for the rendered .m4a or .mp4; failed provides error. Only done yields a url, and the file behind it disappears 24 hours after it was stored, so retrieve again when the link has expired.";
|
|
8406
|
+
readonly http: "GET";
|
|
8407
|
+
readonly path: "/cut/v1/renders/{render_id}";
|
|
8408
|
+
readonly streaming: "no";
|
|
8409
|
+
readonly pagination: false;
|
|
8410
|
+
readonly pathParams: readonly [{
|
|
8411
|
+
readonly name: "render_id";
|
|
8412
|
+
readonly sdkName: "render_id";
|
|
8413
|
+
readonly description: "Draft render id (cutr_…) returned by projects.renders.create.";
|
|
8414
|
+
}];
|
|
8415
|
+
readonly query: readonly [];
|
|
8332
8416
|
}, {
|
|
8333
8417
|
readonly resource: "cut.versions";
|
|
8334
8418
|
readonly method: "restore";
|
|
@@ -9299,7 +9383,7 @@ export declare const operations: readonly [{
|
|
|
9299
9383
|
readonly resource: "file.uploads";
|
|
9300
9384
|
readonly method: "create";
|
|
9301
9385
|
readonly summary: "Create an upload";
|
|
9302
|
-
readonly description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most
|
|
9386
|
+
readonly description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 20 GiB (21474836480 bytes) and only user_data, assistants and vision purposes. Send parts of at most 64000000 bytes; an unfinished upload waits for them for 7 days, so a client can create → send parts → query GET /file/v1/uploads/{upload_id} → resend only the missing parts → complete. Optional part_size fixes every part length and makes each numbered part retryable with identical bytes. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.";
|
|
9303
9387
|
readonly http: "POST";
|
|
9304
9388
|
readonly path: "/file/v1/uploads";
|
|
9305
9389
|
readonly streaming: "no";
|
|
@@ -9312,7 +9396,7 @@ export declare const operations: readonly [{
|
|
|
9312
9396
|
readonly name: "bytes";
|
|
9313
9397
|
readonly type: "integer";
|
|
9314
9398
|
readonly required: true;
|
|
9315
|
-
readonly description: "Exact complete file length in bytes, from 1 through
|
|
9399
|
+
readonly description: "Exact complete file length in bytes, from 1 through 21474836480 (20 GiB); the sum of completed parts must match.";
|
|
9316
9400
|
}, {
|
|
9317
9401
|
readonly name: "filename";
|
|
9318
9402
|
readonly type: "string";
|
|
@@ -9345,7 +9429,7 @@ export declare const operations: readonly [{
|
|
|
9345
9429
|
readonly resource: "file.uploads";
|
|
9346
9430
|
readonly method: "createSigned";
|
|
9347
9431
|
readonly summary: "Create a one-time upload URL";
|
|
9348
|
-
readonly description: "Upload a local file of up to
|
|
9432
|
+
readonly description: "Upload a local file of up to 20 GiB from a coding agent without sending bytes through the model. Provide basename, exact byte count and MIME type. Up to 104857600 bytes, PUT the file to url with curl -T photo.png -H 'Content-Type: image/png' '<url>'; success returns 201 with the file object, and reuse returns 410 CAPABILITY_USED. Above that threshold, split the file into part_size chunks (default 64000000 bytes) and PUT each chunk to its numbered parts[].url in any order; an interrupted client GETs status_url to see the received parts and resends only what is missing, then POSTs complete_url without a body. Part PUTs return 200; completion returns 201 with the file object, including its state, or 400 if a part is missing. A processing file can be polled with files.retrieve until active. Identical part bytes may be retried; changed bytes at the same number return 400. Completion reuse returns 410 CAPABILITY_USED. Each PUT requires the exact signed Content-Length; single-PUT Content-Type must match content_type or be omitted. Expired, revoked, invalid, wrong-action or cross-organization URLs return 404. URL lifetime defaults to 900 seconds for single PUT or 604800 (7 days) for multipart, at most 604800; all multipart URLs, including status_url, share an expiry. Multipart creation reserves storage quota. Issuance requires the same unscoped credential as direct file creation. Each issuance creates a new upload and is not idempotent. Example body: {\"filename\":\"photo.png\",\"bytes\":2048,\"content_type\":\"image/png\"}.";
|
|
9349
9433
|
readonly http: "POST";
|
|
9350
9434
|
readonly path: "/file/v1/uploads/signed";
|
|
9351
9435
|
readonly streaming: "no";
|
|
@@ -9363,7 +9447,7 @@ export declare const operations: readonly [{
|
|
|
9363
9447
|
readonly name: "bytes";
|
|
9364
9448
|
readonly type: "integer";
|
|
9365
9449
|
readonly required: true;
|
|
9366
|
-
readonly description: "Exact local file size in bytes, from 1 through
|
|
9450
|
+
readonly description: "Exact local file size in bytes, from 1 through 21474836480 (20 GiB). Up to 104857600 bytes returns one PUT URL; larger files return numbered part URLs, a completion URL and a status URL. Every PUT requires its exact signed Content-Length.";
|
|
9367
9451
|
}, {
|
|
9368
9452
|
readonly name: "content_type";
|
|
9369
9453
|
readonly type: "string";
|
|
@@ -9379,7 +9463,7 @@ export declare const operations: readonly [{
|
|
|
9379
9463
|
readonly name: "expires_in";
|
|
9380
9464
|
readonly type: "integer";
|
|
9381
9465
|
readonly required: false;
|
|
9382
|
-
readonly description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or
|
|
9466
|
+
readonly description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or 604800 (7 days) for multipart. All part URLs, the status URL and the completion URL share one expiry. This does not set the resulting file's lifetime.";
|
|
9383
9467
|
}, {
|
|
9384
9468
|
readonly name: "part_size";
|
|
9385
9469
|
readonly type: "integer";
|
|
@@ -9387,6 +9471,21 @@ export declare const operations: readonly [{
|
|
|
9387
9471
|
readonly description: "Fixed multipart chunk size in bytes, from 5242880 through 64000000; defaults to 64000000. Used only above 104857600 total bytes. The final part contains the remaining bytes; single-PUT mode keeps its existing response.";
|
|
9388
9472
|
}];
|
|
9389
9473
|
};
|
|
9474
|
+
}, {
|
|
9475
|
+
readonly resource: "file.uploads";
|
|
9476
|
+
readonly method: "retrieve";
|
|
9477
|
+
readonly summary: "Retrieve an upload";
|
|
9478
|
+
readonly description: "Read the state of an unfinished upload — its status, declared bytes, fixed part_size and the parts it already holds (received_parts, each with part_number, bytes and sha256). After a break or a failed part, call it to resend only the missing numbers, then complete. A cancelled or expired upload is refused; a completed one returns its file. A missing or other-organization upload returns 404.";
|
|
9479
|
+
readonly http: "GET";
|
|
9480
|
+
readonly path: "/file/v1/uploads/{upload_id}";
|
|
9481
|
+
readonly streaming: "no";
|
|
9482
|
+
readonly pagination: false;
|
|
9483
|
+
readonly pathParams: readonly [{
|
|
9484
|
+
readonly name: "upload_id";
|
|
9485
|
+
readonly sdkName: "upload_id";
|
|
9486
|
+
readonly description: "Upload identifier returned by create; the upload must belong to your organization.";
|
|
9487
|
+
}];
|
|
9488
|
+
readonly query: readonly [];
|
|
9390
9489
|
}, {
|
|
9391
9490
|
readonly resource: "file.uploads";
|
|
9392
9491
|
readonly method: "cancel";
|
|
@@ -9406,7 +9505,7 @@ export declare const operations: readonly [{
|
|
|
9406
9505
|
readonly resource: "file.uploads";
|
|
9407
9506
|
readonly method: "complete";
|
|
9408
9507
|
readonly summary: "Complete an upload";
|
|
9409
|
-
readonly description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.";
|
|
9508
|
+
readonly description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. When parts were lost, query GET /file/v1/uploads/{upload_id} and resend them before completing. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.";
|
|
9410
9509
|
readonly http: "POST";
|
|
9411
9510
|
readonly path: "/file/v1/uploads/{upload_id}/complete";
|
|
9412
9511
|
readonly streaming: "no";
|
|
@@ -9436,7 +9535,7 @@ export declare const operations: readonly [{
|
|
|
9436
9535
|
readonly resource: "file.uploads.parts";
|
|
9437
9536
|
readonly method: "create";
|
|
9438
9537
|
readonly summary: "Add an upload part";
|
|
9439
|
-
readonly description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.";
|
|
9538
|
+
readonly description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID, and query GET /file/v1/uploads/{upload_id} to see which numbers already arrived. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.";
|
|
9440
9539
|
readonly http: "POST";
|
|
9441
9540
|
readonly path: "/file/v1/uploads/{upload_id}/parts";
|
|
9442
9541
|
readonly streaming: "no";
|
|
@@ -10085,6 +10184,17 @@ export declare const operations: readonly [{
|
|
|
10085
10184
|
readonly description: "Chunk ID returned by segment listing or native search content.";
|
|
10086
10185
|
}];
|
|
10087
10186
|
readonly query: readonly [];
|
|
10187
|
+
}, {
|
|
10188
|
+
readonly resource: "media.generation.capabilities";
|
|
10189
|
+
readonly method: "list";
|
|
10190
|
+
readonly summary: "Get generation capabilities";
|
|
10191
|
+
readonly description: "Read supported text-to-video intent, default model, duration and aspect-ratio limits, per-library concurrency and candidate retention. Generation is charged per second; unsaved candidates expire after 7 days.";
|
|
10192
|
+
readonly http: "GET";
|
|
10193
|
+
readonly path: "/media/v1/generation/capabilities";
|
|
10194
|
+
readonly streaming: "no";
|
|
10195
|
+
readonly pagination: false;
|
|
10196
|
+
readonly pathParams: readonly [];
|
|
10197
|
+
readonly query: readonly [];
|
|
10088
10198
|
}, {
|
|
10089
10199
|
readonly resource: "media.libraries";
|
|
10090
10200
|
readonly method: "list";
|
|
@@ -10267,7 +10377,7 @@ export declare const operations: readonly [{
|
|
|
10267
10377
|
readonly resource: "media.libraries.assets";
|
|
10268
10378
|
readonly method: "create";
|
|
10269
10379
|
readonly summary: "Upload asset";
|
|
10270
|
-
readonly 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.
|
|
10380
|
+
readonly description: " For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
|
|
10271
10381
|
readonly http: "POST";
|
|
10272
10382
|
readonly path: "/media/v1/libraries/{library_id}/assets";
|
|
10273
10383
|
readonly streaming: "no";
|
|
@@ -10364,7 +10474,7 @@ export declare const operations: readonly [{
|
|
|
10364
10474
|
readonly resource: "media.libraries.assets.import";
|
|
10365
10475
|
readonly method: "create";
|
|
10366
10476
|
readonly summary: "Import file";
|
|
10367
|
-
readonly description: "Copy a File into an independent Media asset. New assets default to organization-private delivery (type=authenticated); explicitly set type=upload for public originals and derivatives. Omitting type on overwrite preserves the current type. Deleting the source File does not delete this copy. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
10477
|
+
readonly description: "Copy a File into an independent Media asset. New assets default to organization-private delivery (type=authenticated); explicitly set type=upload for public originals and derivatives. Omitting type on overwrite preserves the current type. Deleting the source File does not delete this copy. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
|
|
10368
10478
|
readonly http: "POST";
|
|
10369
10479
|
readonly path: "/media/v1/libraries/{library_id}/assets/import";
|
|
10370
10480
|
readonly streaming: "no";
|
|
@@ -10577,7 +10687,7 @@ export declare const operations: readonly [{
|
|
|
10577
10687
|
readonly resource: "media.libraries.assets.reprocess";
|
|
10578
10688
|
readonly method: "create";
|
|
10579
10689
|
readonly summary: "Reprocess asset";
|
|
10580
|
-
readonly 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.
|
|
10690
|
+
readonly description: " For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
|
|
10581
10691
|
readonly http: "POST";
|
|
10582
10692
|
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess";
|
|
10583
10693
|
readonly streaming: "no";
|
|
@@ -10629,9 +10739,9 @@ export declare const operations: readonly [{
|
|
|
10629
10739
|
}, {
|
|
10630
10740
|
readonly name: "kind";
|
|
10631
10741
|
readonly type: "string";
|
|
10632
|
-
readonly enum: readonly ["caption", "tags", "ocr", "transcript", "frame", "overview", "audio", "embedding"];
|
|
10742
|
+
readonly enum: readonly ["caption", "tags", "ocr", "transcript", "frame", "overview", "audio", "loudness", "beats", "content", "embedding"];
|
|
10633
10743
|
readonly required: false;
|
|
10634
|
-
readonly description: "Return one output kind: caption is a visual description, tags are generated labels, ocr is visible text, transcript is speech, frame is a video shot, overview is a video summary, audio is sampled audio understanding, and embedding reports a failed embedding step.";
|
|
10744
|
+
readonly description: "Return one output kind: caption is a visual description, tags are generated labels, ocr is visible text, transcript is speech, frame is a video shot, overview is a video summary, audio is sampled audio understanding, loudness is measured loudness, beats is the measured tempo and beat grid, content is the derived speech, music and silence split, and embedding reports a failed embedding step.";
|
|
10635
10745
|
}, {
|
|
10636
10746
|
readonly name: "cursor";
|
|
10637
10747
|
readonly type: "string";
|
|
@@ -10647,7 +10757,7 @@ export declare const operations: readonly [{
|
|
|
10647
10757
|
readonly resource: "media.libraries.assets";
|
|
10648
10758
|
readonly method: "batch";
|
|
10649
10759
|
readonly summary: "Batch assets alias";
|
|
10650
|
-
readonly description: "Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {\"action\":\"reprocess\",\"selector\":{\"expression\":\"processing_state=failed AND failure_code=UPSTREAM_FAILED\"}}. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
10760
|
+
readonly description: "Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {\"action\":\"reprocess\",\"selector\":{\"expression\":\"processing_state=failed AND failure_code=UPSTREAM_FAILED\"}}. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
|
|
10651
10761
|
readonly http: "POST";
|
|
10652
10762
|
readonly path: "/media/v1/libraries/{library_id}/assets:batch";
|
|
10653
10763
|
readonly streaming: "no";
|
|
@@ -10676,7 +10786,7 @@ export declare const operations: readonly [{
|
|
|
10676
10786
|
readonly resource: "media.libraries.batches";
|
|
10677
10787
|
readonly method: "create";
|
|
10678
10788
|
readonly summary: "Create batch";
|
|
10679
|
-
readonly description: "Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {\"action\":\"reprocess\",\"selector\":{\"expression\":\"processing_state=failed AND failure_code=UPSTREAM_FAILED\"}}. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
10789
|
+
readonly description: "Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {\"action\":\"reprocess\",\"selector\":{\"expression\":\"processing_state=failed AND failure_code=UPSTREAM_FAILED\"}}. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
|
|
10680
10790
|
readonly http: "POST";
|
|
10681
10791
|
readonly path: "/media/v1/libraries/{library_id}/batches";
|
|
10682
10792
|
readonly streaming: "no";
|
|
@@ -10805,11 +10915,120 @@ export declare const operations: readonly [{
|
|
|
10805
10915
|
readonly required: false;
|
|
10806
10916
|
readonly description: "Folder whose immediate children are returned. Omit or use an empty string for the library root; invalid folder paths are rejected.";
|
|
10807
10917
|
}];
|
|
10918
|
+
}, {
|
|
10919
|
+
readonly resource: "media.libraries.generations";
|
|
10920
|
+
readonly method: "create";
|
|
10921
|
+
readonly summary: "Create video generation";
|
|
10922
|
+
readonly description: "Create a video.generate job. Generation is charged per second. The response is 202 with a queued Job; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until terminal, then save successful outputs. Unsaved candidate Files expire after 7 days.";
|
|
10923
|
+
readonly http: "POST";
|
|
10924
|
+
readonly path: "/media/v1/libraries/{library_id}/generations";
|
|
10925
|
+
readonly streaming: "no";
|
|
10926
|
+
readonly pagination: false;
|
|
10927
|
+
readonly pathParams: readonly [{
|
|
10928
|
+
readonly name: "library_id";
|
|
10929
|
+
readonly sdkName: "library_id";
|
|
10930
|
+
readonly description: "Library ID returned by creation.";
|
|
10931
|
+
}];
|
|
10932
|
+
readonly query: readonly [];
|
|
10933
|
+
readonly body: {
|
|
10934
|
+
readonly required: true;
|
|
10935
|
+
readonly fields: readonly [{
|
|
10936
|
+
readonly name: "intent";
|
|
10937
|
+
readonly type: "string";
|
|
10938
|
+
readonly required: true;
|
|
10939
|
+
readonly description: "Generation operation; v1 accepts only video.generate text-to-video requests.";
|
|
10940
|
+
}, {
|
|
10941
|
+
readonly name: "prompt";
|
|
10942
|
+
readonly type: "string";
|
|
10943
|
+
readonly required: true;
|
|
10944
|
+
readonly description: "Text prompt describing the video to generate.";
|
|
10945
|
+
}, {
|
|
10946
|
+
readonly name: "count";
|
|
10947
|
+
readonly type: "integer";
|
|
10948
|
+
readonly required: false;
|
|
10949
|
+
readonly description: "Number of videos to generate; defaults to 1 and must be from 1 to 4.";
|
|
10950
|
+
}, {
|
|
10951
|
+
readonly name: "duration_seconds";
|
|
10952
|
+
readonly type: "integer";
|
|
10953
|
+
readonly required: false;
|
|
10954
|
+
readonly description: "Requested video duration in seconds; Router validates the model-specific supported durations.";
|
|
10955
|
+
}, {
|
|
10956
|
+
readonly name: "aspect_ratio";
|
|
10957
|
+
readonly type: "string";
|
|
10958
|
+
readonly required: false;
|
|
10959
|
+
readonly description: "Requested output aspect ratio; defaults to 16:9 and Router validates model support.";
|
|
10960
|
+
}, {
|
|
10961
|
+
readonly name: "model";
|
|
10962
|
+
readonly type: "string";
|
|
10963
|
+
readonly required: false;
|
|
10964
|
+
readonly description: "Router model with video_generation capability; defaults to wan2.7-t2v.";
|
|
10965
|
+
}, {
|
|
10966
|
+
readonly name: "save";
|
|
10967
|
+
readonly type: "string";
|
|
10968
|
+
readonly enum: readonly ["candidate", "library"];
|
|
10969
|
+
readonly required: false;
|
|
10970
|
+
readonly description: "candidate keeps outputs temporary for explicit save calls; library saves successful outputs automatically.";
|
|
10971
|
+
}, {
|
|
10972
|
+
readonly name: "asset_folder";
|
|
10973
|
+
readonly type: "string";
|
|
10974
|
+
readonly required: false;
|
|
10975
|
+
readonly description: "Folder for assets saved automatically or by later save calls; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.";
|
|
10976
|
+
}, {
|
|
10977
|
+
readonly name: "tags";
|
|
10978
|
+
readonly type: "array";
|
|
10979
|
+
readonly itemType: "string";
|
|
10980
|
+
readonly required: false;
|
|
10981
|
+
readonly description: "Tags applied when an output becomes a library asset.";
|
|
10982
|
+
}, {
|
|
10983
|
+
readonly name: "understanding";
|
|
10984
|
+
readonly type: "string";
|
|
10985
|
+
readonly enum: readonly ["auto", "skip"];
|
|
10986
|
+
readonly required: false;
|
|
10987
|
+
readonly description: "Understanding behavior when a candidate is saved as an asset; defaults to auto.";
|
|
10988
|
+
}, {
|
|
10989
|
+
readonly name: "references";
|
|
10990
|
+
readonly type: "array";
|
|
10991
|
+
readonly itemType: "object";
|
|
10992
|
+
readonly required: false;
|
|
10993
|
+
readonly description: "Not supported in v1; omit this field. Only text-to-video is currently available.";
|
|
10994
|
+
}];
|
|
10995
|
+
};
|
|
10996
|
+
}, {
|
|
10997
|
+
readonly resource: "media.libraries.jobs";
|
|
10998
|
+
readonly method: "list";
|
|
10999
|
+
readonly summary: "List jobs";
|
|
11000
|
+
readonly description: "List batch and video-generation jobs in a library. Filter by status and continue with next_cursor. Poll a generation Job until terminal, then save successful candidate outputs before they expire after 7 days.";
|
|
11001
|
+
readonly http: "GET";
|
|
11002
|
+
readonly path: "/media/v1/libraries/{library_id}/jobs";
|
|
11003
|
+
readonly streaming: "no";
|
|
11004
|
+
readonly pagination: true;
|
|
11005
|
+
readonly pathParams: readonly [{
|
|
11006
|
+
readonly name: "library_id";
|
|
11007
|
+
readonly sdkName: "library_id";
|
|
11008
|
+
readonly description: "Library ID returned by creation.";
|
|
11009
|
+
}];
|
|
11010
|
+
readonly query: readonly [{
|
|
11011
|
+
readonly name: "status";
|
|
11012
|
+
readonly type: "string";
|
|
11013
|
+
readonly enum: readonly ["queued", "running", "completed", "completed_with_errors", "failed", "cancelled"];
|
|
11014
|
+
readonly required: false;
|
|
11015
|
+
readonly description: "Filter jobs by their current status.";
|
|
11016
|
+
}, {
|
|
11017
|
+
readonly name: "limit";
|
|
11018
|
+
readonly type: "integer";
|
|
11019
|
+
readonly required: false;
|
|
11020
|
+
readonly description: "Maximum entries in this page, from 1 through 100; defaults to 100.";
|
|
11021
|
+
}, {
|
|
11022
|
+
readonly name: "cursor";
|
|
11023
|
+
readonly type: "string";
|
|
11024
|
+
readonly required: false;
|
|
11025
|
+
readonly description: "Job id from the previous page’s next_cursor; omit for the first page.";
|
|
11026
|
+
}];
|
|
10808
11027
|
}, {
|
|
10809
11028
|
readonly resource: "media.libraries.jobs";
|
|
10810
11029
|
readonly method: "retrieve";
|
|
10811
|
-
readonly summary: "Get job
|
|
10812
|
-
readonly description: "Read
|
|
11030
|
+
readonly summary: "Get job";
|
|
11031
|
+
readonly description: "Read the current batch or video-generation Job status and progress. For generation, inspect outputs and failures, then save successful candidates before their preview and save window expires after 7 days.";
|
|
10813
11032
|
readonly http: "GET";
|
|
10814
11033
|
readonly path: "/media/v1/libraries/{library_id}/jobs/{job_id}";
|
|
10815
11034
|
readonly streaming: "no";
|
|
@@ -10821,9 +11040,77 @@ export declare const operations: readonly [{
|
|
|
10821
11040
|
}, {
|
|
10822
11041
|
readonly name: "job_id";
|
|
10823
11042
|
readonly sdkName: "job_id";
|
|
10824
|
-
readonly description: "
|
|
11043
|
+
readonly description: "Job identifier returned by batch creation, video-generation creation or job listing; resolved within this library.";
|
|
11044
|
+
}];
|
|
11045
|
+
readonly query: readonly [];
|
|
11046
|
+
}, {
|
|
11047
|
+
readonly resource: "media.libraries.jobs";
|
|
11048
|
+
readonly method: "cancel";
|
|
11049
|
+
readonly summary: "Cancel job";
|
|
11050
|
+
readonly description: "Cancel a queued or running generation job. Already completed outputs remain available to save; poll or read the returned Job to confirm its status.";
|
|
11051
|
+
readonly http: "POST";
|
|
11052
|
+
readonly path: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel";
|
|
11053
|
+
readonly streaming: "no";
|
|
11054
|
+
readonly pagination: false;
|
|
11055
|
+
readonly pathParams: readonly [{
|
|
11056
|
+
readonly name: "library_id";
|
|
11057
|
+
readonly sdkName: "library_id";
|
|
11058
|
+
readonly description: "Library ID returned by creation.";
|
|
11059
|
+
}, {
|
|
11060
|
+
readonly name: "job_id";
|
|
11061
|
+
readonly sdkName: "job_id";
|
|
11062
|
+
readonly description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library.";
|
|
11063
|
+
}];
|
|
11064
|
+
readonly query: readonly [];
|
|
11065
|
+
}, {
|
|
11066
|
+
readonly resource: "media.libraries.jobs.outputs.save";
|
|
11067
|
+
readonly method: "create";
|
|
11068
|
+
readonly summary: "Save generation output";
|
|
11069
|
+
readonly description: "Save a successful candidate as a library asset. Candidate outputs expire after 7 days; save before expiry. Generation is charged per second when the job runs, not when an output is saved.";
|
|
11070
|
+
readonly http: "POST";
|
|
11071
|
+
readonly path: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save";
|
|
11072
|
+
readonly streaming: "no";
|
|
11073
|
+
readonly pagination: false;
|
|
11074
|
+
readonly pathParams: readonly [{
|
|
11075
|
+
readonly name: "library_id";
|
|
11076
|
+
readonly sdkName: "library_id";
|
|
11077
|
+
readonly description: "Library ID returned by creation.";
|
|
11078
|
+
}, {
|
|
11079
|
+
readonly name: "job_id";
|
|
11080
|
+
readonly sdkName: "job_id";
|
|
11081
|
+
readonly description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library.";
|
|
11082
|
+
}, {
|
|
11083
|
+
readonly name: "index";
|
|
11084
|
+
readonly sdkName: "index";
|
|
11085
|
+
readonly description: "Zero-based position of the candidate in the Job outputs array.";
|
|
10825
11086
|
}];
|
|
10826
11087
|
readonly query: readonly [];
|
|
11088
|
+
readonly body: {
|
|
11089
|
+
readonly required: false;
|
|
11090
|
+
readonly fields: readonly [{
|
|
11091
|
+
readonly name: "public_id";
|
|
11092
|
+
readonly type: "string";
|
|
11093
|
+
readonly required: false;
|
|
11094
|
+
readonly description: "Delivery identifier for the saved asset; defaults to gen_<job_id>_<index> and is idempotent.";
|
|
11095
|
+
}, {
|
|
11096
|
+
readonly name: "asset_folder";
|
|
11097
|
+
readonly type: "string";
|
|
11098
|
+
readonly required: false;
|
|
11099
|
+
readonly description: "Destination folder for the saved asset; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.";
|
|
11100
|
+
}, {
|
|
11101
|
+
readonly name: "tags";
|
|
11102
|
+
readonly type: "array";
|
|
11103
|
+
readonly itemType: "string";
|
|
11104
|
+
readonly required: false;
|
|
11105
|
+
readonly description: "Tags to apply to the saved asset.";
|
|
11106
|
+
}, {
|
|
11107
|
+
readonly name: "understanding";
|
|
11108
|
+
readonly type: "string";
|
|
11109
|
+
readonly enum: readonly ["auto", "skip"];
|
|
11110
|
+
readonly required: false;
|
|
11111
|
+
readonly description: "Understanding behavior for the saved asset; defaults to auto.";
|
|
11112
|
+
}];
|
|
11113
|
+
};
|
|
10827
11114
|
}, {
|
|
10828
11115
|
readonly resource: "media.libraries.purge";
|
|
10829
11116
|
readonly method: "create";
|
|
@@ -11050,7 +11337,7 @@ export declare const operations: readonly [{
|
|
|
11050
11337
|
readonly name: "kinds";
|
|
11051
11338
|
readonly type: "string";
|
|
11052
11339
|
readonly required: false;
|
|
11053
|
-
readonly description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind.";
|
|
11340
|
+
readonly description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, loudness, beats, content, embedding. Omit or empty to include every kind.";
|
|
11054
11341
|
}, {
|
|
11055
11342
|
readonly name: "cursor";
|
|
11056
11343
|
readonly type: "string";
|
|
@@ -12883,6 +13170,451 @@ export declare const operations: readonly [{
|
|
|
12883
13170
|
readonly description: "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400.";
|
|
12884
13171
|
}];
|
|
12885
13172
|
readonly query: readonly [];
|
|
13173
|
+
}, {
|
|
13174
|
+
readonly resource: "ontology.changesets";
|
|
13175
|
+
readonly method: "create";
|
|
13176
|
+
readonly summary: "Apply changeset";
|
|
13177
|
+
readonly description: "Apply a batch of node, relation and invalidation operations as one transaction, when a mirror has several records to write together and a partial write would leave the graph inconsistent. Every operation succeeds or none is applied. Send an Idempotency-Key header; the same key with the same content replays the first result, and the same key with different content is ONTOLOGY_CONFLICT.";
|
|
13178
|
+
readonly http: "POST";
|
|
13179
|
+
readonly path: "/ontology/v1/changesets";
|
|
13180
|
+
readonly streaming: "no";
|
|
13181
|
+
readonly pagination: false;
|
|
13182
|
+
readonly pathParams: readonly [];
|
|
13183
|
+
readonly query: readonly [];
|
|
13184
|
+
readonly body: {
|
|
13185
|
+
readonly required: true;
|
|
13186
|
+
readonly fields: readonly [{
|
|
13187
|
+
readonly name: "at";
|
|
13188
|
+
readonly type: "string";
|
|
13189
|
+
readonly required: true;
|
|
13190
|
+
readonly description: "World time the batch describes, in ISO 8601 UTC; operations without their own time are dated by it.";
|
|
13191
|
+
}, {
|
|
13192
|
+
readonly name: "scope";
|
|
13193
|
+
readonly type: "string";
|
|
13194
|
+
readonly required: false;
|
|
13195
|
+
readonly description: "Scope the batch came from, normally the session id it was observed in; it is stored with the operations for later reading.";
|
|
13196
|
+
}, {
|
|
13197
|
+
readonly name: "ops";
|
|
13198
|
+
readonly type: "array";
|
|
13199
|
+
readonly itemType: "object";
|
|
13200
|
+
readonly required: true;
|
|
13201
|
+
readonly description: "At most 500 operations, applied in order; each names its kind in op and the fields that kind requires.";
|
|
13202
|
+
}];
|
|
13203
|
+
};
|
|
13204
|
+
}, {
|
|
13205
|
+
readonly resource: "ontology.nodes";
|
|
13206
|
+
readonly method: "list";
|
|
13207
|
+
readonly summary: "List nodes";
|
|
13208
|
+
readonly description: "Discover the entities in this organization's graph and obtain node ids for retrieval, updates and relations. Filter by type, by free text over names, aliases, descriptions and facts, or by owner; limit is 1–100 and defaults to 50. Omit cursor for the first page, then copy next_cursor into the next request until it is null. A node whose content belongs to somebody else comes back as a restricted entry carrying only its id, type and name.";
|
|
13209
|
+
readonly http: "GET";
|
|
13210
|
+
readonly path: "/ontology/v1/nodes";
|
|
13211
|
+
readonly streaming: "no";
|
|
13212
|
+
readonly pagination: true;
|
|
13213
|
+
readonly pathParams: readonly [];
|
|
13214
|
+
readonly query: readonly [{
|
|
13215
|
+
readonly name: "type";
|
|
13216
|
+
readonly type: "array";
|
|
13217
|
+
readonly itemType: "string";
|
|
13218
|
+
readonly required: false;
|
|
13219
|
+
readonly description: "Repeat to filter to any of several registered node type names, for example type=file&type=ticket; omit to list every type.";
|
|
13220
|
+
}, {
|
|
13221
|
+
readonly name: "q";
|
|
13222
|
+
readonly type: "string";
|
|
13223
|
+
readonly required: false;
|
|
13224
|
+
readonly description: "Free text matched against node names, aliases and descriptions; omit to list without a text filter.";
|
|
13225
|
+
}, {
|
|
13226
|
+
readonly name: "owner";
|
|
13227
|
+
readonly type: "string";
|
|
13228
|
+
readonly required: false;
|
|
13229
|
+
readonly description: "Filter to nodes owned by this member id, or omit to list nodes of every owner; organization-wide nodes carry no owner.";
|
|
13230
|
+
}, {
|
|
13231
|
+
readonly name: "as_of";
|
|
13232
|
+
readonly type: "string";
|
|
13233
|
+
readonly required: false;
|
|
13234
|
+
readonly description: "ISO 8601 timestamp; return the graph as it was then, so a node recorded later is absent. Omit to read current state.";
|
|
13235
|
+
}, {
|
|
13236
|
+
readonly name: "limit";
|
|
13237
|
+
readonly type: "integer";
|
|
13238
|
+
readonly required: false;
|
|
13239
|
+
readonly description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100.";
|
|
13240
|
+
}, {
|
|
13241
|
+
readonly name: "cursor";
|
|
13242
|
+
readonly type: "string";
|
|
13243
|
+
readonly required: false;
|
|
13244
|
+
readonly description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null.";
|
|
13245
|
+
}];
|
|
13246
|
+
}, {
|
|
13247
|
+
readonly resource: "ontology.nodes";
|
|
13248
|
+
readonly method: "create";
|
|
13249
|
+
readonly summary: "Create node";
|
|
13250
|
+
readonly description: "Record one entity in the graph, for a system mirroring a record it owns. type must already be registered and ref, when given, must match that type's ref_prefix. Send an Idempotency-Key header; repeating the same key with the same content returns the first result instead of creating a second node. This writes structure only — to give an agent something to remember, use POST /agent/v1/agents/{agent_id}/consolidations.";
|
|
13251
|
+
readonly http: "POST";
|
|
13252
|
+
readonly path: "/ontology/v1/nodes";
|
|
13253
|
+
readonly streaming: "no";
|
|
13254
|
+
readonly pagination: false;
|
|
13255
|
+
readonly pathParams: readonly [];
|
|
13256
|
+
readonly query: readonly [];
|
|
13257
|
+
readonly body: {
|
|
13258
|
+
readonly required: true;
|
|
13259
|
+
readonly fields: readonly [{
|
|
13260
|
+
readonly name: "type";
|
|
13261
|
+
readonly type: "string";
|
|
13262
|
+
readonly required: true;
|
|
13263
|
+
readonly description: "Registered node type name from types.list; an unregistered name is refused and nothing is written.";
|
|
13264
|
+
}, {
|
|
13265
|
+
readonly name: "ref";
|
|
13266
|
+
readonly type: "string";
|
|
13267
|
+
readonly required: false;
|
|
13268
|
+
readonly description: "Id of the mirrored record in the owning service, which must start with the type's ref_prefix; omit or null for a concept with no external record.";
|
|
13269
|
+
}, {
|
|
13270
|
+
readonly name: "name";
|
|
13271
|
+
readonly type: "string";
|
|
13272
|
+
readonly required: true;
|
|
13273
|
+
readonly description: "Display name of the entity, at most 200 characters.";
|
|
13274
|
+
}, {
|
|
13275
|
+
readonly name: "aliases";
|
|
13276
|
+
readonly type: "array";
|
|
13277
|
+
readonly itemType: "string";
|
|
13278
|
+
readonly required: false;
|
|
13279
|
+
readonly description: "Other names this entity is known by; they are matched by search alongside the name.";
|
|
13280
|
+
}, {
|
|
13281
|
+
readonly name: "description";
|
|
13282
|
+
readonly type: "string";
|
|
13283
|
+
readonly required: false;
|
|
13284
|
+
readonly description: "Profile of the entity, at most 500 characters; omit or null for none.";
|
|
13285
|
+
}, {
|
|
13286
|
+
readonly name: "owner";
|
|
13287
|
+
readonly type: "string";
|
|
13288
|
+
readonly required: false;
|
|
13289
|
+
readonly description: "Member id whose content this is, restricting it to that member; omit or null to make it readable organization-wide.";
|
|
13290
|
+
}];
|
|
13291
|
+
};
|
|
13292
|
+
}, {
|
|
13293
|
+
readonly resource: "ontology.nodes";
|
|
13294
|
+
readonly method: "retrieve";
|
|
13295
|
+
readonly summary: "Retrieve node";
|
|
13296
|
+
readonly description: "Read one node's content and, with expand=relations, every relation on and around it. as_of reads the node as it was at that time. A node id from another organization, or one that never existed, answers ONTOLOGY_NODE_NOT_FOUND; a node you may reach but not read returns restricted true with its name only.";
|
|
13297
|
+
readonly http: "GET";
|
|
13298
|
+
readonly path: "/ontology/v1/nodes/{node_id}";
|
|
13299
|
+
readonly streaming: "no";
|
|
13300
|
+
readonly pagination: false;
|
|
13301
|
+
readonly pathParams: readonly [{
|
|
13302
|
+
readonly name: "node_id";
|
|
13303
|
+
readonly sdkName: "node_id";
|
|
13304
|
+
readonly description: "Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted.";
|
|
13305
|
+
}];
|
|
13306
|
+
readonly query: readonly [{
|
|
13307
|
+
readonly name: "expand";
|
|
13308
|
+
readonly type: "string";
|
|
13309
|
+
readonly enum: readonly ["relations"];
|
|
13310
|
+
readonly required: false;
|
|
13311
|
+
readonly description: "Set to relations to include the node's incoming and outgoing relations in the same response; omit for the node alone.";
|
|
13312
|
+
}, {
|
|
13313
|
+
readonly name: "as_of";
|
|
13314
|
+
readonly type: "string";
|
|
13315
|
+
readonly required: false;
|
|
13316
|
+
readonly description: "ISO 8601 timestamp; read the node and its relations as they were then, including relations invalidated since. Omit to read current state.";
|
|
13317
|
+
}];
|
|
13318
|
+
}, {
|
|
13319
|
+
readonly resource: "ontology.nodes";
|
|
13320
|
+
readonly method: "update";
|
|
13321
|
+
readonly summary: "Update node";
|
|
13322
|
+
readonly description: "Change a node's name, aliases or description when the mirrored record was renamed, without touching its type or identity. Send only the fields to change; omitted fields keep their current values and an explicitly null description clears it. Repeating the same edit converges on the same node, so this needs no Idempotency-Key.";
|
|
13323
|
+
readonly http: "PATCH";
|
|
13324
|
+
readonly path: "/ontology/v1/nodes/{node_id}";
|
|
13325
|
+
readonly streaming: "no";
|
|
13326
|
+
readonly pagination: false;
|
|
13327
|
+
readonly pathParams: readonly [{
|
|
13328
|
+
readonly name: "node_id";
|
|
13329
|
+
readonly sdkName: "node_id";
|
|
13330
|
+
readonly description: "Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted.";
|
|
13331
|
+
}];
|
|
13332
|
+
readonly query: readonly [];
|
|
13333
|
+
readonly body: {
|
|
13334
|
+
readonly required: true;
|
|
13335
|
+
readonly fields: readonly [{
|
|
13336
|
+
readonly name: "name";
|
|
13337
|
+
readonly type: "string";
|
|
13338
|
+
readonly required: false;
|
|
13339
|
+
readonly description: "New display name, at most 200 characters; omit to keep the current name.";
|
|
13340
|
+
}, {
|
|
13341
|
+
readonly name: "aliases";
|
|
13342
|
+
readonly type: "array";
|
|
13343
|
+
readonly itemType: "string";
|
|
13344
|
+
readonly required: false;
|
|
13345
|
+
readonly description: "Replacement alias list; an empty array clears the aliases and omitting the field keeps them.";
|
|
13346
|
+
}, {
|
|
13347
|
+
readonly name: "description";
|
|
13348
|
+
readonly type: "string";
|
|
13349
|
+
readonly required: false;
|
|
13350
|
+
readonly description: "Replacement profile, at most 500 characters; an explicit null clears it and omitting the field keeps it.";
|
|
13351
|
+
}];
|
|
13352
|
+
};
|
|
13353
|
+
}, {
|
|
13354
|
+
readonly resource: "ontology.nodes.merge";
|
|
13355
|
+
readonly method: "create";
|
|
13356
|
+
readonly summary: "Merge node";
|
|
13357
|
+
readonly description: "Fold a duplicate node into the node that should survive, when two records are discovered to be the same entity. The merged node's relations and aliases move to the survivor and later reads of the duplicate resolve to it. Send an Idempotency-Key header; repeating the same key replays the first result. Reversal is a staff operation, not available here.";
|
|
13358
|
+
readonly http: "POST";
|
|
13359
|
+
readonly path: "/ontology/v1/nodes/{node_id}/merge";
|
|
13360
|
+
readonly streaming: "no";
|
|
13361
|
+
readonly pagination: false;
|
|
13362
|
+
readonly pathParams: readonly [{
|
|
13363
|
+
readonly name: "node_id";
|
|
13364
|
+
readonly sdkName: "node_id";
|
|
13365
|
+
readonly description: "Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted.";
|
|
13366
|
+
}];
|
|
13367
|
+
readonly query: readonly [];
|
|
13368
|
+
readonly body: {
|
|
13369
|
+
readonly required: true;
|
|
13370
|
+
readonly fields: readonly [{
|
|
13371
|
+
readonly name: "into";
|
|
13372
|
+
readonly type: "string";
|
|
13373
|
+
readonly required: true;
|
|
13374
|
+
readonly description: "Node id that should survive, from nodes.list or search; the merged node's relations and aliases move to it.";
|
|
13375
|
+
}];
|
|
13376
|
+
};
|
|
13377
|
+
}, {
|
|
13378
|
+
readonly resource: "ontology.relations";
|
|
13379
|
+
readonly method: "list";
|
|
13380
|
+
readonly summary: "List relations";
|
|
13381
|
+
readonly description: "Read the facts in the graph and obtain relation ids for retrieval, invalidation or spreading. Filter by endpoint node, by type and by direction; as_of reads the relations as they were then. Invalidated relations are omitted unless include_invalid is true. limit is 1–100 and defaults to 50; follow next_cursor until it is null.";
|
|
13382
|
+
readonly http: "GET";
|
|
13383
|
+
readonly path: "/ontology/v1/relations";
|
|
13384
|
+
readonly streaming: "no";
|
|
13385
|
+
readonly pagination: true;
|
|
13386
|
+
readonly pathParams: readonly [];
|
|
13387
|
+
readonly query: readonly [{
|
|
13388
|
+
readonly name: "node";
|
|
13389
|
+
readonly type: "string";
|
|
13390
|
+
readonly required: false;
|
|
13391
|
+
readonly description: "A node id from nodes.list or nodes.create; returns the relations this node takes part in, narrowed by direction. Omit to list relations between every node.";
|
|
13392
|
+
}, {
|
|
13393
|
+
readonly name: "type";
|
|
13394
|
+
readonly type: "array";
|
|
13395
|
+
readonly itemType: "string";
|
|
13396
|
+
readonly required: false;
|
|
13397
|
+
readonly description: "Repeat to filter to any of several registered relation type names, for example type=references&type=serves; omit to list every type.";
|
|
13398
|
+
}, {
|
|
13399
|
+
readonly name: "direction";
|
|
13400
|
+
readonly type: "string";
|
|
13401
|
+
readonly enum: readonly ["out", "in", "both"];
|
|
13402
|
+
readonly required: false;
|
|
13403
|
+
readonly description: "Which side of node to follow; out returns relations the node is the source of, in returns those it is the target of. Only meaningful together with node.";
|
|
13404
|
+
}, {
|
|
13405
|
+
readonly name: "as_of";
|
|
13406
|
+
readonly type: "string";
|
|
13407
|
+
readonly required: false;
|
|
13408
|
+
readonly description: "ISO 8601 timestamp; read relations as they were then, so one recorded or invalidated later is judged by that time. Omit to read current state.";
|
|
13409
|
+
}, {
|
|
13410
|
+
readonly name: "include_invalid";
|
|
13411
|
+
readonly type: "boolean";
|
|
13412
|
+
readonly required: false;
|
|
13413
|
+
readonly description: "Set true to include relations whose invalid_at has passed, which is how a relation that stopped being true stays readable. Omit or false for currently valid relations only.";
|
|
13414
|
+
}, {
|
|
13415
|
+
readonly name: "limit";
|
|
13416
|
+
readonly type: "integer";
|
|
13417
|
+
readonly required: false;
|
|
13418
|
+
readonly description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100.";
|
|
13419
|
+
}, {
|
|
13420
|
+
readonly name: "cursor";
|
|
13421
|
+
readonly type: "string";
|
|
13422
|
+
readonly required: false;
|
|
13423
|
+
readonly description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null.";
|
|
13424
|
+
}];
|
|
13425
|
+
}, {
|
|
13426
|
+
readonly resource: "ontology.relations";
|
|
13427
|
+
readonly method: "create";
|
|
13428
|
+
readonly summary: "Create relation";
|
|
13429
|
+
readonly description: "Record one fact between two existing nodes, for a system mirroring a relationship it owns. type must be registered and must admit these endpoints; fact states the relationship in one sentence. Send an Idempotency-Key header; repeating the same key returns the first result instead of writing a second relation. This writes structure only — to give an agent something to remember, use POST /agent/v1/agents/{agent_id}/consolidations.";
|
|
13430
|
+
readonly http: "POST";
|
|
13431
|
+
readonly path: "/ontology/v1/relations";
|
|
13432
|
+
readonly streaming: "no";
|
|
13433
|
+
readonly pagination: false;
|
|
13434
|
+
readonly pathParams: readonly [];
|
|
13435
|
+
readonly query: readonly [];
|
|
13436
|
+
readonly body: {
|
|
13437
|
+
readonly required: true;
|
|
13438
|
+
readonly fields: readonly [{
|
|
13439
|
+
readonly name: "type";
|
|
13440
|
+
readonly type: "string";
|
|
13441
|
+
readonly required: true;
|
|
13442
|
+
readonly description: "Registered relation type name from types.list; it must admit both endpoints or the write is refused.";
|
|
13443
|
+
}, {
|
|
13444
|
+
readonly name: "source";
|
|
13445
|
+
readonly type: "string";
|
|
13446
|
+
readonly required: true;
|
|
13447
|
+
readonly description: "Node id the fact starts from, from nodes.list or nodes.create.";
|
|
13448
|
+
}, {
|
|
13449
|
+
readonly name: "target";
|
|
13450
|
+
readonly type: "string";
|
|
13451
|
+
readonly required: true;
|
|
13452
|
+
readonly description: "Node id the fact points at, from nodes.list or nodes.create.";
|
|
13453
|
+
}, {
|
|
13454
|
+
readonly name: "fact";
|
|
13455
|
+
readonly type: "string";
|
|
13456
|
+
readonly required: true;
|
|
13457
|
+
readonly description: "The relationship in one sentence, at most 280 characters, written to read back on its own.";
|
|
13458
|
+
}, {
|
|
13459
|
+
readonly name: "valid_at";
|
|
13460
|
+
readonly type: "string";
|
|
13461
|
+
readonly required: false;
|
|
13462
|
+
readonly description: "World time the fact became true, when the mirrored record dates it; omit to leave it undated.";
|
|
13463
|
+
}, {
|
|
13464
|
+
readonly name: "owner";
|
|
13465
|
+
readonly type: "string";
|
|
13466
|
+
readonly required: false;
|
|
13467
|
+
readonly description: "Member id whose content this fact is, restricting it to that member; omit or null for organization-wide.";
|
|
13468
|
+
}];
|
|
13469
|
+
};
|
|
13470
|
+
}, {
|
|
13471
|
+
readonly resource: "ontology.relations";
|
|
13472
|
+
readonly method: "retrieve";
|
|
13473
|
+
readonly summary: "Retrieve relation";
|
|
13474
|
+
readonly description: "Read one relation's fact and both of its clocks — valid_at and invalid_at for when it was true in the world, created_at and expired_at for when it was recorded and retired. An id from another organization, or one that never existed, answers ONTOLOGY_EDGE_NOT_FOUND.";
|
|
13475
|
+
readonly http: "GET";
|
|
13476
|
+
readonly path: "/ontology/v1/relations/{relation_id}";
|
|
13477
|
+
readonly streaming: "no";
|
|
13478
|
+
readonly pagination: false;
|
|
13479
|
+
readonly pathParams: readonly [{
|
|
13480
|
+
readonly name: "relation_id";
|
|
13481
|
+
readonly sdkName: "relation_id";
|
|
13482
|
+
readonly description: "Relation id returned by relations.list, relations.create or a changeset, in the form oed_ followed by 32 lowercase letters or digits; a node id is not accepted.";
|
|
13483
|
+
}];
|
|
13484
|
+
readonly query: readonly [];
|
|
13485
|
+
}, {
|
|
13486
|
+
readonly resource: "ontology.relations.invalidate";
|
|
13487
|
+
readonly method: "create";
|
|
13488
|
+
readonly summary: "Invalidate relation";
|
|
13489
|
+
readonly description: "Mark a relation as no longer true from a world time, when the mirrored record changed. The relation is kept — invalid_at moves and the relation still reads at an earlier as_of, so history stays answerable. Send an Idempotency-Key header; repeating the same key replays the first result. There is no delete.";
|
|
13490
|
+
readonly http: "POST";
|
|
13491
|
+
readonly path: "/ontology/v1/relations/{relation_id}/invalidate";
|
|
13492
|
+
readonly streaming: "no";
|
|
13493
|
+
readonly pagination: false;
|
|
13494
|
+
readonly pathParams: readonly [{
|
|
13495
|
+
readonly name: "relation_id";
|
|
13496
|
+
readonly sdkName: "relation_id";
|
|
13497
|
+
readonly description: "Relation id returned by relations.list, relations.create or a changeset, in the form oed_ followed by 32 lowercase letters or digits; a node id is not accepted.";
|
|
13498
|
+
}];
|
|
13499
|
+
readonly query: readonly [];
|
|
13500
|
+
readonly body: {
|
|
13501
|
+
readonly required: true;
|
|
13502
|
+
readonly fields: readonly [{
|
|
13503
|
+
readonly name: "invalid_at";
|
|
13504
|
+
readonly type: "string";
|
|
13505
|
+
readonly required: true;
|
|
13506
|
+
readonly description: "World time the fact stopped being true, in ISO 8601 UTC; reads at an earlier as_of still return the relation.";
|
|
13507
|
+
}, {
|
|
13508
|
+
readonly name: "superseded_by";
|
|
13509
|
+
readonly type: "string";
|
|
13510
|
+
readonly required: false;
|
|
13511
|
+
readonly description: "Relation id that replaces this one, when a successor was recorded; omit or null when nothing replaced it.";
|
|
13512
|
+
}, {
|
|
13513
|
+
readonly name: "reason";
|
|
13514
|
+
readonly type: "string";
|
|
13515
|
+
readonly required: false;
|
|
13516
|
+
readonly description: "Why it stopped being true, for people reading the history later; not enforced and safe to omit.";
|
|
13517
|
+
}];
|
|
13518
|
+
};
|
|
13519
|
+
}, {
|
|
13520
|
+
readonly resource: "ontology.search";
|
|
13521
|
+
readonly method: "create";
|
|
13522
|
+
readonly summary: "Search nodes";
|
|
13523
|
+
readonly description: "Resolve text to the nodes it most likely names, when a mirror holds a name and needs the node id it corresponds to. Results are ranked candidates, not an answer, each reporting whether the match came from the node's name, an alias, its description or a relation's fact. Narrow with types, and cap the result count with limit (1–50, default 20). This reads structure; it is not an agent recall — agents recall through POST /agent/v1/agents/{agent_id}/consolidations.";
|
|
13524
|
+
readonly http: "POST";
|
|
13525
|
+
readonly path: "/ontology/v1/search";
|
|
13526
|
+
readonly streaming: "no";
|
|
13527
|
+
readonly pagination: false;
|
|
13528
|
+
readonly pathParams: readonly [];
|
|
13529
|
+
readonly query: readonly [];
|
|
13530
|
+
readonly body: {
|
|
13531
|
+
readonly required: true;
|
|
13532
|
+
readonly fields: readonly [{
|
|
13533
|
+
readonly name: "text";
|
|
13534
|
+
readonly type: "string";
|
|
13535
|
+
readonly required: true;
|
|
13536
|
+
readonly description: "Text to find nodes for, matched against names, aliases, descriptions and relation facts; an empty string is refused.";
|
|
13537
|
+
}, {
|
|
13538
|
+
readonly name: "types";
|
|
13539
|
+
readonly type: "array";
|
|
13540
|
+
readonly itemType: "string";
|
|
13541
|
+
readonly required: false;
|
|
13542
|
+
readonly description: "Registered node type names to search within; omit to search every type.";
|
|
13543
|
+
}, {
|
|
13544
|
+
readonly name: "window";
|
|
13545
|
+
readonly type: "object";
|
|
13546
|
+
readonly required: false;
|
|
13547
|
+
readonly description: "Restrict matches to facts recorded within a period; omit to search all time.";
|
|
13548
|
+
}, {
|
|
13549
|
+
readonly name: "limit";
|
|
13550
|
+
readonly type: "integer";
|
|
13551
|
+
readonly required: false;
|
|
13552
|
+
readonly description: "Maximum candidate nodes to return, from 1 to 50; defaults to 20 when omitted.";
|
|
13553
|
+
}];
|
|
13554
|
+
};
|
|
13555
|
+
}, {
|
|
13556
|
+
readonly resource: "ontology.types";
|
|
13557
|
+
readonly method: "list";
|
|
13558
|
+
readonly summary: "List types";
|
|
13559
|
+
readonly description: "Read the node and relation types registered for this organization before writing, so a create names a type the graph accepts. Each entry is one registrant's registration with its owner, version and definitions. Types cannot be created at runtime; they are registered by the owning service at deploy time, so a type missing here is not available to write.";
|
|
13560
|
+
readonly http: "GET";
|
|
13561
|
+
readonly path: "/ontology/v1/types";
|
|
13562
|
+
readonly streaming: "no";
|
|
13563
|
+
readonly pagination: false;
|
|
13564
|
+
readonly pathParams: readonly [];
|
|
13565
|
+
readonly query: readonly [];
|
|
13566
|
+
}, {
|
|
13567
|
+
readonly resource: "ontology.types";
|
|
13568
|
+
readonly method: "create";
|
|
13569
|
+
readonly summary: "Register type";
|
|
13570
|
+
readonly description: "Register a node or relation type for this organization. Not open yet — this call currently answers 501 NOT_IMPLEMENTED and writes nothing, because a registration is checked and stored by the deploy gate that ships the registering service, not by a runtime call. Until it opens, read the types already in force with praxis.ontology.types.list and create records only of those types.";
|
|
13571
|
+
readonly http: "POST";
|
|
13572
|
+
readonly path: "/ontology/v1/types";
|
|
13573
|
+
readonly streaming: "no";
|
|
13574
|
+
readonly pagination: false;
|
|
13575
|
+
readonly pathParams: readonly [];
|
|
13576
|
+
readonly query: readonly [];
|
|
13577
|
+
readonly body: {
|
|
13578
|
+
readonly required: true;
|
|
13579
|
+
readonly fields: readonly [{
|
|
13580
|
+
readonly name: "owner";
|
|
13581
|
+
readonly type: "string";
|
|
13582
|
+
readonly required: true;
|
|
13583
|
+
readonly description: "Service that registered these types, for example file or ticket; it is the registrant a later change to a type is checked against.";
|
|
13584
|
+
}, {
|
|
13585
|
+
readonly name: "version";
|
|
13586
|
+
readonly type: "integer";
|
|
13587
|
+
readonly required: true;
|
|
13588
|
+
readonly description: "Monotonic version of this owner's registration; a later registration must extend this one without removing or narrowing anything.";
|
|
13589
|
+
}, {
|
|
13590
|
+
readonly name: "nodes";
|
|
13591
|
+
readonly type: "array";
|
|
13592
|
+
readonly itemType: "object";
|
|
13593
|
+
readonly required: true;
|
|
13594
|
+
readonly description: "Node types this owner registers.";
|
|
13595
|
+
}, {
|
|
13596
|
+
readonly name: "edges";
|
|
13597
|
+
readonly type: "array";
|
|
13598
|
+
readonly itemType: "object";
|
|
13599
|
+
readonly required: true;
|
|
13600
|
+
readonly description: "Relation types this owner registers.";
|
|
13601
|
+
}];
|
|
13602
|
+
};
|
|
13603
|
+
}, {
|
|
13604
|
+
readonly resource: "ontology.types";
|
|
13605
|
+
readonly method: "retrieve";
|
|
13606
|
+
readonly summary: "Retrieve type";
|
|
13607
|
+
readonly description: "Read one registered type's definition before writing a record of it, to learn whether it is a node or an edge, which endpoints an edge type admits, and which origins it accepts. The name comes from types.list; a name that is not registered answers ONTOLOGY_TYPE_UNKNOWN, and writes of that type are refused.";
|
|
13608
|
+
readonly http: "GET";
|
|
13609
|
+
readonly path: "/ontology/v1/types/{name}";
|
|
13610
|
+
readonly streaming: "no";
|
|
13611
|
+
readonly pagination: false;
|
|
13612
|
+
readonly pathParams: readonly [{
|
|
13613
|
+
readonly name: "name";
|
|
13614
|
+
readonly sdkName: "name";
|
|
13615
|
+
readonly description: "A type name from types.list, with its dots preserved — a display label is not accepted.";
|
|
13616
|
+
}];
|
|
13617
|
+
readonly query: readonly [];
|
|
12886
13618
|
}, {
|
|
12887
13619
|
readonly resource: "organization.charges";
|
|
12888
13620
|
readonly method: "list";
|
|
@@ -14935,7 +15667,7 @@ export declare const operations: readonly [{
|
|
|
14935
15667
|
readonly resource: "ticket.labels";
|
|
14936
15668
|
readonly method: "create";
|
|
14937
15669
|
readonly summary: "Create or add labels";
|
|
14938
|
-
readonly description: "Create or add labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result.
|
|
15670
|
+
readonly description: "Create or add labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
14939
15671
|
readonly http: "POST";
|
|
14940
15672
|
readonly path: "/ticket/v1/labels";
|
|
14941
15673
|
readonly streaming: "no";
|
|
@@ -14970,7 +15702,7 @@ export declare const operations: readonly [{
|
|
|
14970
15702
|
readonly resource: "ticket.labels";
|
|
14971
15703
|
readonly method: "delete";
|
|
14972
15704
|
readonly summary: "Remove labels";
|
|
14973
|
-
readonly description: "Remove labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result.
|
|
15705
|
+
readonly description: "Remove labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
14974
15706
|
readonly http: "DELETE";
|
|
14975
15707
|
readonly path: "/ticket/v1/labels/{name}";
|
|
14976
15708
|
readonly streaming: "no";
|
|
@@ -14990,7 +15722,7 @@ export declare const operations: readonly [{
|
|
|
14990
15722
|
readonly resource: "ticket.labels";
|
|
14991
15723
|
readonly method: "update";
|
|
14992
15724
|
readonly summary: "Update labels";
|
|
14993
|
-
readonly description: "Update labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result.
|
|
15725
|
+
readonly description: "Update labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
14994
15726
|
readonly http: "PATCH";
|
|
14995
15727
|
readonly path: "/ticket/v1/labels/{name}";
|
|
14996
15728
|
readonly streaming: "no";
|
|
@@ -15230,7 +15962,7 @@ export declare const operations: readonly [{
|
|
|
15230
15962
|
readonly name: "filter";
|
|
15231
15963
|
readonly type: "string";
|
|
15232
15964
|
readonly required: false;
|
|
15233
|
-
readonly description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort;
|
|
15965
|
+
readonly description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort; write each qualifier as field:value (for example, is:open milestone:5), never field=value. Unknown qualifiers return INVALID_PARAMS. Passed unchanged to the service.";
|
|
15234
15966
|
}];
|
|
15235
15967
|
}, {
|
|
15236
15968
|
readonly resource: "ticket.tickets";
|
|
@@ -16124,7 +16856,7 @@ export declare const operations: readonly [{
|
|
|
16124
16856
|
readonly resource: "vault.vaults";
|
|
16125
16857
|
readonly method: "create";
|
|
16126
16858
|
readonly summary: "Create vault";
|
|
16127
|
-
readonly description: "Create an empty, active vault to hold credentials for your account, with a display name and optional metadata. Use its returned id as vault_id when creating secrets or OAuth authorizations.
|
|
16859
|
+
readonly description: "Create an empty, active vault to hold credentials for your account, with a display name and optional metadata. Use its returned id as vault_id when creating secrets or OAuth authorizations. Agent sessions and deployments accept up to 50 vault_ids and match their credentials against the session's MCP servers, so a stored static or oauth credential does serve as vault-backed MCP authentication; only environment_variable credentials are not yet placed, because the egress proxy ADR-058 §6 gives them is not built. Application vault references are also unavailable; praxis_vault_ref version bindings and secret writes with a vault source return 501, so creating a vault does not yet enable either consumer.";
|
|
16128
16860
|
readonly http: "POST";
|
|
16129
16861
|
readonly path: "/vault/v1/vaults";
|
|
16130
16862
|
readonly streaming: "no";
|