@deepraxis/sdk 0.1.1-dev.e5db771 → 0.1.1-dev.e9377c2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/METHODS.md +53 -1
- package/README.md +2 -2
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +132 -25
- package/dist/generated/sdk.gen.js +283 -24
- package/dist/generated/types.gen.d.ts +1444 -33
- package/dist/operations.generated.d.ts +482 -17
- package/dist/operations.generated.js +574 -17
- package/dist/resources.generated.d.ts +41 -8
- package/dist/resources.generated.js +34 -0
- package/package.json +2 -2
|
@@ -1169,7 +1169,7 @@ export const fileRetrieveFileContent = (options) => (options.client ?? client).g
|
|
|
1169
1169
|
/**
|
|
1170
1170
|
* Create an upload
|
|
1171
1171
|
*
|
|
1172
|
-
* Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most
|
|
1172
|
+
* Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 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.
|
|
1173
1173
|
*/
|
|
1174
1174
|
export const fileCreateUpload = (options) => (options.client ?? client).post({
|
|
1175
1175
|
security: [{
|
|
@@ -1187,7 +1187,7 @@ export const fileCreateUpload = (options) => (options.client ?? client).post({
|
|
|
1187
1187
|
/**
|
|
1188
1188
|
* Add an upload part
|
|
1189
1189
|
*
|
|
1190
|
-
* 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.
|
|
1190
|
+
* 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.
|
|
1191
1191
|
*/
|
|
1192
1192
|
export const fileAddUploadPart = (options) => (options.client ?? client).post({
|
|
1193
1193
|
...formDataBodySerializer,
|
|
@@ -1206,7 +1206,7 @@ export const fileAddUploadPart = (options) => (options.client ?? client).post({
|
|
|
1206
1206
|
/**
|
|
1207
1207
|
* Complete an upload
|
|
1208
1208
|
*
|
|
1209
|
-
* 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.
|
|
1209
|
+
* 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.
|
|
1210
1210
|
*/
|
|
1211
1211
|
export const fileCompleteUpload = (options) => (options.client ?? client).post({
|
|
1212
1212
|
security: [{
|
|
@@ -1235,10 +1235,24 @@ export const fileCancelUpload = (options) => (options.client ?? client).post({
|
|
|
1235
1235
|
url: '/file/v1/uploads/{upload_id}/cancel',
|
|
1236
1236
|
...options
|
|
1237
1237
|
});
|
|
1238
|
+
/**
|
|
1239
|
+
* Retrieve an upload
|
|
1240
|
+
*
|
|
1241
|
+
* 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.
|
|
1242
|
+
*/
|
|
1243
|
+
export const fileRetrieveUpload = (options) => (options.client ?? client).get({
|
|
1244
|
+
security: [{
|
|
1245
|
+
key: 'BearerAuth',
|
|
1246
|
+
scheme: 'bearer',
|
|
1247
|
+
type: 'http'
|
|
1248
|
+
}],
|
|
1249
|
+
url: '/file/v1/uploads/{upload_id}',
|
|
1250
|
+
...options
|
|
1251
|
+
});
|
|
1238
1252
|
/**
|
|
1239
1253
|
* Create a one-time upload URL
|
|
1240
1254
|
*
|
|
1241
|
-
* Upload a local file of up to
|
|
1255
|
+
* 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"}.
|
|
1242
1256
|
*/
|
|
1243
1257
|
export const fileCreateSignedUpload = (options) => (options.client ?? client).post({
|
|
1244
1258
|
security: [{
|
|
@@ -6383,11 +6397,14 @@ export const cutUndeleteProject = (options) => (options.client ?? client).post({
|
|
|
6383
6397
|
* GetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];
|
|
6384
6398
|
* GetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];
|
|
6385
6399
|
* ListTransitions(): TransitionInfo[];
|
|
6400
|
+
* ListEffects(): EffectInfo[];
|
|
6401
|
+
* ListTextStyles(): TextStylePreset[];
|
|
6402
|
+
* ListTextTemplates(): TextTemplate[];
|
|
6386
6403
|
* ListAnimations(): { id: string; version: number; phase: "in" | "out" | "loop"; target: "any" | "text"; name: string; description: string; defaultDuration: number; params: { name: string; type: string; values?: string[]; default?: string | number; min?: number; max?: number; description: string }[] }[];
|
|
6387
6404
|
* ListFonts(): { family: string; weights: number[]; scripts: ("latin"|"cjk")[]; source: "bundled"|"catalog" }[];
|
|
6388
6405
|
* Insert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;
|
|
6389
6406
|
* Update(id: ClipId, patch: ItemPatchView): void;
|
|
6390
|
-
* SetSpeed(id: ClipId, rate: number, o: { keep: "source" | "duration"; ripple?: boolean }): { length: number; sourceOut: number };
|
|
6407
|
+
* SetSpeed(id: ClipId, rate: number | { curve: { at: number; rate: number; ease?: Ease }[]; audio?: "mute" | "resample" }, o: { keep: "source" | "duration"; ripple?: boolean }): { length: number; sourceOut: number };
|
|
6391
6408
|
* Delete(id: ClipId, o?: { ripple?: boolean }): void;
|
|
6392
6409
|
* Join(left: ClipId, right: ClipId, o: { length?: number; effect: TransitionInput }): JoinId;
|
|
6393
6410
|
* UpdateJoin(id: JoinId, patch: { length?: number; effect?: TransitionInput }): void;
|
|
@@ -6396,11 +6413,15 @@ export const cutUndeleteProject = (options) => (options.client ?? client).post({
|
|
|
6396
6413
|
* Trim(id: ClipId, edge: "in" | "out", delta: number, o?: { ripple?: boolean }): void;
|
|
6397
6414
|
* Move(id: ClipId, start: number, track?: TrackId): void;
|
|
6398
6415
|
* RippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;
|
|
6399
|
-
* AddTrack(kind: "video" | "audio" | "caption", init?: { name?: string }, index?: number): TrackId;
|
|
6416
|
+
* AddTrack(kind: "video" | "audio" | "caption", init?: { name?: string; role?: "voice" | "music" | "sfx" }, index?: number): TrackId;
|
|
6400
6417
|
* UpdateTrack(id: TrackId, patch: TrackPatch): void;
|
|
6401
6418
|
* DeleteTrack(id: TrackId): void;
|
|
6402
6419
|
* SetSettings(patch: Partial<ProjectSettingsView>): void;
|
|
6403
|
-
* AddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle
|
|
6420
|
+
* AddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle> & { preset?: string }; maxChars?: number }): ClipId[];
|
|
6421
|
+
* InsertTemplate(track: TrackId, o: { template: string; start: number; slots?: Record<string, string> }): ClipId[];
|
|
6422
|
+
* AlignCaptions(trackId: TrackId, script: string, options?: { resplit?: boolean; maxChars?: number }): { replaced: number; added: number; deleted: number };
|
|
6423
|
+
* ImportCaptions(trackId: TrackId, text: string, o?: { format?: "srt" | "vtt"; offset?: number }): ClipId[];
|
|
6424
|
+
* ExportCaptions(trackId: TrackId, o: { format: "srt" | "vtt" }): string;
|
|
6404
6425
|
* SetMarker(at: number, label: string): string;
|
|
6405
6426
|
* Print(...values: unknown[]): void;
|
|
6406
6427
|
* Preview(at: number[]): void;
|
|
@@ -6408,20 +6429,22 @@ export const cutUndeleteProject = (options) => (options.client ?? client).post({
|
|
|
6408
6429
|
*
|
|
6409
6430
|
* | Functions | Behavior and arguments |
|
|
6410
6431
|
* | --- | --- |
|
|
6411
|
-
* | GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, playback, sourceIn/sourceOut, text and offline reason. GetTimeline returns duration, tracks (id, kind, name, index, locked, items), and joins (id, track, left, right, length in seconds, normalized effect). from/to and tracks narrow the items and joins; joins are selected by their overlap window. |
|
|
6432
|
+
* | GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, playback, sourceIn/sourceOut, text, effects, blend and offline reason. GetTimeline returns duration, tracks (id, kind, name, index, locked, items), and joins (id, track, left, right, length in seconds, normalized effect). from/to and tracks narrow the items and joins; joins are selected by their overlap window. |
|
|
6433
|
+
* | ListEffects | Discover the shared visual-effect catalog with parameter types, ranges, defaults, cost and bounds. Effects are supported only on visual clips. |
|
|
6412
6434
|
* | ListTransitions | Discover the shared validation catalog: each entry contains kind (effect ID), name, description and params. Each parameter has name, type (enum/number/integer), default, description, enum values or numeric min/max. Use the returned kind and parameter names inside effect. |
|
|
6413
6435
|
* | ListAnimations | Discover animation presets. Each entry has id, version, phase (`in`, `out`, `loop`), target (`any`, `text`), name, description, defaultDuration (seconds), and params (name, type, values/default/min/max/description as applicable). A slot use is `{preset, duration?, ...params}`; duration is seconds. |
|
|
6414
6436
|
* | FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |
|
|
6415
6437
|
* | GetMedia | Read metadata for `{libraryId, assetId}` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |
|
|
6416
6438
|
* | GetTranscript, GetAnalysis | Read available transcript words or silence/filler/scenes segments. Transcript filter from/to is seconds; returned word and segment from/to values are source microseconds (divide by 1,000,000 for editing). Words contain text and optional speaker/filler; segments may include label/confidence. Request analysis first if unavailable. |
|
|
6417
6439
|
* | Insert, Update, Delete | Insert returns the new clip ID; Update changes supplied fields; Delete removes the clip. Optional ripple on Insert/Delete closes or opens space on the track. |
|
|
6418
|
-
* | SetSpeed | Change video/audio rate in 0.25–4; keep is required. source preserves consumed source and changes length
|
|
6440
|
+
* | SetSpeed | Change video/audio rate in 0.25–4; keep is required. A `{curve: [{at, rate, ease?}, ...], audio?: "mute" | "resample"}` rate is forward-only and holds output duration fixed; pitch preservation is unavailable. Scalar rates: source preserves consumed source and changes length; duration preserves output length. Returns actual length and sourceOut in seconds. Optional ripple explicitly shifts same-track followers when keeping source; otherwise overlaps are rejected. |
|
|
6419
6441
|
* | Join, UpdateJoin, DeleteJoin | Join creates an overlap between two butt-adjacent visual clips on the same track and returns its ID. length defaults to 0.5 seconds; effect is required. The right clip and all same-track followers move left by length, shortening that track and potentially the project. UpdateJoin moves those followers by the difference in length; omitted fields are preserved. DeleteJoin moves them right to restore the butt cut. Other tracks stay in place. |
|
|
6420
6442
|
* | Split, Trim, Move | Split at a timeline position and return the new right-hand clip ID. Trim changes the in or out edge by delta seconds. Move sets the timeline start and optionally a new track. |
|
|
6421
6443
|
* | RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |
|
|
6422
|
-
* | AddTrack, UpdateTrack, DeleteTrack | Add video/audio/caption tracks; index selects layer order (0 is top). TrackPatch supports name, locked, hidden, muted, gainDb and style as appropriate to track kind. |
|
|
6444
|
+
* | AddTrack, UpdateTrack, DeleteTrack | Add video/audio/caption tracks; index selects layer order (0 is top). TrackPatch supports name, locked, hidden, muted, gainDb, audio role (`voice`, `music`, `sfx`) and style as appropriate to track kind. |
|
|
6423
6445
|
* | SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |
|
|
6424
6446
|
* | 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. |
|
|
6447
|
+
* | ImportCaptions, ExportCaptions | Import SRT or WebVTT text onto a caption track and export it back. format is inferred from a WEBVTT header when omitted. offset shifts imported cues in seconds. Import rejects more than 100000 bytes, more than 5000 cues, malformed or overlapping file cues with INVALID_CAPTION_FILE; overlap with existing timeline clips uses the normal OVERLAP rejection. Export sorts by timeline start and writes millisecond timecodes. |
|
|
6425
6448
|
* | SetMarker | Add a label at a timeline time and return its ID. |
|
|
6426
6449
|
* | Print, Preview | Print appends text to prints. Preview requests up to eight times total per execute and puts images in the result's frames. Each url is an inline PNG data URL, not an HTTP image link. Decode the base64 payload to save an image. Codemode returns at most four images per call; request at most four times there. |
|
|
6427
6450
|
*
|
|
@@ -6439,15 +6462,15 @@ export const cutUndeleteProject = (options) => (options.client ?? client).post({
|
|
|
6439
6462
|
*
|
|
6440
6463
|
* | type | Required fields beyond type/start | Optional fields |
|
|
6441
6464
|
* | --- | --- | --- |
|
|
6442
|
-
* | video | media | length, sourceIn, playback, volumeDb, transform, fit, animate, animation, transitionIn, transitionOut |
|
|
6443
|
-
* | image | media, length | transform, fit, animate, animation, transitionIn, transitionOut |
|
|
6444
|
-
* | text | text, length | style, transform, reveal, animate, animation, transitionIn, transitionOut |
|
|
6445
|
-
* | color | color, length | transform, fill, animate, animation, transitionIn, transitionOut |
|
|
6446
|
-
* | shape | shape, length, width, height, fill | radius, stroke, transform, animate, animation, transitionIn, transitionOut |
|
|
6447
|
-
* | audio | media | length, sourceIn, playback, volumeDb, fadeIn, fadeOut |
|
|
6465
|
+
* | video | media | length, sourceIn, playback, volumeDb, transform, fit, blend, animate, animation, effects, mask, transitionIn, transitionOut |
|
|
6466
|
+
* | image | media, length | transform, fit, blend, animate, animation, effects, mask, transitionIn, transitionOut |
|
|
6467
|
+
* | text | text, length | style, transform, blend, reveal, animate, animation, effects, mask, transitionIn, transitionOut |
|
|
6468
|
+
* | color | color, length | transform, fill, blend, animate, animation, effects, mask, transitionIn, transitionOut |
|
|
6469
|
+
* | shape | shape, length, width, height, fill | radius, stroke, transform, blend, animate, animation, effects, mask, transitionIn, transitionOut |
|
|
6470
|
+
* | audio | media | length, sourceIn, playback, volumeDb, gain, fadeIn, fadeOut, duck |
|
|
6448
6471
|
* | caption | text, length | — |
|
|
6449
6472
|
*
|
|
6450
|
-
* Video tracks accept video/image/text/color/shape; audio and caption tracks accept their corresponding type. Media is `{libraryId: string, assetId: string}` from a bound library. sourceIn defaults to 0, volumeDb to 0 dB, audio fades to 0 seconds. fit defaults to contain: contain fits the whole image, cover fills and crops, fill stretches, none keeps native dimensions.
|
|
6473
|
+
* Visual Insert/Update also accepts `blend`: `normal` (default), `screen`, `multiply`, `overlay`, or `add`; set it to null in Update to clear it. During a Join overlap, both inputs render with normal blending. Video tracks accept video/image/text/color/shape; audio and caption tracks accept their corresponding type. Media is `{libraryId: string, assetId: string}` from a bound library. sourceIn defaults to 0, volumeDb to 0 dB, audio fades to 0 seconds. fit defaults to contain: contain fits the whole image, cover fills and crops, fill stretches, none keeps native dimensions.
|
|
6451
6474
|
*
|
|
6452
6475
|
* | Field | Value |
|
|
6453
6476
|
* | --- | --- |
|
|
@@ -6461,9 +6484,17 @@ export const cutUndeleteProject = (options) => (options.client ?? client).post({
|
|
|
6461
6484
|
* | shape, width, height, radius, stroke | shape is rect or ellipse. width/height are fractions of canvas width/height before scaling. radius rounds rect corners in pixels at 1080-pixel frame height. stroke is `{color: string, width: number}`. |
|
|
6462
6485
|
* | transitionIn, transitionOut | `{kind, length: number}` at the clip's beginning/end. length is seconds. fade changes opacity; dissolve blends; push_left/push_right move horizontally; wipe_left reveals horizontally. |
|
|
6463
6486
|
*
|
|
6487
|
+
* #### Visual effects
|
|
6488
|
+
*
|
|
6489
|
+
* `effects` is an ordered stack of at most 8 catalog entries. Call `ListEffects()` to discover the catalog; unknown kinds return `UNKNOWN_EFFECT`, invalid names/values/keyframes return `INVALID_EFFECT_PARAM`, and stacks over 8 return `TOO_MANY_EFFECTS`. Entries include blur, color adjustment, vignette, film grain, chromatic aberration, pixelate, glitch, shake, flash, light leak and built-in `lut` looks; user `.cube` LUTs are not supported. `speed` is cycles per second. Effects run on CPU during export and increase render time. Parameters are discovered with ListEffects(). Catalog entries expose their own parameters through ListEffects(), including `blur` (`radius` 0–100, default 24) and `color_adjust`: `brightness`, `contrast`, `temperature`, and `tint` each range -1–1 (default 0), while `saturation` ranges 0–2 (default 1). Disabled entries are skipped. `color_adjust` uses an SDR-only Rec.709 adjustment matrix with no color management.
|
|
6490
|
+
*
|
|
6491
|
+
* Numeric and integer effect parameters accept `keyframes: {parameter: [{at, value, ease?}, ...]}`; times are seconds relative to the clip, snap to frames like `animate`, must be strictly increasing and within clip duration, and values follow that parameter's catalog range. Omitted parameters use catalog defaults. Trim and Split preserve effect keyframes with the same clip-local behavior as `animate`. There are no custom shaders.
|
|
6492
|
+
*
|
|
6493
|
+
* `blend` applies to the completed visual layer after its content, effects and `transform.blur`; `add` maps to Skia Plus. The default `normal` path adds no blend layer. During Join overlaps, blending is forced to normal because each input is composed on transparency.
|
|
6494
|
+
*
|
|
6464
6495
|
* #### Update fields (ItemPatchView)
|
|
6465
6496
|
*
|
|
6466
|
-
* All fields are optional; use only fields relevant to the item's type. Supported fields: start, length, sourceIn, playback, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, animate, reveal, animation, fill, stroke, shape, width, height, radius, transitionIn, transitionOut. Values and units match Insert. Set animation to null to clear the preset; set animate or reveal to null to remove that effect. Applying a preset replaces existing animate/reveal. Do not set animation together with animate or reveal in one Insert/Update call. Omit a field to preserve it.
|
|
6497
|
+
* All fields are optional; use only fields relevant to the item's type. Supported fields: start, length, sourceIn, playback, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, duck, animate, reveal, animation, fill, stroke, shape, width, height, radius, transitionIn, transitionOut, effects, blend, mask, gain. Values and units match Insert; set effects or blend to null to clear them. Set animation to null to clear the preset; set animate or reveal to null to remove that effect. Applying a preset replaces existing animate/reveal. Do not set animation together with animate or reveal in one Insert/Update call. Omit a field to preserve it.
|
|
6467
6498
|
*
|
|
6468
6499
|
* #### Animation presets
|
|
6469
6500
|
*
|
|
@@ -7596,7 +7627,7 @@ export const mediaListAssets = (options) => (options.client ?? client).get({
|
|
|
7596
7627
|
/**
|
|
7597
7628
|
* Upload asset
|
|
7598
7629
|
*
|
|
7599
|
-
* For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
7630
|
+
* 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.
|
|
7600
7631
|
*/
|
|
7601
7632
|
export const mediaUploadAsset = (options) => (options.client ?? client).post({
|
|
7602
7633
|
security: [{
|
|
@@ -7614,7 +7645,7 @@ export const mediaUploadAsset = (options) => (options.client ?? client).post({
|
|
|
7614
7645
|
/**
|
|
7615
7646
|
* Import file
|
|
7616
7647
|
*
|
|
7617
|
-
* Copy a File into an independent Media asset. New assets default to organization-private delivery (type=authenticated); explicitly set type=upload for public originals and derivatives. Omitting type on overwrite preserves the current type. Deleting the source File does not delete this copy. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
7648
|
+
* 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.
|
|
7618
7649
|
*/
|
|
7619
7650
|
export const mediaImportAsset = (options) => (options.client ?? client).post({
|
|
7620
7651
|
security: [{
|
|
@@ -7678,7 +7709,7 @@ export const mediaUpdateAsset = (options) => (options.client ?? client).patch({
|
|
|
7678
7709
|
/**
|
|
7679
7710
|
* Reprocess asset
|
|
7680
7711
|
*
|
|
7681
|
-
* For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
7712
|
+
* 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.
|
|
7682
7713
|
*/
|
|
7683
7714
|
export const mediaReprocessAsset = (options) => (options.client ?? client).post({
|
|
7684
7715
|
security: [{
|
|
@@ -7796,7 +7827,7 @@ export const mediaListFolders = (options) => (options.client ?? client).get({
|
|
|
7796
7827
|
/**
|
|
7797
7828
|
* Create batch
|
|
7798
7829
|
*
|
|
7799
|
-
* Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
7830
|
+
* 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.
|
|
7800
7831
|
*/
|
|
7801
7832
|
export const mediaCreateBatch = (options) => (options.client ?? client).post({
|
|
7802
7833
|
security: [{
|
|
@@ -7828,7 +7859,7 @@ export const mediaGetBatch = (options) => (options.client ?? client).get({
|
|
|
7828
7859
|
/**
|
|
7829
7860
|
* Batch assets alias
|
|
7830
7861
|
*
|
|
7831
|
-
* Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
7862
|
+
* 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.
|
|
7832
7863
|
*/
|
|
7833
7864
|
export const mediaBatchAssets = (options) => (options.client ?? client).post({
|
|
7834
7865
|
security: [{
|
|
@@ -7995,6 +8026,234 @@ export const mediaGetGenerationCapabilities = (options) => (options?.client ?? c
|
|
|
7995
8026
|
url: '/media/v1/generation/capabilities',
|
|
7996
8027
|
...options
|
|
7997
8028
|
});
|
|
8029
|
+
/**
|
|
8030
|
+
* List types
|
|
8031
|
+
*
|
|
8032
|
+
* 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.
|
|
8033
|
+
*/
|
|
8034
|
+
export const ontologyListTypes = (options) => (options?.client ?? client).get({
|
|
8035
|
+
security: [{
|
|
8036
|
+
key: 'ontology-bearerAuth',
|
|
8037
|
+
scheme: 'bearer',
|
|
8038
|
+
type: 'http'
|
|
8039
|
+
}],
|
|
8040
|
+
url: '/ontology/v1/types',
|
|
8041
|
+
...options
|
|
8042
|
+
});
|
|
8043
|
+
/**
|
|
8044
|
+
* Register type
|
|
8045
|
+
*
|
|
8046
|
+
* 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.
|
|
8047
|
+
*/
|
|
8048
|
+
export const ontologyRegisterType = (options) => (options.client ?? client).post({
|
|
8049
|
+
security: [{
|
|
8050
|
+
key: 'ontology-bearerAuth',
|
|
8051
|
+
scheme: 'bearer',
|
|
8052
|
+
type: 'http'
|
|
8053
|
+
}],
|
|
8054
|
+
url: '/ontology/v1/types',
|
|
8055
|
+
...options,
|
|
8056
|
+
headers: {
|
|
8057
|
+
'Content-Type': 'application/json',
|
|
8058
|
+
...options.headers
|
|
8059
|
+
}
|
|
8060
|
+
});
|
|
8061
|
+
/**
|
|
8062
|
+
* Retrieve type
|
|
8063
|
+
*
|
|
8064
|
+
* 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.
|
|
8065
|
+
*/
|
|
8066
|
+
export const ontologyRetrieveType = (options) => (options.client ?? client).get({
|
|
8067
|
+
security: [{
|
|
8068
|
+
key: 'ontology-bearerAuth',
|
|
8069
|
+
scheme: 'bearer',
|
|
8070
|
+
type: 'http'
|
|
8071
|
+
}],
|
|
8072
|
+
url: '/ontology/v1/types/{name}',
|
|
8073
|
+
...options
|
|
8074
|
+
});
|
|
8075
|
+
/**
|
|
8076
|
+
* List nodes
|
|
8077
|
+
*
|
|
8078
|
+
* 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.
|
|
8079
|
+
*/
|
|
8080
|
+
export const ontologyListNodes = (options) => (options?.client ?? client).get({
|
|
8081
|
+
security: [{
|
|
8082
|
+
key: 'ontology-bearerAuth',
|
|
8083
|
+
scheme: 'bearer',
|
|
8084
|
+
type: 'http'
|
|
8085
|
+
}],
|
|
8086
|
+
url: '/ontology/v1/nodes',
|
|
8087
|
+
...options
|
|
8088
|
+
});
|
|
8089
|
+
/**
|
|
8090
|
+
* Create node
|
|
8091
|
+
*
|
|
8092
|
+
* 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.
|
|
8093
|
+
*/
|
|
8094
|
+
export const ontologyCreateNode = (options) => (options.client ?? client).post({
|
|
8095
|
+
security: [{
|
|
8096
|
+
key: 'ontology-bearerAuth',
|
|
8097
|
+
scheme: 'bearer',
|
|
8098
|
+
type: 'http'
|
|
8099
|
+
}],
|
|
8100
|
+
url: '/ontology/v1/nodes',
|
|
8101
|
+
...options,
|
|
8102
|
+
headers: {
|
|
8103
|
+
'Content-Type': 'application/json',
|
|
8104
|
+
...options.headers
|
|
8105
|
+
}
|
|
8106
|
+
});
|
|
8107
|
+
/**
|
|
8108
|
+
* Retrieve node
|
|
8109
|
+
*
|
|
8110
|
+
* 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.
|
|
8111
|
+
*/
|
|
8112
|
+
export const ontologyRetrieveNode = (options) => (options.client ?? client).get({
|
|
8113
|
+
security: [{
|
|
8114
|
+
key: 'ontology-bearerAuth',
|
|
8115
|
+
scheme: 'bearer',
|
|
8116
|
+
type: 'http'
|
|
8117
|
+
}],
|
|
8118
|
+
url: '/ontology/v1/nodes/{node_id}',
|
|
8119
|
+
...options
|
|
8120
|
+
});
|
|
8121
|
+
/**
|
|
8122
|
+
* Update node
|
|
8123
|
+
*
|
|
8124
|
+
* 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.
|
|
8125
|
+
*/
|
|
8126
|
+
export const ontologyUpdateNode = (options) => (options.client ?? client).patch({
|
|
8127
|
+
security: [{
|
|
8128
|
+
key: 'ontology-bearerAuth',
|
|
8129
|
+
scheme: 'bearer',
|
|
8130
|
+
type: 'http'
|
|
8131
|
+
}],
|
|
8132
|
+
url: '/ontology/v1/nodes/{node_id}',
|
|
8133
|
+
...options,
|
|
8134
|
+
headers: {
|
|
8135
|
+
'Content-Type': 'application/json',
|
|
8136
|
+
...options.headers
|
|
8137
|
+
}
|
|
8138
|
+
});
|
|
8139
|
+
/**
|
|
8140
|
+
* Merge node
|
|
8141
|
+
*
|
|
8142
|
+
* 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.
|
|
8143
|
+
*/
|
|
8144
|
+
export const ontologyMergeNode = (options) => (options.client ?? client).post({
|
|
8145
|
+
security: [{
|
|
8146
|
+
key: 'ontology-bearerAuth',
|
|
8147
|
+
scheme: 'bearer',
|
|
8148
|
+
type: 'http'
|
|
8149
|
+
}],
|
|
8150
|
+
url: '/ontology/v1/nodes/{node_id}/merge',
|
|
8151
|
+
...options,
|
|
8152
|
+
headers: {
|
|
8153
|
+
'Content-Type': 'application/json',
|
|
8154
|
+
...options.headers
|
|
8155
|
+
}
|
|
8156
|
+
});
|
|
8157
|
+
/**
|
|
8158
|
+
* List relations
|
|
8159
|
+
*
|
|
8160
|
+
* 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.
|
|
8161
|
+
*/
|
|
8162
|
+
export const ontologyListRelations = (options) => (options?.client ?? client).get({
|
|
8163
|
+
security: [{
|
|
8164
|
+
key: 'ontology-bearerAuth',
|
|
8165
|
+
scheme: 'bearer',
|
|
8166
|
+
type: 'http'
|
|
8167
|
+
}],
|
|
8168
|
+
url: '/ontology/v1/relations',
|
|
8169
|
+
...options
|
|
8170
|
+
});
|
|
8171
|
+
/**
|
|
8172
|
+
* Create relation
|
|
8173
|
+
*
|
|
8174
|
+
* 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.
|
|
8175
|
+
*/
|
|
8176
|
+
export const ontologyCreateRelation = (options) => (options.client ?? client).post({
|
|
8177
|
+
security: [{
|
|
8178
|
+
key: 'ontology-bearerAuth',
|
|
8179
|
+
scheme: 'bearer',
|
|
8180
|
+
type: 'http'
|
|
8181
|
+
}],
|
|
8182
|
+
url: '/ontology/v1/relations',
|
|
8183
|
+
...options,
|
|
8184
|
+
headers: {
|
|
8185
|
+
'Content-Type': 'application/json',
|
|
8186
|
+
...options.headers
|
|
8187
|
+
}
|
|
8188
|
+
});
|
|
8189
|
+
/**
|
|
8190
|
+
* Retrieve relation
|
|
8191
|
+
*
|
|
8192
|
+
* 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.
|
|
8193
|
+
*/
|
|
8194
|
+
export const ontologyRetrieveRelation = (options) => (options.client ?? client).get({
|
|
8195
|
+
security: [{
|
|
8196
|
+
key: 'ontology-bearerAuth',
|
|
8197
|
+
scheme: 'bearer',
|
|
8198
|
+
type: 'http'
|
|
8199
|
+
}],
|
|
8200
|
+
url: '/ontology/v1/relations/{relation_id}',
|
|
8201
|
+
...options
|
|
8202
|
+
});
|
|
8203
|
+
/**
|
|
8204
|
+
* Invalidate relation
|
|
8205
|
+
*
|
|
8206
|
+
* 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.
|
|
8207
|
+
*/
|
|
8208
|
+
export const ontologyInvalidateRelation = (options) => (options.client ?? client).post({
|
|
8209
|
+
security: [{
|
|
8210
|
+
key: 'ontology-bearerAuth',
|
|
8211
|
+
scheme: 'bearer',
|
|
8212
|
+
type: 'http'
|
|
8213
|
+
}],
|
|
8214
|
+
url: '/ontology/v1/relations/{relation_id}/invalidate',
|
|
8215
|
+
...options,
|
|
8216
|
+
headers: {
|
|
8217
|
+
'Content-Type': 'application/json',
|
|
8218
|
+
...options.headers
|
|
8219
|
+
}
|
|
8220
|
+
});
|
|
8221
|
+
/**
|
|
8222
|
+
* Apply changeset
|
|
8223
|
+
*
|
|
8224
|
+
* 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.
|
|
8225
|
+
*/
|
|
8226
|
+
export const ontologyApplyChangeset = (options) => (options.client ?? client).post({
|
|
8227
|
+
security: [{
|
|
8228
|
+
key: 'ontology-bearerAuth',
|
|
8229
|
+
scheme: 'bearer',
|
|
8230
|
+
type: 'http'
|
|
8231
|
+
}],
|
|
8232
|
+
url: '/ontology/v1/changesets',
|
|
8233
|
+
...options,
|
|
8234
|
+
headers: {
|
|
8235
|
+
'Content-Type': 'application/json',
|
|
8236
|
+
...options.headers
|
|
8237
|
+
}
|
|
8238
|
+
});
|
|
8239
|
+
/**
|
|
8240
|
+
* Search nodes
|
|
8241
|
+
*
|
|
8242
|
+
* 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.
|
|
8243
|
+
*/
|
|
8244
|
+
export const ontologySearch = (options) => (options.client ?? client).post({
|
|
8245
|
+
security: [{
|
|
8246
|
+
key: 'ontology-bearerAuth',
|
|
8247
|
+
scheme: 'bearer',
|
|
8248
|
+
type: 'http'
|
|
8249
|
+
}],
|
|
8250
|
+
url: '/ontology/v1/search',
|
|
8251
|
+
...options,
|
|
8252
|
+
headers: {
|
|
8253
|
+
'Content-Type': 'application/json',
|
|
8254
|
+
...options.headers
|
|
8255
|
+
}
|
|
8256
|
+
});
|
|
7998
8257
|
/**
|
|
7999
8258
|
* List sandboxes (v2)
|
|
8000
8259
|
*
|
|
@@ -9095,7 +9354,7 @@ export const vaultListVaults = (options) => (options?.client ?? client).get({
|
|
|
9095
9354
|
/**
|
|
9096
9355
|
* Create vault
|
|
9097
9356
|
*
|
|
9098
|
-
* 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.
|
|
9357
|
+
* 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.
|
|
9099
9358
|
*/
|
|
9100
9359
|
export const vaultCreateVault = (options) => (options.client ?? client).post({
|
|
9101
9360
|
security: [{
|