@deepraxis/sdk 0.1.1-dev.e5614a0 → 0.1.1-dev.e5cbcae
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 +98 -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 +344 -47
- package/dist/generated/sdk.gen.js +599 -46
- package/dist/generated/types.gen.d.ts +5980 -1753
- package/dist/operations.generated.d.ts +897 -88
- package/dist/operations.generated.js +1361 -363
- package/dist/resources.generated.d.ts +96 -8
- package/dist/resources.generated.js +62 -0
- package/package.json +2 -2
|
@@ -513,6 +513,30 @@ export const computersFilesContent = (options) => (options.client ?? client).get
|
|
|
513
513
|
url: '/agent/v1/computers/{computer_id}/files/content',
|
|
514
514
|
...options
|
|
515
515
|
});
|
|
516
|
+
/**
|
|
517
|
+
* Convert a Computer Document to PDF
|
|
518
|
+
*
|
|
519
|
+
* 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.
|
|
520
|
+
*
|
|
521
|
+
* Praxis 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.
|
|
522
|
+
*/
|
|
523
|
+
export const computersFilesConvert = (options) => (options.client ?? client).post({
|
|
524
|
+
security: [{
|
|
525
|
+
key: 'BearerAuth',
|
|
526
|
+
scheme: 'bearer',
|
|
527
|
+
type: 'http'
|
|
528
|
+
}, {
|
|
529
|
+
key: 'ApiKeyAuth',
|
|
530
|
+
name: 'X-API-Key',
|
|
531
|
+
type: 'apiKey'
|
|
532
|
+
}],
|
|
533
|
+
url: '/agent/v1/computers/{computer_id}/files/convert',
|
|
534
|
+
...options,
|
|
535
|
+
headers: {
|
|
536
|
+
'Content-Type': 'application/json',
|
|
537
|
+
...options.headers
|
|
538
|
+
}
|
|
539
|
+
});
|
|
516
540
|
/**
|
|
517
541
|
* Connect computer
|
|
518
542
|
*
|
|
@@ -1092,7 +1116,7 @@ export const fileListFiles = (options) => (options?.client ?? client).get({
|
|
|
1092
1116
|
/**
|
|
1093
1117
|
* Upload file
|
|
1094
1118
|
*
|
|
1095
|
-
* Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File(["Return within 23 days."], "policy.txt", { type: "text/plain" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.
|
|
1119
|
+
* Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File(["Return within 23 days."], "policy.txt", { type: "text/plain" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.
|
|
1096
1120
|
*/
|
|
1097
1121
|
export const fileCreateFile = (options) => (options.client ?? client).post({
|
|
1098
1122
|
...formDataBodySerializer,
|
|
@@ -1169,7 +1193,7 @@ export const fileRetrieveFileContent = (options) => (options.client ?? client).g
|
|
|
1169
1193
|
/**
|
|
1170
1194
|
* Create an upload
|
|
1171
1195
|
*
|
|
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
|
|
1196
|
+
* 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
1197
|
*/
|
|
1174
1198
|
export const fileCreateUpload = (options) => (options.client ?? client).post({
|
|
1175
1199
|
security: [{
|
|
@@ -1187,7 +1211,7 @@ export const fileCreateUpload = (options) => (options.client ?? client).post({
|
|
|
1187
1211
|
/**
|
|
1188
1212
|
* Add an upload part
|
|
1189
1213
|
*
|
|
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.
|
|
1214
|
+
* 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
1215
|
*/
|
|
1192
1216
|
export const fileAddUploadPart = (options) => (options.client ?? client).post({
|
|
1193
1217
|
...formDataBodySerializer,
|
|
@@ -1206,7 +1230,7 @@ export const fileAddUploadPart = (options) => (options.client ?? client).post({
|
|
|
1206
1230
|
/**
|
|
1207
1231
|
* Complete an upload
|
|
1208
1232
|
*
|
|
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.
|
|
1233
|
+
* 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
1234
|
*/
|
|
1211
1235
|
export const fileCompleteUpload = (options) => (options.client ?? client).post({
|
|
1212
1236
|
security: [{
|
|
@@ -1235,10 +1259,24 @@ export const fileCancelUpload = (options) => (options.client ?? client).post({
|
|
|
1235
1259
|
url: '/file/v1/uploads/{upload_id}/cancel',
|
|
1236
1260
|
...options
|
|
1237
1261
|
});
|
|
1262
|
+
/**
|
|
1263
|
+
* Retrieve an upload
|
|
1264
|
+
*
|
|
1265
|
+
* 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.
|
|
1266
|
+
*/
|
|
1267
|
+
export const fileRetrieveUpload = (options) => (options.client ?? client).get({
|
|
1268
|
+
security: [{
|
|
1269
|
+
key: 'BearerAuth',
|
|
1270
|
+
scheme: 'bearer',
|
|
1271
|
+
type: 'http'
|
|
1272
|
+
}],
|
|
1273
|
+
url: '/file/v1/uploads/{upload_id}',
|
|
1274
|
+
...options
|
|
1275
|
+
});
|
|
1238
1276
|
/**
|
|
1239
1277
|
* Create a one-time upload URL
|
|
1240
1278
|
*
|
|
1241
|
-
* Upload a local file of up to
|
|
1279
|
+
* 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
1280
|
*/
|
|
1243
1281
|
export const fileCreateSignedUpload = (options) => (options.client ?? client).post({
|
|
1244
1282
|
security: [{
|
|
@@ -1260,7 +1298,7 @@ export const fileCreateSignedUpload = (options) => (options.client ?? client).po
|
|
|
1260
1298
|
/**
|
|
1261
1299
|
* Create a download URL
|
|
1262
1300
|
*
|
|
1263
|
-
* Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to
|
|
1301
|
+
* Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to 900 seconds and is at most 604800 seconds. Issuance requires the same credential and file-read access as files.retrieveContent; a processing file returns 409 FILE_NOT_READY, so poll files.retrieve until active before retrying. A missing, expired or other-organization file returns 404. Each issuance creates a new link. OpenAI Files has no signed download URL; this follows S3 presigned GET semantics. Example body: {"ttl_seconds":3600}.
|
|
1264
1302
|
*/
|
|
1265
1303
|
export const fileCreateContentUrl = (options) => (options.client ?? client).post({
|
|
1266
1304
|
security: [{
|
|
@@ -1282,7 +1320,7 @@ export const fileCreateContentUrl = (options) => (options.client ?? client).post
|
|
|
1282
1320
|
/**
|
|
1283
1321
|
* Revoke a file content link
|
|
1284
1322
|
*
|
|
1285
|
-
* Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within
|
|
1323
|
+
* Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within 15 minutes; the file and other links remain available. Only current IAM capability tokens can be revoked; legacy content links expire at the migration deadline. Example body: {"token":"<token from /c/>"}.
|
|
1286
1324
|
*/
|
|
1287
1325
|
export const fileRevokeContentLink = (options) => (options.client ?? client).post({
|
|
1288
1326
|
security: [{
|
|
@@ -1988,6 +2026,24 @@ export const countResponseInputTokens = (options) => (options.client ?? client).
|
|
|
1988
2026
|
...options.headers
|
|
1989
2027
|
}
|
|
1990
2028
|
});
|
|
2029
|
+
/**
|
|
2030
|
+
* List organization members
|
|
2031
|
+
*
|
|
2032
|
+
* Concepts follow GitHub org members: find a person's user id, for example to assign an approver to an approval task. Lists only members of the organization behind your API key or runtime token, ordered by joined_at ascending (membership id breaks ties). Ask the user who should approve, then use that member's id. Emails are visible only within this organization. The request cannot select another organization. Pass next_page unchanged as page; null means the end. Read-only; no usage charge. Example: GET /organization/v1/members?limit=20.
|
|
2033
|
+
*/
|
|
2034
|
+
export const listOrganizationMembers = (options) => (options?.client ?? client).get({
|
|
2035
|
+
security: [{
|
|
2036
|
+
key: 'BearerAuth',
|
|
2037
|
+
scheme: 'bearer',
|
|
2038
|
+
type: 'http'
|
|
2039
|
+
}, {
|
|
2040
|
+
key: 'ApiKeyAuth',
|
|
2041
|
+
name: 'X-API-Key',
|
|
2042
|
+
type: 'apiKey'
|
|
2043
|
+
}],
|
|
2044
|
+
url: '/organization/v1/members',
|
|
2045
|
+
...options
|
|
2046
|
+
});
|
|
1991
2047
|
/**
|
|
1992
2048
|
* List your organization's feedback
|
|
1993
2049
|
*
|
|
@@ -6351,13 +6407,158 @@ export const cutUndeleteProject = (options) => (options.client ?? client).post({
|
|
|
6351
6407
|
/**
|
|
6352
6408
|
* Execute editing script
|
|
6353
6409
|
*
|
|
6354
|
-
* Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes.
|
|
6410
|
+
* 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);`
|
|
6355
6411
|
*
|
|
6356
|
-
*
|
|
6357
|
-
*
|
|
6358
|
-
*
|
|
6359
|
-
*
|
|
6412
|
+
* <!-- cut-reference:start -->
|
|
6413
|
+
* ### Script function, field and error reference
|
|
6414
|
+
*
|
|
6415
|
+
* Every script function, clip field and error code has its own section, read one at a time:
|
|
6416
|
+
*
|
|
6417
|
+
* ```
|
|
6418
|
+
* codemode.describe("praxis.cut.script.<Name>") // one function: signature, arguments, return, errors, example
|
|
6419
|
+
* codemode.describe("praxis.cut.fields.<name>") // one field: type, unit, range, default, where writable
|
|
6420
|
+
* codemode.describe("praxis.cut.errors.<CODE>") // one code: meaning, causes, fix
|
|
6421
|
+
* codemode.describe("praxis.cut.script") // names, one page at a time
|
|
6360
6422
|
* ```
|
|
6423
|
+
*
|
|
6424
|
+
* Published at https://docs.deepraxis.com/docs/developers/cut/script-reference with one anchor per entry. Names below omit the `praxis.cut.<kind>.` prefix.
|
|
6425
|
+
*
|
|
6426
|
+
* #### Script functions (script)
|
|
6427
|
+
*
|
|
6428
|
+
* - `GetTimeline` — Duration, tracks, joins; clips are under `items`.
|
|
6429
|
+
* - `GetItem` — One clip's compact view, by id.
|
|
6430
|
+
* - `FindItems` — Visit every clip with its track; collect results.
|
|
6431
|
+
* - `GetMedia` — Media metadata; `durationUs` is microseconds.
|
|
6432
|
+
* - `GetTranscript` — Transcript words in source microseconds.
|
|
6433
|
+
* - `GetAnalysis` — Silence, filler or scene segments.
|
|
6434
|
+
* - `ListTransitions` — Join transition kinds and parameters.
|
|
6435
|
+
* - `ListEffects` — Visual-effect catalog and parameters.
|
|
6436
|
+
* - `ListAnimations` — Animation presets by phase and target.
|
|
6437
|
+
* - `ListFonts` — Font families, weights and scripts.
|
|
6438
|
+
* - `ListTextStyles` — Text style presets for `style.preset`.
|
|
6439
|
+
* - `ListTextTemplates` — Multi-layer templates and their slots.
|
|
6440
|
+
* - `Insert` — Add a clip; a track never overlaps itself.
|
|
6441
|
+
* - `Append` — Add a clip at the end of a track.
|
|
6442
|
+
* - `Update` — Change named fields; the rest stay.
|
|
6443
|
+
* - `SetSpeed` — Change rate, keeping source or duration.
|
|
6444
|
+
* - `Delete` — Remove a clip. There is no `Remove`.
|
|
6445
|
+
* - `Join` — Overlap clips; followers shift, track shortens.
|
|
6446
|
+
* - `UpdateJoin` — Change a join's length or effect.
|
|
6447
|
+
* - `DeleteJoin` — Remove a join; restore the butt cut.
|
|
6448
|
+
* - `Split` — Cut a clip in two at a time.
|
|
6449
|
+
* - `Trim` — Move one clip edge by seconds.
|
|
6450
|
+
* - `Move` — Set a clip's start or track.
|
|
6451
|
+
* - `RippleDeleteRange` — Cut a time range and close the gap.
|
|
6452
|
+
* - `AddTrack` — Add a video, audio or caption track.
|
|
6453
|
+
* - `UpdateTrack` — Change a track's name, lock, gain or role.
|
|
6454
|
+
* - `DeleteTrack` — Remove a track and its clips.
|
|
6455
|
+
* - `SetSettings` — Change canvas, frame rate or background.
|
|
6456
|
+
* - `AddCaptionsFromTranscript` — Captions from a clip's kept words.
|
|
6457
|
+
* - `InsertTemplate` — Insert a template and fill its slots.
|
|
6458
|
+
* - `AlignCaptions` — Rebuild captions from text punctuation.
|
|
6459
|
+
* - `ImportCaptions` — Import SRT or WebVTT onto captions.
|
|
6460
|
+
* - `ExportCaptions` — Export captions as SRT or WebVTT.
|
|
6461
|
+
* - `SetMarker` — Label a timeline position.
|
|
6462
|
+
* - `Print` — Append values to the result's `prints`.
|
|
6463
|
+
* - `Preview` — Up to 8 frames as inline PNG data URLs.
|
|
6464
|
+
*
|
|
6465
|
+
* #### Fields (fields)
|
|
6466
|
+
*
|
|
6467
|
+
* - `type` — Clip kind; decides which fields apply.
|
|
6468
|
+
* - `start` — Clip start in seconds; snaps to frames.
|
|
6469
|
+
* - `length` — Duration; optional for video and audio.
|
|
6470
|
+
* - `media` — Source `{ libraryId, assetId }`.
|
|
6471
|
+
* - `sourceIn` — First source second kept; default 0.
|
|
6472
|
+
* - `sourceOut` — Exclusive source end; read-only.
|
|
6473
|
+
* - `text` — Text of a text or caption clip.
|
|
6474
|
+
* - `color` — Solid colour of a color clip.
|
|
6475
|
+
* - `shape` — Shape clip kind: `rect` or `ellipse`.
|
|
6476
|
+
* - `width` — Shape width, a fraction of canvas width.
|
|
6477
|
+
* - `height` — Shape height, a fraction of canvas height.
|
|
6478
|
+
* - `radius` — Rect corner rounding, in 1080-height px.
|
|
6479
|
+
* - `fill` — Shape or text paint: colour or gradient.
|
|
6480
|
+
* - `stroke` — Shape outline: colour and width.
|
|
6481
|
+
* - `transform` — Position, scale, rotation, opacity, crop, blur.
|
|
6482
|
+
* - `fit` — contain, cover, fill or none.
|
|
6483
|
+
* - `blend` — Layer blend mode; null clears.
|
|
6484
|
+
* - `style` — Text styling: font, fill, strokes, glow, position.
|
|
6485
|
+
* - `style.position` — top, middle or bottom; omit it, never null.
|
|
6486
|
+
* - `playback` — Rate, direction, audio policy, or freeze.
|
|
6487
|
+
* - `volumeDb` — Audio level in dB; 0 is source level.
|
|
6488
|
+
* - `gain` — Keyframed audio level in dB.
|
|
6489
|
+
* - `fadeIn` — Fade-in seconds at the clip's start.
|
|
6490
|
+
* - `fadeOut` — Fade-out seconds at the clip's end.
|
|
6491
|
+
* - `duck` — Lower this clip while another track plays.
|
|
6492
|
+
* - `animate` — Transform keyframes; `at` is clip-relative seconds.
|
|
6493
|
+
* - `reveal` — Per-character, word or line reveal timing.
|
|
6494
|
+
* - `animation` — Preset slots `{ in, out, loop }`; null clears.
|
|
6495
|
+
* - `effects` — Effect stack, at most 8; null clears.
|
|
6496
|
+
* - `transitionIn` — Entrance effect: kind plus seconds.
|
|
6497
|
+
* - `transitionOut` — Exit effect: kind plus seconds.
|
|
6498
|
+
* - `mask` — Shape, path or track matte.
|
|
6499
|
+
* - `words` — Caption words with clip-local times.
|
|
6500
|
+
*
|
|
6501
|
+
* #### Error codes (errors)
|
|
6502
|
+
*
|
|
6503
|
+
* - `JOIN_CONFLICT` — A join is invalid or blocks this edit.
|
|
6504
|
+
* - `INVALID_TRANSITION` — Bad transition kind, parameter or length.
|
|
6505
|
+
* - `INVALID_STYLE` — A style value is out of range.
|
|
6506
|
+
* - `INVALID_MASK` — A mask definition is malformed.
|
|
6507
|
+
* - `MASK_IN_USE` — The edit would break a live mask.
|
|
6508
|
+
* - `TOO_MANY_MASKS` — At most 16 masks per project.
|
|
6509
|
+
* - `RATE_OUT_OF_RANGE` — A rate is outside 0.25-4.
|
|
6510
|
+
* - `UNSUPPORTED_PLAYBACK` — Reverse without an explicit mute.
|
|
6511
|
+
* - `INVALID_PLAYBACK` — A playback object is partial or malformed.
|
|
6512
|
+
* - `UNKNOWN_FONT` — The family is not in `ListFonts()`.
|
|
6513
|
+
* - `UNKNOWN_FIELD` — The field name is not accepted here.
|
|
6514
|
+
* - `UNKNOWN_TEXT_STYLE` — `style.preset` is not in the catalog.
|
|
6515
|
+
* - `TEXT_STYLE_TARGET_MISMATCH` — Preset on the wrong clip type.
|
|
6516
|
+
* - `CAPTION_ALIGN_LOW_CONFIDENCE` — Alignment confidence too low; nothing changed.
|
|
6517
|
+
* - `OVERLAP` — Two clips on one track would share time.
|
|
6518
|
+
* - `OUT_OF_SOURCE` — The clip would read past its source.
|
|
6519
|
+
* - `LOCKED_TRACK` — The edit targets a locked track.
|
|
6520
|
+
* - `UNBOUND_LIBRARY` — The library is not bound to the project.
|
|
6521
|
+
* - `TRACK_KIND_MISMATCH` — The clip type does not fit the track.
|
|
6522
|
+
* - `NOT_FOUND` — The named id is not in this project.
|
|
6523
|
+
* - `TOO_SHORT` — The result would be under one frame.
|
|
6524
|
+
* - `INVALID_DUCK` — Bad `duck` level or a missing track.
|
|
6525
|
+
* - `UNKNOWN_ANIMATION` — The preset is not in `ListAnimations()`.
|
|
6526
|
+
* - `INVALID_ANIMATION_PARAM` — Bad slot, parameter or keyframe limit.
|
|
6527
|
+
* - `ANIMATION_TOO_LONG` — In plus out exceed the clip length.
|
|
6528
|
+
* - `ANIMATION_TARGET_MISMATCH` — The preset does not match the clip type.
|
|
6529
|
+
* - `ANIMATION_PHASE_MISMATCH` — The preset is in the wrong slot.
|
|
6530
|
+
* - `UNKNOWN_EFFECT` — The effect is not in `ListEffects()`.
|
|
6531
|
+
* - `INVALID_EFFECT_PARAM` — Bad effect parameter or keyframe.
|
|
6532
|
+
* - `TOO_MANY_EFFECTS` — More than 8 effects on one clip.
|
|
6533
|
+
* - `PROJECT_NOT_FOUND` — No visible project has this id.
|
|
6534
|
+
* - `EXPORT_NOT_FOUND` — No such export in this project.
|
|
6535
|
+
* - `VERSION_NOT_FOUND` — No saved version has this revision.
|
|
6536
|
+
* - `LIBRARY_NOT_FOUND` — The library is missing or invisible.
|
|
6537
|
+
* - `BINDING_INVALID` — The binding request is malformed.
|
|
6538
|
+
* - `BINDING_IN_USE` — Clips still use this library's assets.
|
|
6539
|
+
* - `NOTHING_TO_UNDO` — No earlier revision to return to.
|
|
6540
|
+
* - `NOTHING_TO_REDO` — No undone revision is waiting.
|
|
6541
|
+
* - `UNDO_CONFLICT` — The revision to undo is no longer head.
|
|
6542
|
+
* - `REVISION_CONFLICT` — The project moved; your revision is stale.
|
|
6543
|
+
* - `CUT_BUSY` — The project is busy; retry.
|
|
6544
|
+
* - `INVALID_CAPTION_FILE` — The subtitle file is malformed or too big.
|
|
6545
|
+
* - `SCRIPT_ERROR` — The script threw or did not parse.
|
|
6546
|
+
* - `SCRIPT_LIMIT` — An execute budget was exceeded.
|
|
6547
|
+
* - `OPS_REJECTED` — An op failed; the whole edit rolled back.
|
|
6548
|
+
* - `EDIT_EXPIRED` — The saved edit id is over ten minutes old.
|
|
6549
|
+
* - `MEDIA_OFFLINE` — The asset cannot be fetched right now.
|
|
6550
|
+
* - `MEDIA_UNAVAILABLE` — The asset is not usable for rendering.
|
|
6551
|
+
* - `MEDIA_IMPORT_FAILED` — Importing media failed.
|
|
6552
|
+
* - `FRAME_OUT_OF_RANGE` — The preview time is outside the project.
|
|
6553
|
+
* - `PROJECT_TOO_LARGE` — The project exceeds the size limit.
|
|
6554
|
+
* - `RESPONSE_TOO_LARGE` — The response would exceed its budget.
|
|
6555
|
+
* - `EXPORT_FAILED` — The render failed; read `error.cause`.
|
|
6556
|
+
* - `INVALID_PARAMS` — The request is malformed.
|
|
6557
|
+
* - `PERMISSION_DENIED` — This credential may not do that here.
|
|
6558
|
+
* - `NOT_IMPLEMENTED` — Not available on this platform yet.
|
|
6559
|
+
* - `INTERNAL` — Unexpected failure; retry with the request id.
|
|
6560
|
+
* <!-- cut-reference:end -->
|
|
6561
|
+
*
|
|
6361
6562
|
*/
|
|
6362
6563
|
export const cutExecute = (options) => (options.client ?? client).post({
|
|
6363
6564
|
security: [{
|
|
@@ -6415,7 +6616,7 @@ export const cutRetrieveTimeline = (options) => (options.client ?? client).get({
|
|
|
6415
6616
|
/**
|
|
6416
6617
|
* Render preview frames
|
|
6417
6618
|
*
|
|
6418
|
-
* Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision.
|
|
6619
|
+
* Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution. The response always includes warnings; FRAME_UNAVAILABLE means a source preview could not be obtained and an offline tile was drawn. Its message identifies a timeout, delivery capacity limit, or unavailable source and contains no source URL. Decode each image's base64 payload to save it. Codemode returns at most four images per call, so request at most four times when reviewing there.
|
|
6419
6620
|
*/
|
|
6420
6621
|
export const cutListFrames = (options) => (options.client ?? client).get({
|
|
6421
6622
|
security: [{
|
|
@@ -6433,7 +6634,7 @@ export const cutListFrames = (options) => (options.client ?? client).get({
|
|
|
6433
6634
|
/**
|
|
6434
6635
|
* Analyze project media
|
|
6435
6636
|
*
|
|
6436
|
-
* Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible.
|
|
6637
|
+
* Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible. Silence measures transcript-based speech pauses, not music or loudness. A completed transcript without words returns ready with empty segments and reason no_speech; no completed transcript returns unsupported with reason no_transcript. A failed transcription remains failed.
|
|
6437
6638
|
*/
|
|
6438
6639
|
export const cutCreateAnalysis = (options) => (options.client ?? client).post({
|
|
6439
6640
|
security: [{
|
|
@@ -7011,7 +7212,7 @@ export const knowledgeListVectorStores = (options) => (options?.client ?? client
|
|
|
7011
7212
|
/**
|
|
7012
7213
|
* Create knowledge base
|
|
7013
7214
|
*
|
|
7014
|
-
* Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded.
|
|
7215
|
+
* Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; each account holds up to 100 active/nondeleted stores. Minimal body: {"name":"Refund policies"}.
|
|
7015
7216
|
*/
|
|
7016
7217
|
export const knowledgeCreateVectorStore = (options) => (options.client ?? client).post({
|
|
7017
7218
|
security: [{
|
|
@@ -7107,7 +7308,7 @@ export const knowledgeListFiles = (options) => (options.client ?? client).get({
|
|
|
7107
7308
|
/**
|
|
7108
7309
|
* Add file
|
|
7109
7310
|
*
|
|
7110
|
-
* Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching.
|
|
7311
|
+
* Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; chunk sizes use estimated tokens rather than a model tokenizer. Text, Markdown, CSV, JSON, HTML, PDF, DOCX, PPTX, XLSX and PNG/JPEG/GIF/WebP images can be extracted; audio and video uploads are not knowledge documents. Images may yield generated descriptions rather than verbatim OCR. auto chunking resolves to static 800/400; explicit sizes are 100–4096 with overlap at most half the size. Each store holds at most 10000 attached files. Reattaching the same file returns its existing record without applying new attributes or chunking; inspect last_error after failure.
|
|
7111
7312
|
*/
|
|
7112
7313
|
export const knowledgeAttachFile = (options) => (options.client ?? client).post({
|
|
7113
7314
|
security: [{
|
|
@@ -7329,7 +7530,7 @@ export const knowledgeListEvents = (options) => (options.client ?? client).get({
|
|
|
7329
7530
|
/**
|
|
7330
7531
|
* List libraries
|
|
7331
7532
|
*
|
|
7332
|
-
*
|
|
7533
|
+
* Read a caller-owned library’s current settings, usage and lifecycle status. A deleting library remains readable; missing, foreign or purged libraries return LIBRARY_NOT_FOUND.
|
|
7333
7534
|
*/
|
|
7334
7535
|
export const mediaListLibraries = (options) => (options?.client ?? client).get({
|
|
7335
7536
|
security: [{
|
|
@@ -7358,10 +7559,28 @@ export const mediaCreateLibrary = (options) => (options.client ?? client).post({
|
|
|
7358
7559
|
...options.headers
|
|
7359
7560
|
}
|
|
7360
7561
|
});
|
|
7562
|
+
/**
|
|
7563
|
+
* Create frame URLs
|
|
7564
|
+
*
|
|
7565
|
+
* Media creates JPEG frame URLs for inspecting one or more moments in a video without downloading the original. Obtain library_id from libraries and asset_id plus duration from assets. Send 1–20 integer microsecond timestamps strictly below duration, for example {"at_micros":[0,1000000],"width":640}. Only video assets are supported; audio and images return INVALID_PARAMS. Width defaults to 640 and accepts 160, 320 or 640. This read operation does not store a new asset or rerun understanding. Fetch each returned URL to obtain the frame; delivery usage follows media pricing. Authenticated links expire after 300 seconds; upload links remain public and permanent. Reissue expired links. Foreign libraries and assets return 404 without revealing their existence.
|
|
7566
|
+
*/
|
|
7567
|
+
export const mediaCreateFrameUrls = (options) => (options.client ?? client).post({
|
|
7568
|
+
security: [{
|
|
7569
|
+
key: 'media-BearerAuth',
|
|
7570
|
+
scheme: 'bearer',
|
|
7571
|
+
type: 'http'
|
|
7572
|
+
}],
|
|
7573
|
+
url: '/media/v1/libraries/{library_id}/assets/{asset_id}/frames',
|
|
7574
|
+
...options,
|
|
7575
|
+
headers: {
|
|
7576
|
+
'Content-Type': 'application/json',
|
|
7577
|
+
...options.headers
|
|
7578
|
+
}
|
|
7579
|
+
});
|
|
7361
7580
|
/**
|
|
7362
7581
|
* Delete library
|
|
7363
7582
|
*
|
|
7364
|
-
*
|
|
7583
|
+
* Restore a deleting library before its purge_at deadline. The library becomes active again and deleted_at and purge_at are cleared; expired or non-deleting libraries cannot be restored.
|
|
7365
7584
|
*/
|
|
7366
7585
|
export const mediaDeleteLibrary = (options) => (options.client ?? client).delete({
|
|
7367
7586
|
security: [{
|
|
@@ -7375,7 +7594,7 @@ export const mediaDeleteLibrary = (options) => (options.client ?? client).delete
|
|
|
7375
7594
|
/**
|
|
7376
7595
|
* Get library
|
|
7377
7596
|
*
|
|
7378
|
-
*
|
|
7597
|
+
* Update an active library’s supplied settings. Labels replace the complete map; understanding settings and model roles merge with current values. Changing the embedding model is rejected while assets exist.
|
|
7379
7598
|
*/
|
|
7380
7599
|
export const mediaGetLibrary = (options) => (options.client ?? client).get({
|
|
7381
7600
|
security: [{
|
|
@@ -7389,7 +7608,7 @@ export const mediaGetLibrary = (options) => (options.client ?? client).get({
|
|
|
7389
7608
|
/**
|
|
7390
7609
|
* Update library
|
|
7391
7610
|
*
|
|
7392
|
-
* Update an active library
|
|
7611
|
+
* Update an active library. Set hotwords for spelling evidence in subsequent transcripts; [] disables inferred vocabulary. Transcript understanding calls the timestamped ASR, optional reference ASR and correction model through the existing metered model path. Reprocess assets to apply new settings to existing transcripts.
|
|
7393
7612
|
*/
|
|
7394
7613
|
export const mediaUpdateLibrary = (options) => (options.client ?? client).patch({
|
|
7395
7614
|
security: [{
|
|
@@ -7407,7 +7626,7 @@ export const mediaUpdateLibrary = (options) => (options.client ?? client).patch(
|
|
|
7407
7626
|
/**
|
|
7408
7627
|
* Restore library
|
|
7409
7628
|
*
|
|
7410
|
-
*
|
|
7629
|
+
* Permanently remove a library that is already deleting, without waiting for purge_at. Its assets and related resources are removed and cannot be restored; first soft-delete an active library.
|
|
7411
7630
|
*/
|
|
7412
7631
|
export const mediaRestoreLibrary = (options) => (options.client ?? client).post({
|
|
7413
7632
|
security: [{
|
|
@@ -7421,7 +7640,7 @@ export const mediaRestoreLibrary = (options) => (options.client ?? client).post(
|
|
|
7421
7640
|
/**
|
|
7422
7641
|
* Purge library
|
|
7423
7642
|
*
|
|
7424
|
-
*
|
|
7643
|
+
* List assets in an active library, newest first, optionally filtering by exact folder and stored resource type. Continue using next_cursor; video includes audio-only assets.
|
|
7425
7644
|
*/
|
|
7426
7645
|
export const mediaPurgeLibrary = (options) => (options.client ?? client).post({
|
|
7427
7646
|
security: [{
|
|
@@ -7435,7 +7654,7 @@ export const mediaPurgeLibrary = (options) => (options.client ?? client).post({
|
|
|
7435
7654
|
/**
|
|
7436
7655
|
* List assets
|
|
7437
7656
|
*
|
|
7438
|
-
*
|
|
7657
|
+
* Upload content into an active library and return a Cloudinary-compatible resource. Use file for a multipart file, data URI, public HTTPS URL or same-owner file identifier. Reusing public_id overwrites by default; overwrite=false returns the existing resource. Chunk uploads require both chunk headers.
|
|
7439
7658
|
*/
|
|
7440
7659
|
export const mediaListAssets = (options) => (options.client ?? client).get({
|
|
7441
7660
|
security: [{
|
|
@@ -7449,7 +7668,7 @@ export const mediaListAssets = (options) => (options.client ?? client).get({
|
|
|
7449
7668
|
/**
|
|
7450
7669
|
* Upload asset
|
|
7451
7670
|
*
|
|
7452
|
-
*
|
|
7671
|
+
* 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.
|
|
7453
7672
|
*/
|
|
7454
7673
|
export const mediaUploadAsset = (options) => (options.client ?? client).post({
|
|
7455
7674
|
security: [{
|
|
@@ -7467,7 +7686,7 @@ export const mediaUploadAsset = (options) => (options.client ?? client).post({
|
|
|
7467
7686
|
/**
|
|
7468
7687
|
* Import file
|
|
7469
7688
|
*
|
|
7470
|
-
* Copy
|
|
7689
|
+
* 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.
|
|
7471
7690
|
*/
|
|
7472
7691
|
export const mediaImportAsset = (options) => (options.client ?? client).post({
|
|
7473
7692
|
security: [{
|
|
@@ -7485,7 +7704,7 @@ export const mediaImportAsset = (options) => (options.client ?? client).post({
|
|
|
7485
7704
|
/**
|
|
7486
7705
|
* Delete asset
|
|
7487
7706
|
*
|
|
7488
|
-
*
|
|
7707
|
+
* Queue reprocessing of the asset’s current version and return its updated state immediately. Omit kinds to retry failed tasks and legacy source-size unsupported tasks; explicit kinds rerun applicable completed tasks and recoverable source-size unsupported tasks. Other unsupported causes remain unchanged. Replaced understandings become superseded, and processing finishes asynchronously.
|
|
7489
7708
|
*/
|
|
7490
7709
|
export const mediaDeleteAsset = (options) => (options.client ?? client).delete({
|
|
7491
7710
|
security: [{
|
|
@@ -7499,7 +7718,7 @@ export const mediaDeleteAsset = (options) => (options.client ?? client).delete({
|
|
|
7499
7718
|
/**
|
|
7500
7719
|
* Get asset
|
|
7501
7720
|
*
|
|
7502
|
-
*
|
|
7721
|
+
* Update an asset’s supplied metadata fields. Tags and context replace their current collections; an empty collection clears them. Moving asset_folder or changing display_name preserves public_id and delivery URLs.
|
|
7503
7722
|
*/
|
|
7504
7723
|
export const mediaGetAsset = (options) => (options.client ?? client).get({
|
|
7505
7724
|
security: [{
|
|
@@ -7513,7 +7732,7 @@ export const mediaGetAsset = (options) => (options.client ?? client).get({
|
|
|
7513
7732
|
/**
|
|
7514
7733
|
* Update asset
|
|
7515
7734
|
*
|
|
7516
|
-
*
|
|
7735
|
+
* Delete an asset from the library so it is no longer readable, searchable or deliverable. This removes the asset rather than placing it in the library’s restoration window; a missing asset returns ASSET_NOT_FOUND.
|
|
7517
7736
|
*/
|
|
7518
7737
|
export const mediaUpdateAsset = (options) => (options.client ?? client).patch({
|
|
7519
7738
|
security: [{
|
|
@@ -7531,7 +7750,7 @@ export const mediaUpdateAsset = (options) => (options.client ?? client).patch({
|
|
|
7531
7750
|
/**
|
|
7532
7751
|
* Reprocess asset
|
|
7533
7752
|
*
|
|
7534
|
-
*
|
|
7753
|
+
* 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.
|
|
7535
7754
|
*/
|
|
7536
7755
|
export const mediaReprocessAsset = (options) => (options.client ?? client).post({
|
|
7537
7756
|
security: [{
|
|
@@ -7549,7 +7768,7 @@ export const mediaReprocessAsset = (options) => (options.client ?? client).post(
|
|
|
7549
7768
|
/**
|
|
7550
7769
|
* List understandings
|
|
7551
7770
|
*
|
|
7552
|
-
* List an asset
|
|
7771
|
+
* List understanding results for an asset, ordered by creation time. Use the cursor to continue; include_superseded also returns replaced records. The optional shots array contains current-version shot boundaries and per-shot captions, scene, location guesses, visible text and confidence flags; it is absent on legacy records. Location guesses and folder mismatch are unverified hints. Correction-enabled transcripts expose text_original, corrected text and a correction audit. Their timed data array remains suitable for subtitles. Reference failure is marked missing; correction failure returns the original verbatim. Model inference uses the existing metered model path.
|
|
7553
7772
|
*/
|
|
7554
7773
|
export const mediaListUnderstandings = (options) => (options.client ?? client).get({
|
|
7555
7774
|
security: [{
|
|
@@ -7563,7 +7782,7 @@ export const mediaListUnderstandings = (options) => (options.client ?? client).g
|
|
|
7563
7782
|
/**
|
|
7564
7783
|
* Expression search
|
|
7565
7784
|
*
|
|
7566
|
-
*
|
|
7785
|
+
* Find visually similar assets using exactly one of asset_id or an inline base64 image. The library must support image search; an asset query needs a current image embedding and excludes that source asset from results.
|
|
7567
7786
|
*/
|
|
7568
7787
|
export const mediaExpressionSearch = (options) => (options.client ?? client).post({
|
|
7569
7788
|
security: [{
|
|
@@ -7581,7 +7800,7 @@ export const mediaExpressionSearch = (options) => (options.client ?? client).pos
|
|
|
7581
7800
|
/**
|
|
7582
7801
|
* Visual search
|
|
7583
7802
|
*
|
|
7584
|
-
*
|
|
7803
|
+
* Search assets with a nonblank text query and optional expression filter. Hybrid mode combines semantic and keyword matches; semantic mode uses vector similarity only. Results are ranked and limited by top_k.
|
|
7585
7804
|
*/
|
|
7586
7805
|
export const mediaVisualSearch = (options) => (options.client ?? client).post({
|
|
7587
7806
|
security: [{
|
|
@@ -7599,7 +7818,7 @@ export const mediaVisualSearch = (options) => (options.client ?? client).post({
|
|
|
7599
7818
|
/**
|
|
7600
7819
|
* Semantic search
|
|
7601
7820
|
*
|
|
7602
|
-
* Search assets with a nonblank text query
|
|
7821
|
+
* Alias of semantic search. Search assets with a nonblank text query, optional expression filter and top_k; hybrid combines semantic and keyword matches, while semantic uses vector similarity only.
|
|
7603
7822
|
*/
|
|
7604
7823
|
export const mediaSemanticSearch = (options) => (options.client ?? client).post({
|
|
7605
7824
|
security: [{
|
|
@@ -7617,7 +7836,7 @@ export const mediaSemanticSearch = (options) => (options.client ?? client).post(
|
|
|
7617
7836
|
/**
|
|
7618
7837
|
* Semantic search alias
|
|
7619
7838
|
*
|
|
7620
|
-
*
|
|
7839
|
+
* List all immediate child folders under parent, or under the root when parent is omitted. Counts include descendant assets. The result is unpaginated; limit and cursor are rejected.
|
|
7621
7840
|
*/
|
|
7622
7841
|
export const mediaSearch = (options) => (options.client ?? client).post({
|
|
7623
7842
|
security: [{
|
|
@@ -7635,7 +7854,7 @@ export const mediaSearch = (options) => (options.client ?? client).post({
|
|
|
7635
7854
|
/**
|
|
7636
7855
|
* List folders
|
|
7637
7856
|
*
|
|
7638
|
-
*
|
|
7857
|
+
* undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.
|
|
7639
7858
|
*/
|
|
7640
7859
|
export const mediaListFolders = (options) => (options.client ?? client).get({
|
|
7641
7860
|
security: [{
|
|
@@ -7649,7 +7868,7 @@ export const mediaListFolders = (options) => (options.client ?? client).get({
|
|
|
7649
7868
|
/**
|
|
7650
7869
|
* Create batch
|
|
7651
7870
|
*
|
|
7652
|
-
*
|
|
7871
|
+
* 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.
|
|
7653
7872
|
*/
|
|
7654
7873
|
export const mediaCreateBatch = (options) => (options.client ?? client).post({
|
|
7655
7874
|
security: [{
|
|
@@ -7667,7 +7886,7 @@ export const mediaCreateBatch = (options) => (options.client ?? client).post({
|
|
|
7667
7886
|
/**
|
|
7668
7887
|
* Get batch
|
|
7669
7888
|
*
|
|
7670
|
-
*
|
|
7889
|
+
* Alias of batch creation. Apply one metadata or deletion action to ids or a frozen expression selection asynchronously; poll the returned job id to inspect completion and item failures.
|
|
7671
7890
|
*/
|
|
7672
7891
|
export const mediaGetBatch = (options) => (options.client ?? client).get({
|
|
7673
7892
|
security: [{
|
|
@@ -7681,7 +7900,7 @@ export const mediaGetBatch = (options) => (options.client ?? client).get({
|
|
|
7681
7900
|
/**
|
|
7682
7901
|
* Batch assets alias
|
|
7683
7902
|
*
|
|
7684
|
-
*
|
|
7903
|
+
* 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.
|
|
7685
7904
|
*/
|
|
7686
7905
|
export const mediaBatchAssets = (options) => (options.client ?? client).post({
|
|
7687
7906
|
security: [{
|
|
@@ -7697,9 +7916,9 @@ export const mediaBatchAssets = (options) => (options.client ?? client).post({
|
|
|
7697
7916
|
}
|
|
7698
7917
|
});
|
|
7699
7918
|
/**
|
|
7700
|
-
* Get job
|
|
7919
|
+
* Get job
|
|
7701
7920
|
*
|
|
7702
|
-
*
|
|
7921
|
+
* Read the current batch or video-generation Job status and progress. For generation, inspect outputs and failures, then save successful candidates before their preview and save window expires after 7 days.
|
|
7703
7922
|
*/
|
|
7704
7923
|
export const mediaGetJob = (options) => (options.client ?? client).get({
|
|
7705
7924
|
security: [{
|
|
@@ -7713,7 +7932,7 @@ export const mediaGetJob = (options) => (options.client ?? client).get({
|
|
|
7713
7932
|
/**
|
|
7714
7933
|
* List events
|
|
7715
7934
|
*
|
|
7716
|
-
* Read library events in sequence order
|
|
7935
|
+
* Read library events in sequence order for observing asset writes and understanding progress. Obtain library_id from creation or listing; continue with after_seq for asc or before_seq for desc, without combining both. Use next_cursor when supplied. Reads do not start or retry understanding.
|
|
7717
7936
|
*/
|
|
7718
7937
|
export const mediaListEvents = (options) => (options.client ?? client).get({
|
|
7719
7938
|
security: [{
|
|
@@ -7727,7 +7946,7 @@ export const mediaListEvents = (options) => (options.client ?? client).get({
|
|
|
7727
7946
|
/**
|
|
7728
7947
|
* Create delivery token
|
|
7729
7948
|
*
|
|
7730
|
-
* Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is
|
|
7949
|
+
* Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is 900 seconds; narrow acl and expires_in before sharing. Anyone holding the token can read matching paths until expires_at.
|
|
7731
7950
|
*/
|
|
7732
7951
|
export const mediaCreateDeliveryToken = (options) => (options.client ?? client).post({
|
|
7733
7952
|
security: [{
|
|
@@ -7742,6 +7961,340 @@ export const mediaCreateDeliveryToken = (options) => (options.client ?? client).
|
|
|
7742
7961
|
...options.headers
|
|
7743
7962
|
}
|
|
7744
7963
|
});
|
|
7964
|
+
/**
|
|
7965
|
+
* Summarize understanding failures
|
|
7966
|
+
*
|
|
7967
|
+
* Inspect current understanding failures before retrying. Use library_id from library creation or listing. Groups include code, output kind, actual producer model, retryability and up to five sample asset IDs. At most 1024 detailed groups plus two overflow groups are returned; overflow groups separate retryable and unrecoverable entries and mark overflow=true. Unknown failure codes remain retryable. Historical counts are provisional while counts_complete is false. Example: GET /media/v1/libraries/lib_example/understandings/failure_summary.
|
|
7968
|
+
*/
|
|
7969
|
+
export const mediaUnderstandingFailureSummary = (options) => (options.client ?? client).get({
|
|
7970
|
+
security: [{
|
|
7971
|
+
key: 'media-BearerAuth',
|
|
7972
|
+
scheme: 'bearer',
|
|
7973
|
+
type: 'http'
|
|
7974
|
+
}],
|
|
7975
|
+
url: '/media/v1/libraries/{library_id}/understandings/failure_summary',
|
|
7976
|
+
...options
|
|
7977
|
+
});
|
|
7978
|
+
/**
|
|
7979
|
+
* List understanding results across a library
|
|
7980
|
+
*
|
|
7981
|
+
* Read current understanding entries across one library without fetching every asset separately. Use library_id from creation or listing. folder includes descendants; kinds is a comma-separated list of output kinds. Entries are ordered by asset_id and then understanding id. Continue with next_cursor and the same folder and kinds; limit defaults to 100 and cannot exceed 100. Superseded, deleted and old-version entries are excluded. During historical backfill, this method returns 503 CAPACITY rather than incomplete pages; poll failureSummary until counts_complete is true, then start pagination. Example: GET /media/v1/libraries/lib_example/understandings?folder=travel&kinds=caption,transcript&limit=100.
|
|
7982
|
+
*/
|
|
7983
|
+
export const mediaListUnderstandingsByLibrary = (options) => (options.client ?? client).get({
|
|
7984
|
+
security: [{
|
|
7985
|
+
key: 'media-BearerAuth',
|
|
7986
|
+
scheme: 'bearer',
|
|
7987
|
+
type: 'http'
|
|
7988
|
+
}],
|
|
7989
|
+
url: '/media/v1/libraries/{library_id}/understandings',
|
|
7990
|
+
...options
|
|
7991
|
+
});
|
|
7992
|
+
/**
|
|
7993
|
+
* Create video generation
|
|
7994
|
+
*
|
|
7995
|
+
* 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.
|
|
7996
|
+
*/
|
|
7997
|
+
export const mediaCreateGeneration = (options) => (options.client ?? client).post({
|
|
7998
|
+
security: [{
|
|
7999
|
+
key: 'media-BearerAuth',
|
|
8000
|
+
scheme: 'bearer',
|
|
8001
|
+
type: 'http'
|
|
8002
|
+
}],
|
|
8003
|
+
url: '/media/v1/libraries/{library_id}/generations',
|
|
8004
|
+
...options,
|
|
8005
|
+
headers: {
|
|
8006
|
+
'Content-Type': 'application/json',
|
|
8007
|
+
...options.headers
|
|
8008
|
+
}
|
|
8009
|
+
});
|
|
8010
|
+
/**
|
|
8011
|
+
* List jobs
|
|
8012
|
+
*
|
|
8013
|
+
* 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.
|
|
8014
|
+
*/
|
|
8015
|
+
export const mediaListJobs = (options) => (options.client ?? client).get({
|
|
8016
|
+
security: [{
|
|
8017
|
+
key: 'media-BearerAuth',
|
|
8018
|
+
scheme: 'bearer',
|
|
8019
|
+
type: 'http'
|
|
8020
|
+
}],
|
|
8021
|
+
url: '/media/v1/libraries/{library_id}/jobs',
|
|
8022
|
+
...options
|
|
8023
|
+
});
|
|
8024
|
+
/**
|
|
8025
|
+
* Cancel job
|
|
8026
|
+
*
|
|
8027
|
+
* Cancel a queued or running generation job. Already completed outputs remain available to save; poll or read the returned Job to confirm its status.
|
|
8028
|
+
*/
|
|
8029
|
+
export const mediaCancelJob = (options) => (options.client ?? client).post({
|
|
8030
|
+
security: [{
|
|
8031
|
+
key: 'media-BearerAuth',
|
|
8032
|
+
scheme: 'bearer',
|
|
8033
|
+
type: 'http'
|
|
8034
|
+
}],
|
|
8035
|
+
url: '/media/v1/libraries/{library_id}/jobs/{job_id}/cancel',
|
|
8036
|
+
...options
|
|
8037
|
+
});
|
|
8038
|
+
/**
|
|
8039
|
+
* Save generation output
|
|
8040
|
+
*
|
|
8041
|
+
* 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.
|
|
8042
|
+
*/
|
|
8043
|
+
export const mediaSaveGenerationOutput = (options) => (options.client ?? client).post({
|
|
8044
|
+
security: [{
|
|
8045
|
+
key: 'media-BearerAuth',
|
|
8046
|
+
scheme: 'bearer',
|
|
8047
|
+
type: 'http'
|
|
8048
|
+
}],
|
|
8049
|
+
url: '/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save',
|
|
8050
|
+
...options,
|
|
8051
|
+
headers: {
|
|
8052
|
+
'Content-Type': 'application/json',
|
|
8053
|
+
...options.headers
|
|
8054
|
+
}
|
|
8055
|
+
});
|
|
8056
|
+
/**
|
|
8057
|
+
* Get generation capabilities
|
|
8058
|
+
*
|
|
8059
|
+
* 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.
|
|
8060
|
+
*/
|
|
8061
|
+
export const mediaGetGenerationCapabilities = (options) => (options?.client ?? client).get({
|
|
8062
|
+
security: [{
|
|
8063
|
+
key: 'media-BearerAuth',
|
|
8064
|
+
scheme: 'bearer',
|
|
8065
|
+
type: 'http'
|
|
8066
|
+
}],
|
|
8067
|
+
url: '/media/v1/generation/capabilities',
|
|
8068
|
+
...options
|
|
8069
|
+
});
|
|
8070
|
+
/**
|
|
8071
|
+
* List types
|
|
8072
|
+
*
|
|
8073
|
+
* 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.
|
|
8074
|
+
*/
|
|
8075
|
+
export const ontologyListTypes = (options) => (options?.client ?? client).get({
|
|
8076
|
+
security: [{
|
|
8077
|
+
key: 'ontology-bearerAuth',
|
|
8078
|
+
scheme: 'bearer',
|
|
8079
|
+
type: 'http'
|
|
8080
|
+
}],
|
|
8081
|
+
url: '/ontology/v1/types',
|
|
8082
|
+
...options
|
|
8083
|
+
});
|
|
8084
|
+
/**
|
|
8085
|
+
* Register type
|
|
8086
|
+
*
|
|
8087
|
+
* 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.
|
|
8088
|
+
*/
|
|
8089
|
+
export const ontologyRegisterType = (options) => (options.client ?? client).post({
|
|
8090
|
+
security: [{
|
|
8091
|
+
key: 'ontology-bearerAuth',
|
|
8092
|
+
scheme: 'bearer',
|
|
8093
|
+
type: 'http'
|
|
8094
|
+
}],
|
|
8095
|
+
url: '/ontology/v1/types',
|
|
8096
|
+
...options,
|
|
8097
|
+
headers: {
|
|
8098
|
+
'Content-Type': 'application/json',
|
|
8099
|
+
...options.headers
|
|
8100
|
+
}
|
|
8101
|
+
});
|
|
8102
|
+
/**
|
|
8103
|
+
* Retrieve type
|
|
8104
|
+
*
|
|
8105
|
+
* 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.
|
|
8106
|
+
*/
|
|
8107
|
+
export const ontologyRetrieveType = (options) => (options.client ?? client).get({
|
|
8108
|
+
security: [{
|
|
8109
|
+
key: 'ontology-bearerAuth',
|
|
8110
|
+
scheme: 'bearer',
|
|
8111
|
+
type: 'http'
|
|
8112
|
+
}],
|
|
8113
|
+
url: '/ontology/v1/types/{name}',
|
|
8114
|
+
...options
|
|
8115
|
+
});
|
|
8116
|
+
/**
|
|
8117
|
+
* List nodes
|
|
8118
|
+
*
|
|
8119
|
+
* 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.
|
|
8120
|
+
*/
|
|
8121
|
+
export const ontologyListNodes = (options) => (options?.client ?? client).get({
|
|
8122
|
+
security: [{
|
|
8123
|
+
key: 'ontology-bearerAuth',
|
|
8124
|
+
scheme: 'bearer',
|
|
8125
|
+
type: 'http'
|
|
8126
|
+
}],
|
|
8127
|
+
url: '/ontology/v1/nodes',
|
|
8128
|
+
...options
|
|
8129
|
+
});
|
|
8130
|
+
/**
|
|
8131
|
+
* Create node
|
|
8132
|
+
*
|
|
8133
|
+
* 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.
|
|
8134
|
+
*/
|
|
8135
|
+
export const ontologyCreateNode = (options) => (options.client ?? client).post({
|
|
8136
|
+
security: [{
|
|
8137
|
+
key: 'ontology-bearerAuth',
|
|
8138
|
+
scheme: 'bearer',
|
|
8139
|
+
type: 'http'
|
|
8140
|
+
}],
|
|
8141
|
+
url: '/ontology/v1/nodes',
|
|
8142
|
+
...options,
|
|
8143
|
+
headers: {
|
|
8144
|
+
'Content-Type': 'application/json',
|
|
8145
|
+
...options.headers
|
|
8146
|
+
}
|
|
8147
|
+
});
|
|
8148
|
+
/**
|
|
8149
|
+
* Retrieve node
|
|
8150
|
+
*
|
|
8151
|
+
* 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.
|
|
8152
|
+
*/
|
|
8153
|
+
export const ontologyRetrieveNode = (options) => (options.client ?? client).get({
|
|
8154
|
+
security: [{
|
|
8155
|
+
key: 'ontology-bearerAuth',
|
|
8156
|
+
scheme: 'bearer',
|
|
8157
|
+
type: 'http'
|
|
8158
|
+
}],
|
|
8159
|
+
url: '/ontology/v1/nodes/{node_id}',
|
|
8160
|
+
...options
|
|
8161
|
+
});
|
|
8162
|
+
/**
|
|
8163
|
+
* Update node
|
|
8164
|
+
*
|
|
8165
|
+
* 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.
|
|
8166
|
+
*/
|
|
8167
|
+
export const ontologyUpdateNode = (options) => (options.client ?? client).patch({
|
|
8168
|
+
security: [{
|
|
8169
|
+
key: 'ontology-bearerAuth',
|
|
8170
|
+
scheme: 'bearer',
|
|
8171
|
+
type: 'http'
|
|
8172
|
+
}],
|
|
8173
|
+
url: '/ontology/v1/nodes/{node_id}',
|
|
8174
|
+
...options,
|
|
8175
|
+
headers: {
|
|
8176
|
+
'Content-Type': 'application/json',
|
|
8177
|
+
...options.headers
|
|
8178
|
+
}
|
|
8179
|
+
});
|
|
8180
|
+
/**
|
|
8181
|
+
* Merge node
|
|
8182
|
+
*
|
|
8183
|
+
* 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.
|
|
8184
|
+
*/
|
|
8185
|
+
export const ontologyMergeNode = (options) => (options.client ?? client).post({
|
|
8186
|
+
security: [{
|
|
8187
|
+
key: 'ontology-bearerAuth',
|
|
8188
|
+
scheme: 'bearer',
|
|
8189
|
+
type: 'http'
|
|
8190
|
+
}],
|
|
8191
|
+
url: '/ontology/v1/nodes/{node_id}/merge',
|
|
8192
|
+
...options,
|
|
8193
|
+
headers: {
|
|
8194
|
+
'Content-Type': 'application/json',
|
|
8195
|
+
...options.headers
|
|
8196
|
+
}
|
|
8197
|
+
});
|
|
8198
|
+
/**
|
|
8199
|
+
* List relations
|
|
8200
|
+
*
|
|
8201
|
+
* 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.
|
|
8202
|
+
*/
|
|
8203
|
+
export const ontologyListRelations = (options) => (options?.client ?? client).get({
|
|
8204
|
+
security: [{
|
|
8205
|
+
key: 'ontology-bearerAuth',
|
|
8206
|
+
scheme: 'bearer',
|
|
8207
|
+
type: 'http'
|
|
8208
|
+
}],
|
|
8209
|
+
url: '/ontology/v1/relations',
|
|
8210
|
+
...options
|
|
8211
|
+
});
|
|
8212
|
+
/**
|
|
8213
|
+
* Create relation
|
|
8214
|
+
*
|
|
8215
|
+
* 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.
|
|
8216
|
+
*/
|
|
8217
|
+
export const ontologyCreateRelation = (options) => (options.client ?? client).post({
|
|
8218
|
+
security: [{
|
|
8219
|
+
key: 'ontology-bearerAuth',
|
|
8220
|
+
scheme: 'bearer',
|
|
8221
|
+
type: 'http'
|
|
8222
|
+
}],
|
|
8223
|
+
url: '/ontology/v1/relations',
|
|
8224
|
+
...options,
|
|
8225
|
+
headers: {
|
|
8226
|
+
'Content-Type': 'application/json',
|
|
8227
|
+
...options.headers
|
|
8228
|
+
}
|
|
8229
|
+
});
|
|
8230
|
+
/**
|
|
8231
|
+
* Retrieve relation
|
|
8232
|
+
*
|
|
8233
|
+
* 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.
|
|
8234
|
+
*/
|
|
8235
|
+
export const ontologyRetrieveRelation = (options) => (options.client ?? client).get({
|
|
8236
|
+
security: [{
|
|
8237
|
+
key: 'ontology-bearerAuth',
|
|
8238
|
+
scheme: 'bearer',
|
|
8239
|
+
type: 'http'
|
|
8240
|
+
}],
|
|
8241
|
+
url: '/ontology/v1/relations/{relation_id}',
|
|
8242
|
+
...options
|
|
8243
|
+
});
|
|
8244
|
+
/**
|
|
8245
|
+
* Invalidate relation
|
|
8246
|
+
*
|
|
8247
|
+
* 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.
|
|
8248
|
+
*/
|
|
8249
|
+
export const ontologyInvalidateRelation = (options) => (options.client ?? client).post({
|
|
8250
|
+
security: [{
|
|
8251
|
+
key: 'ontology-bearerAuth',
|
|
8252
|
+
scheme: 'bearer',
|
|
8253
|
+
type: 'http'
|
|
8254
|
+
}],
|
|
8255
|
+
url: '/ontology/v1/relations/{relation_id}/invalidate',
|
|
8256
|
+
...options,
|
|
8257
|
+
headers: {
|
|
8258
|
+
'Content-Type': 'application/json',
|
|
8259
|
+
...options.headers
|
|
8260
|
+
}
|
|
8261
|
+
});
|
|
8262
|
+
/**
|
|
8263
|
+
* Apply changeset
|
|
8264
|
+
*
|
|
8265
|
+
* 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.
|
|
8266
|
+
*/
|
|
8267
|
+
export const ontologyApplyChangeset = (options) => (options.client ?? client).post({
|
|
8268
|
+
security: [{
|
|
8269
|
+
key: 'ontology-bearerAuth',
|
|
8270
|
+
scheme: 'bearer',
|
|
8271
|
+
type: 'http'
|
|
8272
|
+
}],
|
|
8273
|
+
url: '/ontology/v1/changesets',
|
|
8274
|
+
...options,
|
|
8275
|
+
headers: {
|
|
8276
|
+
'Content-Type': 'application/json',
|
|
8277
|
+
...options.headers
|
|
8278
|
+
}
|
|
8279
|
+
});
|
|
8280
|
+
/**
|
|
8281
|
+
* Search nodes
|
|
8282
|
+
*
|
|
8283
|
+
* 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.
|
|
8284
|
+
*/
|
|
8285
|
+
export const ontologySearch = (options) => (options.client ?? client).post({
|
|
8286
|
+
security: [{
|
|
8287
|
+
key: 'ontology-bearerAuth',
|
|
8288
|
+
scheme: 'bearer',
|
|
8289
|
+
type: 'http'
|
|
8290
|
+
}],
|
|
8291
|
+
url: '/ontology/v1/search',
|
|
8292
|
+
...options,
|
|
8293
|
+
headers: {
|
|
8294
|
+
'Content-Type': 'application/json',
|
|
8295
|
+
...options.headers
|
|
8296
|
+
}
|
|
8297
|
+
});
|
|
7745
8298
|
/**
|
|
7746
8299
|
* List sandboxes (v2)
|
|
7747
8300
|
*
|
|
@@ -8842,7 +9395,7 @@ export const vaultListVaults = (options) => (options?.client ?? client).get({
|
|
|
8842
9395
|
/**
|
|
8843
9396
|
* Create vault
|
|
8844
9397
|
*
|
|
8845
|
-
* 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.
|
|
9398
|
+
* 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.
|
|
8846
9399
|
*/
|
|
8847
9400
|
export const vaultCreateVault = (options) => (options.client ?? client).post({
|
|
8848
9401
|
security: [{
|
|
@@ -9438,7 +9991,7 @@ export const ticketGetLabels = (options) => (options?.client ?? client).get({
|
|
|
9438
9991
|
/**
|
|
9439
9992
|
* Create or add labels
|
|
9440
9993
|
*
|
|
9441
|
-
* 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.
|
|
9994
|
+
* 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.
|
|
9442
9995
|
*/
|
|
9443
9996
|
export const ticketPostLabels = (options) => (options.client ?? client).post({
|
|
9444
9997
|
security: [{
|
|
@@ -9460,7 +10013,7 @@ export const ticketPostLabels = (options) => (options.client ?? client).post({
|
|
|
9460
10013
|
/**
|
|
9461
10014
|
* Remove labels
|
|
9462
10015
|
*
|
|
9463
|
-
* 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.
|
|
10016
|
+
* 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.
|
|
9464
10017
|
*/
|
|
9465
10018
|
export const ticketDeleteLabelsName = (options) => (options.client ?? client).delete({
|
|
9466
10019
|
security: [{
|
|
@@ -9478,7 +10031,7 @@ export const ticketDeleteLabelsName = (options) => (options.client ?? client).de
|
|
|
9478
10031
|
/**
|
|
9479
10032
|
* Update labels
|
|
9480
10033
|
*
|
|
9481
|
-
* 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.
|
|
10034
|
+
* 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.
|
|
9482
10035
|
*/
|
|
9483
10036
|
export const ticketPatchLabelsName = (options) => (options.client ?? client).patch({
|
|
9484
10037
|
security: [{
|