@deepraxis/sdk 0.1.1-dev.da4893e → 0.1.1-dev.daf3004
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/METHODS.md +91 -1
- package/README.md +2 -2
- package/dist/core/errors.d.ts +6 -0
- package/dist/core/errors.js +8 -0
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +303 -117
- package/dist/generated/sdk.gen.js +546 -116
- package/dist/generated/types.gen.d.ts +3044 -270
- package/dist/operations.generated.d.ts +760 -28
- package/dist/operations.generated.js +1318 -419
- package/dist/resources.generated.d.ts +76 -8
- package/dist/resources.generated.js +58 -0
- package/package.json +2 -2
|
@@ -1144,7 +1144,7 @@ export type OwnFileDeleteFileResponse = {
|
|
|
1144
1144
|
};
|
|
1145
1145
|
export type OwnFilePraxisCreateUpload = {
|
|
1146
1146
|
/**
|
|
1147
|
-
* Exact complete file length in bytes, from 1 through
|
|
1147
|
+
* Exact complete file length in bytes, from 1 through 21474836480 (20 GiB); the sum of completed parts must match.
|
|
1148
1148
|
*/
|
|
1149
1149
|
bytes: number;
|
|
1150
1150
|
/**
|
|
@@ -1195,7 +1195,7 @@ export type OwnFilePraxisUpload = {
|
|
|
1195
1195
|
*/
|
|
1196
1196
|
created_at: number;
|
|
1197
1197
|
/**
|
|
1198
|
-
* Expiry time as Unix seconds; unfinished uploads expire after
|
|
1198
|
+
* Expiry time as Unix seconds; unfinished uploads expire after 7 days.
|
|
1199
1199
|
*/
|
|
1200
1200
|
expires_at: number;
|
|
1201
1201
|
/**
|
|
@@ -1207,13 +1207,38 @@ export type OwnFilePraxisUpload = {
|
|
|
1207
1207
|
*/
|
|
1208
1208
|
purpose: 'user_data' | 'assistants' | 'vision';
|
|
1209
1209
|
/**
|
|
1210
|
-
* Upload state: pending accepts parts; completed has a file; cancelled was cancelled; expired exceeded its
|
|
1210
|
+
* Upload state: pending accepts parts; completed has a file; cancelled was cancelled; expired exceeded its seven-day lifetime.
|
|
1211
1211
|
*/
|
|
1212
1212
|
status: 'pending' | 'completed' | 'cancelled' | 'expired';
|
|
1213
1213
|
/**
|
|
1214
1214
|
* Present after complete. A file with status uploaded is still processing; poll files.retrieve until processed before use.
|
|
1215
1215
|
*/
|
|
1216
1216
|
file?: OwnFileOpenAiFile | null;
|
|
1217
|
+
/**
|
|
1218
|
+
* Fixed part length in bytes for a fixed-size upload, or null for a general upload. Send exactly this many bytes per numbered part except for the final remainder.
|
|
1219
|
+
*/
|
|
1220
|
+
part_size?: number | null;
|
|
1221
|
+
/**
|
|
1222
|
+
* Parts the upload already holds, in resume order: numbered parts by number, then a general upload's parts by arrival. Query GET /file/v1/uploads/{upload_id} after a break and resend only the numbers missing here.
|
|
1223
|
+
*/
|
|
1224
|
+
received_parts?: Array<{
|
|
1225
|
+
/**
|
|
1226
|
+
* Fixed part number, or null for a part of a general upload.
|
|
1227
|
+
*/
|
|
1228
|
+
part_number: number | null;
|
|
1229
|
+
/**
|
|
1230
|
+
* Part identifier to pass to complete for this content.
|
|
1231
|
+
*/
|
|
1232
|
+
id: string;
|
|
1233
|
+
/**
|
|
1234
|
+
* Accepted length of this part in bytes.
|
|
1235
|
+
*/
|
|
1236
|
+
bytes: number;
|
|
1237
|
+
/**
|
|
1238
|
+
* Part content digest prefixed sha256:.
|
|
1239
|
+
*/
|
|
1240
|
+
sha256: string;
|
|
1241
|
+
}>;
|
|
1217
1242
|
/**
|
|
1218
1243
|
* Declared MIME type, verified during assembly.
|
|
1219
1244
|
*/
|
|
@@ -1274,7 +1299,7 @@ export type OwnFileSignedUploadRequest = {
|
|
|
1274
1299
|
*/
|
|
1275
1300
|
filename: string;
|
|
1276
1301
|
/**
|
|
1277
|
-
* Exact local file size in bytes, from 1 through
|
|
1302
|
+
* Exact local file size in bytes, from 1 through 21474836480 (20 GiB). Up to 104857600 bytes returns one PUT URL; larger files return numbered part URLs, a completion URL and a status URL. Every PUT requires its exact signed Content-Length.
|
|
1278
1303
|
*/
|
|
1279
1304
|
bytes: number;
|
|
1280
1305
|
/**
|
|
@@ -1286,7 +1311,7 @@ export type OwnFileSignedUploadRequest = {
|
|
|
1286
1311
|
*/
|
|
1287
1312
|
purpose?: 'user_data' | 'assistants' | 'vision';
|
|
1288
1313
|
/**
|
|
1289
|
-
* Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or
|
|
1314
|
+
* Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or 604800 (7 days) for multipart. All part URLs, the status URL and the completion URL share one expiry. This does not set the resulting file's lifetime.
|
|
1290
1315
|
*/
|
|
1291
1316
|
expires_in?: number;
|
|
1292
1317
|
/**
|
|
@@ -1337,6 +1362,10 @@ export type OwnFileSignedUploadResponse = {
|
|
|
1337
1362
|
* Bearer URL to POST without a body after every chunk is acknowledged. Returns 201 with the file object; missing chunks return 400 and successful completion replays return 410 CAPABILITY_USED.
|
|
1338
1363
|
*/
|
|
1339
1364
|
complete_url: string;
|
|
1365
|
+
/**
|
|
1366
|
+
* Read-only bearer URL for GET that answers the same body as GET /file/v1/uploads/{upload_id}: status, part_size and the received_parts. Use it after a break to resend only the missing chunks; it needs no API key and every write on it is refused.
|
|
1367
|
+
*/
|
|
1368
|
+
status_url: string;
|
|
1340
1369
|
};
|
|
1341
1370
|
/**
|
|
1342
1371
|
* Problem document returned by the Meta method catalog on failure.
|
|
@@ -10553,7 +10582,7 @@ export type AutomationTrigger = {
|
|
|
10553
10582
|
*/
|
|
10554
10583
|
end_at: string | null;
|
|
10555
10584
|
/**
|
|
10556
|
-
* Overlap policy when a firing
|
|
10585
|
+
* Overlap policy when a firing arrives while the previous run is still active: skip skips it, allow starts it anyway. When omitted, a schedule trigger uses skip and a webhook trigger uses allow, because a skipped webhook call is not redelivered.
|
|
10557
10586
|
*/
|
|
10558
10587
|
overlap: AutomationTriggerOverlap;
|
|
10559
10588
|
/**
|
|
@@ -10673,7 +10702,7 @@ export type AutomationTriggerCreateResult = {
|
|
|
10673
10702
|
*/
|
|
10674
10703
|
end_at: string | null;
|
|
10675
10704
|
/**
|
|
10676
|
-
* Overlap policy when a firing
|
|
10705
|
+
* Overlap policy when a firing arrives while the previous run is still active: skip skips it, allow starts it anyway. When omitted, a schedule trigger uses skip and a webhook trigger uses allow, because a skipped webhook call is not redelivered.
|
|
10677
10706
|
*/
|
|
10678
10707
|
overlap: AutomationTriggerOverlap;
|
|
10679
10708
|
/**
|
|
@@ -12774,6 +12803,10 @@ export type CutFramesResult = {
|
|
|
12774
12803
|
images: {
|
|
12775
12804
|
[key: string]: CutRenderRef;
|
|
12776
12805
|
};
|
|
12806
|
+
/**
|
|
12807
|
+
* Frame delivery warnings; empty when every requested source frame was available.
|
|
12808
|
+
*/
|
|
12809
|
+
warnings: Array<CutFrameWarning>;
|
|
12777
12810
|
};
|
|
12778
12811
|
/**
|
|
12779
12812
|
* Analysis status and available ranges for each source asset and kind.
|
|
@@ -13018,6 +13051,27 @@ export type CutExport = {
|
|
|
13018
13051
|
*/
|
|
13019
13052
|
audio: 'pending' | 'done';
|
|
13020
13053
|
};
|
|
13054
|
+
/**
|
|
13055
|
+
* Present when the export was normalized (the default, or an explicit target); contains the target and the measured output levels. Absent when loudness was null.
|
|
13056
|
+
*/
|
|
13057
|
+
loudness?: {
|
|
13058
|
+
/**
|
|
13059
|
+
* Requested integrated loudness target in LUFS.
|
|
13060
|
+
*/
|
|
13061
|
+
target_lufs: number;
|
|
13062
|
+
/**
|
|
13063
|
+
* Requested maximum true peak in dBTP.
|
|
13064
|
+
*/
|
|
13065
|
+
true_peak_dbtp: number;
|
|
13066
|
+
/**
|
|
13067
|
+
* Measured integrated loudness of the rendered export in LUFS.
|
|
13068
|
+
*/
|
|
13069
|
+
integrated_lufs: number;
|
|
13070
|
+
/**
|
|
13071
|
+
* Measured maximum true peak of the rendered export in dBTP.
|
|
13072
|
+
*/
|
|
13073
|
+
measured_true_peak_dbtp: number;
|
|
13074
|
+
};
|
|
13021
13075
|
/**
|
|
13022
13076
|
* Output media reference, available after the export reaches done.
|
|
13023
13077
|
*/
|
|
@@ -13090,6 +13144,19 @@ export type CutExportInput = {
|
|
|
13090
13144
|
*/
|
|
13091
13145
|
binding?: string;
|
|
13092
13146
|
revision?: CutRevision;
|
|
13147
|
+
/**
|
|
13148
|
+
* Loudness normalization target. Omitted, the export is normalized to -14 LUFS integrated and -1 dBTP true peak, the level short-video and streaming platforms play at; null renders without normalization. Normalization adds analysis and rendering work.
|
|
13149
|
+
*/
|
|
13150
|
+
loudness?: {
|
|
13151
|
+
/**
|
|
13152
|
+
* Integrated loudness target in LUFS.
|
|
13153
|
+
*/
|
|
13154
|
+
target_lufs: number;
|
|
13155
|
+
/**
|
|
13156
|
+
* Maximum true peak in dBTP.
|
|
13157
|
+
*/
|
|
13158
|
+
true_peak_dbtp: number;
|
|
13159
|
+
} | null;
|
|
13093
13160
|
};
|
|
13094
13161
|
/**
|
|
13095
13162
|
* One page of organization-accessible exports.
|
|
@@ -13104,6 +13171,93 @@ export type CutExportPage = {
|
|
|
13104
13171
|
*/
|
|
13105
13172
|
next_page_token?: string;
|
|
13106
13173
|
};
|
|
13174
|
+
/**
|
|
13175
|
+
* A draft range render of one timeline interval, stored as a temporary file that expires and belongs to no media library.
|
|
13176
|
+
*/
|
|
13177
|
+
export type CutDraftRender = {
|
|
13178
|
+
/**
|
|
13179
|
+
* Draft render id returned by create; use as render_id for retrieve.
|
|
13180
|
+
*/
|
|
13181
|
+
id?: string;
|
|
13182
|
+
/**
|
|
13183
|
+
* Project whose timeline is rendered.
|
|
13184
|
+
*/
|
|
13185
|
+
project_id?: string;
|
|
13186
|
+
/**
|
|
13187
|
+
* queued is accepted and not started; rendering is producing the interval; done means file_id and url are usable; failed means inspect error and, if the interval matters, submit it again. Only done yields a url.
|
|
13188
|
+
*/
|
|
13189
|
+
status?: 'queued' | 'rendering' | 'done' | 'failed';
|
|
13190
|
+
/**
|
|
13191
|
+
* What was rendered, as chosen at creation; audio is an .m4a of the mix, video is a draft-quality .mp4.
|
|
13192
|
+
*/
|
|
13193
|
+
kind?: 'audio' | 'video';
|
|
13194
|
+
/**
|
|
13195
|
+
* Start of the rendered interval in seconds on the project clock, inclusive.
|
|
13196
|
+
*/
|
|
13197
|
+
from?: number;
|
|
13198
|
+
/**
|
|
13199
|
+
* End of the rendered interval in seconds on the project clock, exclusive.
|
|
13200
|
+
*/
|
|
13201
|
+
to?: number;
|
|
13202
|
+
/**
|
|
13203
|
+
* Revision the interval was sliced from, frozen when the draft was created.
|
|
13204
|
+
*/
|
|
13205
|
+
revision?: CutRevision;
|
|
13206
|
+
/**
|
|
13207
|
+
* Seconds of rendered material, present once the render finished; this is what the draft bills for.
|
|
13208
|
+
*/
|
|
13209
|
+
duration?: number;
|
|
13210
|
+
/**
|
|
13211
|
+
* Temporary file holding the rendered bytes, present once status is done. It expires 24 hours after it was stored and is not a media asset, so it can be read but never referenced as library material.
|
|
13212
|
+
*/
|
|
13213
|
+
file_id?: string;
|
|
13214
|
+
/**
|
|
13215
|
+
* Short-lived link for reading the finished draft, present only while status is done. It expires within minutes, so retrieve the render again rather than saving it.
|
|
13216
|
+
*/
|
|
13217
|
+
url?: string;
|
|
13218
|
+
/**
|
|
13219
|
+
* Present when status is failed; nothing was stored.
|
|
13220
|
+
*/
|
|
13221
|
+
error?: {
|
|
13222
|
+
/**
|
|
13223
|
+
* Stable error code, EXPORT_FAILED for a render that could not finish.
|
|
13224
|
+
*/
|
|
13225
|
+
code: string;
|
|
13226
|
+
/**
|
|
13227
|
+
* Bounded cause of the failure, safe to read; provider URLs are stripped.
|
|
13228
|
+
*/
|
|
13229
|
+
message: string;
|
|
13230
|
+
};
|
|
13231
|
+
/**
|
|
13232
|
+
* When the draft was accepted, as an RFC 3339 timestamp.
|
|
13233
|
+
*/
|
|
13234
|
+
create_time?: string;
|
|
13235
|
+
/**
|
|
13236
|
+
* When the draft reached done or failed, as an RFC 3339 timestamp; absent while it is still running.
|
|
13237
|
+
*/
|
|
13238
|
+
finish_time?: string;
|
|
13239
|
+
};
|
|
13240
|
+
/**
|
|
13241
|
+
* The interval of the timeline to render as a draft.
|
|
13242
|
+
*/
|
|
13243
|
+
export type CutDraftRenderInput = {
|
|
13244
|
+
/**
|
|
13245
|
+
* audio renders the mixed soundtrack alone as an .m4a file for listening; video renders a draft-quality .mp4 with picture and sound for looking at. An audio draft is the cheaper of the two and is what a loudness or mix measurement asks for.
|
|
13246
|
+
*/
|
|
13247
|
+
kind: 'audio' | 'video';
|
|
13248
|
+
/**
|
|
13249
|
+
* Start of the interval in seconds on the project clock, inclusive. Must be less than to.
|
|
13250
|
+
*/
|
|
13251
|
+
from: number;
|
|
13252
|
+
/**
|
|
13253
|
+
* End of the interval in seconds on the project clock, exclusive. At most 120 seconds after from, and never beyond the timeline duration; a longer passage is requested as several ranges.
|
|
13254
|
+
*/
|
|
13255
|
+
to: number;
|
|
13256
|
+
/**
|
|
13257
|
+
* Optional revision to render. Omitted renders the project's current revision; a revision that is no longer current is refused with REVISION_CONFLICT, so read the project state first when the interval must match an earlier edit.
|
|
13258
|
+
*/
|
|
13259
|
+
revision?: CutRevision;
|
|
13260
|
+
};
|
|
13107
13261
|
/**
|
|
13108
13262
|
* One page of organization-accessible versions.
|
|
13109
13263
|
*/
|
|
@@ -14142,7 +14296,7 @@ export type MediaLibrary = {
|
|
|
14142
14296
|
};
|
|
14143
14297
|
export type MediaMediaError = {
|
|
14144
14298
|
error: {
|
|
14145
|
-
code: 'LIBRARY_NOT_FOUND' | 'ASSET_NOT_FOUND' | 'JOB_NOT_FOUND' | 'UNDERSTANDING_NOT_FOUND' | 'ASSET_VERSION_CHANGED' | 'LIBRARY_INVALID_STATE' | 'INVALID_PARAMS' | 'INVALID_EXPRESSION' | 'UNSUPPORTED' | 'NOT_IMPLEMENTED' | 'FILE_TOO_LARGE' | 'FILE_EMPTY' | 'UNSUPPORTED_MEDIA' | 'FETCH_FAILED' | 'LIMIT_EXCEEDED' | 'CHUNK_INVALID' | 'RATE_LIMITED' | 'CAPACITY' | 'UPSTREAM_FAILED' | 'BINDING_READ_ONLY';
|
|
14299
|
+
code: 'LIBRARY_NOT_FOUND' | 'ASSET_NOT_FOUND' | 'JOB_NOT_FOUND' | 'UNDERSTANDING_NOT_FOUND' | 'ASSET_VERSION_CHANGED' | 'LIBRARY_INVALID_STATE' | 'INVALID_PARAMS' | 'INVALID_EXPRESSION' | 'UNSUPPORTED' | 'NOT_IMPLEMENTED' | 'FILE_TOO_LARGE' | 'FILE_EMPTY' | 'UNSUPPORTED_MEDIA' | 'FETCH_FAILED' | 'LIMIT_EXCEEDED' | 'CHUNK_INVALID' | 'RATE_LIMITED' | 'CAPACITY' | 'UPSTREAM_FAILED' | 'CONTENT_REJECTED' | 'GENERATION_FAILED' | 'CANDIDATE_EXPIRED' | 'BINDING_READ_ONLY';
|
|
14146
14300
|
message: string;
|
|
14147
14301
|
details: string | null;
|
|
14148
14302
|
};
|
|
@@ -14394,6 +14548,10 @@ export type MediaAsset = {
|
|
|
14394
14548
|
* Resource status; active identifies an asset that has not been deleted.
|
|
14395
14549
|
*/
|
|
14396
14550
|
status: 'active';
|
|
14551
|
+
/**
|
|
14552
|
+
* True when the source header declares an alpha channel: a PNG color type 4 or 6 or a tRNS chunk, a WebP VP8X alpha flag or VP8L alpha bit, a WebM or MKV video track AlphaMode of 1, or a GIF transparent-color flag. False when a known container has no alpha channel. Omitted when the format is unknown, the header could not be parsed, or the asset was stored before this field existed; absence does not mean the source is opaque.
|
|
14553
|
+
*/
|
|
14554
|
+
has_alpha?: boolean;
|
|
14397
14555
|
/**
|
|
14398
14556
|
* Search-vector status: pending awaits vector generation or reprocessing; ready has searchable vectors; unavailable indicates disabled, unsupported or failed embedding. Existing vectors may still serve searches while reprocessing is pending.
|
|
14399
14557
|
*/
|
|
@@ -14450,6 +14608,27 @@ export type MediaAsset = {
|
|
|
14450
14608
|
};
|
|
14451
14609
|
};
|
|
14452
14610
|
};
|
|
14611
|
+
/**
|
|
14612
|
+
* Source details for the video-generation job that created this asset.
|
|
14613
|
+
*/
|
|
14614
|
+
generation?: {
|
|
14615
|
+
/**
|
|
14616
|
+
* Job id that generated this asset.
|
|
14617
|
+
*/
|
|
14618
|
+
job_id: MediaJobId;
|
|
14619
|
+
/**
|
|
14620
|
+
* Generation intent used to create the asset; v1 supports video.generate.
|
|
14621
|
+
*/
|
|
14622
|
+
intent: string;
|
|
14623
|
+
/**
|
|
14624
|
+
* Text prompt submitted for the generation job.
|
|
14625
|
+
*/
|
|
14626
|
+
prompt: string;
|
|
14627
|
+
/**
|
|
14628
|
+
* Router video-generation model that produced the asset.
|
|
14629
|
+
*/
|
|
14630
|
+
model: string;
|
|
14631
|
+
};
|
|
14453
14632
|
};
|
|
14454
14633
|
/**
|
|
14455
14634
|
* Receipt confirming that the asset was deleted.
|
|
@@ -14592,11 +14771,11 @@ export type MediaJob = {
|
|
|
14592
14771
|
/**
|
|
14593
14772
|
* Batch operation: tag adds labels, untag removes labels, set_context replaces custom metadata, move changes asset_folder, and delete removes selected assets. reprocess starts fenced understanding Workflows for retryable failed steps and legacy source-size unsupported steps; kinds narrows the selection. Other unsupported and permanent steps remain unchanged.
|
|
14594
14773
|
*/
|
|
14595
|
-
action: 'tag' | 'untag' | 'set_context' | 'move' | 'delete' | 'reprocess';
|
|
14774
|
+
action: 'tag' | 'untag' | 'set_context' | 'move' | 'delete' | 'reprocess' | 'generate';
|
|
14596
14775
|
/**
|
|
14597
14776
|
* Job status: queued awaits execution; running is processing items; completed means all items succeeded; completed_with_errors means some succeeded and some failed; failed means all selected items failed. An empty job completes successfully.
|
|
14598
14777
|
*/
|
|
14599
|
-
status:
|
|
14778
|
+
status: MediaJobStatus;
|
|
14600
14779
|
/**
|
|
14601
14780
|
* Number of distinct assets selected when the job was created.
|
|
14602
14781
|
*/
|
|
@@ -14616,12 +14795,66 @@ export type MediaJob = {
|
|
|
14616
14795
|
/**
|
|
14617
14796
|
* Identifier supplied for the failed item; it may identify a missing asset.
|
|
14618
14797
|
*/
|
|
14619
|
-
asset_id
|
|
14798
|
+
asset_id?: MediaAssetId;
|
|
14799
|
+
/**
|
|
14800
|
+
* Zero-based output index for a failed video-generation item.
|
|
14801
|
+
*/
|
|
14802
|
+
index?: number;
|
|
14620
14803
|
/**
|
|
14621
14804
|
* Domain error code explaining the individual item failure.
|
|
14622
14805
|
*/
|
|
14623
14806
|
code: MediaMediaErrorCode;
|
|
14624
14807
|
}>;
|
|
14808
|
+
/**
|
|
14809
|
+
* Generation intent used by this job; v1 supports video.generate.
|
|
14810
|
+
*/
|
|
14811
|
+
intent?: string;
|
|
14812
|
+
/**
|
|
14813
|
+
* Router video-generation model used for the outputs.
|
|
14814
|
+
*/
|
|
14815
|
+
model?: string;
|
|
14816
|
+
/**
|
|
14817
|
+
* Per-video results in index order; save a successful candidate before expires_at.
|
|
14818
|
+
*/
|
|
14819
|
+
outputs?: Array<{
|
|
14820
|
+
/**
|
|
14821
|
+
* Zero-based position of this video in the requested count.
|
|
14822
|
+
*/
|
|
14823
|
+
index: number;
|
|
14824
|
+
/**
|
|
14825
|
+
* State of this requested video output.
|
|
14826
|
+
*/
|
|
14827
|
+
status: MediaGenerationOutputStatus;
|
|
14828
|
+
/**
|
|
14829
|
+
* Short-lived signed URL for previewing this candidate; read the Job again to obtain a fresh URL.
|
|
14830
|
+
*/
|
|
14831
|
+
preview_url?: string;
|
|
14832
|
+
/**
|
|
14833
|
+
* Router seed for this video, when returned; it may be absent.
|
|
14834
|
+
*/
|
|
14835
|
+
seed?: number | null;
|
|
14836
|
+
/**
|
|
14837
|
+
* Candidate expiry time; after expiry, save returns CANDIDATE_EXPIRED.
|
|
14838
|
+
*/
|
|
14839
|
+
expires_at?: MediaIsoTimestamp;
|
|
14840
|
+
/**
|
|
14841
|
+
* Library asset identifier after this candidate has been saved, or when the job requested save=library.
|
|
14842
|
+
*/
|
|
14843
|
+
asset_id?: MediaAssetId;
|
|
14844
|
+
}>;
|
|
14845
|
+
/**
|
|
14846
|
+
* Router-reported generation charge for the job.
|
|
14847
|
+
*/
|
|
14848
|
+
usage?: {
|
|
14849
|
+
/**
|
|
14850
|
+
* Decimal amount in the currency named by currency; this is not a floating-point value.
|
|
14851
|
+
*/
|
|
14852
|
+
amount: string;
|
|
14853
|
+
/**
|
|
14854
|
+
* Currency code for amount.
|
|
14855
|
+
*/
|
|
14856
|
+
currency: string;
|
|
14857
|
+
};
|
|
14625
14858
|
/**
|
|
14626
14859
|
* Time the batch job was created, in UTC.
|
|
14627
14860
|
*/
|
|
@@ -14736,6 +14969,524 @@ export type MediaFailureSummary = {
|
|
|
14736
14969
|
*/
|
|
14737
14970
|
counts_complete: boolean;
|
|
14738
14971
|
};
|
|
14972
|
+
/**
|
|
14973
|
+
* Current state of a batch or video-generation job.
|
|
14974
|
+
*/
|
|
14975
|
+
export type MediaJobStatus = 'queued' | 'running' | 'completed' | 'completed_with_errors' | 'failed' | 'cancelled';
|
|
14976
|
+
/**
|
|
14977
|
+
* Identifier returned when a batch job is created.
|
|
14978
|
+
*/
|
|
14979
|
+
export type MediaJobId = string;
|
|
14980
|
+
/**
|
|
14981
|
+
* A page of jobs in a library.
|
|
14982
|
+
*/
|
|
14983
|
+
export type MediaJobPage = {
|
|
14984
|
+
/**
|
|
14985
|
+
* Jobs returned in this page.
|
|
14986
|
+
*/
|
|
14987
|
+
data: Array<MediaJob>;
|
|
14988
|
+
/**
|
|
14989
|
+
* Cursor for the next page, or null when there are no more jobs.
|
|
14990
|
+
*/
|
|
14991
|
+
next_cursor: MediaJobId | null;
|
|
14992
|
+
};
|
|
14993
|
+
/**
|
|
14994
|
+
* Current text-to-video options, concurrency and candidate retention. Generation is charged per second; unsaved candidates expire after 7 days.
|
|
14995
|
+
*/
|
|
14996
|
+
export type MediaGenerationCapabilities = {
|
|
14997
|
+
/**
|
|
14998
|
+
* Text-to-video intents currently supported by Media.
|
|
14999
|
+
*/
|
|
15000
|
+
intents: Array<string>;
|
|
15001
|
+
/**
|
|
15002
|
+
* Model selected when model is omitted from a generation request.
|
|
15003
|
+
*/
|
|
15004
|
+
default_model: string;
|
|
15005
|
+
/**
|
|
15006
|
+
* Allowed number of videos per generation job.
|
|
15007
|
+
*/
|
|
15008
|
+
count: {
|
|
15009
|
+
/**
|
|
15010
|
+
* Minimum number of videos in one generation job.
|
|
15011
|
+
*/
|
|
15012
|
+
minimum: number;
|
|
15013
|
+
/**
|
|
15014
|
+
* Maximum number of videos in one generation job.
|
|
15015
|
+
*/
|
|
15016
|
+
maximum: number;
|
|
15017
|
+
};
|
|
15018
|
+
/**
|
|
15019
|
+
* Durations in seconds supported by the default video model.
|
|
15020
|
+
*/
|
|
15021
|
+
duration_seconds: Array<number>;
|
|
15022
|
+
/**
|
|
15023
|
+
* Aspect ratios supported by the default video model.
|
|
15024
|
+
*/
|
|
15025
|
+
aspect_ratios: Array<string>;
|
|
15026
|
+
/**
|
|
15027
|
+
* Aspect ratio used when aspect_ratio is omitted.
|
|
15028
|
+
*/
|
|
15029
|
+
default_aspect_ratio: string;
|
|
15030
|
+
/**
|
|
15031
|
+
* Maximum number of queued or running generation jobs per library.
|
|
15032
|
+
*/
|
|
15033
|
+
concurrency_per_library: number;
|
|
15034
|
+
/**
|
|
15035
|
+
* Unit used to charge video generation; generated duration is billed per second by Router.
|
|
15036
|
+
*/
|
|
15037
|
+
price_unit: 'per second';
|
|
15038
|
+
/**
|
|
15039
|
+
* Days an unsaved candidate is retained before its File is deleted.
|
|
15040
|
+
*/
|
|
15041
|
+
candidate_retention_days: number;
|
|
15042
|
+
};
|
|
15043
|
+
/**
|
|
15044
|
+
* One page of type registrations; types are few enough that this face returns them in a single page.
|
|
15045
|
+
*/
|
|
15046
|
+
export type OntologyTypeRegistrationPage = {
|
|
15047
|
+
/**
|
|
15048
|
+
* The registrations in force for this organization.
|
|
15049
|
+
*/
|
|
15050
|
+
data: Array<OntologyTypeRegistration>;
|
|
15051
|
+
/**
|
|
15052
|
+
* Always null here; the field is present so every list on this face has the same shape.
|
|
15053
|
+
*/
|
|
15054
|
+
next_cursor: string;
|
|
15055
|
+
};
|
|
15056
|
+
/**
|
|
15057
|
+
* One service's registered types for this organization, as shipped by that service and stored by the deploy gate.
|
|
15058
|
+
*/
|
|
15059
|
+
export type OntologyTypeRegistration = {
|
|
15060
|
+
/**
|
|
15061
|
+
* Service that registered these types, for example file or ticket; it is the registrant a later change to a type is checked against.
|
|
15062
|
+
*/
|
|
15063
|
+
owner: string;
|
|
15064
|
+
/**
|
|
15065
|
+
* Monotonic version of this owner's registration; a later registration must extend this one without removing or narrowing anything.
|
|
15066
|
+
*/
|
|
15067
|
+
version: number;
|
|
15068
|
+
/**
|
|
15069
|
+
* Node types this owner registers.
|
|
15070
|
+
*/
|
|
15071
|
+
nodes: Array<OntologyNodeType>;
|
|
15072
|
+
/**
|
|
15073
|
+
* Relation types this owner registers.
|
|
15074
|
+
*/
|
|
15075
|
+
edges: Array<OntologyEdgeType>;
|
|
15076
|
+
};
|
|
15077
|
+
export type OntologyOntologyError = {
|
|
15078
|
+
/**
|
|
15079
|
+
* Failure details for a non-2xx response; choose a recovery action using the operation's status and code description.
|
|
15080
|
+
*/
|
|
15081
|
+
error: {
|
|
15082
|
+
/**
|
|
15083
|
+
* Machine-readable failure category; see this operation's error responses for triggering conditions and recovery actions.
|
|
15084
|
+
*/
|
|
15085
|
+
code: string;
|
|
15086
|
+
/**
|
|
15087
|
+
* Human-readable explanation of why the request failed; it names the offending field or condition and the action to take.
|
|
15088
|
+
*/
|
|
15089
|
+
message: string;
|
|
15090
|
+
/**
|
|
15091
|
+
* Optional error-specific context, present when the failure names particular items; absent for failures that concern the request as a whole.
|
|
15092
|
+
*/
|
|
15093
|
+
details?: {
|
|
15094
|
+
[key: string]: unknown;
|
|
15095
|
+
};
|
|
15096
|
+
};
|
|
15097
|
+
};
|
|
15098
|
+
/**
|
|
15099
|
+
* One registered type, with the registration it belongs to and whether it is a node or a relation type.
|
|
15100
|
+
*/
|
|
15101
|
+
export type OntologyTypeLookup = {
|
|
15102
|
+
/**
|
|
15103
|
+
* Service that registered this type; a change to the type is checked against that registrant.
|
|
15104
|
+
*/
|
|
15105
|
+
owner: string;
|
|
15106
|
+
/**
|
|
15107
|
+
* Version of the registration this type came from, so a caller can tell when a definition moved on.
|
|
15108
|
+
*/
|
|
15109
|
+
version: number;
|
|
15110
|
+
/**
|
|
15111
|
+
* Whether the type describes an entity or a fact, which decides whether it is used when creating a node or a relation.
|
|
15112
|
+
*/
|
|
15113
|
+
kind: 'node' | 'edge';
|
|
15114
|
+
/**
|
|
15115
|
+
* The full registered definition — the same object as the entry in its registration's nodes or edges array.
|
|
15116
|
+
*/
|
|
15117
|
+
definition: {
|
|
15118
|
+
[key: string]: unknown;
|
|
15119
|
+
};
|
|
15120
|
+
};
|
|
15121
|
+
/**
|
|
15122
|
+
* One page of nodes; a restricted entry carries only id, type, name and restricted.
|
|
15123
|
+
*/
|
|
15124
|
+
export type OntologyNodePage = {
|
|
15125
|
+
/**
|
|
15126
|
+
* The nodes on this page, ordered by node id.
|
|
15127
|
+
*/
|
|
15128
|
+
data: Array<OntologyNode | OntologyRestrictedNode>;
|
|
15129
|
+
/**
|
|
15130
|
+
* Opaque cursor for the next page, or null when this is the last page; copy it into the next request's cursor unchanged.
|
|
15131
|
+
*/
|
|
15132
|
+
next_cursor: string;
|
|
15133
|
+
};
|
|
15134
|
+
/**
|
|
15135
|
+
* The entity to record; type must be registered and ref must match that type's prefix.
|
|
15136
|
+
*/
|
|
15137
|
+
export type OntologyCreateNodeInput = {
|
|
15138
|
+
/**
|
|
15139
|
+
* Registered node type name from types.list; an unregistered name is refused and nothing is written.
|
|
15140
|
+
*/
|
|
15141
|
+
type: string;
|
|
15142
|
+
/**
|
|
15143
|
+
* Id of the mirrored record in the owning service, which must start with the type's ref_prefix; omit or null for a concept with no external record.
|
|
15144
|
+
*/
|
|
15145
|
+
ref?: string;
|
|
15146
|
+
/**
|
|
15147
|
+
* Display name of the entity, at most 200 characters.
|
|
15148
|
+
*/
|
|
15149
|
+
name: string;
|
|
15150
|
+
/**
|
|
15151
|
+
* Other names this entity is known by; they are matched by search alongside the name.
|
|
15152
|
+
*/
|
|
15153
|
+
aliases?: Array<string>;
|
|
15154
|
+
/**
|
|
15155
|
+
* Profile of the entity, at most 500 characters; omit or null for none.
|
|
15156
|
+
*/
|
|
15157
|
+
description?: string;
|
|
15158
|
+
/**
|
|
15159
|
+
* Member id whose content this is, restricting it to that member; omit or null to make it readable organization-wide.
|
|
15160
|
+
*/
|
|
15161
|
+
owner?: string;
|
|
15162
|
+
};
|
|
15163
|
+
/**
|
|
15164
|
+
* One entity in the graph, with when it was recorded and last changed.
|
|
15165
|
+
*/
|
|
15166
|
+
export type OntologyNode = {
|
|
15167
|
+
/**
|
|
15168
|
+
* Node id, used by relations, merges and later reads; treat it as opaque and do not parse it.
|
|
15169
|
+
*/
|
|
15170
|
+
id: string;
|
|
15171
|
+
/**
|
|
15172
|
+
* Registered node type this entity was recorded as; it never changes after creation.
|
|
15173
|
+
*/
|
|
15174
|
+
type: string;
|
|
15175
|
+
/**
|
|
15176
|
+
* Id of the mirrored record in the service that owns it, matching the type's ref_prefix; null for a concept with no external record.
|
|
15177
|
+
*/
|
|
15178
|
+
ref?: string;
|
|
15179
|
+
/**
|
|
15180
|
+
* Display name of the entity, at most 200 characters.
|
|
15181
|
+
*/
|
|
15182
|
+
name: string;
|
|
15183
|
+
/**
|
|
15184
|
+
* Other names this entity is known by; they are matched by search alongside the name.
|
|
15185
|
+
*/
|
|
15186
|
+
aliases: Array<string>;
|
|
15187
|
+
/**
|
|
15188
|
+
* Profile of the entity, at most 500 characters; null when none was recorded.
|
|
15189
|
+
*/
|
|
15190
|
+
description?: string;
|
|
15191
|
+
/**
|
|
15192
|
+
* Member id whose content this is; null means it is readable organization-wide. Another member's node comes back restricted.
|
|
15193
|
+
*/
|
|
15194
|
+
owner: string;
|
|
15195
|
+
/**
|
|
15196
|
+
* When this node was merged into another, that survivor's id; reads of a merged node resolve to the survivor.
|
|
15197
|
+
*/
|
|
15198
|
+
merged_into?: string;
|
|
15199
|
+
/**
|
|
15200
|
+
* System time when the node was first recorded, in ISO 8601 UTC.
|
|
15201
|
+
*/
|
|
15202
|
+
created_at: string;
|
|
15203
|
+
/**
|
|
15204
|
+
* System time of the last change to this node's content, in ISO 8601 UTC.
|
|
15205
|
+
*/
|
|
15206
|
+
updated_at: string;
|
|
15207
|
+
/**
|
|
15208
|
+
* System time the mirrored record was deleted, when that is known; kept so history stays answerable.
|
|
15209
|
+
*/
|
|
15210
|
+
deleted_at?: string;
|
|
15211
|
+
};
|
|
15212
|
+
export type OntologyNodeWithRelations = OntologyNode & {
|
|
15213
|
+
/**
|
|
15214
|
+
* Relations on and around this node that the caller may read, ordered by relation id; present only when expand=relations was sent.
|
|
15215
|
+
*/
|
|
15216
|
+
relations?: Array<OntologyRelation>;
|
|
15217
|
+
};
|
|
15218
|
+
/**
|
|
15219
|
+
* The fields to change; omitted fields keep their current values.
|
|
15220
|
+
*/
|
|
15221
|
+
export type OntologyUpdateNodeInput = {
|
|
15222
|
+
/**
|
|
15223
|
+
* New display name, at most 200 characters; omit to keep the current name.
|
|
15224
|
+
*/
|
|
15225
|
+
name?: string;
|
|
15226
|
+
/**
|
|
15227
|
+
* Replacement alias list; an empty array clears the aliases and omitting the field keeps them.
|
|
15228
|
+
*/
|
|
15229
|
+
aliases?: Array<string>;
|
|
15230
|
+
/**
|
|
15231
|
+
* Replacement profile, at most 500 characters; an explicit null clears it and omitting the field keeps it.
|
|
15232
|
+
*/
|
|
15233
|
+
description?: string;
|
|
15234
|
+
};
|
|
15235
|
+
/**
|
|
15236
|
+
* The survivor the merged node folds into.
|
|
15237
|
+
*/
|
|
15238
|
+
export type OntologyMergeNodeInput = {
|
|
15239
|
+
/**
|
|
15240
|
+
* Node id that should survive, from nodes.list or search; the merged node's relations and aliases move to it.
|
|
15241
|
+
*/
|
|
15242
|
+
into: string;
|
|
15243
|
+
};
|
|
15244
|
+
/**
|
|
15245
|
+
* One page of relations.
|
|
15246
|
+
*/
|
|
15247
|
+
export type OntologyRelationPage = {
|
|
15248
|
+
/**
|
|
15249
|
+
* The relations on this page, ordered by relation id.
|
|
15250
|
+
*/
|
|
15251
|
+
data: Array<OntologyRelation>;
|
|
15252
|
+
/**
|
|
15253
|
+
* Opaque cursor for the next page, or null when this is the last page; copy it into the next request's cursor unchanged.
|
|
15254
|
+
*/
|
|
15255
|
+
next_cursor: string;
|
|
15256
|
+
};
|
|
15257
|
+
/**
|
|
15258
|
+
* The fact to record between two existing nodes of this organization.
|
|
15259
|
+
*/
|
|
15260
|
+
export type OntologyCreateRelationInput = {
|
|
15261
|
+
/**
|
|
15262
|
+
* Registered relation type name from types.list; it must admit both endpoints or the write is refused.
|
|
15263
|
+
*/
|
|
15264
|
+
type: string;
|
|
15265
|
+
/**
|
|
15266
|
+
* Node id the fact starts from, from nodes.list or nodes.create.
|
|
15267
|
+
*/
|
|
15268
|
+
source: string;
|
|
15269
|
+
/**
|
|
15270
|
+
* Node id the fact points at, from nodes.list or nodes.create.
|
|
15271
|
+
*/
|
|
15272
|
+
target: string;
|
|
15273
|
+
/**
|
|
15274
|
+
* The relationship in one sentence, at most 280 characters, written to read back on its own.
|
|
15275
|
+
*/
|
|
15276
|
+
fact: string;
|
|
15277
|
+
/**
|
|
15278
|
+
* World time the fact became true, when the mirrored record dates it; omit to leave it undated.
|
|
15279
|
+
*/
|
|
15280
|
+
valid_at?: string;
|
|
15281
|
+
/**
|
|
15282
|
+
* Member id whose content this fact is, restricting it to that member; omit or null for organization-wide.
|
|
15283
|
+
*/
|
|
15284
|
+
owner?: string;
|
|
15285
|
+
};
|
|
15286
|
+
/**
|
|
15287
|
+
* One fact between two nodes, with two clocks — when it was true in the world and when it was recorded.
|
|
15288
|
+
*/
|
|
15289
|
+
export type OntologyRelation = {
|
|
15290
|
+
/**
|
|
15291
|
+
* Relation id, used by invalidation and later reads; treat it as opaque and do not parse it.
|
|
15292
|
+
*/
|
|
15293
|
+
id: string;
|
|
15294
|
+
/**
|
|
15295
|
+
* Registered relation type this fact was recorded as; it must admit both endpoints.
|
|
15296
|
+
*/
|
|
15297
|
+
type: string;
|
|
15298
|
+
/**
|
|
15299
|
+
* Node id the fact starts from.
|
|
15300
|
+
*/
|
|
15301
|
+
source: string;
|
|
15302
|
+
/**
|
|
15303
|
+
* Node id the fact points at.
|
|
15304
|
+
*/
|
|
15305
|
+
target: string;
|
|
15306
|
+
/**
|
|
15307
|
+
* The relationship in one sentence, at most 280 characters, as it should be read back.
|
|
15308
|
+
*/
|
|
15309
|
+
fact: string;
|
|
15310
|
+
/**
|
|
15311
|
+
* Where this fact was learned, oldest first; each entry names the scope it came from and an optional time range.
|
|
15312
|
+
*/
|
|
15313
|
+
episodes?: Array<{
|
|
15314
|
+
/**
|
|
15315
|
+
* Scope the experience belonged to, normally a session id.
|
|
15316
|
+
*/
|
|
15317
|
+
scope?: string;
|
|
15318
|
+
/**
|
|
15319
|
+
* Start of the period the experience covered, when known; omit for a single moment.
|
|
15320
|
+
*/
|
|
15321
|
+
from?: string;
|
|
15322
|
+
/**
|
|
15323
|
+
* End of the period the experience covered, when known; omit for a single moment.
|
|
15324
|
+
*/
|
|
15325
|
+
to?: string;
|
|
15326
|
+
}>;
|
|
15327
|
+
/**
|
|
15328
|
+
* Where the fact came from; the relation type must list this origin among the ones it accepts.
|
|
15329
|
+
*/
|
|
15330
|
+
origin: 'platform' | 'stated' | 'observed' | 'inferred';
|
|
15331
|
+
/**
|
|
15332
|
+
* How strongly the fact is held, from 0 to 1; 1 is fully held and lower values fade faster.
|
|
15333
|
+
*/
|
|
15334
|
+
confidence: number;
|
|
15335
|
+
/**
|
|
15336
|
+
* Member id whose content this fact is; null means it is readable organization-wide. Another member's relation reads as not found.
|
|
15337
|
+
*/
|
|
15338
|
+
owner?: string;
|
|
15339
|
+
/**
|
|
15340
|
+
* World time the fact became true; null when it was never dated, in which case treat it as true since it was recorded.
|
|
15341
|
+
*/
|
|
15342
|
+
valid_at?: string;
|
|
15343
|
+
/**
|
|
15344
|
+
* World time the fact stopped being true; null while it still holds. The relation is kept and reads at an earlier as_of.
|
|
15345
|
+
*/
|
|
15346
|
+
invalid_at?: string;
|
|
15347
|
+
/**
|
|
15348
|
+
* System time the fact was recorded, in ISO 8601 UTC.
|
|
15349
|
+
*/
|
|
15350
|
+
created_at: string;
|
|
15351
|
+
/**
|
|
15352
|
+
* System time the fact was judged no longer true, which trails invalid_at; null while it still holds.
|
|
15353
|
+
*/
|
|
15354
|
+
expired_at?: string;
|
|
15355
|
+
/**
|
|
15356
|
+
* Relation id that replaced this one, when the invalidation named a successor; null when nothing replaced it.
|
|
15357
|
+
*/
|
|
15358
|
+
superseded_by?: string;
|
|
15359
|
+
/**
|
|
15360
|
+
* System time the fact was archived out of spreading; null while it still spreads, and reads by time still reach it either way.
|
|
15361
|
+
*/
|
|
15362
|
+
archived_at?: string;
|
|
15363
|
+
};
|
|
15364
|
+
/**
|
|
15365
|
+
* When the fact stopped being true, and optionally what replaced it.
|
|
15366
|
+
*/
|
|
15367
|
+
export type OntologyInvalidateRelationInput = {
|
|
15368
|
+
/**
|
|
15369
|
+
* World time the fact stopped being true, in ISO 8601 UTC; reads at an earlier as_of still return the relation.
|
|
15370
|
+
*/
|
|
15371
|
+
invalid_at: string;
|
|
15372
|
+
/**
|
|
15373
|
+
* Relation id that replaces this one, when a successor was recorded; omit or null when nothing replaced it.
|
|
15374
|
+
*/
|
|
15375
|
+
superseded_by?: string;
|
|
15376
|
+
/**
|
|
15377
|
+
* Why it stopped being true, for people reading the history later; not enforced and safe to omit.
|
|
15378
|
+
*/
|
|
15379
|
+
reason?: string;
|
|
15380
|
+
};
|
|
15381
|
+
/**
|
|
15382
|
+
* A batch of graph operations applied as one transaction; every operation succeeds or none is applied.
|
|
15383
|
+
*/
|
|
15384
|
+
export type OntologyChangesetInput = {
|
|
15385
|
+
/**
|
|
15386
|
+
* World time the batch describes, in ISO 8601 UTC; operations without their own time are dated by it.
|
|
15387
|
+
*/
|
|
15388
|
+
at: string;
|
|
15389
|
+
/**
|
|
15390
|
+
* Scope the batch came from, normally the session id it was observed in; it is stored with the operations for later reading.
|
|
15391
|
+
*/
|
|
15392
|
+
scope?: string;
|
|
15393
|
+
/**
|
|
15394
|
+
* At most 500 operations, applied in order; each names its kind in op and the fields that kind requires.
|
|
15395
|
+
*/
|
|
15396
|
+
ops: Array<OntologyChangesetOp>;
|
|
15397
|
+
};
|
|
15398
|
+
/**
|
|
15399
|
+
* What the batch did, including the ids it assigned and anything it refused.
|
|
15400
|
+
*/
|
|
15401
|
+
export type OntologyChangesetResult = {
|
|
15402
|
+
/**
|
|
15403
|
+
* Number of operations that changed the graph; zero when the key had been seen before.
|
|
15404
|
+
*/
|
|
15405
|
+
applied: number;
|
|
15406
|
+
/**
|
|
15407
|
+
* Map from each key used in the batch to the node or relation id it produced or matched.
|
|
15408
|
+
*/
|
|
15409
|
+
ids: {
|
|
15410
|
+
[key: string]: string;
|
|
15411
|
+
};
|
|
15412
|
+
/**
|
|
15413
|
+
* Relations that already held the same meaning and were refreshed instead of duplicated.
|
|
15414
|
+
*/
|
|
15415
|
+
refreshed: Array<string>;
|
|
15416
|
+
/**
|
|
15417
|
+
* Operations refused within the batch, each with its index and reason; empty when the batch applied whole.
|
|
15418
|
+
*/
|
|
15419
|
+
rejected: Array<{
|
|
15420
|
+
/**
|
|
15421
|
+
* Zero-based position of the operation in the submitted ops array.
|
|
15422
|
+
*/
|
|
15423
|
+
index?: number;
|
|
15424
|
+
/**
|
|
15425
|
+
* Failure category for this operation, such as ONTOLOGY_TYPE_UNKNOWN for an unregistered type.
|
|
15426
|
+
*/
|
|
15427
|
+
code?: string;
|
|
15428
|
+
/**
|
|
15429
|
+
* Why this operation was refused, naming the offending field.
|
|
15430
|
+
*/
|
|
15431
|
+
message?: string;
|
|
15432
|
+
}>;
|
|
15433
|
+
/**
|
|
15434
|
+
* True when the Idempotency-Key had been seen before, so nothing changed and the first result is returned.
|
|
15435
|
+
*/
|
|
15436
|
+
replayed: boolean;
|
|
15437
|
+
};
|
|
15438
|
+
/**
|
|
15439
|
+
* The text to resolve, optionally narrowed to types and a result count.
|
|
15440
|
+
*/
|
|
15441
|
+
export type OntologySearchInput = {
|
|
15442
|
+
/**
|
|
15443
|
+
* Text to find nodes for, matched against names, aliases, descriptions and relation facts; an empty string is refused.
|
|
15444
|
+
*/
|
|
15445
|
+
text: string;
|
|
15446
|
+
/**
|
|
15447
|
+
* Registered node type names to search within; omit to search every type.
|
|
15448
|
+
*/
|
|
15449
|
+
types?: Array<string>;
|
|
15450
|
+
/**
|
|
15451
|
+
* Restrict matches to facts recorded within a period; omit to search all time.
|
|
15452
|
+
*/
|
|
15453
|
+
window?: {
|
|
15454
|
+
/**
|
|
15455
|
+
* Start of the period, inclusive, in ISO 8601 UTC; omit to leave the start open.
|
|
15456
|
+
*/
|
|
15457
|
+
from?: string;
|
|
15458
|
+
/**
|
|
15459
|
+
* End of the period, exclusive, in ISO 8601 UTC; omit to leave the end open.
|
|
15460
|
+
*/
|
|
15461
|
+
to?: string;
|
|
15462
|
+
};
|
|
15463
|
+
/**
|
|
15464
|
+
* Maximum candidate nodes to return, from 1 to 50; defaults to 20 when omitted.
|
|
15465
|
+
*/
|
|
15466
|
+
limit?: number;
|
|
15467
|
+
};
|
|
15468
|
+
/**
|
|
15469
|
+
* Ranked candidate nodes for the searched text, best match first.
|
|
15470
|
+
*/
|
|
15471
|
+
export type OntologySearchResult = {
|
|
15472
|
+
/**
|
|
15473
|
+
* The candidate nodes, strongest match first; an empty array means nothing matched.
|
|
15474
|
+
*/
|
|
15475
|
+
hits: Array<{
|
|
15476
|
+
/**
|
|
15477
|
+
* Node id of the candidate; pass it to nodes.retrieve to confirm before writing with it.
|
|
15478
|
+
*/
|
|
15479
|
+
node?: string;
|
|
15480
|
+
/**
|
|
15481
|
+
* Match strength from 0 to 1; compare candidates within one response rather than across queries.
|
|
15482
|
+
*/
|
|
15483
|
+
score?: number;
|
|
15484
|
+
/**
|
|
15485
|
+
* Which field matched, so a weak fact match can be checked against the node itself.
|
|
15486
|
+
*/
|
|
15487
|
+
matched?: 'name' | 'alias' | 'description' | 'fact';
|
|
15488
|
+
}>;
|
|
15489
|
+
};
|
|
14739
15490
|
/**
|
|
14740
15491
|
* Sandbox creation request. All system communication with the sandbox is always secured; the template's envd version must support secured access.
|
|
14741
15492
|
*/
|
|
@@ -15178,6 +15929,10 @@ export type SandboxTemplateBuildInfo = {
|
|
|
15178
15929
|
reason?: SandboxBuildStatusReason;
|
|
15179
15930
|
};
|
|
15180
15931
|
export type SandboxTemplateWithBuilds = {
|
|
15932
|
+
/**
|
|
15933
|
+
* Lifecycle classes this template can run as. ephemeral: cannot pause, snapshot or mount volumes and is deleted when it stops; persistent: can pause, resume and snapshot.
|
|
15934
|
+
*/
|
|
15935
|
+
lifecycles?: Array<'ephemeral' | 'persistent'>;
|
|
15181
15936
|
/**
|
|
15182
15937
|
* Identifier of the template
|
|
15183
15938
|
*/
|
|
@@ -25182,6 +25937,20 @@ export type CutTrackSummary = {
|
|
|
25182
25937
|
*/
|
|
25183
25938
|
items: number;
|
|
25184
25939
|
};
|
|
25940
|
+
export type CutFrameWarning = {
|
|
25941
|
+
/**
|
|
25942
|
+
* FRAME_UNAVAILABLE means a source image could not be fetched for this preview.
|
|
25943
|
+
*/
|
|
25944
|
+
code: 'FRAME_UNAVAILABLE';
|
|
25945
|
+
/**
|
|
25946
|
+
* Identifier of the clip whose source frame could not be fetched.
|
|
25947
|
+
*/
|
|
25948
|
+
clip_id?: string;
|
|
25949
|
+
/**
|
|
25950
|
+
* Actionable safe explanation; source URLs and credentials are omitted.
|
|
25951
|
+
*/
|
|
25952
|
+
message: string;
|
|
25953
|
+
};
|
|
25185
25954
|
/**
|
|
25186
25955
|
* Reference to an asset in a bound library; follows asset overwrites to the latest version rather than pinning a version.
|
|
25187
25956
|
*/
|
|
@@ -25216,9 +25985,9 @@ export type CutExportOutput = {
|
|
|
25216
25985
|
*/
|
|
25217
25986
|
fps?: number;
|
|
25218
25987
|
/**
|
|
25219
|
-
* draft
|
|
25988
|
+
* Compression of the encoded video, like Shotstack quality. medium is the default and balances render, upload and storage at about 70% of the bitrate of high. draft is about 40% of high, for review renders. high is for delivery that will be transcoded again or needs the most detail.
|
|
25220
25989
|
*/
|
|
25221
|
-
quality?: 'draft' | 'high';
|
|
25990
|
+
quality?: 'draft' | 'medium' | 'high';
|
|
25222
25991
|
};
|
|
25223
25992
|
export type DatabaseField = {
|
|
25224
25993
|
/**
|
|
@@ -25404,7 +26173,7 @@ export type KnowledgeKnowledgeModels = {
|
|
|
25404
26173
|
*/
|
|
25405
26174
|
query_rewrite: string;
|
|
25406
26175
|
/**
|
|
25407
|
-
* Extracts text from scanned PDF pages. Default:
|
|
26176
|
+
* Extracts text from scanned PDF pages through the OCR API. Default: qwen-vl-ocr-2025-11-20, falling back to glm-ocr and qwen3.8-flash. A custom model precedes these defaults. OCR is billed by pages processed.
|
|
25408
26177
|
*/
|
|
25409
26178
|
ocr: string;
|
|
25410
26179
|
/**
|
|
@@ -25433,7 +26202,7 @@ export type KnowledgeKnowledgeModelsInput = {
|
|
|
25433
26202
|
*/
|
|
25434
26203
|
query_rewrite?: string | null;
|
|
25435
26204
|
/**
|
|
25436
|
-
* Scanned PDF text extraction model; requires mistral.ocr or pdf_input capability. null restores
|
|
26205
|
+
* Scanned PDF text extraction model; requires mistral.ocr or pdf_input capability. null restores qwen-vl-ocr-2025-11-20. The preference leads the OCR API fallback chain qwen-vl-ocr-2025-11-20, glm-ocr, qwen3.8-flash with duplicates removed.
|
|
25437
26206
|
*/
|
|
25438
26207
|
ocr?: string | null;
|
|
25439
26208
|
/**
|
|
@@ -25874,7 +26643,7 @@ export type MediaChunkComplete = MediaCloudinaryResource & {
|
|
|
25874
26643
|
done: true;
|
|
25875
26644
|
};
|
|
25876
26645
|
/**
|
|
25877
|
-
* Per-task processing progress and its aggregate state for the asset. 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.
|
|
26646
|
+
* Per-task processing progress and its aggregate state for the asset. 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.
|
|
25878
26647
|
*/
|
|
25879
26648
|
export type MediaProcessing = {
|
|
25880
26649
|
/**
|
|
@@ -25947,7 +26716,7 @@ export type MediaUnderstanding = {
|
|
|
25947
26716
|
*/
|
|
25948
26717
|
asset_version: number;
|
|
25949
26718
|
/**
|
|
25950
|
-
* Result kind: caption is a visual description, tags are recognized labels, ocr is text recognized in the image, transcript is speech text, and frame is a description of a video segment. audio describes sampled speech, music, ambient sound and silence; overview is a full-video summary with chapters, IAB categories and an unverified location; embedding reports a failed embedding step.
|
|
26719
|
+
* Result kind: caption is a visual description, tags are recognized labels, ocr is text recognized in the image, transcript is speech text, and frame is a description of a video segment. audio describes sampled speech, music, ambient sound and silence; overview is a full-video summary with chapters, IAB categories and an unverified location; embedding reports a failed embedding step. loudness is the measured BS.1770-4 loudness of the audio (integrated loudness, loudness range, true and sample peak, a one-point-per-second series and the clipped sections); beats is the measured tempo, beat and bar grid with the sections of the music, recorded as not_applicable with a reason when the asset has no music; content is derived from those measurements and from the transcript into speech, music and silence percentages and sections. Their time values are seconds and their data is not model output.
|
|
25951
26720
|
*/
|
|
25952
26721
|
kind: MediaUnderstandingKind;
|
|
25953
26722
|
/**
|
|
@@ -26174,6 +26943,10 @@ export type MediaSearchAsset = {
|
|
|
26174
26943
|
* Resource status; active identifies an asset that has not been deleted.
|
|
26175
26944
|
*/
|
|
26176
26945
|
status: 'active';
|
|
26946
|
+
/**
|
|
26947
|
+
* True when the source header declares an alpha channel: a PNG color type 4 or 6 or a tRNS chunk, a WebP VP8X alpha flag or VP8L alpha bit, a WebM or MKV video track AlphaMode of 1, or a GIF transparent-color flag. False when a known container has no alpha channel. Omitted when the format is unknown, the header could not be parsed, or the asset was stored before this field existed; absence does not mean the source is opaque.
|
|
26948
|
+
*/
|
|
26949
|
+
has_alpha?: boolean;
|
|
26177
26950
|
/**
|
|
26178
26951
|
* Search-vector status: pending awaits vector generation or reprocessing; ready has searchable vectors; unavailable indicates disabled, unsupported or failed embedding. Existing vectors may still serve searches while reprocessing is pending.
|
|
26179
26952
|
*/
|
|
@@ -26230,6 +27003,27 @@ export type MediaSearchAsset = {
|
|
|
26230
27003
|
};
|
|
26231
27004
|
};
|
|
26232
27005
|
};
|
|
27006
|
+
/**
|
|
27007
|
+
* Source details for the video-generation job that created this asset.
|
|
27008
|
+
*/
|
|
27009
|
+
generation?: {
|
|
27010
|
+
/**
|
|
27011
|
+
* Job id that generated this asset.
|
|
27012
|
+
*/
|
|
27013
|
+
job_id: MediaJobId;
|
|
27014
|
+
/**
|
|
27015
|
+
* Generation intent used to create the asset; v1 supports video.generate.
|
|
27016
|
+
*/
|
|
27017
|
+
intent: string;
|
|
27018
|
+
/**
|
|
27019
|
+
* Text prompt submitted for the generation job.
|
|
27020
|
+
*/
|
|
27021
|
+
prompt: string;
|
|
27022
|
+
/**
|
|
27023
|
+
* Router video-generation model that produced the asset.
|
|
27024
|
+
*/
|
|
27025
|
+
model: string;
|
|
27026
|
+
};
|
|
26233
27027
|
};
|
|
26234
27028
|
/**
|
|
26235
27029
|
* A matching asset with its ranking score and supporting matches.
|
|
@@ -26252,11 +27046,11 @@ export type MediaSemanticHit = {
|
|
|
26252
27046
|
*/
|
|
26253
27047
|
matches: Array<MediaSemanticMatch>;
|
|
26254
27048
|
};
|
|
27049
|
+
export type MediaMediaErrorCode = 'LIBRARY_NOT_FOUND' | 'ASSET_NOT_FOUND' | 'JOB_NOT_FOUND' | 'UNDERSTANDING_NOT_FOUND' | 'ASSET_VERSION_CHANGED' | 'LIBRARY_INVALID_STATE' | 'INVALID_PARAMS' | 'INVALID_EXPRESSION' | 'UNSUPPORTED' | 'NOT_IMPLEMENTED' | 'FILE_TOO_LARGE' | 'FILE_EMPTY' | 'UNSUPPORTED_MEDIA' | 'FETCH_FAILED' | 'LIMIT_EXCEEDED' | 'CHUNK_INVALID' | 'RATE_LIMITED' | 'CAPACITY' | 'UPSTREAM_FAILED' | 'CONTENT_REJECTED' | 'GENERATION_FAILED' | 'CANDIDATE_EXPIRED' | 'BINDING_READ_ONLY';
|
|
26255
27050
|
/**
|
|
26256
|
-
*
|
|
27051
|
+
* State of a requested video output.
|
|
26257
27052
|
*/
|
|
26258
|
-
export type
|
|
26259
|
-
export type MediaMediaErrorCode = 'LIBRARY_NOT_FOUND' | 'ASSET_NOT_FOUND' | 'JOB_NOT_FOUND' | 'UNDERSTANDING_NOT_FOUND' | 'ASSET_VERSION_CHANGED' | 'LIBRARY_INVALID_STATE' | 'INVALID_PARAMS' | 'INVALID_EXPRESSION' | 'UNSUPPORTED' | 'NOT_IMPLEMENTED' | 'FILE_TOO_LARGE' | 'FILE_EMPTY' | 'UNSUPPORTED_MEDIA' | 'FETCH_FAILED' | 'LIMIT_EXCEEDED' | 'CHUNK_INVALID' | 'RATE_LIMITED' | 'CAPACITY' | 'UPSTREAM_FAILED' | 'BINDING_READ_ONLY';
|
|
27053
|
+
export type MediaGenerationOutputStatus = 'pending' | 'succeeded' | 'failed';
|
|
26260
27054
|
/**
|
|
26261
27055
|
* A recorded library event with a monotonically increasing sequence within that library.
|
|
26262
27056
|
*/
|
|
@@ -26330,6 +27124,170 @@ export type MediaFailureGroup = {
|
|
|
26330
27124
|
*/
|
|
26331
27125
|
sample_asset_ids: Array<MediaAssetId>;
|
|
26332
27126
|
};
|
|
27127
|
+
/**
|
|
27128
|
+
* A kind of entity the graph accepts, for example a file or a customer.
|
|
27129
|
+
*/
|
|
27130
|
+
export type OntologyNodeType = {
|
|
27131
|
+
/**
|
|
27132
|
+
* Globally unique type name, used as a node's type when creating it; a dotted name marks a namespaced subtype.
|
|
27133
|
+
*/
|
|
27134
|
+
name: string;
|
|
27135
|
+
/**
|
|
27136
|
+
* Required prefix of the external record id when a node of this type carries a ref, for example file_ for the file type; omit for types that are pure concepts.
|
|
27137
|
+
*/
|
|
27138
|
+
ref_prefix?: string;
|
|
27139
|
+
/**
|
|
27140
|
+
* Type significance from 0 to 1, used when ranking how strongly reaching this kind of node matters.
|
|
27141
|
+
*/
|
|
27142
|
+
weight: number;
|
|
27143
|
+
/**
|
|
27144
|
+
* Whether the graph may continue through a node of this type; false makes it a stopping point that is reached but never expanded.
|
|
27145
|
+
*/
|
|
27146
|
+
passable: boolean;
|
|
27147
|
+
/**
|
|
27148
|
+
* What this type means in the registering service, used to choose the right type when writing.
|
|
27149
|
+
*/
|
|
27150
|
+
description: string;
|
|
27151
|
+
};
|
|
27152
|
+
/**
|
|
27153
|
+
* A kind of fact the graph accepts between two nodes.
|
|
27154
|
+
*/
|
|
27155
|
+
export type OntologyEdgeType = {
|
|
27156
|
+
/**
|
|
27157
|
+
* Globally unique relation type name, used as a relation's type when creating it.
|
|
27158
|
+
*/
|
|
27159
|
+
name: string;
|
|
27160
|
+
/**
|
|
27161
|
+
* Node type names this relation may start from; the single entry * admits every type.
|
|
27162
|
+
*/
|
|
27163
|
+
source: Array<string>;
|
|
27164
|
+
/**
|
|
27165
|
+
* Node type names this relation may point at; the single entry * admits every type.
|
|
27166
|
+
*/
|
|
27167
|
+
target: Array<string>;
|
|
27168
|
+
/**
|
|
27169
|
+
* Whether the fact reads one way or the same in both directions, which decides how it renders on each endpoint.
|
|
27170
|
+
*/
|
|
27171
|
+
direction: 'forward' | 'both';
|
|
27172
|
+
/**
|
|
27173
|
+
* Whether spreading may continue through this relation; false makes it a stopping point that is reached but never traversed.
|
|
27174
|
+
*/
|
|
27175
|
+
passable: boolean;
|
|
27176
|
+
/**
|
|
27177
|
+
* Relation significance from 0 to 1, used when ranking how strongly reaching through this relation matters.
|
|
27178
|
+
*/
|
|
27179
|
+
weight: number;
|
|
27180
|
+
/**
|
|
27181
|
+
* Whether a source may have at most one valid relation of this type at a time; true makes a new one supersede the old.
|
|
27182
|
+
*/
|
|
27183
|
+
functional: boolean;
|
|
27184
|
+
/**
|
|
27185
|
+
* How long the relation stays strong while valid, from 0 to 1; 1 never fades and lower values decay faster. Omit for the default decay.
|
|
27186
|
+
*/
|
|
27187
|
+
persistence?: number;
|
|
27188
|
+
/**
|
|
27189
|
+
* Origins a relation of this type may carry; each value names where the fact came from and they are checked when writing.
|
|
27190
|
+
*/
|
|
27191
|
+
origins: Array<'platform' | 'stated' | 'observed' | 'inferred'>;
|
|
27192
|
+
/**
|
|
27193
|
+
* What this fact means in the registering service, used to choose the right type when writing.
|
|
27194
|
+
*/
|
|
27195
|
+
description: string;
|
|
27196
|
+
};
|
|
27197
|
+
/**
|
|
27198
|
+
* A node the caller may reach but not read, because its content belongs to another member; its name confirms what was reached while the content stays withheld.
|
|
27199
|
+
*/
|
|
27200
|
+
export type OntologyRestrictedNode = {
|
|
27201
|
+
/**
|
|
27202
|
+
* Node id, usable to relate this entity to others; treat it as opaque.
|
|
27203
|
+
*/
|
|
27204
|
+
id: string;
|
|
27205
|
+
/**
|
|
27206
|
+
* Registered node type of the hidden entity, which is not itself restricted content.
|
|
27207
|
+
*/
|
|
27208
|
+
type: string;
|
|
27209
|
+
/**
|
|
27210
|
+
* Display name of the hidden entity, shown so a caller can tell whether the reached node is the one it meant.
|
|
27211
|
+
*/
|
|
27212
|
+
name: string;
|
|
27213
|
+
/**
|
|
27214
|
+
* Always true; its presence is how a caller tells a withheld node from a readable one.
|
|
27215
|
+
*/
|
|
27216
|
+
restricted: boolean;
|
|
27217
|
+
};
|
|
27218
|
+
/**
|
|
27219
|
+
* One operation of a changeset, discriminated by op; it names new nodes and relations by caller-local keys reused within the same batch.
|
|
27220
|
+
*/
|
|
27221
|
+
export type OntologyChangesetOp = {
|
|
27222
|
+
/**
|
|
27223
|
+
* Which operation to apply; the remaining required fields follow from this value.
|
|
27224
|
+
*/
|
|
27225
|
+
op: 'upsert_node' | 'relate' | 'invalidate' | 'merge' | 'alias';
|
|
27226
|
+
/**
|
|
27227
|
+
* Caller-local name for the node or relation this operation creates, reused by later operations in the same batch; it is not an id.
|
|
27228
|
+
*/
|
|
27229
|
+
key?: string;
|
|
27230
|
+
/**
|
|
27231
|
+
* Registered type name for upsert_node and relate; an unregistered name refuses the whole batch.
|
|
27232
|
+
*/
|
|
27233
|
+
type?: string;
|
|
27234
|
+
/**
|
|
27235
|
+
* Mirrored record id for upsert_node, which must start with the type's ref_prefix; omit for a concept.
|
|
27236
|
+
*/
|
|
27237
|
+
ref?: string;
|
|
27238
|
+
/**
|
|
27239
|
+
* Display name for upsert_node, at most 200 characters.
|
|
27240
|
+
*/
|
|
27241
|
+
name?: string;
|
|
27242
|
+
/**
|
|
27243
|
+
* Start of a relate fact; a key from this batch or an existing node id.
|
|
27244
|
+
*/
|
|
27245
|
+
source?: string;
|
|
27246
|
+
/**
|
|
27247
|
+
* End of a relate fact; a key from this batch or an existing node id.
|
|
27248
|
+
*/
|
|
27249
|
+
target?: string;
|
|
27250
|
+
/**
|
|
27251
|
+
* The relationship in one sentence for relate, at most 280 characters.
|
|
27252
|
+
*/
|
|
27253
|
+
fact?: string;
|
|
27254
|
+
/**
|
|
27255
|
+
* Where a relate fact came from; the relation type must accept this origin.
|
|
27256
|
+
*/
|
|
27257
|
+
origin?: 'platform' | 'stated' | 'observed' | 'inferred';
|
|
27258
|
+
/**
|
|
27259
|
+
* Relation id an invalidate operation acts on, from relations.list or an earlier operation in this batch.
|
|
27260
|
+
*/
|
|
27261
|
+
edge?: string;
|
|
27262
|
+
/**
|
|
27263
|
+
* World time an invalidate operation marks the fact as no longer true.
|
|
27264
|
+
*/
|
|
27265
|
+
invalid_at?: string;
|
|
27266
|
+
/**
|
|
27267
|
+
* Relation id that replaces the invalidated one, when a successor was recorded; omit when nothing replaced it.
|
|
27268
|
+
*/
|
|
27269
|
+
by?: string;
|
|
27270
|
+
/**
|
|
27271
|
+
* Why the operation was applied, kept for people reading the history; not enforced.
|
|
27272
|
+
*/
|
|
27273
|
+
reason?: string;
|
|
27274
|
+
/**
|
|
27275
|
+
* Node id a merge operation folds away, resolving to the into node afterwards.
|
|
27276
|
+
*/
|
|
27277
|
+
from?: string;
|
|
27278
|
+
/**
|
|
27279
|
+
* Node id a merge operation keeps, receiving the merged node's relations and aliases.
|
|
27280
|
+
*/
|
|
27281
|
+
into?: string;
|
|
27282
|
+
/**
|
|
27283
|
+
* Node id an alias operation adds a name to.
|
|
27284
|
+
*/
|
|
27285
|
+
node?: string;
|
|
27286
|
+
/**
|
|
27287
|
+
* The additional name an alias operation records for its node.
|
|
27288
|
+
*/
|
|
27289
|
+
alias?: string;
|
|
27290
|
+
};
|
|
26333
27291
|
/**
|
|
26334
27292
|
* Auto-resume configuration for paused sandboxes.
|
|
26335
27293
|
*/
|
|
@@ -30845,9 +31803,9 @@ export type MediaTranscriptCorrection = {
|
|
|
30845
31803
|
*/
|
|
30846
31804
|
export type MediaUnderstandingId = string;
|
|
30847
31805
|
/**
|
|
30848
|
-
* Result kind: caption is a visual description, tags are recognized labels, ocr is text recognized in the image, transcript is speech text, and frame is a description of a video segment. audio describes sampled speech, music, ambient sound and silence; overview is a full-video summary with chapters, IAB categories and an unverified location; embedding reports a failed embedding step.
|
|
31806
|
+
* Result kind: caption is a visual description, tags are recognized labels, ocr is text recognized in the image, transcript is speech text, and frame is a description of a video segment. audio describes sampled speech, music, ambient sound and silence; overview is a full-video summary with chapters, IAB categories and an unverified location; embedding reports a failed embedding step. loudness is the measured BS.1770-4 loudness of the audio (integrated loudness, loudness range, true and sample peak, a one-point-per-second series and the clipped sections); beats is the measured tempo, beat and bar grid with the sections of the music, recorded as not_applicable with a reason when the asset has no music; content is derived from those measurements and from the transcript into speech, music and silence percentages and sections. Their time values are seconds and their data is not model output.
|
|
30849
31807
|
*/
|
|
30850
|
-
export type MediaUnderstandingKind = 'caption' | 'tags' | 'ocr' | 'transcript' | 'frame' | 'overview' | 'audio' | 'embedding';
|
|
31808
|
+
export type MediaUnderstandingKind = 'caption' | 'tags' | 'ocr' | 'transcript' | 'frame' | 'overview' | 'audio' | 'loudness' | 'beats' | 'content' | 'embedding';
|
|
30851
31809
|
/**
|
|
30852
31810
|
* Time range within the source media, expressed in milliseconds.
|
|
30853
31811
|
*/
|
|
@@ -30907,7 +31865,7 @@ export type MediaSemanticMatch = {
|
|
|
30907
31865
|
/**
|
|
30908
31866
|
* Type of change recorded for a library, asset, processing task, search index or batch.
|
|
30909
31867
|
*/
|
|
30910
|
-
export type MediaMediaEventType = 'library.status_provisioning' | 'library.status_active' | 'library.status_deleting' | 'library.status_deleted' | 'library.status_failed' | 'library.restored' | 'library.updated' | 'asset.created' | 'asset.updated' | 'asset.overwritten' | 'asset.renamed' | 'asset.deleted' | 'understanding.status_ready' | 'understanding.status_failed' | 'understanding.status_unsupported' | 'search.indexed' | 'batch.succeeded' | 'batch.failed' | 'library.understanding_drained' | 'batch.created';
|
|
31868
|
+
export type MediaMediaEventType = 'library.status_provisioning' | 'library.status_active' | 'library.status_deleting' | 'library.status_deleted' | 'library.status_failed' | 'library.restored' | 'library.updated' | 'asset.created' | 'asset.updated' | 'asset.overwritten' | 'asset.renamed' | 'asset.deleted' | 'understanding.status_ready' | 'understanding.status_failed' | 'understanding.status_unsupported' | 'search.indexed' | 'batch.succeeded' | 'batch.failed' | 'library.understanding_drained' | 'batch.created' | 'generation.created' | 'generation.succeeded' | 'generation.failed' | 'generation.cancelled';
|
|
30911
31869
|
/**
|
|
30912
31870
|
* Auto-resume enabled flag for paused sandboxes. Default false.
|
|
30913
31871
|
*/
|
|
@@ -31539,21 +32497,25 @@ export type AnthropicToolReferenceBlock = {
|
|
|
31539
32497
|
*/
|
|
31540
32498
|
export type CutTextStyle = {
|
|
31541
32499
|
/**
|
|
31542
|
-
*
|
|
32500
|
+
* Canonical font family name; call ListFonts() in the Cut script API to retrieve the available font families.
|
|
31543
32501
|
*/
|
|
31544
|
-
font_family?:
|
|
32502
|
+
font_family?: string;
|
|
31545
32503
|
/**
|
|
31546
32504
|
* Text size in output pixels.
|
|
31547
32505
|
*/
|
|
31548
32506
|
font_size?: number;
|
|
31549
32507
|
/**
|
|
31550
|
-
*
|
|
32508
|
+
* Positive requested font weight; each family has its own available catalog weights, and unsupported values resolve to the nearest available weight, preferring the heavier weight on a tie.
|
|
31551
32509
|
*/
|
|
31552
|
-
font_weight?:
|
|
32510
|
+
font_weight?: number;
|
|
31553
32511
|
/**
|
|
31554
32512
|
* Text color in #RRGGBB or #RRGGBBAA notation.
|
|
31555
32513
|
*/
|
|
31556
32514
|
color?: string;
|
|
32515
|
+
/**
|
|
32516
|
+
* Optional solid or gradient glyph fill; gradients span the text box.
|
|
32517
|
+
*/
|
|
32518
|
+
fill?: CutFill;
|
|
31557
32519
|
/**
|
|
31558
32520
|
* Optional text outline.
|
|
31559
32521
|
*/
|
|
@@ -31563,9 +32525,60 @@ export type CutTextStyle = {
|
|
|
31563
32525
|
*/
|
|
31564
32526
|
color?: string;
|
|
31565
32527
|
/**
|
|
31566
|
-
* Outline width in output pixels.
|
|
32528
|
+
* Outline width in output pixels; must be non-negative and at most 40 pixels.
|
|
32529
|
+
*/
|
|
32530
|
+
width?: number;
|
|
32531
|
+
};
|
|
32532
|
+
/**
|
|
32533
|
+
* Additional outlines, painted from outermost to innermost; at most 4 strokes.
|
|
32534
|
+
*/
|
|
32535
|
+
strokes?: Array<{
|
|
32536
|
+
/**
|
|
32537
|
+
* Outline color in #RRGGBB or #RRGGBBAA notation.
|
|
32538
|
+
*/
|
|
32539
|
+
color?: string;
|
|
32540
|
+
/**
|
|
32541
|
+
* Outline width in output pixels, from 0 to 40.
|
|
31567
32542
|
*/
|
|
31568
32543
|
width?: number;
|
|
32544
|
+
}>;
|
|
32545
|
+
/**
|
|
32546
|
+
* Offset text shadows; at most 4 shadows. Offsets are non-negative output pixels; blur is 0 to 100 output pixels.
|
|
32547
|
+
*/
|
|
32548
|
+
shadows?: Array<{
|
|
32549
|
+
/**
|
|
32550
|
+
* Shadow color in #RRGGBB or #RRGGBBAA notation.
|
|
32551
|
+
*/
|
|
32552
|
+
color?: string;
|
|
32553
|
+
/**
|
|
32554
|
+
* Non-negative horizontal offset in output pixels.
|
|
32555
|
+
*/
|
|
32556
|
+
x?: number;
|
|
32557
|
+
/**
|
|
32558
|
+
* Non-negative vertical offset in output pixels.
|
|
32559
|
+
*/
|
|
32560
|
+
y?: number;
|
|
32561
|
+
/**
|
|
32562
|
+
* Blur radius in output pixels, from 0 to 100.
|
|
32563
|
+
*/
|
|
32564
|
+
blur?: number;
|
|
32565
|
+
}>;
|
|
32566
|
+
/**
|
|
32567
|
+
* Colored glow around glyphs; radius is in output pixels, from 0 to 100, and strength is from 0 to 1.
|
|
32568
|
+
*/
|
|
32569
|
+
glow?: {
|
|
32570
|
+
/**
|
|
32571
|
+
* Glow color in #RRGGBB or #RRGGBBAA notation.
|
|
32572
|
+
*/
|
|
32573
|
+
color?: string;
|
|
32574
|
+
/**
|
|
32575
|
+
* Glow blur radius in output pixels, from 0 to 100.
|
|
32576
|
+
*/
|
|
32577
|
+
radius?: number;
|
|
32578
|
+
/**
|
|
32579
|
+
* Glow opacity multiplier from 0 to 1.
|
|
32580
|
+
*/
|
|
32581
|
+
strength?: number;
|
|
31569
32582
|
};
|
|
31570
32583
|
/**
|
|
31571
32584
|
* Optional text background color as hexadecimal RGB or RGBA.
|
|
@@ -31772,6 +32785,70 @@ export type CutJoinEffect = {
|
|
|
31772
32785
|
* Blur radius in pixels at a reference frame height of 1080 pixels.
|
|
31773
32786
|
*/
|
|
31774
32787
|
radius?: number;
|
|
32788
|
+
} | {
|
|
32789
|
+
/**
|
|
32790
|
+
* Zoom transition.
|
|
32791
|
+
*/
|
|
32792
|
+
kind: 'zoom';
|
|
32793
|
+
/**
|
|
32794
|
+
* Zoom in or out.
|
|
32795
|
+
*/
|
|
32796
|
+
direction?: 'in' | 'out';
|
|
32797
|
+
/**
|
|
32798
|
+
* Peak scale increase as a multiple of the original scale.
|
|
32799
|
+
*/
|
|
32800
|
+
amount?: number;
|
|
32801
|
+
/**
|
|
32802
|
+
* Radial blur strength; zero disables blur sampling.
|
|
32803
|
+
*/
|
|
32804
|
+
blur?: number;
|
|
32805
|
+
} | {
|
|
32806
|
+
/**
|
|
32807
|
+
* Clock transition.
|
|
32808
|
+
*/
|
|
32809
|
+
kind: 'clock';
|
|
32810
|
+
/**
|
|
32811
|
+
* Sweep direction.
|
|
32812
|
+
*/
|
|
32813
|
+
direction?: 'clockwise' | 'counterclockwise';
|
|
32814
|
+
/**
|
|
32815
|
+
* Start angle in degrees, with zero at twelve o'clock.
|
|
32816
|
+
*/
|
|
32817
|
+
start_angle?: number;
|
|
32818
|
+
/**
|
|
32819
|
+
* Angular feather width.
|
|
32820
|
+
*/
|
|
32821
|
+
softness?: number;
|
|
32822
|
+
} | {
|
|
32823
|
+
/**
|
|
32824
|
+
* Flash transition.
|
|
32825
|
+
*/
|
|
32826
|
+
kind: 'flash';
|
|
32827
|
+
/**
|
|
32828
|
+
* Flash color.
|
|
32829
|
+
*/
|
|
32830
|
+
color?: 'white' | 'black';
|
|
32831
|
+
/**
|
|
32832
|
+
* Flash strength.
|
|
32833
|
+
*/
|
|
32834
|
+
intensity?: number;
|
|
32835
|
+
} | {
|
|
32836
|
+
/**
|
|
32837
|
+
* Luma transition.
|
|
32838
|
+
*/
|
|
32839
|
+
kind: 'luma';
|
|
32840
|
+
/**
|
|
32841
|
+
* Built-in map. User maps are not available yet.
|
|
32842
|
+
*/
|
|
32843
|
+
map?: 'radial' | 'diagonal' | 'clouds' | 'spiral' | 'honeycomb' | 'bars';
|
|
32844
|
+
/**
|
|
32845
|
+
* Edge feather width.
|
|
32846
|
+
*/
|
|
32847
|
+
softness?: number;
|
|
32848
|
+
/**
|
|
32849
|
+
* Reveal order.
|
|
32850
|
+
*/
|
|
32851
|
+
invert?: 'normal' | 'inverted';
|
|
31775
32852
|
};
|
|
31776
32853
|
export type KnowledgeStaticChunking = {
|
|
31777
32854
|
/**
|
|
@@ -32013,6 +33090,51 @@ export type AnthropicCitationsConfig = {
|
|
|
32013
33090
|
*/
|
|
32014
33091
|
enabled: boolean;
|
|
32015
33092
|
};
|
|
33093
|
+
/**
|
|
33094
|
+
* Solid color or a gradient over the styled text box.
|
|
33095
|
+
*/
|
|
33096
|
+
export type CutFill = string | {
|
|
33097
|
+
/**
|
|
33098
|
+
* Linear gradient; angle is in degrees and stop positions range from 0 to 1.
|
|
33099
|
+
*/
|
|
33100
|
+
linear?: {
|
|
33101
|
+
/**
|
|
33102
|
+
* Gradient angle in degrees; 0 runs left to right.
|
|
33103
|
+
*/
|
|
33104
|
+
angle?: number;
|
|
33105
|
+
/**
|
|
33106
|
+
* Gradient color stops; each position is a fraction from 0 to 1.
|
|
33107
|
+
*/
|
|
33108
|
+
stops?: Array<{
|
|
33109
|
+
/**
|
|
33110
|
+
* Stop position as a fraction from 0 to 1.
|
|
33111
|
+
*/
|
|
33112
|
+
at?: number;
|
|
33113
|
+
/**
|
|
33114
|
+
* Stop color in #RRGGBB or #RRGGBBAA notation.
|
|
33115
|
+
*/
|
|
33116
|
+
color?: string;
|
|
33117
|
+
}>;
|
|
33118
|
+
};
|
|
33119
|
+
/**
|
|
33120
|
+
* Radial gradient with stop positions as fractions from 0 to 1.
|
|
33121
|
+
*/
|
|
33122
|
+
radial?: {
|
|
33123
|
+
/**
|
|
33124
|
+
* Gradient color stops; each position is a fraction from 0 to 1.
|
|
33125
|
+
*/
|
|
33126
|
+
stops?: Array<{
|
|
33127
|
+
/**
|
|
33128
|
+
* Stop position as a fraction from 0 to 1.
|
|
33129
|
+
*/
|
|
33130
|
+
at?: number;
|
|
33131
|
+
/**
|
|
33132
|
+
* Stop color in #RRGGBB or #RRGGBBAA notation.
|
|
33133
|
+
*/
|
|
33134
|
+
color?: string;
|
|
33135
|
+
}>;
|
|
33136
|
+
};
|
|
33137
|
+
};
|
|
32016
33138
|
/**
|
|
32017
33139
|
* Visual placement; coordinates are normalized canvas centers.
|
|
32018
33140
|
*/
|
|
@@ -32645,6 +33767,10 @@ export type MediaAssetWritable = {
|
|
|
32645
33767
|
* Resource status; active identifies an asset that has not been deleted.
|
|
32646
33768
|
*/
|
|
32647
33769
|
status: 'active';
|
|
33770
|
+
/**
|
|
33771
|
+
* True when the source header declares an alpha channel: a PNG color type 4 or 6 or a tRNS chunk, a WebP VP8X alpha flag or VP8L alpha bit, a WebM or MKV video track AlphaMode of 1, or a GIF transparent-color flag. False when a known container has no alpha channel. Omitted when the format is unknown, the header could not be parsed, or the asset was stored before this field existed; absence does not mean the source is opaque.
|
|
33772
|
+
*/
|
|
33773
|
+
has_alpha?: boolean;
|
|
32648
33774
|
/**
|
|
32649
33775
|
* Search-vector status: pending awaits vector generation or reprocessing; ready has searchable vectors; unavailable indicates disabled, unsupported or failed embedding. Existing vectors may still serve searches while reprocessing is pending.
|
|
32650
33776
|
*/
|
|
@@ -32701,6 +33827,27 @@ export type MediaAssetWritable = {
|
|
|
32701
33827
|
};
|
|
32702
33828
|
};
|
|
32703
33829
|
};
|
|
33830
|
+
/**
|
|
33831
|
+
* Source details for the video-generation job that created this asset.
|
|
33832
|
+
*/
|
|
33833
|
+
generation?: {
|
|
33834
|
+
/**
|
|
33835
|
+
* Job id that generated this asset.
|
|
33836
|
+
*/
|
|
33837
|
+
job_id: MediaJobId;
|
|
33838
|
+
/**
|
|
33839
|
+
* Generation intent used to create the asset; v1 supports video.generate.
|
|
33840
|
+
*/
|
|
33841
|
+
intent: string;
|
|
33842
|
+
/**
|
|
33843
|
+
* Text prompt submitted for the generation job.
|
|
33844
|
+
*/
|
|
33845
|
+
prompt: string;
|
|
33846
|
+
/**
|
|
33847
|
+
* Router video-generation model that produced the asset.
|
|
33848
|
+
*/
|
|
33849
|
+
model: string;
|
|
33850
|
+
};
|
|
32704
33851
|
};
|
|
32705
33852
|
/**
|
|
32706
33853
|
* Understanding results in this page, ordered by creation time ascending.
|
|
@@ -33017,7 +34164,7 @@ export type MediaChunkCompleteWritable = MediaCloudinaryResourceWritable & {
|
|
|
33017
34164
|
done: true;
|
|
33018
34165
|
};
|
|
33019
34166
|
/**
|
|
33020
|
-
* Per-task processing progress and its aggregate state for the asset. 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.
|
|
34167
|
+
* Per-task processing progress and its aggregate state for the asset. 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.
|
|
33021
34168
|
*/
|
|
33022
34169
|
export type MediaProcessingWritable = {
|
|
33023
34170
|
state: MediaProcessingState;
|
|
@@ -33049,7 +34196,7 @@ export type MediaUnderstandingWritable = {
|
|
|
33049
34196
|
*/
|
|
33050
34197
|
asset_version: number;
|
|
33051
34198
|
/**
|
|
33052
|
-
* Result kind: caption is a visual description, tags are recognized labels, ocr is text recognized in the image, transcript is speech text, and frame is a description of a video segment. audio describes sampled speech, music, ambient sound and silence; overview is a full-video summary with chapters, IAB categories and an unverified location; embedding reports a failed embedding step.
|
|
34199
|
+
* Result kind: caption is a visual description, tags are recognized labels, ocr is text recognized in the image, transcript is speech text, and frame is a description of a video segment. audio describes sampled speech, music, ambient sound and silence; overview is a full-video summary with chapters, IAB categories and an unverified location; embedding reports a failed embedding step. loudness is the measured BS.1770-4 loudness of the audio (integrated loudness, loudness range, true and sample peak, a one-point-per-second series and the clipped sections); beats is the measured tempo, beat and bar grid with the sections of the music, recorded as not_applicable with a reason when the asset has no music; content is derived from those measurements and from the transcript into speech, music and silence percentages and sections. Their time values are seconds and their data is not model output.
|
|
33053
34200
|
*/
|
|
33054
34201
|
kind: MediaUnderstandingKind;
|
|
33055
34202
|
/**
|
|
@@ -33246,6 +34393,10 @@ export type MediaSearchAssetWritable = {
|
|
|
33246
34393
|
* Resource status; active identifies an asset that has not been deleted.
|
|
33247
34394
|
*/
|
|
33248
34395
|
status: 'active';
|
|
34396
|
+
/**
|
|
34397
|
+
* True when the source header declares an alpha channel: a PNG color type 4 or 6 or a tRNS chunk, a WebP VP8X alpha flag or VP8L alpha bit, a WebM or MKV video track AlphaMode of 1, or a GIF transparent-color flag. False when a known container has no alpha channel. Omitted when the format is unknown, the header could not be parsed, or the asset was stored before this field existed; absence does not mean the source is opaque.
|
|
34398
|
+
*/
|
|
34399
|
+
has_alpha?: boolean;
|
|
33249
34400
|
/**
|
|
33250
34401
|
* Search-vector status: pending awaits vector generation or reprocessing; ready has searchable vectors; unavailable indicates disabled, unsupported or failed embedding. Existing vectors may still serve searches while reprocessing is pending.
|
|
33251
34402
|
*/
|
|
@@ -33302,6 +34453,27 @@ export type MediaSearchAssetWritable = {
|
|
|
33302
34453
|
};
|
|
33303
34454
|
};
|
|
33304
34455
|
};
|
|
34456
|
+
/**
|
|
34457
|
+
* Source details for the video-generation job that created this asset.
|
|
34458
|
+
*/
|
|
34459
|
+
generation?: {
|
|
34460
|
+
/**
|
|
34461
|
+
* Job id that generated this asset.
|
|
34462
|
+
*/
|
|
34463
|
+
job_id: MediaJobId;
|
|
34464
|
+
/**
|
|
34465
|
+
* Generation intent used to create the asset; v1 supports video.generate.
|
|
34466
|
+
*/
|
|
34467
|
+
intent: string;
|
|
34468
|
+
/**
|
|
34469
|
+
* Text prompt submitted for the generation job.
|
|
34470
|
+
*/
|
|
34471
|
+
prompt: string;
|
|
34472
|
+
/**
|
|
34473
|
+
* Router video-generation model that produced the asset.
|
|
34474
|
+
*/
|
|
34475
|
+
model: string;
|
|
34476
|
+
};
|
|
33305
34477
|
};
|
|
33306
34478
|
/**
|
|
33307
34479
|
* A matching asset with its ranking score and supporting matches.
|
|
@@ -33358,6 +34530,26 @@ export type CutExportId = string;
|
|
|
33358
34530
|
* Version identifier returned by its create or list operation; use the id, not a display name.
|
|
33359
34531
|
*/
|
|
33360
34532
|
export type CutVersionId = string;
|
|
34533
|
+
/**
|
|
34534
|
+
* A type name from types.list, with its dots preserved — a display label is not accepted.
|
|
34535
|
+
*/
|
|
34536
|
+
export type OntologyTypeName = string;
|
|
34537
|
+
/**
|
|
34538
|
+
* Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100.
|
|
34539
|
+
*/
|
|
34540
|
+
export type OntologyLimit = number;
|
|
34541
|
+
/**
|
|
34542
|
+
* Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null.
|
|
34543
|
+
*/
|
|
34544
|
+
export type OntologyCursor = string;
|
|
34545
|
+
/**
|
|
34546
|
+
* Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted.
|
|
34547
|
+
*/
|
|
34548
|
+
export type OntologyNodeId = string;
|
|
34549
|
+
/**
|
|
34550
|
+
* Relation id returned by relations.list, relations.create or a changeset, in the form oed_ followed by 32 lowercase letters or digits; a node id is not accepted.
|
|
34551
|
+
*/
|
|
34552
|
+
export type OntologyRelationId = string;
|
|
33361
34553
|
/**
|
|
33362
34554
|
* Cursor to start the list from
|
|
33363
34555
|
*/
|
|
@@ -33547,7 +34739,7 @@ export type ApplyAgentVersionResponses = {
|
|
|
33547
34739
|
*/
|
|
33548
34740
|
note: string | null;
|
|
33549
34741
|
/**
|
|
33550
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or
|
|
34742
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
33551
34743
|
*/
|
|
33552
34744
|
bindings: Array<{
|
|
33553
34745
|
/**
|
|
@@ -33578,7 +34770,7 @@ export type ApplyAgentVersionResponses = {
|
|
|
33578
34770
|
/**
|
|
33579
34771
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
33580
34772
|
*/
|
|
33581
|
-
type: 'search' | 'browser';
|
|
34773
|
+
type: 'search' | 'browser' | 'ticket' | 'crm' | 'canvas' | 'cut';
|
|
33582
34774
|
/**
|
|
33583
34775
|
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
33584
34776
|
*/
|
|
@@ -34764,7 +35956,7 @@ export type UnarchiveAgentResponses = {
|
|
|
34764
35956
|
*/
|
|
34765
35957
|
note: string | null;
|
|
34766
35958
|
/**
|
|
34767
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or
|
|
35959
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
34768
35960
|
*/
|
|
34769
35961
|
bindings: Array<{
|
|
34770
35962
|
/**
|
|
@@ -34795,7 +35987,7 @@ export type UnarchiveAgentResponses = {
|
|
|
34795
35987
|
/**
|
|
34796
35988
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
34797
35989
|
*/
|
|
34798
|
-
type: 'search' | 'browser';
|
|
35990
|
+
type: 'search' | 'browser' | 'ticket' | 'crm' | 'canvas' | 'cut';
|
|
34799
35991
|
/**
|
|
34800
35992
|
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
34801
35993
|
*/
|
|
@@ -38905,6 +40097,280 @@ export type ComputersFilesContentResponses = {
|
|
|
38905
40097
|
206: Blob | File;
|
|
38906
40098
|
};
|
|
38907
40099
|
export type ComputersFilesContentResponse = ComputersFilesContentResponses[keyof ComputersFilesContentResponses];
|
|
40100
|
+
export type ComputersFilesConvertData = {
|
|
40101
|
+
body: {
|
|
40102
|
+
/**
|
|
40103
|
+
* Name of the entry or object.
|
|
40104
|
+
*/
|
|
40105
|
+
name: string;
|
|
40106
|
+
};
|
|
40107
|
+
path: {
|
|
40108
|
+
/**
|
|
40109
|
+
* Computer id (cmp_...), as returned by computers.create or computers.list.
|
|
40110
|
+
*/
|
|
40111
|
+
computer_id: string;
|
|
40112
|
+
};
|
|
40113
|
+
query?: never;
|
|
40114
|
+
url: '/agent/v1/computers/{computer_id}/files/convert';
|
|
40115
|
+
};
|
|
40116
|
+
export type ComputersFilesConvertErrors = {
|
|
40117
|
+
/**
|
|
40118
|
+
* Platform error in the one /agent/v1 error body; computer failures add error.hint
|
|
40119
|
+
*/
|
|
40120
|
+
400: {
|
|
40121
|
+
type: 'error';
|
|
40122
|
+
error: {
|
|
40123
|
+
/**
|
|
40124
|
+
* Anthropic error type, such as invalid_request_error or not_found_error.
|
|
40125
|
+
*/
|
|
40126
|
+
type: string;
|
|
40127
|
+
message: string;
|
|
40128
|
+
code: string;
|
|
40129
|
+
retryable: boolean;
|
|
40130
|
+
/**
|
|
40131
|
+
* How to recover, for computer failures.
|
|
40132
|
+
*/
|
|
40133
|
+
hint?: string;
|
|
40134
|
+
};
|
|
40135
|
+
/**
|
|
40136
|
+
* Equals the X-Request-Id response header.
|
|
40137
|
+
*/
|
|
40138
|
+
request_id: string;
|
|
40139
|
+
};
|
|
40140
|
+
/**
|
|
40141
|
+
* Platform error in the one /agent/v1 error body; computer failures add error.hint
|
|
40142
|
+
*/
|
|
40143
|
+
401: {
|
|
40144
|
+
type: 'error';
|
|
40145
|
+
error: {
|
|
40146
|
+
/**
|
|
40147
|
+
* Anthropic error type, such as invalid_request_error or not_found_error.
|
|
40148
|
+
*/
|
|
40149
|
+
type: string;
|
|
40150
|
+
message: string;
|
|
40151
|
+
code: string;
|
|
40152
|
+
retryable: boolean;
|
|
40153
|
+
/**
|
|
40154
|
+
* How to recover, for computer failures.
|
|
40155
|
+
*/
|
|
40156
|
+
hint?: string;
|
|
40157
|
+
};
|
|
40158
|
+
/**
|
|
40159
|
+
* Equals the X-Request-Id response header.
|
|
40160
|
+
*/
|
|
40161
|
+
request_id: string;
|
|
40162
|
+
};
|
|
40163
|
+
/**
|
|
40164
|
+
* Platform error in the one /agent/v1 error body; computer failures add error.hint
|
|
40165
|
+
*/
|
|
40166
|
+
403: {
|
|
40167
|
+
type: 'error';
|
|
40168
|
+
error: {
|
|
40169
|
+
/**
|
|
40170
|
+
* Anthropic error type, such as invalid_request_error or not_found_error.
|
|
40171
|
+
*/
|
|
40172
|
+
type: string;
|
|
40173
|
+
message: string;
|
|
40174
|
+
code: string;
|
|
40175
|
+
retryable: boolean;
|
|
40176
|
+
/**
|
|
40177
|
+
* How to recover, for computer failures.
|
|
40178
|
+
*/
|
|
40179
|
+
hint?: string;
|
|
40180
|
+
};
|
|
40181
|
+
/**
|
|
40182
|
+
* Equals the X-Request-Id response header.
|
|
40183
|
+
*/
|
|
40184
|
+
request_id: string;
|
|
40185
|
+
};
|
|
40186
|
+
/**
|
|
40187
|
+
* Computer or path not found; foreign computers are indistinguishable from absent computers.
|
|
40188
|
+
*/
|
|
40189
|
+
404: {
|
|
40190
|
+
type: 'error';
|
|
40191
|
+
error: {
|
|
40192
|
+
/**
|
|
40193
|
+
* Anthropic error type, such as invalid_request_error or not_found_error.
|
|
40194
|
+
*/
|
|
40195
|
+
type: string;
|
|
40196
|
+
message: string;
|
|
40197
|
+
code: string;
|
|
40198
|
+
retryable: boolean;
|
|
40199
|
+
/**
|
|
40200
|
+
* How to recover, for computer failures.
|
|
40201
|
+
*/
|
|
40202
|
+
hint?: string;
|
|
40203
|
+
};
|
|
40204
|
+
/**
|
|
40205
|
+
* Equals the X-Request-Id response header.
|
|
40206
|
+
*/
|
|
40207
|
+
request_id: string;
|
|
40208
|
+
};
|
|
40209
|
+
/**
|
|
40210
|
+
* Platform error in the one /agent/v1 error body; computer failures add error.hint
|
|
40211
|
+
*/
|
|
40212
|
+
409: {
|
|
40213
|
+
type: 'error';
|
|
40214
|
+
error: {
|
|
40215
|
+
/**
|
|
40216
|
+
* Anthropic error type, such as invalid_request_error or not_found_error.
|
|
40217
|
+
*/
|
|
40218
|
+
type: string;
|
|
40219
|
+
message: string;
|
|
40220
|
+
code: string;
|
|
40221
|
+
retryable: boolean;
|
|
40222
|
+
/**
|
|
40223
|
+
* How to recover, for computer failures.
|
|
40224
|
+
*/
|
|
40225
|
+
hint?: string;
|
|
40226
|
+
};
|
|
40227
|
+
/**
|
|
40228
|
+
* Equals the X-Request-Id response header.
|
|
40229
|
+
*/
|
|
40230
|
+
request_id: string;
|
|
40231
|
+
};
|
|
40232
|
+
/**
|
|
40233
|
+
* Platform error in the one /agent/v1 error body; computer failures add error.hint
|
|
40234
|
+
*/
|
|
40235
|
+
413: {
|
|
40236
|
+
type: 'error';
|
|
40237
|
+
error: {
|
|
40238
|
+
/**
|
|
40239
|
+
* Anthropic error type, such as invalid_request_error or not_found_error.
|
|
40240
|
+
*/
|
|
40241
|
+
type: string;
|
|
40242
|
+
message: string;
|
|
40243
|
+
code: string;
|
|
40244
|
+
retryable: boolean;
|
|
40245
|
+
/**
|
|
40246
|
+
* How to recover, for computer failures.
|
|
40247
|
+
*/
|
|
40248
|
+
hint?: string;
|
|
40249
|
+
};
|
|
40250
|
+
/**
|
|
40251
|
+
* Equals the X-Request-Id response header.
|
|
40252
|
+
*/
|
|
40253
|
+
request_id: string;
|
|
40254
|
+
};
|
|
40255
|
+
/**
|
|
40256
|
+
* Platform error in the one /agent/v1 error body; computer failures add error.hint
|
|
40257
|
+
*/
|
|
40258
|
+
429: {
|
|
40259
|
+
type: 'error';
|
|
40260
|
+
error: {
|
|
40261
|
+
/**
|
|
40262
|
+
* Anthropic error type, such as invalid_request_error or not_found_error.
|
|
40263
|
+
*/
|
|
40264
|
+
type: string;
|
|
40265
|
+
message: string;
|
|
40266
|
+
code: string;
|
|
40267
|
+
retryable: boolean;
|
|
40268
|
+
/**
|
|
40269
|
+
* How to recover, for computer failures.
|
|
40270
|
+
*/
|
|
40271
|
+
hint?: string;
|
|
40272
|
+
};
|
|
40273
|
+
/**
|
|
40274
|
+
* Equals the X-Request-Id response header.
|
|
40275
|
+
*/
|
|
40276
|
+
request_id: string;
|
|
40277
|
+
};
|
|
40278
|
+
/**
|
|
40279
|
+
* Platform error in the one /agent/v1 error body; computer failures add error.hint
|
|
40280
|
+
*/
|
|
40281
|
+
500: {
|
|
40282
|
+
type: 'error';
|
|
40283
|
+
error: {
|
|
40284
|
+
/**
|
|
40285
|
+
* Anthropic error type, such as invalid_request_error or not_found_error.
|
|
40286
|
+
*/
|
|
40287
|
+
type: string;
|
|
40288
|
+
message: string;
|
|
40289
|
+
code: string;
|
|
40290
|
+
retryable: boolean;
|
|
40291
|
+
/**
|
|
40292
|
+
* How to recover, for computer failures.
|
|
40293
|
+
*/
|
|
40294
|
+
hint?: string;
|
|
40295
|
+
};
|
|
40296
|
+
/**
|
|
40297
|
+
* Equals the X-Request-Id response header.
|
|
40298
|
+
*/
|
|
40299
|
+
request_id: string;
|
|
40300
|
+
};
|
|
40301
|
+
/**
|
|
40302
|
+
* Platform error in the one /agent/v1 error body; computer failures add error.hint
|
|
40303
|
+
*/
|
|
40304
|
+
503: {
|
|
40305
|
+
type: 'error';
|
|
40306
|
+
error: {
|
|
40307
|
+
/**
|
|
40308
|
+
* Anthropic error type, such as invalid_request_error or not_found_error.
|
|
40309
|
+
*/
|
|
40310
|
+
type: string;
|
|
40311
|
+
message: string;
|
|
40312
|
+
code: string;
|
|
40313
|
+
retryable: boolean;
|
|
40314
|
+
/**
|
|
40315
|
+
* How to recover, for computer failures.
|
|
40316
|
+
*/
|
|
40317
|
+
hint?: string;
|
|
40318
|
+
};
|
|
40319
|
+
/**
|
|
40320
|
+
* Equals the X-Request-Id response header.
|
|
40321
|
+
*/
|
|
40322
|
+
request_id: string;
|
|
40323
|
+
};
|
|
40324
|
+
};
|
|
40325
|
+
export type ComputersFilesConvertError = ComputersFilesConvertErrors[keyof ComputersFilesConvertErrors];
|
|
40326
|
+
export type ComputersFilesConvertResponses = {
|
|
40327
|
+
/**
|
|
40328
|
+
* Computer result
|
|
40329
|
+
*/
|
|
40330
|
+
200: {
|
|
40331
|
+
/**
|
|
40332
|
+
* Always `computer`. A computer.
|
|
40333
|
+
*/
|
|
40334
|
+
type: 'computer';
|
|
40335
|
+
/**
|
|
40336
|
+
* Computer id (cmp_...), the computer_id of computer calls.
|
|
40337
|
+
*/
|
|
40338
|
+
id: string;
|
|
40339
|
+
/**
|
|
40340
|
+
* Display name of the computer, 1 to 255 characters.
|
|
40341
|
+
*/
|
|
40342
|
+
name: string;
|
|
40343
|
+
/**
|
|
40344
|
+
* Public id of the sandbox that backs the computer, usable with the sandbox API; null while none has been created.
|
|
40345
|
+
*/
|
|
40346
|
+
sandbox_id: string | null;
|
|
40347
|
+
/**
|
|
40348
|
+
* not_started means the machine has not been created; first use provisions it. provisioned means a machine has been created, whether running or paused.
|
|
40349
|
+
*/
|
|
40350
|
+
machine_state: 'not_started' | 'provisioned';
|
|
40351
|
+
/**
|
|
40352
|
+
* Environment recipe the computer was created with; null when none.
|
|
40353
|
+
*/
|
|
40354
|
+
environment_id: string | null;
|
|
40355
|
+
/**
|
|
40356
|
+
* active computers can be used by new sessions; archived ones keep their files readable but cannot start new sessions.
|
|
40357
|
+
*/
|
|
40358
|
+
status: 'active' | 'archived';
|
|
40359
|
+
/**
|
|
40360
|
+
* RFC 3339 time at which the computer was created.
|
|
40361
|
+
*/
|
|
40362
|
+
created_at: string;
|
|
40363
|
+
/**
|
|
40364
|
+
* RFC 3339 time at which the computer was last modified.
|
|
40365
|
+
*/
|
|
40366
|
+
updated_at: string;
|
|
40367
|
+
/**
|
|
40368
|
+
* RFC 3339 time at which the computer was archived; null while active.
|
|
40369
|
+
*/
|
|
40370
|
+
archived_at: string | null;
|
|
40371
|
+
};
|
|
40372
|
+
};
|
|
40373
|
+
export type ComputersFilesConvertResponse = ComputersFilesConvertResponses[keyof ComputersFilesConvertResponses];
|
|
38908
40374
|
export type ConnectComputerData = {
|
|
38909
40375
|
body?: {
|
|
38910
40376
|
/**
|
|
@@ -43902,6 +45368,42 @@ export type FileCancelUploadResponses = {
|
|
|
43902
45368
|
200: OwnFilePraxisUpload;
|
|
43903
45369
|
};
|
|
43904
45370
|
export type FileCancelUploadResponse = FileCancelUploadResponses[keyof FileCancelUploadResponses];
|
|
45371
|
+
export type FileRetrieveUploadData = {
|
|
45372
|
+
body?: never;
|
|
45373
|
+
path: {
|
|
45374
|
+
/**
|
|
45375
|
+
* Upload identifier returned by create on this face; the upload belongs to your organization.
|
|
45376
|
+
*/
|
|
45377
|
+
upload_id: string;
|
|
45378
|
+
};
|
|
45379
|
+
query?: never;
|
|
45380
|
+
url: '/file/v1/uploads/{upload_id}';
|
|
45381
|
+
};
|
|
45382
|
+
export type FileRetrieveUploadErrors = {
|
|
45383
|
+
/**
|
|
45384
|
+
* INVALID_PARAMS: correct the upload_id before retrying.
|
|
45385
|
+
*/
|
|
45386
|
+
400: unknown;
|
|
45387
|
+
/**
|
|
45388
|
+
* UNAUTHENTICATED: supply a valid organization API key or signed-in session.
|
|
45389
|
+
*/
|
|
45390
|
+
401: unknown;
|
|
45391
|
+
/**
|
|
45392
|
+
* UPLOAD_NOT_FOUND: the upload is missing or belongs to another organization; create a new upload and send its parts.
|
|
45393
|
+
*/
|
|
45394
|
+
404: unknown;
|
|
45395
|
+
/**
|
|
45396
|
+
* UPLOAD_INVALID_STATE: the upload was cancelled or expired; create a new upload and send its parts again.
|
|
45397
|
+
*/
|
|
45398
|
+
409: unknown;
|
|
45399
|
+
};
|
|
45400
|
+
export type FileRetrieveUploadResponses = {
|
|
45401
|
+
/**
|
|
45402
|
+
* The upload state plus part_size and the received_parts list; complete once every part is present.
|
|
45403
|
+
*/
|
|
45404
|
+
200: OwnFilePraxisUpload;
|
|
45405
|
+
};
|
|
45406
|
+
export type FileRetrieveUploadResponse = FileRetrieveUploadResponses[keyof FileRetrieveUploadResponses];
|
|
43905
45407
|
export type FileCreateSignedUploadData = {
|
|
43906
45408
|
body: OwnFileSignedUploadRequest;
|
|
43907
45409
|
path?: never;
|
|
@@ -51338,7 +52840,7 @@ export type AgentsListResponses = {
|
|
|
51338
52840
|
*/
|
|
51339
52841
|
note: string | null;
|
|
51340
52842
|
/**
|
|
51341
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or
|
|
52843
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
51342
52844
|
*/
|
|
51343
52845
|
bindings: Array<{
|
|
51344
52846
|
/**
|
|
@@ -51369,7 +52871,7 @@ export type AgentsListResponses = {
|
|
|
51369
52871
|
/**
|
|
51370
52872
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
51371
52873
|
*/
|
|
51372
|
-
type: 'search' | 'browser';
|
|
52874
|
+
type: 'search' | 'browser' | 'ticket' | 'crm' | 'canvas' | 'cut';
|
|
51373
52875
|
/**
|
|
51374
52876
|
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
51375
52877
|
*/
|
|
@@ -51877,7 +53379,7 @@ export type AgentsCreateData = {
|
|
|
51877
53379
|
*/
|
|
51878
53380
|
tools?: Array<AgentManaged15 | AgentManaged29 | AgentManaged32>;
|
|
51879
53381
|
/**
|
|
51880
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or
|
|
53382
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
51881
53383
|
*/
|
|
51882
53384
|
bindings?: Array<{
|
|
51883
53385
|
/**
|
|
@@ -51908,7 +53410,7 @@ export type AgentsCreateData = {
|
|
|
51908
53410
|
/**
|
|
51909
53411
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
51910
53412
|
*/
|
|
51911
|
-
type: 'search' | 'browser';
|
|
53413
|
+
type: 'search' | 'browser' | 'ticket' | 'crm' | 'canvas' | 'cut';
|
|
51912
53414
|
/**
|
|
51913
53415
|
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
51914
53416
|
*/
|
|
@@ -52478,7 +53980,7 @@ export type AgentsCreateResponses = {
|
|
|
52478
53980
|
*/
|
|
52479
53981
|
note: string | null;
|
|
52480
53982
|
/**
|
|
52481
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or
|
|
53983
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
52482
53984
|
*/
|
|
52483
53985
|
bindings: Array<{
|
|
52484
53986
|
/**
|
|
@@ -52509,7 +54011,7 @@ export type AgentsCreateResponses = {
|
|
|
52509
54011
|
/**
|
|
52510
54012
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
52511
54013
|
*/
|
|
52512
|
-
type: 'search' | 'browser';
|
|
54014
|
+
type: 'search' | 'browser' | 'ticket' | 'crm' | 'canvas' | 'cut';
|
|
52513
54015
|
/**
|
|
52514
54016
|
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
52515
54017
|
*/
|
|
@@ -53106,7 +54608,7 @@ export type AgentsRetrieveResponses = {
|
|
|
53106
54608
|
*/
|
|
53107
54609
|
note: string | null;
|
|
53108
54610
|
/**
|
|
53109
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or
|
|
54611
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
53110
54612
|
*/
|
|
53111
54613
|
bindings: Array<{
|
|
53112
54614
|
/**
|
|
@@ -53137,7 +54639,7 @@ export type AgentsRetrieveResponses = {
|
|
|
53137
54639
|
/**
|
|
53138
54640
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
53139
54641
|
*/
|
|
53140
|
-
type: 'search' | 'browser';
|
|
54642
|
+
type: 'search' | 'browser' | 'ticket' | 'crm' | 'canvas' | 'cut';
|
|
53141
54643
|
/**
|
|
53142
54644
|
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
53143
54645
|
*/
|
|
@@ -53685,7 +55187,7 @@ export type AgentsUpdateData = {
|
|
|
53685
55187
|
/**
|
|
53686
55188
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
53687
55189
|
*/
|
|
53688
|
-
type: 'search' | 'browser';
|
|
55190
|
+
type: 'search' | 'browser' | 'ticket' | 'crm' | 'canvas' | 'cut';
|
|
53689
55191
|
/**
|
|
53690
55192
|
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
53691
55193
|
*/
|
|
@@ -54268,7 +55770,7 @@ export type AgentsUpdateResponses = {
|
|
|
54268
55770
|
*/
|
|
54269
55771
|
note: string | null;
|
|
54270
55772
|
/**
|
|
54271
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or
|
|
55773
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
54272
55774
|
*/
|
|
54273
55775
|
bindings: Array<{
|
|
54274
55776
|
/**
|
|
@@ -54299,7 +55801,7 @@ export type AgentsUpdateResponses = {
|
|
|
54299
55801
|
/**
|
|
54300
55802
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
54301
55803
|
*/
|
|
54302
|
-
type: 'search' | 'browser';
|
|
55804
|
+
type: 'search' | 'browser' | 'ticket' | 'crm' | 'canvas' | 'cut';
|
|
54303
55805
|
/**
|
|
54304
55806
|
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
54305
55807
|
*/
|
|
@@ -54882,7 +56384,7 @@ export type AgentsArchiveResponses = {
|
|
|
54882
56384
|
*/
|
|
54883
56385
|
note: string | null;
|
|
54884
56386
|
/**
|
|
54885
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or
|
|
56387
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
54886
56388
|
*/
|
|
54887
56389
|
bindings: Array<{
|
|
54888
56390
|
/**
|
|
@@ -54913,7 +56415,7 @@ export type AgentsArchiveResponses = {
|
|
|
54913
56415
|
/**
|
|
54914
56416
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
54915
56417
|
*/
|
|
54916
|
-
type: 'search' | 'browser';
|
|
56418
|
+
type: 'search' | 'browser' | 'ticket' | 'crm' | 'canvas' | 'cut';
|
|
54917
56419
|
/**
|
|
54918
56420
|
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
54919
56421
|
*/
|
|
@@ -55514,7 +57016,7 @@ export type AgentsVersionsListResponses = {
|
|
|
55514
57016
|
*/
|
|
55515
57017
|
note: string | null;
|
|
55516
57018
|
/**
|
|
55517
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or
|
|
57019
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
55518
57020
|
*/
|
|
55519
57021
|
bindings: Array<{
|
|
55520
57022
|
/**
|
|
@@ -55545,7 +57047,7 @@ export type AgentsVersionsListResponses = {
|
|
|
55545
57047
|
/**
|
|
55546
57048
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
55547
57049
|
*/
|
|
55548
|
-
type: 'search' | 'browser';
|
|
57050
|
+
type: 'search' | 'browser' | 'ticket' | 'crm' | 'canvas' | 'cut';
|
|
55549
57051
|
/**
|
|
55550
57052
|
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
55551
57053
|
*/
|
|
@@ -65522,7 +67024,7 @@ export type AutomationTriggersCreateData = {
|
|
|
65522
67024
|
*/
|
|
65523
67025
|
end_at?: string | null;
|
|
65524
67026
|
/**
|
|
65525
|
-
* skip
|
|
67027
|
+
* skip skips while a previous run is still active; allow permits overlapping runs. When omitted, schedule triggers use skip and webhook triggers use allow.
|
|
65526
67028
|
*/
|
|
65527
67029
|
overlap?: 'skip' | 'allow';
|
|
65528
67030
|
/**
|
|
@@ -65721,7 +67223,7 @@ export type AutomationTriggersPatchData = {
|
|
|
65721
67223
|
*/
|
|
65722
67224
|
end_at?: string | null;
|
|
65723
67225
|
/**
|
|
65724
|
-
* skip
|
|
67226
|
+
* skip skips while a previous run is still active; allow permits overlapping runs. When omitted, schedule triggers use skip and webhook triggers use allow.
|
|
65725
67227
|
*/
|
|
65726
67228
|
overlap?: 'skip' | 'allow';
|
|
65727
67229
|
/**
|
|
@@ -69306,7 +70808,7 @@ export type CutExecuteData = {
|
|
|
69306
70808
|
};
|
|
69307
70809
|
export type CutExecuteErrors = {
|
|
69308
70810
|
/**
|
|
69309
|
-
* SCRIPT_ERROR, SCRIPT_LIMIT or
|
|
70811
|
+
* SCRIPT_ERROR, SCRIPT_LIMIT, OPS_REJECTED or INVALID_CAPTION_FILE means the script failed and its writes rolled back; correct the source using error.details.edit_id and edits when provided. EDIT_EXPIRED means the saved source is older than ten minutes; resubmit corrected script source.
|
|
69310
70812
|
*/
|
|
69311
70813
|
400: CutCutError;
|
|
69312
70814
|
/**
|
|
@@ -69863,6 +71365,99 @@ export type CutCreateExportResponses = {
|
|
|
69863
71365
|
202: CutExport;
|
|
69864
71366
|
};
|
|
69865
71367
|
export type CutCreateExportResponse = CutCreateExportResponses[keyof CutCreateExportResponses];
|
|
71368
|
+
export type CutCreateRenderData = {
|
|
71369
|
+
/**
|
|
71370
|
+
* The interval to render, on the project's own second-based clock. The interval is bounded so a draft stays a listening or viewing aid rather than a delivery; long passages are requested in several ranges.
|
|
71371
|
+
*/
|
|
71372
|
+
body: CutDraftRenderInput;
|
|
71373
|
+
path: {
|
|
71374
|
+
/**
|
|
71375
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
71376
|
+
*/
|
|
71377
|
+
project_id: string;
|
|
71378
|
+
};
|
|
71379
|
+
query?: never;
|
|
71380
|
+
url: '/cut/v1/projects/{project_id}/renders';
|
|
71381
|
+
};
|
|
71382
|
+
export type CutCreateRenderErrors = {
|
|
71383
|
+
/**
|
|
71384
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
71385
|
+
*/
|
|
71386
|
+
400: CutCutError;
|
|
71387
|
+
/**
|
|
71388
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
71389
|
+
*/
|
|
71390
|
+
401: CutCutError;
|
|
71391
|
+
/**
|
|
71392
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
71393
|
+
*/
|
|
71394
|
+
403: CutCutError;
|
|
71395
|
+
/**
|
|
71396
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
71397
|
+
*/
|
|
71398
|
+
404: CutCutError;
|
|
71399
|
+
/**
|
|
71400
|
+
* CUT_BUSY means too much work is queued for this project; let pending work complete before retrying.
|
|
71401
|
+
*/
|
|
71402
|
+
429: CutCutError;
|
|
71403
|
+
/**
|
|
71404
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
71405
|
+
*/
|
|
71406
|
+
500: CutCutError;
|
|
71407
|
+
/**
|
|
71408
|
+
* MEDIA_OFFLINE, MEDIA_UNAVAILABLE, MEDIA_IMPORT_FAILED or EXPORT_FAILED means required media or rendering could not complete; inspect source availability or the export error before retrying.
|
|
71409
|
+
*/
|
|
71410
|
+
503: CutCutError;
|
|
71411
|
+
};
|
|
71412
|
+
export type CutCreateRenderError = CutCreateRenderErrors[keyof CutCreateRenderErrors];
|
|
71413
|
+
export type CutCreateRenderResponses = {
|
|
71414
|
+
/**
|
|
71415
|
+
* Draft render accepted; poll renders.retrieve until status is done or failed.
|
|
71416
|
+
*/
|
|
71417
|
+
202: CutDraftRender;
|
|
71418
|
+
};
|
|
71419
|
+
export type CutCreateRenderResponse = CutCreateRenderResponses[keyof CutCreateRenderResponses];
|
|
71420
|
+
export type CutRetrieveRenderData = {
|
|
71421
|
+
body?: never;
|
|
71422
|
+
path: {
|
|
71423
|
+
/**
|
|
71424
|
+
* Draft render id (cutr_…) returned by projects.renders.create.
|
|
71425
|
+
*/
|
|
71426
|
+
render_id: string;
|
|
71427
|
+
};
|
|
71428
|
+
query?: never;
|
|
71429
|
+
url: '/cut/v1/renders/{render_id}';
|
|
71430
|
+
};
|
|
71431
|
+
export type CutRetrieveRenderErrors = {
|
|
71432
|
+
/**
|
|
71433
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
71434
|
+
*/
|
|
71435
|
+
400: CutCutError;
|
|
71436
|
+
/**
|
|
71437
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
71438
|
+
*/
|
|
71439
|
+
401: CutCutError;
|
|
71440
|
+
/**
|
|
71441
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
71442
|
+
*/
|
|
71443
|
+
403: CutCutError;
|
|
71444
|
+
/**
|
|
71445
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
71446
|
+
*/
|
|
71447
|
+
404: CutCutError;
|
|
71448
|
+
/**
|
|
71449
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
71450
|
+
*/
|
|
71451
|
+
500: CutCutError;
|
|
71452
|
+
};
|
|
71453
|
+
export type CutRetrieveRenderError = CutRetrieveRenderErrors[keyof CutRetrieveRenderErrors];
|
|
71454
|
+
export type CutRetrieveRenderResponses = {
|
|
71455
|
+
/**
|
|
71456
|
+
* Draft render state; file_id and url are present only once status is done.
|
|
71457
|
+
*/
|
|
71458
|
+
200: CutDraftRender;
|
|
71459
|
+
};
|
|
71460
|
+
export type CutRetrieveRenderResponse = CutRetrieveRenderResponses[keyof CutRetrieveRenderResponses];
|
|
69866
71461
|
export type CutRetrieveExportData = {
|
|
69867
71462
|
body?: never;
|
|
69868
71463
|
path: {
|
|
@@ -72614,6 +74209,10 @@ export type MediaListLibrariesErrors = {
|
|
|
72614
74209
|
* Request failed; see the error code reference.
|
|
72615
74210
|
*/
|
|
72616
74211
|
415: MediaMediaError;
|
|
74212
|
+
/**
|
|
74213
|
+
* Request failed; see the error code reference.
|
|
74214
|
+
*/
|
|
74215
|
+
422: MediaMediaError;
|
|
72617
74216
|
/**
|
|
72618
74217
|
* Request failed; see the error code reference.
|
|
72619
74218
|
*/
|
|
@@ -72705,6 +74304,10 @@ export type MediaCreateLibraryErrors = {
|
|
|
72705
74304
|
* Request failed; see the error code reference.
|
|
72706
74305
|
*/
|
|
72707
74306
|
415: MediaMediaError;
|
|
74307
|
+
/**
|
|
74308
|
+
* Request failed; see the error code reference.
|
|
74309
|
+
*/
|
|
74310
|
+
422: MediaMediaError;
|
|
72708
74311
|
/**
|
|
72709
74312
|
* Request failed; see the error code reference.
|
|
72710
74313
|
*/
|
|
@@ -72779,6 +74382,10 @@ export type MediaCreateFrameUrlsErrors = {
|
|
|
72779
74382
|
* This media format is unsupported; provide a supported format.
|
|
72780
74383
|
*/
|
|
72781
74384
|
415: MediaMediaError;
|
|
74385
|
+
/**
|
|
74386
|
+
* Request failed; see the error code reference.
|
|
74387
|
+
*/
|
|
74388
|
+
422: MediaMediaError;
|
|
72782
74389
|
/**
|
|
72783
74390
|
* A rate limit was reached; wait before retrying.
|
|
72784
74391
|
*/
|
|
@@ -72840,6 +74447,10 @@ export type MediaDeleteLibraryErrors = {
|
|
|
72840
74447
|
* Request failed; see the error code reference.
|
|
72841
74448
|
*/
|
|
72842
74449
|
415: MediaMediaError;
|
|
74450
|
+
/**
|
|
74451
|
+
* Request failed; see the error code reference.
|
|
74452
|
+
*/
|
|
74453
|
+
422: MediaMediaError;
|
|
72843
74454
|
/**
|
|
72844
74455
|
* Request failed; see the error code reference.
|
|
72845
74456
|
*/
|
|
@@ -72901,6 +74512,10 @@ export type MediaGetLibraryErrors = {
|
|
|
72901
74512
|
* Request failed; see the error code reference.
|
|
72902
74513
|
*/
|
|
72903
74514
|
415: MediaMediaError;
|
|
74515
|
+
/**
|
|
74516
|
+
* Request failed; see the error code reference.
|
|
74517
|
+
*/
|
|
74518
|
+
422: MediaMediaError;
|
|
72904
74519
|
/**
|
|
72905
74520
|
* Request failed; see the error code reference.
|
|
72906
74521
|
*/
|
|
@@ -73001,6 +74616,10 @@ export type MediaUpdateLibraryErrors = {
|
|
|
73001
74616
|
* Request failed; see the error code reference.
|
|
73002
74617
|
*/
|
|
73003
74618
|
415: MediaMediaError;
|
|
74619
|
+
/**
|
|
74620
|
+
* Request failed; see the error code reference.
|
|
74621
|
+
*/
|
|
74622
|
+
422: MediaMediaError;
|
|
73004
74623
|
/**
|
|
73005
74624
|
* Request failed; see the error code reference.
|
|
73006
74625
|
*/
|
|
@@ -73062,6 +74681,10 @@ export type MediaRestoreLibraryErrors = {
|
|
|
73062
74681
|
* Request failed; see the error code reference.
|
|
73063
74682
|
*/
|
|
73064
74683
|
415: MediaMediaError;
|
|
74684
|
+
/**
|
|
74685
|
+
* Request failed; see the error code reference.
|
|
74686
|
+
*/
|
|
74687
|
+
422: MediaMediaError;
|
|
73065
74688
|
/**
|
|
73066
74689
|
* Request failed; see the error code reference.
|
|
73067
74690
|
*/
|
|
@@ -73123,6 +74746,10 @@ export type MediaPurgeLibraryErrors = {
|
|
|
73123
74746
|
* Request failed; see the error code reference.
|
|
73124
74747
|
*/
|
|
73125
74748
|
415: MediaMediaError;
|
|
74749
|
+
/**
|
|
74750
|
+
* Request failed; see the error code reference.
|
|
74751
|
+
*/
|
|
74752
|
+
422: MediaMediaError;
|
|
73126
74753
|
/**
|
|
73127
74754
|
* Request failed; see the error code reference.
|
|
73128
74755
|
*/
|
|
@@ -73201,6 +74828,10 @@ export type MediaListAssetsErrors = {
|
|
|
73201
74828
|
* Request failed; see the error code reference.
|
|
73202
74829
|
*/
|
|
73203
74830
|
415: MediaMediaError;
|
|
74831
|
+
/**
|
|
74832
|
+
* Request failed; see the error code reference.
|
|
74833
|
+
*/
|
|
74834
|
+
422: MediaMediaError;
|
|
73204
74835
|
/**
|
|
73205
74836
|
* Request failed; see the error code reference.
|
|
73206
74837
|
*/
|
|
@@ -73338,6 +74969,10 @@ export type MediaUploadAssetErrors = {
|
|
|
73338
74969
|
* Request failed; see the error code reference.
|
|
73339
74970
|
*/
|
|
73340
74971
|
415: MediaMediaError;
|
|
74972
|
+
/**
|
|
74973
|
+
* Request failed; see the error code reference.
|
|
74974
|
+
*/
|
|
74975
|
+
422: MediaMediaError;
|
|
73341
74976
|
/**
|
|
73342
74977
|
* Request failed; see the error code reference.
|
|
73343
74978
|
*/
|
|
@@ -73465,6 +75100,10 @@ export type MediaImportAssetErrors = {
|
|
|
73465
75100
|
* Request failed; see the error code reference.
|
|
73466
75101
|
*/
|
|
73467
75102
|
415: MediaMediaError;
|
|
75103
|
+
/**
|
|
75104
|
+
* Request failed; see the error code reference.
|
|
75105
|
+
*/
|
|
75106
|
+
422: MediaMediaError;
|
|
73468
75107
|
/**
|
|
73469
75108
|
* Request failed; see the error code reference.
|
|
73470
75109
|
*/
|
|
@@ -73530,6 +75169,10 @@ export type MediaDeleteAssetErrors = {
|
|
|
73530
75169
|
* Request failed; see the error code reference.
|
|
73531
75170
|
*/
|
|
73532
75171
|
415: MediaMediaError;
|
|
75172
|
+
/**
|
|
75173
|
+
* Request failed; see the error code reference.
|
|
75174
|
+
*/
|
|
75175
|
+
422: MediaMediaError;
|
|
73533
75176
|
/**
|
|
73534
75177
|
* Request failed; see the error code reference.
|
|
73535
75178
|
*/
|
|
@@ -73595,6 +75238,10 @@ export type MediaGetAssetErrors = {
|
|
|
73595
75238
|
* Request failed; see the error code reference.
|
|
73596
75239
|
*/
|
|
73597
75240
|
415: MediaMediaError;
|
|
75241
|
+
/**
|
|
75242
|
+
* Request failed; see the error code reference.
|
|
75243
|
+
*/
|
|
75244
|
+
422: MediaMediaError;
|
|
73598
75245
|
/**
|
|
73599
75246
|
* Request failed; see the error code reference.
|
|
73600
75247
|
*/
|
|
@@ -73682,6 +75329,10 @@ export type MediaUpdateAssetErrors = {
|
|
|
73682
75329
|
* Request failed; see the error code reference.
|
|
73683
75330
|
*/
|
|
73684
75331
|
415: MediaMediaError;
|
|
75332
|
+
/**
|
|
75333
|
+
* Request failed; see the error code reference.
|
|
75334
|
+
*/
|
|
75335
|
+
422: MediaMediaError;
|
|
73685
75336
|
/**
|
|
73686
75337
|
* Request failed; see the error code reference.
|
|
73687
75338
|
*/
|
|
@@ -73755,6 +75406,10 @@ export type MediaReprocessAssetErrors = {
|
|
|
73755
75406
|
* Request failed; see the error code reference.
|
|
73756
75407
|
*/
|
|
73757
75408
|
415: MediaMediaError;
|
|
75409
|
+
/**
|
|
75410
|
+
* Request failed; see the error code reference.
|
|
75411
|
+
*/
|
|
75412
|
+
422: MediaMediaError;
|
|
73758
75413
|
/**
|
|
73759
75414
|
* Request failed; see the error code reference.
|
|
73760
75415
|
*/
|
|
@@ -73798,9 +75453,9 @@ export type MediaListUnderstandingsData = {
|
|
|
73798
75453
|
*/
|
|
73799
75454
|
include_superseded?: boolean;
|
|
73800
75455
|
/**
|
|
73801
|
-
* Return one output kind: caption is a visual description, tags are generated labels, ocr is visible text, transcript is speech, frame is a video shot, overview is a video summary, audio is sampled audio understanding, and embedding reports a failed embedding step.
|
|
75456
|
+
* Return one output kind: caption is a visual description, tags are generated labels, ocr is visible text, transcript is speech, frame is a video shot, overview is a video summary, audio is sampled audio understanding, loudness is measured loudness, beats is the measured tempo and beat grid, content is the derived speech, music and silence split, and embedding reports a failed embedding step.
|
|
73802
75457
|
*/
|
|
73803
|
-
kind?: 'caption' | 'tags' | 'ocr' | 'transcript' | 'frame' | 'overview' | 'audio' | 'embedding';
|
|
75458
|
+
kind?: 'caption' | 'tags' | 'ocr' | 'transcript' | 'frame' | 'overview' | 'audio' | 'loudness' | 'beats' | 'content' | 'embedding';
|
|
73804
75459
|
/**
|
|
73805
75460
|
* Cursor from the previous next_cursor.
|
|
73806
75461
|
*/
|
|
@@ -73837,6 +75492,10 @@ export type MediaListUnderstandingsErrors = {
|
|
|
73837
75492
|
* Request failed; see the error code reference.
|
|
73838
75493
|
*/
|
|
73839
75494
|
415: MediaMediaError;
|
|
75495
|
+
/**
|
|
75496
|
+
* Request failed; see the error code reference.
|
|
75497
|
+
*/
|
|
75498
|
+
422: MediaMediaError;
|
|
73840
75499
|
/**
|
|
73841
75500
|
* Request failed; see the error code reference.
|
|
73842
75501
|
*/
|
|
@@ -73928,6 +75587,10 @@ export type MediaExpressionSearchErrors = {
|
|
|
73928
75587
|
* Request failed; see the error code reference.
|
|
73929
75588
|
*/
|
|
73930
75589
|
415: MediaMediaError;
|
|
75590
|
+
/**
|
|
75591
|
+
* Request failed; see the error code reference.
|
|
75592
|
+
*/
|
|
75593
|
+
422: MediaMediaError;
|
|
73931
75594
|
/**
|
|
73932
75595
|
* Request failed; see the error code reference.
|
|
73933
75596
|
*/
|
|
@@ -74015,6 +75678,10 @@ export type MediaVisualSearchErrors = {
|
|
|
74015
75678
|
* Request failed; see the error code reference.
|
|
74016
75679
|
*/
|
|
74017
75680
|
415: MediaMediaError;
|
|
75681
|
+
/**
|
|
75682
|
+
* Request failed; see the error code reference.
|
|
75683
|
+
*/
|
|
75684
|
+
422: MediaMediaError;
|
|
74018
75685
|
/**
|
|
74019
75686
|
* Request failed; see the error code reference.
|
|
74020
75687
|
*/
|
|
@@ -74096,6 +75763,10 @@ export type MediaSemanticSearchErrors = {
|
|
|
74096
75763
|
* Request failed; see the error code reference.
|
|
74097
75764
|
*/
|
|
74098
75765
|
415: MediaMediaError;
|
|
75766
|
+
/**
|
|
75767
|
+
* Request failed; see the error code reference.
|
|
75768
|
+
*/
|
|
75769
|
+
422: MediaMediaError;
|
|
74099
75770
|
/**
|
|
74100
75771
|
* Request failed; see the error code reference.
|
|
74101
75772
|
*/
|
|
@@ -74177,6 +75848,10 @@ export type MediaSearchErrors = {
|
|
|
74177
75848
|
* Request failed; see the error code reference.
|
|
74178
75849
|
*/
|
|
74179
75850
|
415: MediaMediaError;
|
|
75851
|
+
/**
|
|
75852
|
+
* Request failed; see the error code reference.
|
|
75853
|
+
*/
|
|
75854
|
+
422: MediaMediaError;
|
|
74180
75855
|
/**
|
|
74181
75856
|
* Request failed; see the error code reference.
|
|
74182
75857
|
*/
|
|
@@ -74243,6 +75918,10 @@ export type MediaListFoldersErrors = {
|
|
|
74243
75918
|
* Request failed; see the error code reference.
|
|
74244
75919
|
*/
|
|
74245
75920
|
415: MediaMediaError;
|
|
75921
|
+
/**
|
|
75922
|
+
* Request failed; see the error code reference.
|
|
75923
|
+
*/
|
|
75924
|
+
422: MediaMediaError;
|
|
74246
75925
|
/**
|
|
74247
75926
|
* Request failed; see the error code reference.
|
|
74248
75927
|
*/
|
|
@@ -74316,6 +75995,10 @@ export type MediaCreateBatchErrors = {
|
|
|
74316
75995
|
* Request failed; see the error code reference.
|
|
74317
75996
|
*/
|
|
74318
75997
|
415: MediaMediaError;
|
|
75998
|
+
/**
|
|
75999
|
+
* Request failed; see the error code reference.
|
|
76000
|
+
*/
|
|
76001
|
+
422: MediaMediaError;
|
|
74319
76002
|
/**
|
|
74320
76003
|
* Request failed; see the error code reference.
|
|
74321
76004
|
*/
|
|
@@ -74381,6 +76064,10 @@ export type MediaGetBatchErrors = {
|
|
|
74381
76064
|
* Request failed; see the error code reference.
|
|
74382
76065
|
*/
|
|
74383
76066
|
415: MediaMediaError;
|
|
76067
|
+
/**
|
|
76068
|
+
* Request failed; see the error code reference.
|
|
76069
|
+
*/
|
|
76070
|
+
422: MediaMediaError;
|
|
74384
76071
|
/**
|
|
74385
76072
|
* Request failed; see the error code reference.
|
|
74386
76073
|
*/
|
|
@@ -74454,6 +76141,10 @@ export type MediaBatchAssetsErrors = {
|
|
|
74454
76141
|
* Request failed; see the error code reference.
|
|
74455
76142
|
*/
|
|
74456
76143
|
415: MediaMediaError;
|
|
76144
|
+
/**
|
|
76145
|
+
* Request failed; see the error code reference.
|
|
76146
|
+
*/
|
|
76147
|
+
422: MediaMediaError;
|
|
74457
76148
|
/**
|
|
74458
76149
|
* Request failed; see the error code reference.
|
|
74459
76150
|
*/
|
|
@@ -74487,7 +76178,7 @@ export type MediaGetJobData = {
|
|
|
74487
76178
|
*/
|
|
74488
76179
|
library_id: string;
|
|
74489
76180
|
/**
|
|
74490
|
-
*
|
|
76181
|
+
* Job identifier returned by batch creation, video-generation creation or job listing; resolved within this library.
|
|
74491
76182
|
*/
|
|
74492
76183
|
job_id: string;
|
|
74493
76184
|
};
|
|
@@ -74495,218 +76186,6 @@ export type MediaGetJobData = {
|
|
|
74495
76186
|
url: '/media/v1/libraries/{library_id}/jobs/{job_id}';
|
|
74496
76187
|
};
|
|
74497
76188
|
export type MediaGetJobErrors = {
|
|
74498
|
-
/**
|
|
74499
|
-
* Request failed; see the error code reference.
|
|
74500
|
-
*/
|
|
74501
|
-
400: MediaMediaError;
|
|
74502
|
-
/**
|
|
74503
|
-
* Request failed; see the error code reference.
|
|
74504
|
-
*/
|
|
74505
|
-
403: MediaMediaError;
|
|
74506
|
-
/**
|
|
74507
|
-
* Request failed; see the error code reference.
|
|
74508
|
-
*/
|
|
74509
|
-
404: MediaMediaError;
|
|
74510
|
-
/**
|
|
74511
|
-
* Request failed; see the error code reference.
|
|
74512
|
-
*/
|
|
74513
|
-
409: MediaMediaError;
|
|
74514
|
-
/**
|
|
74515
|
-
* Request failed; see the error code reference.
|
|
74516
|
-
*/
|
|
74517
|
-
413: MediaMediaError;
|
|
74518
|
-
/**
|
|
74519
|
-
* Request failed; see the error code reference.
|
|
74520
|
-
*/
|
|
74521
|
-
415: MediaMediaError;
|
|
74522
|
-
/**
|
|
74523
|
-
* Request failed; see the error code reference.
|
|
74524
|
-
*/
|
|
74525
|
-
429: MediaMediaError;
|
|
74526
|
-
/**
|
|
74527
|
-
* Request failed; see the error code reference.
|
|
74528
|
-
*/
|
|
74529
|
-
501: MediaMediaError;
|
|
74530
|
-
/**
|
|
74531
|
-
* Request failed; see the error code reference.
|
|
74532
|
-
*/
|
|
74533
|
-
502: MediaMediaError;
|
|
74534
|
-
/**
|
|
74535
|
-
* Request failed; see the error code reference.
|
|
74536
|
-
*/
|
|
74537
|
-
503: MediaMediaError;
|
|
74538
|
-
};
|
|
74539
|
-
export type MediaGetJobError = MediaGetJobErrors[keyof MediaGetJobErrors];
|
|
74540
|
-
export type MediaGetJobResponses = {
|
|
74541
|
-
/**
|
|
74542
|
-
* Successful response.
|
|
74543
|
-
*/
|
|
74544
|
-
200: MediaJob;
|
|
74545
|
-
};
|
|
74546
|
-
export type MediaGetJobResponse = MediaGetJobResponses[keyof MediaGetJobResponses];
|
|
74547
|
-
export type MediaListEventsData = {
|
|
74548
|
-
body?: never;
|
|
74549
|
-
path: {
|
|
74550
|
-
/**
|
|
74551
|
-
* Library ID returned by creation.
|
|
74552
|
-
*/
|
|
74553
|
-
library_id: string;
|
|
74554
|
-
};
|
|
74555
|
-
query?: {
|
|
74556
|
-
/**
|
|
74557
|
-
* Events with a larger sequence. Use with asc; cannot combine with before_seq.
|
|
74558
|
-
*/
|
|
74559
|
-
after_seq?: number;
|
|
74560
|
-
/**
|
|
74561
|
-
* Events with a smaller sequence. Use with desc; cannot combine with after_seq.
|
|
74562
|
-
*/
|
|
74563
|
-
before_seq?: number;
|
|
74564
|
-
/**
|
|
74565
|
-
* Sequence order: asc is increasing; desc is decreasing.
|
|
74566
|
-
*/
|
|
74567
|
-
order?: 'asc' | 'desc';
|
|
74568
|
-
/**
|
|
74569
|
-
* Maximum items per page, from 1 to 200; defaults to 50.
|
|
74570
|
-
*/
|
|
74571
|
-
limit?: number;
|
|
74572
|
-
};
|
|
74573
|
-
url: '/media/v1/libraries/{library_id}/events';
|
|
74574
|
-
};
|
|
74575
|
-
export type MediaListEventsErrors = {
|
|
74576
|
-
/**
|
|
74577
|
-
* Request failed; see the error code reference.
|
|
74578
|
-
*/
|
|
74579
|
-
400: MediaMediaError;
|
|
74580
|
-
/**
|
|
74581
|
-
* Request failed; see the error code reference.
|
|
74582
|
-
*/
|
|
74583
|
-
403: MediaMediaError;
|
|
74584
|
-
/**
|
|
74585
|
-
* Request failed; see the error code reference.
|
|
74586
|
-
*/
|
|
74587
|
-
404: MediaMediaError;
|
|
74588
|
-
/**
|
|
74589
|
-
* Request failed; see the error code reference.
|
|
74590
|
-
*/
|
|
74591
|
-
409: MediaMediaError;
|
|
74592
|
-
/**
|
|
74593
|
-
* Request failed; see the error code reference.
|
|
74594
|
-
*/
|
|
74595
|
-
413: MediaMediaError;
|
|
74596
|
-
/**
|
|
74597
|
-
* Request failed; see the error code reference.
|
|
74598
|
-
*/
|
|
74599
|
-
415: MediaMediaError;
|
|
74600
|
-
/**
|
|
74601
|
-
* Request failed; see the error code reference.
|
|
74602
|
-
*/
|
|
74603
|
-
429: MediaMediaError;
|
|
74604
|
-
/**
|
|
74605
|
-
* Request failed; see the error code reference.
|
|
74606
|
-
*/
|
|
74607
|
-
501: MediaMediaError;
|
|
74608
|
-
/**
|
|
74609
|
-
* Request failed; see the error code reference.
|
|
74610
|
-
*/
|
|
74611
|
-
502: MediaMediaError;
|
|
74612
|
-
/**
|
|
74613
|
-
* Request failed; see the error code reference.
|
|
74614
|
-
*/
|
|
74615
|
-
503: MediaMediaError;
|
|
74616
|
-
};
|
|
74617
|
-
export type MediaListEventsError = MediaListEventsErrors[keyof MediaListEventsErrors];
|
|
74618
|
-
export type MediaListEventsResponses = {
|
|
74619
|
-
/**
|
|
74620
|
-
* Successful response.
|
|
74621
|
-
*/
|
|
74622
|
-
200: MediaMediaEventPage;
|
|
74623
|
-
};
|
|
74624
|
-
export type MediaListEventsResponse = MediaListEventsResponses[keyof MediaListEventsResponses];
|
|
74625
|
-
export type MediaCreateDeliveryTokenData = {
|
|
74626
|
-
/**
|
|
74627
|
-
* Options for authorizing private asset delivery within one active library.
|
|
74628
|
-
*/
|
|
74629
|
-
body: {
|
|
74630
|
-
/**
|
|
74631
|
-
* Delivery path glob restricted to the library path prefix (a slash, library_id, then a slash). Defaults to that prefix followed by *; * matches any path text. Tildes and control characters are rejected.
|
|
74632
|
-
*/
|
|
74633
|
-
acl?: string;
|
|
74634
|
-
/**
|
|
74635
|
-
* Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 900.
|
|
74636
|
-
*/
|
|
74637
|
-
expires_in?: number;
|
|
74638
|
-
};
|
|
74639
|
-
path: {
|
|
74640
|
-
/**
|
|
74641
|
-
* Library ID returned by creation.
|
|
74642
|
-
*/
|
|
74643
|
-
library_id: string;
|
|
74644
|
-
};
|
|
74645
|
-
query?: never;
|
|
74646
|
-
url: '/media/v1/libraries/{library_id}/delivery_tokens';
|
|
74647
|
-
};
|
|
74648
|
-
export type MediaCreateDeliveryTokenErrors = {
|
|
74649
|
-
/**
|
|
74650
|
-
* Request failed; see the error code reference.
|
|
74651
|
-
*/
|
|
74652
|
-
400: MediaMediaError;
|
|
74653
|
-
/**
|
|
74654
|
-
* Request failed; see the error code reference.
|
|
74655
|
-
*/
|
|
74656
|
-
403: MediaMediaError;
|
|
74657
|
-
/**
|
|
74658
|
-
* Request failed; see the error code reference.
|
|
74659
|
-
*/
|
|
74660
|
-
404: MediaMediaError;
|
|
74661
|
-
/**
|
|
74662
|
-
* Request failed; see the error code reference.
|
|
74663
|
-
*/
|
|
74664
|
-
409: MediaMediaError;
|
|
74665
|
-
/**
|
|
74666
|
-
* Request failed; see the error code reference.
|
|
74667
|
-
*/
|
|
74668
|
-
413: MediaMediaError;
|
|
74669
|
-
/**
|
|
74670
|
-
* Request failed; see the error code reference.
|
|
74671
|
-
*/
|
|
74672
|
-
415: MediaMediaError;
|
|
74673
|
-
/**
|
|
74674
|
-
* Request failed; see the error code reference.
|
|
74675
|
-
*/
|
|
74676
|
-
429: MediaMediaError;
|
|
74677
|
-
/**
|
|
74678
|
-
* Request failed; see the error code reference.
|
|
74679
|
-
*/
|
|
74680
|
-
501: MediaMediaError;
|
|
74681
|
-
/**
|
|
74682
|
-
* Request failed; see the error code reference.
|
|
74683
|
-
*/
|
|
74684
|
-
502: MediaMediaError;
|
|
74685
|
-
/**
|
|
74686
|
-
* Request failed; see the error code reference.
|
|
74687
|
-
*/
|
|
74688
|
-
503: MediaMediaError;
|
|
74689
|
-
};
|
|
74690
|
-
export type MediaCreateDeliveryTokenError = MediaCreateDeliveryTokenErrors[keyof MediaCreateDeliveryTokenErrors];
|
|
74691
|
-
export type MediaCreateDeliveryTokenResponses = {
|
|
74692
|
-
/**
|
|
74693
|
-
* Successful response.
|
|
74694
|
-
*/
|
|
74695
|
-
200: MediaDeliveryToken;
|
|
74696
|
-
};
|
|
74697
|
-
export type MediaCreateDeliveryTokenResponse = MediaCreateDeliveryTokenResponses[keyof MediaCreateDeliveryTokenResponses];
|
|
74698
|
-
export type MediaUnderstandingFailureSummaryData = {
|
|
74699
|
-
body?: never;
|
|
74700
|
-
path: {
|
|
74701
|
-
/**
|
|
74702
|
-
* Library ID returned by creation.
|
|
74703
|
-
*/
|
|
74704
|
-
library_id: string;
|
|
74705
|
-
};
|
|
74706
|
-
query?: never;
|
|
74707
|
-
url: '/media/v1/libraries/{library_id}/understandings/failure_summary';
|
|
74708
|
-
};
|
|
74709
|
-
export type MediaUnderstandingFailureSummaryErrors = {
|
|
74710
76189
|
/**
|
|
74711
76190
|
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
74712
76191
|
*/
|
|
@@ -74731,6 +76210,234 @@ export type MediaUnderstandingFailureSummaryErrors = {
|
|
|
74731
76210
|
* This media format is unsupported; provide a supported format.
|
|
74732
76211
|
*/
|
|
74733
76212
|
415: MediaMediaError;
|
|
76213
|
+
/**
|
|
76214
|
+
* Request failed; see the error code reference.
|
|
76215
|
+
*/
|
|
76216
|
+
422: MediaMediaError;
|
|
76217
|
+
/**
|
|
76218
|
+
* A rate limit was reached; wait before retrying.
|
|
76219
|
+
*/
|
|
76220
|
+
429: MediaMediaError;
|
|
76221
|
+
/**
|
|
76222
|
+
* The requested operation is unsupported; choose a supported method.
|
|
76223
|
+
*/
|
|
76224
|
+
501: MediaMediaError;
|
|
76225
|
+
/**
|
|
76226
|
+
* Request failed; see the error code reference.
|
|
76227
|
+
*/
|
|
76228
|
+
502: MediaMediaError;
|
|
76229
|
+
/**
|
|
76230
|
+
* Historical projections are still being initialized, or library storage is temporarily unavailable; retry shortly and check failureSummary counts_complete.
|
|
76231
|
+
*/
|
|
76232
|
+
503: MediaMediaError;
|
|
76233
|
+
};
|
|
76234
|
+
export type MediaGetJobError = MediaGetJobErrors[keyof MediaGetJobErrors];
|
|
76235
|
+
export type MediaGetJobResponses = {
|
|
76236
|
+
/**
|
|
76237
|
+
* Successful response.
|
|
76238
|
+
*/
|
|
76239
|
+
200: MediaJob;
|
|
76240
|
+
};
|
|
76241
|
+
export type MediaGetJobResponse = MediaGetJobResponses[keyof MediaGetJobResponses];
|
|
76242
|
+
export type MediaListEventsData = {
|
|
76243
|
+
body?: never;
|
|
76244
|
+
path: {
|
|
76245
|
+
/**
|
|
76246
|
+
* Library ID returned by creation.
|
|
76247
|
+
*/
|
|
76248
|
+
library_id: string;
|
|
76249
|
+
};
|
|
76250
|
+
query?: {
|
|
76251
|
+
/**
|
|
76252
|
+
* Events with a larger sequence. Use with asc; cannot combine with before_seq.
|
|
76253
|
+
*/
|
|
76254
|
+
after_seq?: number;
|
|
76255
|
+
/**
|
|
76256
|
+
* Events with a smaller sequence. Use with desc; cannot combine with after_seq.
|
|
76257
|
+
*/
|
|
76258
|
+
before_seq?: number;
|
|
76259
|
+
/**
|
|
76260
|
+
* Sequence order: asc is increasing; desc is decreasing.
|
|
76261
|
+
*/
|
|
76262
|
+
order?: 'asc' | 'desc';
|
|
76263
|
+
/**
|
|
76264
|
+
* Maximum items per page, from 1 to 200; defaults to 50.
|
|
76265
|
+
*/
|
|
76266
|
+
limit?: number;
|
|
76267
|
+
};
|
|
76268
|
+
url: '/media/v1/libraries/{library_id}/events';
|
|
76269
|
+
};
|
|
76270
|
+
export type MediaListEventsErrors = {
|
|
76271
|
+
/**
|
|
76272
|
+
* Request failed; see the error code reference.
|
|
76273
|
+
*/
|
|
76274
|
+
400: MediaMediaError;
|
|
76275
|
+
/**
|
|
76276
|
+
* Request failed; see the error code reference.
|
|
76277
|
+
*/
|
|
76278
|
+
403: MediaMediaError;
|
|
76279
|
+
/**
|
|
76280
|
+
* Request failed; see the error code reference.
|
|
76281
|
+
*/
|
|
76282
|
+
404: MediaMediaError;
|
|
76283
|
+
/**
|
|
76284
|
+
* Request failed; see the error code reference.
|
|
76285
|
+
*/
|
|
76286
|
+
409: MediaMediaError;
|
|
76287
|
+
/**
|
|
76288
|
+
* Request failed; see the error code reference.
|
|
76289
|
+
*/
|
|
76290
|
+
413: MediaMediaError;
|
|
76291
|
+
/**
|
|
76292
|
+
* Request failed; see the error code reference.
|
|
76293
|
+
*/
|
|
76294
|
+
415: MediaMediaError;
|
|
76295
|
+
/**
|
|
76296
|
+
* Request failed; see the error code reference.
|
|
76297
|
+
*/
|
|
76298
|
+
422: MediaMediaError;
|
|
76299
|
+
/**
|
|
76300
|
+
* Request failed; see the error code reference.
|
|
76301
|
+
*/
|
|
76302
|
+
429: MediaMediaError;
|
|
76303
|
+
/**
|
|
76304
|
+
* Request failed; see the error code reference.
|
|
76305
|
+
*/
|
|
76306
|
+
501: MediaMediaError;
|
|
76307
|
+
/**
|
|
76308
|
+
* Request failed; see the error code reference.
|
|
76309
|
+
*/
|
|
76310
|
+
502: MediaMediaError;
|
|
76311
|
+
/**
|
|
76312
|
+
* Request failed; see the error code reference.
|
|
76313
|
+
*/
|
|
76314
|
+
503: MediaMediaError;
|
|
76315
|
+
};
|
|
76316
|
+
export type MediaListEventsError = MediaListEventsErrors[keyof MediaListEventsErrors];
|
|
76317
|
+
export type MediaListEventsResponses = {
|
|
76318
|
+
/**
|
|
76319
|
+
* Successful response.
|
|
76320
|
+
*/
|
|
76321
|
+
200: MediaMediaEventPage;
|
|
76322
|
+
};
|
|
76323
|
+
export type MediaListEventsResponse = MediaListEventsResponses[keyof MediaListEventsResponses];
|
|
76324
|
+
export type MediaCreateDeliveryTokenData = {
|
|
76325
|
+
/**
|
|
76326
|
+
* Options for authorizing private asset delivery within one active library.
|
|
76327
|
+
*/
|
|
76328
|
+
body: {
|
|
76329
|
+
/**
|
|
76330
|
+
* Delivery path glob restricted to the library path prefix (a slash, library_id, then a slash). Defaults to that prefix followed by *; * matches any path text. Tildes and control characters are rejected.
|
|
76331
|
+
*/
|
|
76332
|
+
acl?: string;
|
|
76333
|
+
/**
|
|
76334
|
+
* Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 900.
|
|
76335
|
+
*/
|
|
76336
|
+
expires_in?: number;
|
|
76337
|
+
};
|
|
76338
|
+
path: {
|
|
76339
|
+
/**
|
|
76340
|
+
* Library ID returned by creation.
|
|
76341
|
+
*/
|
|
76342
|
+
library_id: string;
|
|
76343
|
+
};
|
|
76344
|
+
query?: never;
|
|
76345
|
+
url: '/media/v1/libraries/{library_id}/delivery_tokens';
|
|
76346
|
+
};
|
|
76347
|
+
export type MediaCreateDeliveryTokenErrors = {
|
|
76348
|
+
/**
|
|
76349
|
+
* Request failed; see the error code reference.
|
|
76350
|
+
*/
|
|
76351
|
+
400: MediaMediaError;
|
|
76352
|
+
/**
|
|
76353
|
+
* Request failed; see the error code reference.
|
|
76354
|
+
*/
|
|
76355
|
+
403: MediaMediaError;
|
|
76356
|
+
/**
|
|
76357
|
+
* Request failed; see the error code reference.
|
|
76358
|
+
*/
|
|
76359
|
+
404: MediaMediaError;
|
|
76360
|
+
/**
|
|
76361
|
+
* Request failed; see the error code reference.
|
|
76362
|
+
*/
|
|
76363
|
+
409: MediaMediaError;
|
|
76364
|
+
/**
|
|
76365
|
+
* Request failed; see the error code reference.
|
|
76366
|
+
*/
|
|
76367
|
+
413: MediaMediaError;
|
|
76368
|
+
/**
|
|
76369
|
+
* Request failed; see the error code reference.
|
|
76370
|
+
*/
|
|
76371
|
+
415: MediaMediaError;
|
|
76372
|
+
/**
|
|
76373
|
+
* Request failed; see the error code reference.
|
|
76374
|
+
*/
|
|
76375
|
+
422: MediaMediaError;
|
|
76376
|
+
/**
|
|
76377
|
+
* Request failed; see the error code reference.
|
|
76378
|
+
*/
|
|
76379
|
+
429: MediaMediaError;
|
|
76380
|
+
/**
|
|
76381
|
+
* Request failed; see the error code reference.
|
|
76382
|
+
*/
|
|
76383
|
+
501: MediaMediaError;
|
|
76384
|
+
/**
|
|
76385
|
+
* Request failed; see the error code reference.
|
|
76386
|
+
*/
|
|
76387
|
+
502: MediaMediaError;
|
|
76388
|
+
/**
|
|
76389
|
+
* Request failed; see the error code reference.
|
|
76390
|
+
*/
|
|
76391
|
+
503: MediaMediaError;
|
|
76392
|
+
};
|
|
76393
|
+
export type MediaCreateDeliveryTokenError = MediaCreateDeliveryTokenErrors[keyof MediaCreateDeliveryTokenErrors];
|
|
76394
|
+
export type MediaCreateDeliveryTokenResponses = {
|
|
76395
|
+
/**
|
|
76396
|
+
* Successful response.
|
|
76397
|
+
*/
|
|
76398
|
+
200: MediaDeliveryToken;
|
|
76399
|
+
};
|
|
76400
|
+
export type MediaCreateDeliveryTokenResponse = MediaCreateDeliveryTokenResponses[keyof MediaCreateDeliveryTokenResponses];
|
|
76401
|
+
export type MediaUnderstandingFailureSummaryData = {
|
|
76402
|
+
body?: never;
|
|
76403
|
+
path: {
|
|
76404
|
+
/**
|
|
76405
|
+
* Library ID returned by creation.
|
|
76406
|
+
*/
|
|
76407
|
+
library_id: string;
|
|
76408
|
+
};
|
|
76409
|
+
query?: never;
|
|
76410
|
+
url: '/media/v1/libraries/{library_id}/understandings/failure_summary';
|
|
76411
|
+
};
|
|
76412
|
+
export type MediaUnderstandingFailureSummaryErrors = {
|
|
76413
|
+
/**
|
|
76414
|
+
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
76415
|
+
*/
|
|
76416
|
+
400: MediaMediaError;
|
|
76417
|
+
/**
|
|
76418
|
+
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
76419
|
+
*/
|
|
76420
|
+
403: MediaMediaError;
|
|
76421
|
+
/**
|
|
76422
|
+
* The library or asset is missing, deleted or belongs to another tenant; verify its identifier and owner.
|
|
76423
|
+
*/
|
|
76424
|
+
404: MediaMediaError;
|
|
76425
|
+
/**
|
|
76426
|
+
* Request failed; see the error code reference.
|
|
76427
|
+
*/
|
|
76428
|
+
409: MediaMediaError;
|
|
76429
|
+
/**
|
|
76430
|
+
* The file exceeds an input limit; provide a smaller source file.
|
|
76431
|
+
*/
|
|
76432
|
+
413: MediaMediaError;
|
|
76433
|
+
/**
|
|
76434
|
+
* This media format is unsupported; provide a supported format.
|
|
76435
|
+
*/
|
|
76436
|
+
415: MediaMediaError;
|
|
76437
|
+
/**
|
|
76438
|
+
* Request failed; see the error code reference.
|
|
76439
|
+
*/
|
|
76440
|
+
422: MediaMediaError;
|
|
74734
76441
|
/**
|
|
74735
76442
|
* A rate limit was reached; wait before retrying.
|
|
74736
76443
|
*/
|
|
@@ -74770,7 +76477,7 @@ export type MediaListUnderstandingsByLibraryData = {
|
|
|
74770
76477
|
*/
|
|
74771
76478
|
folder?: string;
|
|
74772
76479
|
/**
|
|
74773
|
-
* Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind.
|
|
76480
|
+
* Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, loudness, beats, content, embedding. Omit or empty to include every kind.
|
|
74774
76481
|
*/
|
|
74775
76482
|
kinds?: string;
|
|
74776
76483
|
/**
|
|
@@ -74809,6 +76516,10 @@ export type MediaListUnderstandingsByLibraryErrors = {
|
|
|
74809
76516
|
* This media format is unsupported; provide a supported format.
|
|
74810
76517
|
*/
|
|
74811
76518
|
415: MediaMediaError;
|
|
76519
|
+
/**
|
|
76520
|
+
* Request failed; see the error code reference.
|
|
76521
|
+
*/
|
|
76522
|
+
422: MediaMediaError;
|
|
74812
76523
|
/**
|
|
74813
76524
|
* A rate limit was reached; wait before retrying.
|
|
74814
76525
|
*/
|
|
@@ -74834,6 +76545,1065 @@ export type MediaListUnderstandingsByLibraryResponses = {
|
|
|
74834
76545
|
200: MediaUnderstandingPage;
|
|
74835
76546
|
};
|
|
74836
76547
|
export type MediaListUnderstandingsByLibraryResponse = MediaListUnderstandingsByLibraryResponses[keyof MediaListUnderstandingsByLibraryResponses];
|
|
76548
|
+
export type MediaCreateGenerationData = {
|
|
76549
|
+
/**
|
|
76550
|
+
* Text-to-video request. Generation is charged per second; unsaved candidates expire after 7 days.
|
|
76551
|
+
*/
|
|
76552
|
+
body: {
|
|
76553
|
+
/**
|
|
76554
|
+
* Generation operation; v1 accepts only video.generate text-to-video requests.
|
|
76555
|
+
*/
|
|
76556
|
+
intent: 'video.generate';
|
|
76557
|
+
/**
|
|
76558
|
+
* Text prompt describing the video to generate.
|
|
76559
|
+
*/
|
|
76560
|
+
prompt: string;
|
|
76561
|
+
/**
|
|
76562
|
+
* Number of videos to generate; defaults to 1 and must be from 1 to 4.
|
|
76563
|
+
*/
|
|
76564
|
+
count?: number;
|
|
76565
|
+
/**
|
|
76566
|
+
* Requested video duration in seconds; Router validates the model-specific supported durations.
|
|
76567
|
+
*/
|
|
76568
|
+
duration_seconds?: number;
|
|
76569
|
+
/**
|
|
76570
|
+
* Requested output aspect ratio; defaults to 16:9 and Router validates model support.
|
|
76571
|
+
*/
|
|
76572
|
+
aspect_ratio?: string;
|
|
76573
|
+
/**
|
|
76574
|
+
* Router model with video_generation capability; defaults to wan2.7-t2v.
|
|
76575
|
+
*/
|
|
76576
|
+
model?: string;
|
|
76577
|
+
/**
|
|
76578
|
+
* candidate keeps outputs temporary for explicit save calls; library saves successful outputs automatically.
|
|
76579
|
+
*/
|
|
76580
|
+
save?: 'candidate' | 'library';
|
|
76581
|
+
/**
|
|
76582
|
+
* Folder for assets saved automatically or by later save calls; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.
|
|
76583
|
+
*/
|
|
76584
|
+
asset_folder?: string;
|
|
76585
|
+
/**
|
|
76586
|
+
* Tags applied when an output becomes a library asset.
|
|
76587
|
+
*/
|
|
76588
|
+
tags?: Array<string>;
|
|
76589
|
+
/**
|
|
76590
|
+
* Understanding behavior when a candidate is saved as an asset; defaults to auto.
|
|
76591
|
+
*/
|
|
76592
|
+
understanding?: 'auto' | 'skip';
|
|
76593
|
+
/**
|
|
76594
|
+
* Not supported in v1; omit this field. Only text-to-video is currently available.
|
|
76595
|
+
*/
|
|
76596
|
+
references?: Array<unknown>;
|
|
76597
|
+
};
|
|
76598
|
+
headers?: {
|
|
76599
|
+
/**
|
|
76600
|
+
* Stable key for retrying the same request without creating or charging for another job; reusing it with different request content is rejected.
|
|
76601
|
+
*/
|
|
76602
|
+
'Idempotency-Key'?: string;
|
|
76603
|
+
};
|
|
76604
|
+
path: {
|
|
76605
|
+
/**
|
|
76606
|
+
* Library ID returned by creation.
|
|
76607
|
+
*/
|
|
76608
|
+
library_id: string;
|
|
76609
|
+
};
|
|
76610
|
+
query?: never;
|
|
76611
|
+
url: '/media/v1/libraries/{library_id}/generations';
|
|
76612
|
+
};
|
|
76613
|
+
export type MediaCreateGenerationErrors = {
|
|
76614
|
+
/**
|
|
76615
|
+
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
76616
|
+
*/
|
|
76617
|
+
400: MediaMediaError;
|
|
76618
|
+
/**
|
|
76619
|
+
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
76620
|
+
*/
|
|
76621
|
+
403: MediaMediaError;
|
|
76622
|
+
/**
|
|
76623
|
+
* The library or asset is missing, deleted or belongs to another tenant; verify its identifier and owner.
|
|
76624
|
+
*/
|
|
76625
|
+
404: MediaMediaError;
|
|
76626
|
+
/**
|
|
76627
|
+
* Request failed; see the error code reference.
|
|
76628
|
+
*/
|
|
76629
|
+
409: MediaMediaError;
|
|
76630
|
+
/**
|
|
76631
|
+
* The file exceeds an input limit; provide a smaller source file.
|
|
76632
|
+
*/
|
|
76633
|
+
413: MediaMediaError;
|
|
76634
|
+
/**
|
|
76635
|
+
* This media format is unsupported; provide a supported format.
|
|
76636
|
+
*/
|
|
76637
|
+
415: MediaMediaError;
|
|
76638
|
+
/**
|
|
76639
|
+
* Request failed; see the error code reference.
|
|
76640
|
+
*/
|
|
76641
|
+
422: MediaMediaError;
|
|
76642
|
+
/**
|
|
76643
|
+
* This library already has five queued or running generation jobs; wait until one finishes and retry.
|
|
76644
|
+
*/
|
|
76645
|
+
429: MediaMediaError;
|
|
76646
|
+
/**
|
|
76647
|
+
* The requested operation is unsupported; choose a supported method.
|
|
76648
|
+
*/
|
|
76649
|
+
501: MediaMediaError;
|
|
76650
|
+
/**
|
|
76651
|
+
* Request failed; see the error code reference.
|
|
76652
|
+
*/
|
|
76653
|
+
502: MediaMediaError;
|
|
76654
|
+
/**
|
|
76655
|
+
* Historical projections are still being initialized, or library storage is temporarily unavailable; retry shortly and check failureSummary counts_complete.
|
|
76656
|
+
*/
|
|
76657
|
+
503: MediaMediaError;
|
|
76658
|
+
};
|
|
76659
|
+
export type MediaCreateGenerationError = MediaCreateGenerationErrors[keyof MediaCreateGenerationErrors];
|
|
76660
|
+
export type MediaCreateGenerationResponses = {
|
|
76661
|
+
/**
|
|
76662
|
+
* Successful response.
|
|
76663
|
+
*/
|
|
76664
|
+
202: MediaJob;
|
|
76665
|
+
};
|
|
76666
|
+
export type MediaCreateGenerationResponse = MediaCreateGenerationResponses[keyof MediaCreateGenerationResponses];
|
|
76667
|
+
export type MediaListJobsData = {
|
|
76668
|
+
body?: never;
|
|
76669
|
+
path: {
|
|
76670
|
+
/**
|
|
76671
|
+
* Library ID returned by creation.
|
|
76672
|
+
*/
|
|
76673
|
+
library_id: string;
|
|
76674
|
+
};
|
|
76675
|
+
query?: {
|
|
76676
|
+
/**
|
|
76677
|
+
* Filter jobs by their current status.
|
|
76678
|
+
*/
|
|
76679
|
+
status?: MediaJobStatus;
|
|
76680
|
+
/**
|
|
76681
|
+
* Maximum entries in this page, from 1 through 100; defaults to 100.
|
|
76682
|
+
*/
|
|
76683
|
+
limit?: number;
|
|
76684
|
+
/**
|
|
76685
|
+
* Job id from the previous page’s next_cursor; omit for the first page.
|
|
76686
|
+
*/
|
|
76687
|
+
cursor?: MediaJobId;
|
|
76688
|
+
};
|
|
76689
|
+
url: '/media/v1/libraries/{library_id}/jobs';
|
|
76690
|
+
};
|
|
76691
|
+
export type MediaListJobsErrors = {
|
|
76692
|
+
/**
|
|
76693
|
+
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
76694
|
+
*/
|
|
76695
|
+
400: MediaMediaError;
|
|
76696
|
+
/**
|
|
76697
|
+
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
76698
|
+
*/
|
|
76699
|
+
403: MediaMediaError;
|
|
76700
|
+
/**
|
|
76701
|
+
* The library or asset is missing, deleted or belongs to another tenant; verify its identifier and owner.
|
|
76702
|
+
*/
|
|
76703
|
+
404: MediaMediaError;
|
|
76704
|
+
/**
|
|
76705
|
+
* Request failed; see the error code reference.
|
|
76706
|
+
*/
|
|
76707
|
+
409: MediaMediaError;
|
|
76708
|
+
/**
|
|
76709
|
+
* The file exceeds an input limit; provide a smaller source file.
|
|
76710
|
+
*/
|
|
76711
|
+
413: MediaMediaError;
|
|
76712
|
+
/**
|
|
76713
|
+
* This media format is unsupported; provide a supported format.
|
|
76714
|
+
*/
|
|
76715
|
+
415: MediaMediaError;
|
|
76716
|
+
/**
|
|
76717
|
+
* Request failed; see the error code reference.
|
|
76718
|
+
*/
|
|
76719
|
+
422: MediaMediaError;
|
|
76720
|
+
/**
|
|
76721
|
+
* A rate limit was reached; wait before retrying.
|
|
76722
|
+
*/
|
|
76723
|
+
429: MediaMediaError;
|
|
76724
|
+
/**
|
|
76725
|
+
* The requested operation is unsupported; choose a supported method.
|
|
76726
|
+
*/
|
|
76727
|
+
501: MediaMediaError;
|
|
76728
|
+
/**
|
|
76729
|
+
* Request failed; see the error code reference.
|
|
76730
|
+
*/
|
|
76731
|
+
502: MediaMediaError;
|
|
76732
|
+
/**
|
|
76733
|
+
* Historical projections are still being initialized, or library storage is temporarily unavailable; retry shortly and check failureSummary counts_complete.
|
|
76734
|
+
*/
|
|
76735
|
+
503: MediaMediaError;
|
|
76736
|
+
};
|
|
76737
|
+
export type MediaListJobsError = MediaListJobsErrors[keyof MediaListJobsErrors];
|
|
76738
|
+
export type MediaListJobsResponses = {
|
|
76739
|
+
/**
|
|
76740
|
+
* Successful response.
|
|
76741
|
+
*/
|
|
76742
|
+
200: MediaJobPage;
|
|
76743
|
+
};
|
|
76744
|
+
export type MediaListJobsResponse = MediaListJobsResponses[keyof MediaListJobsResponses];
|
|
76745
|
+
export type MediaCancelJobData = {
|
|
76746
|
+
body?: never;
|
|
76747
|
+
path: {
|
|
76748
|
+
/**
|
|
76749
|
+
* Library ID returned by creation.
|
|
76750
|
+
*/
|
|
76751
|
+
library_id: string;
|
|
76752
|
+
/**
|
|
76753
|
+
* Job identifier returned by batch or generation creation; the job is resolved within the specified library.
|
|
76754
|
+
*/
|
|
76755
|
+
job_id: string;
|
|
76756
|
+
};
|
|
76757
|
+
query?: never;
|
|
76758
|
+
url: '/media/v1/libraries/{library_id}/jobs/{job_id}/cancel';
|
|
76759
|
+
};
|
|
76760
|
+
export type MediaCancelJobErrors = {
|
|
76761
|
+
/**
|
|
76762
|
+
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
76763
|
+
*/
|
|
76764
|
+
400: MediaMediaError;
|
|
76765
|
+
/**
|
|
76766
|
+
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
76767
|
+
*/
|
|
76768
|
+
403: MediaMediaError;
|
|
76769
|
+
/**
|
|
76770
|
+
* The library or asset is missing, deleted or belongs to another tenant; verify its identifier and owner.
|
|
76771
|
+
*/
|
|
76772
|
+
404: MediaMediaError;
|
|
76773
|
+
/**
|
|
76774
|
+
* Request failed; see the error code reference.
|
|
76775
|
+
*/
|
|
76776
|
+
409: MediaMediaError;
|
|
76777
|
+
/**
|
|
76778
|
+
* The file exceeds an input limit; provide a smaller source file.
|
|
76779
|
+
*/
|
|
76780
|
+
413: MediaMediaError;
|
|
76781
|
+
/**
|
|
76782
|
+
* This media format is unsupported; provide a supported format.
|
|
76783
|
+
*/
|
|
76784
|
+
415: MediaMediaError;
|
|
76785
|
+
/**
|
|
76786
|
+
* Request failed; see the error code reference.
|
|
76787
|
+
*/
|
|
76788
|
+
422: MediaMediaError;
|
|
76789
|
+
/**
|
|
76790
|
+
* A rate limit was reached; wait before retrying.
|
|
76791
|
+
*/
|
|
76792
|
+
429: MediaMediaError;
|
|
76793
|
+
/**
|
|
76794
|
+
* The requested operation is unsupported; choose a supported method.
|
|
76795
|
+
*/
|
|
76796
|
+
501: MediaMediaError;
|
|
76797
|
+
/**
|
|
76798
|
+
* Request failed; see the error code reference.
|
|
76799
|
+
*/
|
|
76800
|
+
502: MediaMediaError;
|
|
76801
|
+
/**
|
|
76802
|
+
* Historical projections are still being initialized, or library storage is temporarily unavailable; retry shortly and check failureSummary counts_complete.
|
|
76803
|
+
*/
|
|
76804
|
+
503: MediaMediaError;
|
|
76805
|
+
};
|
|
76806
|
+
export type MediaCancelJobError = MediaCancelJobErrors[keyof MediaCancelJobErrors];
|
|
76807
|
+
export type MediaCancelJobResponses = {
|
|
76808
|
+
/**
|
|
76809
|
+
* Successful response.
|
|
76810
|
+
*/
|
|
76811
|
+
200: MediaJob;
|
|
76812
|
+
};
|
|
76813
|
+
export type MediaCancelJobResponse = MediaCancelJobResponses[keyof MediaCancelJobResponses];
|
|
76814
|
+
export type MediaSaveGenerationOutputData = {
|
|
76815
|
+
/**
|
|
76816
|
+
* Optional asset metadata and understanding behavior for a successful candidate.
|
|
76817
|
+
*/
|
|
76818
|
+
body?: {
|
|
76819
|
+
/**
|
|
76820
|
+
* Delivery identifier for the saved asset; defaults to gen_<job_id>_<index> and is idempotent.
|
|
76821
|
+
*/
|
|
76822
|
+
public_id?: string;
|
|
76823
|
+
/**
|
|
76824
|
+
* Destination folder for the saved asset; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.
|
|
76825
|
+
*/
|
|
76826
|
+
asset_folder?: string;
|
|
76827
|
+
/**
|
|
76828
|
+
* Tags to apply to the saved asset.
|
|
76829
|
+
*/
|
|
76830
|
+
tags?: Array<string>;
|
|
76831
|
+
/**
|
|
76832
|
+
* Understanding behavior for the saved asset; defaults to auto.
|
|
76833
|
+
*/
|
|
76834
|
+
understanding?: 'auto' | 'skip';
|
|
76835
|
+
};
|
|
76836
|
+
path: {
|
|
76837
|
+
/**
|
|
76838
|
+
* Library ID returned by creation.
|
|
76839
|
+
*/
|
|
76840
|
+
library_id: string;
|
|
76841
|
+
/**
|
|
76842
|
+
* Job identifier returned by batch or generation creation; the job is resolved within the specified library.
|
|
76843
|
+
*/
|
|
76844
|
+
job_id: string;
|
|
76845
|
+
/**
|
|
76846
|
+
* Zero-based position of the candidate in the Job outputs array.
|
|
76847
|
+
*/
|
|
76848
|
+
index: string;
|
|
76849
|
+
};
|
|
76850
|
+
query?: never;
|
|
76851
|
+
url: '/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save';
|
|
76852
|
+
};
|
|
76853
|
+
export type MediaSaveGenerationOutputErrors = {
|
|
76854
|
+
/**
|
|
76855
|
+
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
76856
|
+
*/
|
|
76857
|
+
400: MediaMediaError;
|
|
76858
|
+
/**
|
|
76859
|
+
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
76860
|
+
*/
|
|
76861
|
+
403: MediaMediaError;
|
|
76862
|
+
/**
|
|
76863
|
+
* The job or output is inaccessible, missing, or the candidate has expired; verify library ownership and create a new job for an expired candidate.
|
|
76864
|
+
*/
|
|
76865
|
+
404: MediaMediaError;
|
|
76866
|
+
/**
|
|
76867
|
+
* Request failed; see the error code reference.
|
|
76868
|
+
*/
|
|
76869
|
+
409: MediaMediaError;
|
|
76870
|
+
/**
|
|
76871
|
+
* The file exceeds an input limit; provide a smaller source file.
|
|
76872
|
+
*/
|
|
76873
|
+
413: MediaMediaError;
|
|
76874
|
+
/**
|
|
76875
|
+
* This media format is unsupported; provide a supported format.
|
|
76876
|
+
*/
|
|
76877
|
+
415: MediaMediaError;
|
|
76878
|
+
/**
|
|
76879
|
+
* Request failed; see the error code reference.
|
|
76880
|
+
*/
|
|
76881
|
+
422: MediaMediaError;
|
|
76882
|
+
/**
|
|
76883
|
+
* A rate limit was reached; wait before retrying.
|
|
76884
|
+
*/
|
|
76885
|
+
429: MediaMediaError;
|
|
76886
|
+
/**
|
|
76887
|
+
* The requested operation is unsupported; choose a supported method.
|
|
76888
|
+
*/
|
|
76889
|
+
501: MediaMediaError;
|
|
76890
|
+
/**
|
|
76891
|
+
* Request failed; see the error code reference.
|
|
76892
|
+
*/
|
|
76893
|
+
502: MediaMediaError;
|
|
76894
|
+
/**
|
|
76895
|
+
* Historical projections are still being initialized, or library storage is temporarily unavailable; retry shortly and check failureSummary counts_complete.
|
|
76896
|
+
*/
|
|
76897
|
+
503: MediaMediaError;
|
|
76898
|
+
};
|
|
76899
|
+
export type MediaSaveGenerationOutputError = MediaSaveGenerationOutputErrors[keyof MediaSaveGenerationOutputErrors];
|
|
76900
|
+
export type MediaSaveGenerationOutputResponses = {
|
|
76901
|
+
/**
|
|
76902
|
+
* Successful response.
|
|
76903
|
+
*/
|
|
76904
|
+
200: MediaAsset;
|
|
76905
|
+
};
|
|
76906
|
+
export type MediaSaveGenerationOutputResponse = MediaSaveGenerationOutputResponses[keyof MediaSaveGenerationOutputResponses];
|
|
76907
|
+
export type MediaGetGenerationCapabilitiesData = {
|
|
76908
|
+
body?: never;
|
|
76909
|
+
path?: never;
|
|
76910
|
+
query?: never;
|
|
76911
|
+
url: '/media/v1/generation/capabilities';
|
|
76912
|
+
};
|
|
76913
|
+
export type MediaGetGenerationCapabilitiesErrors = {
|
|
76914
|
+
/**
|
|
76915
|
+
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
76916
|
+
*/
|
|
76917
|
+
400: MediaMediaError;
|
|
76918
|
+
/**
|
|
76919
|
+
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
76920
|
+
*/
|
|
76921
|
+
403: MediaMediaError;
|
|
76922
|
+
/**
|
|
76923
|
+
* The library or asset is missing, deleted or belongs to another tenant; verify its identifier and owner.
|
|
76924
|
+
*/
|
|
76925
|
+
404: MediaMediaError;
|
|
76926
|
+
/**
|
|
76927
|
+
* Request failed; see the error code reference.
|
|
76928
|
+
*/
|
|
76929
|
+
409: MediaMediaError;
|
|
76930
|
+
/**
|
|
76931
|
+
* The file exceeds an input limit; provide a smaller source file.
|
|
76932
|
+
*/
|
|
76933
|
+
413: MediaMediaError;
|
|
76934
|
+
/**
|
|
76935
|
+
* This media format is unsupported; provide a supported format.
|
|
76936
|
+
*/
|
|
76937
|
+
415: MediaMediaError;
|
|
76938
|
+
/**
|
|
76939
|
+
* Request failed; see the error code reference.
|
|
76940
|
+
*/
|
|
76941
|
+
422: MediaMediaError;
|
|
76942
|
+
/**
|
|
76943
|
+
* A rate limit was reached; wait before retrying.
|
|
76944
|
+
*/
|
|
76945
|
+
429: MediaMediaError;
|
|
76946
|
+
/**
|
|
76947
|
+
* The requested operation is unsupported; choose a supported method.
|
|
76948
|
+
*/
|
|
76949
|
+
501: MediaMediaError;
|
|
76950
|
+
/**
|
|
76951
|
+
* Request failed; see the error code reference.
|
|
76952
|
+
*/
|
|
76953
|
+
502: MediaMediaError;
|
|
76954
|
+
/**
|
|
76955
|
+
* Historical projections are still being initialized, or library storage is temporarily unavailable; retry shortly and check failureSummary counts_complete.
|
|
76956
|
+
*/
|
|
76957
|
+
503: MediaMediaError;
|
|
76958
|
+
};
|
|
76959
|
+
export type MediaGetGenerationCapabilitiesError = MediaGetGenerationCapabilitiesErrors[keyof MediaGetGenerationCapabilitiesErrors];
|
|
76960
|
+
export type MediaGetGenerationCapabilitiesResponses = {
|
|
76961
|
+
/**
|
|
76962
|
+
* Successful response.
|
|
76963
|
+
*/
|
|
76964
|
+
200: MediaGenerationCapabilities;
|
|
76965
|
+
};
|
|
76966
|
+
export type MediaGetGenerationCapabilitiesResponse = MediaGetGenerationCapabilitiesResponses[keyof MediaGetGenerationCapabilitiesResponses];
|
|
76967
|
+
export type OntologyListTypesData = {
|
|
76968
|
+
body?: never;
|
|
76969
|
+
path?: never;
|
|
76970
|
+
query?: never;
|
|
76971
|
+
url: '/ontology/v1/types';
|
|
76972
|
+
};
|
|
76973
|
+
export type OntologyListTypesErrors = {
|
|
76974
|
+
/**
|
|
76975
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
76976
|
+
*/
|
|
76977
|
+
401: OntologyOntologyError;
|
|
76978
|
+
/**
|
|
76979
|
+
* The API key lacks permission for this operation, or carries no organization; use a key with the required ontology access in the owning organization.
|
|
76980
|
+
*/
|
|
76981
|
+
403: OntologyOntologyError;
|
|
76982
|
+
/**
|
|
76983
|
+
* INTERNAL means the service could not complete the request; before retrying a write, read the graph back so a partially applied change is not sent twice.
|
|
76984
|
+
*/
|
|
76985
|
+
500: OntologyOntologyError;
|
|
76986
|
+
};
|
|
76987
|
+
export type OntologyListTypesError = OntologyListTypesErrors[keyof OntologyListTypesErrors];
|
|
76988
|
+
export type OntologyListTypesResponses = {
|
|
76989
|
+
/**
|
|
76990
|
+
* Every registration in force for this organization, in registration order.
|
|
76991
|
+
*/
|
|
76992
|
+
200: OntologyTypeRegistrationPage;
|
|
76993
|
+
};
|
|
76994
|
+
export type OntologyListTypesResponse = OntologyListTypesResponses[keyof OntologyListTypesResponses];
|
|
76995
|
+
export type OntologyRegisterTypeData = {
|
|
76996
|
+
/**
|
|
76997
|
+
* The registration to add; the same shape one registrant ships as its ontology.types.json.
|
|
76998
|
+
*/
|
|
76999
|
+
body: OntologyTypeRegistration;
|
|
77000
|
+
path?: never;
|
|
77001
|
+
query?: never;
|
|
77002
|
+
url: '/ontology/v1/types';
|
|
77003
|
+
};
|
|
77004
|
+
export type OntologyRegisterTypeErrors = {
|
|
77005
|
+
/**
|
|
77006
|
+
* INVALID_PARAMS means a field, query value, header or identifier violates the documented format or range — a missing Idempotency-Key, an unknown direction, a non-numeric limit. Correct the indicated input; the message names what was wrong.
|
|
77007
|
+
*/
|
|
77008
|
+
400: OntologyOntologyError;
|
|
77009
|
+
/**
|
|
77010
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
77011
|
+
*/
|
|
77012
|
+
401: OntologyOntologyError;
|
|
77013
|
+
/**
|
|
77014
|
+
* The API key lacks permission for this operation, or carries no organization; use a key with the required ontology access in the owning organization.
|
|
77015
|
+
*/
|
|
77016
|
+
403: OntologyOntologyError;
|
|
77017
|
+
/**
|
|
77018
|
+
* INTERNAL means the service could not complete the request; before retrying a write, read the graph back so a partially applied change is not sent twice.
|
|
77019
|
+
*/
|
|
77020
|
+
500: OntologyOntologyError;
|
|
77021
|
+
/**
|
|
77022
|
+
* NOT_IMPLEMENTED means runtime registration is not open; the deploy gate registers types. Nothing was written.
|
|
77023
|
+
*/
|
|
77024
|
+
501: OntologyOntologyError;
|
|
77025
|
+
};
|
|
77026
|
+
export type OntologyRegisterTypeError = OntologyRegisterTypeErrors[keyof OntologyRegisterTypeErrors];
|
|
77027
|
+
export type OntologyRetrieveTypeData = {
|
|
77028
|
+
body?: never;
|
|
77029
|
+
path: {
|
|
77030
|
+
/**
|
|
77031
|
+
* A type name from types.list, with its dots preserved — a display label is not accepted.
|
|
77032
|
+
*/
|
|
77033
|
+
name: string;
|
|
77034
|
+
};
|
|
77035
|
+
query?: never;
|
|
77036
|
+
url: '/ontology/v1/types/{name}';
|
|
77037
|
+
};
|
|
77038
|
+
export type OntologyRetrieveTypeErrors = {
|
|
77039
|
+
/**
|
|
77040
|
+
* ONTOLOGY_TYPE_UNKNOWN means the named type is not registered for this organization; call types.list for the names in force before writing records of it.
|
|
77041
|
+
*/
|
|
77042
|
+
400: OntologyOntologyError;
|
|
77043
|
+
/**
|
|
77044
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
77045
|
+
*/
|
|
77046
|
+
401: OntologyOntologyError;
|
|
77047
|
+
/**
|
|
77048
|
+
* The API key lacks permission for this operation, or carries no organization; use a key with the required ontology access in the owning organization.
|
|
77049
|
+
*/
|
|
77050
|
+
403: OntologyOntologyError;
|
|
77051
|
+
/**
|
|
77052
|
+
* INTERNAL means the service could not complete the request; before retrying a write, read the graph back so a partially applied change is not sent twice.
|
|
77053
|
+
*/
|
|
77054
|
+
500: OntologyOntologyError;
|
|
77055
|
+
};
|
|
77056
|
+
export type OntologyRetrieveTypeError = OntologyRetrieveTypeErrors[keyof OntologyRetrieveTypeErrors];
|
|
77057
|
+
export type OntologyRetrieveTypeResponses = {
|
|
77058
|
+
/**
|
|
77059
|
+
* The registration that carries this type, with its kind and definition.
|
|
77060
|
+
*/
|
|
77061
|
+
200: OntologyTypeLookup;
|
|
77062
|
+
};
|
|
77063
|
+
export type OntologyRetrieveTypeResponse = OntologyRetrieveTypeResponses[keyof OntologyRetrieveTypeResponses];
|
|
77064
|
+
export type OntologyListNodesData = {
|
|
77065
|
+
body?: never;
|
|
77066
|
+
path?: never;
|
|
77067
|
+
query?: {
|
|
77068
|
+
/**
|
|
77069
|
+
* Repeat to filter to any of several registered node type names, for example type=file&type=ticket; omit to list every type.
|
|
77070
|
+
*/
|
|
77071
|
+
type?: Array<string>;
|
|
77072
|
+
/**
|
|
77073
|
+
* Free text matched against node names, aliases and descriptions; omit to list without a text filter.
|
|
77074
|
+
*/
|
|
77075
|
+
q?: string;
|
|
77076
|
+
/**
|
|
77077
|
+
* Filter to nodes owned by this member id, or omit to list nodes of every owner; organization-wide nodes carry no owner.
|
|
77078
|
+
*/
|
|
77079
|
+
owner?: string;
|
|
77080
|
+
/**
|
|
77081
|
+
* ISO 8601 timestamp; return the graph as it was then, so a node recorded later is absent. Omit to read current state.
|
|
77082
|
+
*/
|
|
77083
|
+
as_of?: string;
|
|
77084
|
+
/**
|
|
77085
|
+
* Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100.
|
|
77086
|
+
*/
|
|
77087
|
+
limit?: number;
|
|
77088
|
+
/**
|
|
77089
|
+
* Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null.
|
|
77090
|
+
*/
|
|
77091
|
+
cursor?: string;
|
|
77092
|
+
};
|
|
77093
|
+
url: '/ontology/v1/nodes';
|
|
77094
|
+
};
|
|
77095
|
+
export type OntologyListNodesErrors = {
|
|
77096
|
+
/**
|
|
77097
|
+
* INVALID_PARAMS means a field, query value, header or identifier violates the documented format or range — a missing Idempotency-Key, an unknown direction, a non-numeric limit. Correct the indicated input; the message names what was wrong.
|
|
77098
|
+
*/
|
|
77099
|
+
400: OntologyOntologyError;
|
|
77100
|
+
/**
|
|
77101
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
77102
|
+
*/
|
|
77103
|
+
401: OntologyOntologyError;
|
|
77104
|
+
/**
|
|
77105
|
+
* The API key lacks permission for this operation, or carries no organization; use a key with the required ontology access in the owning organization.
|
|
77106
|
+
*/
|
|
77107
|
+
403: OntologyOntologyError;
|
|
77108
|
+
/**
|
|
77109
|
+
* INTERNAL means the service could not complete the request; before retrying a write, read the graph back so a partially applied change is not sent twice.
|
|
77110
|
+
*/
|
|
77111
|
+
500: OntologyOntologyError;
|
|
77112
|
+
};
|
|
77113
|
+
export type OntologyListNodesError = OntologyListNodesErrors[keyof OntologyListNodesErrors];
|
|
77114
|
+
export type OntologyListNodesResponses = {
|
|
77115
|
+
/**
|
|
77116
|
+
* One page of nodes, ordered by node id, with next_cursor null on the last page.
|
|
77117
|
+
*/
|
|
77118
|
+
200: OntologyNodePage;
|
|
77119
|
+
};
|
|
77120
|
+
export type OntologyListNodesResponse = OntologyListNodesResponses[keyof OntologyListNodesResponses];
|
|
77121
|
+
export type OntologyCreateNodeData = {
|
|
77122
|
+
/**
|
|
77123
|
+
* The entity to record; name, type and the optional identity of the mirrored record.
|
|
77124
|
+
*/
|
|
77125
|
+
body: OntologyCreateNodeInput;
|
|
77126
|
+
headers: {
|
|
77127
|
+
/**
|
|
77128
|
+
* Unique key for this write, at most 255 characters; resend the same key to replay the first result instead of writing twice. A missing or blank key is refused 400.
|
|
77129
|
+
*/
|
|
77130
|
+
'Idempotency-Key': string;
|
|
77131
|
+
};
|
|
77132
|
+
path?: never;
|
|
77133
|
+
query?: never;
|
|
77134
|
+
url: '/ontology/v1/nodes';
|
|
77135
|
+
};
|
|
77136
|
+
export type OntologyCreateNodeErrors = {
|
|
77137
|
+
/**
|
|
77138
|
+
* INVALID_PARAMS means a field, query value, header or identifier violates the documented format or range — a missing Idempotency-Key, an unknown direction, a non-numeric limit. Correct the indicated input; the message names what was wrong.
|
|
77139
|
+
*/
|
|
77140
|
+
400: OntologyOntologyError;
|
|
77141
|
+
/**
|
|
77142
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
77143
|
+
*/
|
|
77144
|
+
401: OntologyOntologyError;
|
|
77145
|
+
/**
|
|
77146
|
+
* The API key lacks permission for this operation, or carries no organization; use a key with the required ontology access in the owning organization.
|
|
77147
|
+
*/
|
|
77148
|
+
403: OntologyOntologyError;
|
|
77149
|
+
/**
|
|
77150
|
+
* ONTOLOGY_CONFLICT means the Idempotency-Key was already used with different content; reuse the original request for that key or send a new key for a different write.
|
|
77151
|
+
*/
|
|
77152
|
+
409: OntologyOntologyError;
|
|
77153
|
+
/**
|
|
77154
|
+
* ONTOLOGY_CAPACITY means this organization's graph is at its size budget; free space by invalidating facts that are no longer true before retrying.
|
|
77155
|
+
*/
|
|
77156
|
+
429: OntologyOntologyError;
|
|
77157
|
+
/**
|
|
77158
|
+
* INTERNAL means the service could not complete the request; before retrying a write, read the graph back so a partially applied change is not sent twice.
|
|
77159
|
+
*/
|
|
77160
|
+
500: OntologyOntologyError;
|
|
77161
|
+
};
|
|
77162
|
+
export type OntologyCreateNodeError = OntologyCreateNodeErrors[keyof OntologyCreateNodeErrors];
|
|
77163
|
+
export type OntologyCreateNodeResponses = {
|
|
77164
|
+
/**
|
|
77165
|
+
* The recorded node, with the id later reads, updates and relations use.
|
|
77166
|
+
*/
|
|
77167
|
+
201: OntologyNode;
|
|
77168
|
+
};
|
|
77169
|
+
export type OntologyCreateNodeResponse = OntologyCreateNodeResponses[keyof OntologyCreateNodeResponses];
|
|
77170
|
+
export type OntologyRetrieveNodeData = {
|
|
77171
|
+
body?: never;
|
|
77172
|
+
path: {
|
|
77173
|
+
/**
|
|
77174
|
+
* Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted.
|
|
77175
|
+
*/
|
|
77176
|
+
node_id: string;
|
|
77177
|
+
};
|
|
77178
|
+
query?: {
|
|
77179
|
+
/**
|
|
77180
|
+
* Set to relations to include the node's incoming and outgoing relations in the same response; omit for the node alone.
|
|
77181
|
+
*/
|
|
77182
|
+
expand?: 'relations';
|
|
77183
|
+
/**
|
|
77184
|
+
* ISO 8601 timestamp; read the node and its relations as they were then, including relations invalidated since. Omit to read current state.
|
|
77185
|
+
*/
|
|
77186
|
+
as_of?: string;
|
|
77187
|
+
};
|
|
77188
|
+
url: '/ontology/v1/nodes/{node_id}';
|
|
77189
|
+
};
|
|
77190
|
+
export type OntologyRetrieveNodeErrors = {
|
|
77191
|
+
/**
|
|
77192
|
+
* INVALID_PARAMS means a field, query value, header or identifier violates the documented format or range — a missing Idempotency-Key, an unknown direction, a non-numeric limit. Correct the indicated input; the message names what was wrong.
|
|
77193
|
+
*/
|
|
77194
|
+
400: OntologyOntologyError;
|
|
77195
|
+
/**
|
|
77196
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
77197
|
+
*/
|
|
77198
|
+
401: OntologyOntologyError;
|
|
77199
|
+
/**
|
|
77200
|
+
* The API key lacks permission for this operation, or carries no organization; use a key with the required ontology access in the owning organization.
|
|
77201
|
+
*/
|
|
77202
|
+
403: OntologyOntologyError;
|
|
77203
|
+
/**
|
|
77204
|
+
* ONTOLOGY_NODE_NOT_FOUND means the node does not exist in this organization — never created, or owned by another organization; list nodes to find an id you can read.
|
|
77205
|
+
*/
|
|
77206
|
+
404: OntologyOntologyError;
|
|
77207
|
+
/**
|
|
77208
|
+
* INTERNAL means the service could not complete the request; before retrying a write, read the graph back so a partially applied change is not sent twice.
|
|
77209
|
+
*/
|
|
77210
|
+
500: OntologyOntologyError;
|
|
77211
|
+
};
|
|
77212
|
+
export type OntologyRetrieveNodeError = OntologyRetrieveNodeErrors[keyof OntologyRetrieveNodeErrors];
|
|
77213
|
+
export type OntologyRetrieveNodeResponses = {
|
|
77214
|
+
/**
|
|
77215
|
+
* The node, plus a relations array when expand=relations was requested.
|
|
77216
|
+
*/
|
|
77217
|
+
200: OntologyNodeWithRelations;
|
|
77218
|
+
};
|
|
77219
|
+
export type OntologyRetrieveNodeResponse = OntologyRetrieveNodeResponses[keyof OntologyRetrieveNodeResponses];
|
|
77220
|
+
export type OntologyUpdateNodeData = {
|
|
77221
|
+
/**
|
|
77222
|
+
* The fields to change; at least one of name, aliases or description.
|
|
77223
|
+
*/
|
|
77224
|
+
body: OntologyUpdateNodeInput;
|
|
77225
|
+
path: {
|
|
77226
|
+
/**
|
|
77227
|
+
* Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted.
|
|
77228
|
+
*/
|
|
77229
|
+
node_id: string;
|
|
77230
|
+
};
|
|
77231
|
+
query?: never;
|
|
77232
|
+
url: '/ontology/v1/nodes/{node_id}';
|
|
77233
|
+
};
|
|
77234
|
+
export type OntologyUpdateNodeErrors = {
|
|
77235
|
+
/**
|
|
77236
|
+
* INVALID_PARAMS means a field, query value, header or identifier violates the documented format or range — a missing Idempotency-Key, an unknown direction, a non-numeric limit. Correct the indicated input; the message names what was wrong.
|
|
77237
|
+
*/
|
|
77238
|
+
400: OntologyOntologyError;
|
|
77239
|
+
/**
|
|
77240
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
77241
|
+
*/
|
|
77242
|
+
401: OntologyOntologyError;
|
|
77243
|
+
/**
|
|
77244
|
+
* The API key lacks permission for this operation, or carries no organization; use a key with the required ontology access in the owning organization.
|
|
77245
|
+
*/
|
|
77246
|
+
403: OntologyOntologyError;
|
|
77247
|
+
/**
|
|
77248
|
+
* ONTOLOGY_NODE_NOT_FOUND means the node does not exist in this organization — never created, or owned by another organization; list nodes to find an id you can read.
|
|
77249
|
+
*/
|
|
77250
|
+
404: OntologyOntologyError;
|
|
77251
|
+
/**
|
|
77252
|
+
* INTERNAL means the service could not complete the request; before retrying a write, read the graph back so a partially applied change is not sent twice.
|
|
77253
|
+
*/
|
|
77254
|
+
500: OntologyOntologyError;
|
|
77255
|
+
};
|
|
77256
|
+
export type OntologyUpdateNodeError = OntologyUpdateNodeErrors[keyof OntologyUpdateNodeErrors];
|
|
77257
|
+
export type OntologyUpdateNodeResponses = {
|
|
77258
|
+
/**
|
|
77259
|
+
* The node after the update, with its new updated_at.
|
|
77260
|
+
*/
|
|
77261
|
+
200: OntologyNode;
|
|
77262
|
+
};
|
|
77263
|
+
export type OntologyUpdateNodeResponse = OntologyUpdateNodeResponses[keyof OntologyUpdateNodeResponses];
|
|
77264
|
+
export type OntologyMergeNodeData = {
|
|
77265
|
+
/**
|
|
77266
|
+
* The node the merged one folds into.
|
|
77267
|
+
*/
|
|
77268
|
+
body: OntologyMergeNodeInput;
|
|
77269
|
+
headers: {
|
|
77270
|
+
/**
|
|
77271
|
+
* Unique key for this merge, at most 255 characters; resend the same key to replay the first result instead of merging twice.
|
|
77272
|
+
*/
|
|
77273
|
+
'Idempotency-Key': string;
|
|
77274
|
+
};
|
|
77275
|
+
path: {
|
|
77276
|
+
/**
|
|
77277
|
+
* Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted.
|
|
77278
|
+
*/
|
|
77279
|
+
node_id: string;
|
|
77280
|
+
};
|
|
77281
|
+
query?: never;
|
|
77282
|
+
url: '/ontology/v1/nodes/{node_id}/merge';
|
|
77283
|
+
};
|
|
77284
|
+
export type OntologyMergeNodeErrors = {
|
|
77285
|
+
/**
|
|
77286
|
+
* INVALID_PARAMS means a field, query value, header or identifier violates the documented format or range — a missing Idempotency-Key, an unknown direction, a non-numeric limit. Correct the indicated input; the message names what was wrong.
|
|
77287
|
+
*/
|
|
77288
|
+
400: OntologyOntologyError;
|
|
77289
|
+
/**
|
|
77290
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
77291
|
+
*/
|
|
77292
|
+
401: OntologyOntologyError;
|
|
77293
|
+
/**
|
|
77294
|
+
* The API key lacks permission for this operation, or carries no organization; use a key with the required ontology access in the owning organization.
|
|
77295
|
+
*/
|
|
77296
|
+
403: OntologyOntologyError;
|
|
77297
|
+
/**
|
|
77298
|
+
* ONTOLOGY_NODE_NOT_FOUND means the node does not exist in this organization — never created, or owned by another organization; list nodes to find an id you can read.
|
|
77299
|
+
*/
|
|
77300
|
+
404: OntologyOntologyError;
|
|
77301
|
+
/**
|
|
77302
|
+
* ONTOLOGY_CONFLICT means the Idempotency-Key was already used with different content; reuse the original request for that key or send a new key for a different write.
|
|
77303
|
+
*/
|
|
77304
|
+
409: OntologyOntologyError;
|
|
77305
|
+
/**
|
|
77306
|
+
* INTERNAL means the service could not complete the request; before retrying a write, read the graph back so a partially applied change is not sent twice.
|
|
77307
|
+
*/
|
|
77308
|
+
500: OntologyOntologyError;
|
|
77309
|
+
};
|
|
77310
|
+
export type OntologyMergeNodeError = OntologyMergeNodeErrors[keyof OntologyMergeNodeErrors];
|
|
77311
|
+
export type OntologyMergeNodeResponses = {
|
|
77312
|
+
/**
|
|
77313
|
+
* The surviving node that the merged id now resolves to.
|
|
77314
|
+
*/
|
|
77315
|
+
200: OntologyNode;
|
|
77316
|
+
};
|
|
77317
|
+
export type OntologyMergeNodeResponse = OntologyMergeNodeResponses[keyof OntologyMergeNodeResponses];
|
|
77318
|
+
export type OntologyListRelationsData = {
|
|
77319
|
+
body?: never;
|
|
77320
|
+
path?: never;
|
|
77321
|
+
query?: {
|
|
77322
|
+
/**
|
|
77323
|
+
* A node id from nodes.list or nodes.create; returns the relations this node takes part in, narrowed by direction. Omit to list relations between every node.
|
|
77324
|
+
*/
|
|
77325
|
+
node?: string;
|
|
77326
|
+
/**
|
|
77327
|
+
* Repeat to filter to any of several registered relation type names, for example type=references&type=serves; omit to list every type.
|
|
77328
|
+
*/
|
|
77329
|
+
type?: Array<string>;
|
|
77330
|
+
/**
|
|
77331
|
+
* Which side of node to follow; out returns relations the node is the source of, in returns those it is the target of. Only meaningful together with node.
|
|
77332
|
+
*/
|
|
77333
|
+
direction?: 'out' | 'in' | 'both';
|
|
77334
|
+
/**
|
|
77335
|
+
* ISO 8601 timestamp; read relations as they were then, so one recorded or invalidated later is judged by that time. Omit to read current state.
|
|
77336
|
+
*/
|
|
77337
|
+
as_of?: string;
|
|
77338
|
+
/**
|
|
77339
|
+
* Set true to include relations whose invalid_at has passed, which is how a relation that stopped being true stays readable. Omit or false for currently valid relations only.
|
|
77340
|
+
*/
|
|
77341
|
+
include_invalid?: boolean;
|
|
77342
|
+
/**
|
|
77343
|
+
* Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100.
|
|
77344
|
+
*/
|
|
77345
|
+
limit?: number;
|
|
77346
|
+
/**
|
|
77347
|
+
* Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null.
|
|
77348
|
+
*/
|
|
77349
|
+
cursor?: string;
|
|
77350
|
+
};
|
|
77351
|
+
url: '/ontology/v1/relations';
|
|
77352
|
+
};
|
|
77353
|
+
export type OntologyListRelationsErrors = {
|
|
77354
|
+
/**
|
|
77355
|
+
* INVALID_PARAMS means a field, query value, header or identifier violates the documented format or range — a missing Idempotency-Key, an unknown direction, a non-numeric limit. Correct the indicated input; the message names what was wrong.
|
|
77356
|
+
*/
|
|
77357
|
+
400: OntologyOntologyError;
|
|
77358
|
+
/**
|
|
77359
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
77360
|
+
*/
|
|
77361
|
+
401: OntologyOntologyError;
|
|
77362
|
+
/**
|
|
77363
|
+
* The API key lacks permission for this operation, or carries no organization; use a key with the required ontology access in the owning organization.
|
|
77364
|
+
*/
|
|
77365
|
+
403: OntologyOntologyError;
|
|
77366
|
+
/**
|
|
77367
|
+
* INTERNAL means the service could not complete the request; before retrying a write, read the graph back so a partially applied change is not sent twice.
|
|
77368
|
+
*/
|
|
77369
|
+
500: OntologyOntologyError;
|
|
77370
|
+
};
|
|
77371
|
+
export type OntologyListRelationsError = OntologyListRelationsErrors[keyof OntologyListRelationsErrors];
|
|
77372
|
+
export type OntologyListRelationsResponses = {
|
|
77373
|
+
/**
|
|
77374
|
+
* One page of relations, ordered by relation id, with next_cursor null on the last page.
|
|
77375
|
+
*/
|
|
77376
|
+
200: OntologyRelationPage;
|
|
77377
|
+
};
|
|
77378
|
+
export type OntologyListRelationsResponse = OntologyListRelationsResponses[keyof OntologyListRelationsResponses];
|
|
77379
|
+
export type OntologyCreateRelationData = {
|
|
77380
|
+
/**
|
|
77381
|
+
* The fact to record, between two node ids from this organization's graph.
|
|
77382
|
+
*/
|
|
77383
|
+
body: OntologyCreateRelationInput;
|
|
77384
|
+
headers: {
|
|
77385
|
+
/**
|
|
77386
|
+
* Unique key for this write, at most 255 characters; resend the same key to replay the first result instead of writing twice. A missing or blank key is refused 400.
|
|
77387
|
+
*/
|
|
77388
|
+
'Idempotency-Key': string;
|
|
77389
|
+
};
|
|
77390
|
+
path?: never;
|
|
77391
|
+
query?: never;
|
|
77392
|
+
url: '/ontology/v1/relations';
|
|
77393
|
+
};
|
|
77394
|
+
export type OntologyCreateRelationErrors = {
|
|
77395
|
+
/**
|
|
77396
|
+
* INVALID_PARAMS means a field, query value, header or identifier violates the documented format or range — a missing Idempotency-Key, an unknown direction, a non-numeric limit. Correct the indicated input; the message names what was wrong.
|
|
77397
|
+
*/
|
|
77398
|
+
400: OntologyOntologyError;
|
|
77399
|
+
/**
|
|
77400
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
77401
|
+
*/
|
|
77402
|
+
401: OntologyOntologyError;
|
|
77403
|
+
/**
|
|
77404
|
+
* The API key lacks permission for this operation, or carries no organization; use a key with the required ontology access in the owning organization.
|
|
77405
|
+
*/
|
|
77406
|
+
403: OntologyOntologyError;
|
|
77407
|
+
/**
|
|
77408
|
+
* ONTOLOGY_CONFLICT means the Idempotency-Key was already used with different content; reuse the original request for that key or send a new key for a different write.
|
|
77409
|
+
*/
|
|
77410
|
+
409: OntologyOntologyError;
|
|
77411
|
+
/**
|
|
77412
|
+
* ONTOLOGY_CAPACITY means this organization's graph is at its size budget; free space by invalidating facts that are no longer true before retrying.
|
|
77413
|
+
*/
|
|
77414
|
+
429: OntologyOntologyError;
|
|
77415
|
+
/**
|
|
77416
|
+
* INTERNAL means the service could not complete the request; before retrying a write, read the graph back so a partially applied change is not sent twice.
|
|
77417
|
+
*/
|
|
77418
|
+
500: OntologyOntologyError;
|
|
77419
|
+
};
|
|
77420
|
+
export type OntologyCreateRelationError = OntologyCreateRelationErrors[keyof OntologyCreateRelationErrors];
|
|
77421
|
+
export type OntologyCreateRelationResponses = {
|
|
77422
|
+
/**
|
|
77423
|
+
* The recorded relation, with the id later reads and invalidation use.
|
|
77424
|
+
*/
|
|
77425
|
+
201: OntologyRelation;
|
|
77426
|
+
};
|
|
77427
|
+
export type OntologyCreateRelationResponse = OntologyCreateRelationResponses[keyof OntologyCreateRelationResponses];
|
|
77428
|
+
export type OntologyRetrieveRelationData = {
|
|
77429
|
+
body?: never;
|
|
77430
|
+
path: {
|
|
77431
|
+
/**
|
|
77432
|
+
* Relation id returned by relations.list, relations.create or a changeset, in the form oed_ followed by 32 lowercase letters or digits; a node id is not accepted.
|
|
77433
|
+
*/
|
|
77434
|
+
relation_id: string;
|
|
77435
|
+
};
|
|
77436
|
+
query?: never;
|
|
77437
|
+
url: '/ontology/v1/relations/{relation_id}';
|
|
77438
|
+
};
|
|
77439
|
+
export type OntologyRetrieveRelationErrors = {
|
|
77440
|
+
/**
|
|
77441
|
+
* INVALID_PARAMS means a field, query value, header or identifier violates the documented format or range — a missing Idempotency-Key, an unknown direction, a non-numeric limit. Correct the indicated input; the message names what was wrong.
|
|
77442
|
+
*/
|
|
77443
|
+
400: OntologyOntologyError;
|
|
77444
|
+
/**
|
|
77445
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
77446
|
+
*/
|
|
77447
|
+
401: OntologyOntologyError;
|
|
77448
|
+
/**
|
|
77449
|
+
* The API key lacks permission for this operation, or carries no organization; use a key with the required ontology access in the owning organization.
|
|
77450
|
+
*/
|
|
77451
|
+
403: OntologyOntologyError;
|
|
77452
|
+
/**
|
|
77453
|
+
* ONTOLOGY_EDGE_NOT_FOUND means the relation does not exist in this organization, or its content belongs to another member; list relations for the ids you may read.
|
|
77454
|
+
*/
|
|
77455
|
+
404: OntologyOntologyError;
|
|
77456
|
+
/**
|
|
77457
|
+
* INTERNAL means the service could not complete the request; before retrying a write, read the graph back so a partially applied change is not sent twice.
|
|
77458
|
+
*/
|
|
77459
|
+
500: OntologyOntologyError;
|
|
77460
|
+
};
|
|
77461
|
+
export type OntologyRetrieveRelationError = OntologyRetrieveRelationErrors[keyof OntologyRetrieveRelationErrors];
|
|
77462
|
+
export type OntologyRetrieveRelationResponses = {
|
|
77463
|
+
/**
|
|
77464
|
+
* The relation, including its fact, endpoints and both clocks.
|
|
77465
|
+
*/
|
|
77466
|
+
200: OntologyRelation;
|
|
77467
|
+
};
|
|
77468
|
+
export type OntologyRetrieveRelationResponse = OntologyRetrieveRelationResponses[keyof OntologyRetrieveRelationResponses];
|
|
77469
|
+
export type OntologyInvalidateRelationData = {
|
|
77470
|
+
/**
|
|
77471
|
+
* When the fact stopped being true, and optionally what replaced it and why.
|
|
77472
|
+
*/
|
|
77473
|
+
body: OntologyInvalidateRelationInput;
|
|
77474
|
+
headers: {
|
|
77475
|
+
/**
|
|
77476
|
+
* Unique key for this invalidation, at most 255 characters; resend the same key to replay the first result instead of invalidating twice.
|
|
77477
|
+
*/
|
|
77478
|
+
'Idempotency-Key': string;
|
|
77479
|
+
};
|
|
77480
|
+
path: {
|
|
77481
|
+
/**
|
|
77482
|
+
* Relation id returned by relations.list, relations.create or a changeset, in the form oed_ followed by 32 lowercase letters or digits; a node id is not accepted.
|
|
77483
|
+
*/
|
|
77484
|
+
relation_id: string;
|
|
77485
|
+
};
|
|
77486
|
+
query?: never;
|
|
77487
|
+
url: '/ontology/v1/relations/{relation_id}/invalidate';
|
|
77488
|
+
};
|
|
77489
|
+
export type OntologyInvalidateRelationErrors = {
|
|
77490
|
+
/**
|
|
77491
|
+
* INVALID_PARAMS means a field, query value, header or identifier violates the documented format or range — a missing Idempotency-Key, an unknown direction, a non-numeric limit. Correct the indicated input; the message names what was wrong.
|
|
77492
|
+
*/
|
|
77493
|
+
400: OntologyOntologyError;
|
|
77494
|
+
/**
|
|
77495
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
77496
|
+
*/
|
|
77497
|
+
401: OntologyOntologyError;
|
|
77498
|
+
/**
|
|
77499
|
+
* The API key lacks permission for this operation, or carries no organization; use a key with the required ontology access in the owning organization.
|
|
77500
|
+
*/
|
|
77501
|
+
403: OntologyOntologyError;
|
|
77502
|
+
/**
|
|
77503
|
+
* ONTOLOGY_EDGE_NOT_FOUND means the relation does not exist in this organization, or its content belongs to another member; list relations for the ids you may read.
|
|
77504
|
+
*/
|
|
77505
|
+
404: OntologyOntologyError;
|
|
77506
|
+
/**
|
|
77507
|
+
* ONTOLOGY_CONFLICT means the Idempotency-Key was already used with different content; reuse the original request for that key or send a new key for a different write.
|
|
77508
|
+
*/
|
|
77509
|
+
409: OntologyOntologyError;
|
|
77510
|
+
/**
|
|
77511
|
+
* INTERNAL means the service could not complete the request; before retrying a write, read the graph back so a partially applied change is not sent twice.
|
|
77512
|
+
*/
|
|
77513
|
+
500: OntologyOntologyError;
|
|
77514
|
+
};
|
|
77515
|
+
export type OntologyInvalidateRelationError = OntologyInvalidateRelationErrors[keyof OntologyInvalidateRelationErrors];
|
|
77516
|
+
export type OntologyInvalidateRelationResponses = {
|
|
77517
|
+
/**
|
|
77518
|
+
* The relation after invalidation, with invalid_at set to the given time.
|
|
77519
|
+
*/
|
|
77520
|
+
200: OntologyRelation;
|
|
77521
|
+
};
|
|
77522
|
+
export type OntologyInvalidateRelationResponse = OntologyInvalidateRelationResponses[keyof OntologyInvalidateRelationResponses];
|
|
77523
|
+
export type OntologyApplyChangesetData = {
|
|
77524
|
+
/**
|
|
77525
|
+
* The operations to apply together, with the world time they describe.
|
|
77526
|
+
*/
|
|
77527
|
+
body: OntologyChangesetInput;
|
|
77528
|
+
headers: {
|
|
77529
|
+
/**
|
|
77530
|
+
* Unique key for this batch, at most 255 characters; resend the same key to replay the first result instead of writing the batch twice.
|
|
77531
|
+
*/
|
|
77532
|
+
'Idempotency-Key': string;
|
|
77533
|
+
};
|
|
77534
|
+
path?: never;
|
|
77535
|
+
query?: never;
|
|
77536
|
+
url: '/ontology/v1/changesets';
|
|
77537
|
+
};
|
|
77538
|
+
export type OntologyApplyChangesetErrors = {
|
|
77539
|
+
/**
|
|
77540
|
+
* INVALID_PARAMS means a field, query value, header or identifier violates the documented format or range — a missing Idempotency-Key, an unknown direction, a non-numeric limit. Correct the indicated input; the message names what was wrong.
|
|
77541
|
+
*/
|
|
77542
|
+
400: OntologyOntologyError;
|
|
77543
|
+
/**
|
|
77544
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
77545
|
+
*/
|
|
77546
|
+
401: OntologyOntologyError;
|
|
77547
|
+
/**
|
|
77548
|
+
* The API key lacks permission for this operation, or carries no organization; use a key with the required ontology access in the owning organization.
|
|
77549
|
+
*/
|
|
77550
|
+
403: OntologyOntologyError;
|
|
77551
|
+
/**
|
|
77552
|
+
* ONTOLOGY_CONFLICT means the Idempotency-Key was already used with different content; reuse the original request for that key or send a new key for a different write.
|
|
77553
|
+
*/
|
|
77554
|
+
409: OntologyOntologyError;
|
|
77555
|
+
/**
|
|
77556
|
+
* ONTOLOGY_CAPACITY means this organization's graph is at its size budget; free space by invalidating facts that are no longer true before retrying.
|
|
77557
|
+
*/
|
|
77558
|
+
429: OntologyOntologyError;
|
|
77559
|
+
/**
|
|
77560
|
+
* INTERNAL means the service could not complete the request; before retrying a write, read the graph back so a partially applied change is not sent twice.
|
|
77561
|
+
*/
|
|
77562
|
+
500: OntologyOntologyError;
|
|
77563
|
+
};
|
|
77564
|
+
export type OntologyApplyChangesetError = OntologyApplyChangesetErrors[keyof OntologyApplyChangesetErrors];
|
|
77565
|
+
export type OntologyApplyChangesetResponses = {
|
|
77566
|
+
/**
|
|
77567
|
+
* The applied count, the ids assigned to the batch's keys, and replayed true when the key had been seen before.
|
|
77568
|
+
*/
|
|
77569
|
+
200: OntologyChangesetResult;
|
|
77570
|
+
};
|
|
77571
|
+
export type OntologyApplyChangesetResponse = OntologyApplyChangesetResponses[keyof OntologyApplyChangesetResponses];
|
|
77572
|
+
export type OntologySearchData = {
|
|
77573
|
+
/**
|
|
77574
|
+
* The text to resolve, optionally narrowed to particular node types and a result count.
|
|
77575
|
+
*/
|
|
77576
|
+
body: OntologySearchInput;
|
|
77577
|
+
path?: never;
|
|
77578
|
+
query?: never;
|
|
77579
|
+
url: '/ontology/v1/search';
|
|
77580
|
+
};
|
|
77581
|
+
export type OntologySearchErrors = {
|
|
77582
|
+
/**
|
|
77583
|
+
* INVALID_PARAMS means a field, query value, header or identifier violates the documented format or range — a missing Idempotency-Key, an unknown direction, a non-numeric limit. Correct the indicated input; the message names what was wrong.
|
|
77584
|
+
*/
|
|
77585
|
+
400: OntologyOntologyError;
|
|
77586
|
+
/**
|
|
77587
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
77588
|
+
*/
|
|
77589
|
+
401: OntologyOntologyError;
|
|
77590
|
+
/**
|
|
77591
|
+
* The API key lacks permission for this operation, or carries no organization; use a key with the required ontology access in the owning organization.
|
|
77592
|
+
*/
|
|
77593
|
+
403: OntologyOntologyError;
|
|
77594
|
+
/**
|
|
77595
|
+
* INTERNAL means the service could not complete the request; before retrying a write, read the graph back so a partially applied change is not sent twice.
|
|
77596
|
+
*/
|
|
77597
|
+
500: OntologyOntologyError;
|
|
77598
|
+
};
|
|
77599
|
+
export type OntologySearchError = OntologySearchErrors[keyof OntologySearchErrors];
|
|
77600
|
+
export type OntologySearchResponses = {
|
|
77601
|
+
/**
|
|
77602
|
+
* Ranked candidate nodes, best match first, with the field each one matched on.
|
|
77603
|
+
*/
|
|
77604
|
+
200: OntologySearchResult;
|
|
77605
|
+
};
|
|
77606
|
+
export type OntologySearchResponse = OntologySearchResponses[keyof OntologySearchResponses];
|
|
74837
77607
|
export type GetSandboxV1SandboxesData = {
|
|
74838
77608
|
body?: never;
|
|
74839
77609
|
path?: never;
|
|
@@ -75226,6 +77996,10 @@ export type ListSandboxTemplatesResponses = {
|
|
|
75226
77996
|
buildCount: number;
|
|
75227
77997
|
envdVersion: SandboxEnvdVersion;
|
|
75228
77998
|
buildStatus: SandboxTemplateBuildStatus;
|
|
77999
|
+
/**
|
|
78000
|
+
* Lifecycle classes this template can run as. ephemeral: cannot pause, snapshot or mount volumes and is deleted when it stops; persistent: can pause, resume and snapshot.
|
|
78001
|
+
*/
|
|
78002
|
+
lifecycles?: Array<'ephemeral' | 'persistent'>;
|
|
75229
78003
|
/**
|
|
75230
78004
|
* True for an official catalog template; false for your organization's custom templates.
|
|
75231
78005
|
*/
|
|
@@ -77429,7 +80203,7 @@ export type TicketGetTicketsData = {
|
|
|
77429
80203
|
*/
|
|
77430
80204
|
page_token?: string;
|
|
77431
80205
|
/**
|
|
77432
|
-
* Filter expression.
|
|
80206
|
+
* Filter expression using field:value qualifiers, such as is:open milestone:5.
|
|
77433
80207
|
*/
|
|
77434
80208
|
filter?: string;
|
|
77435
80209
|
};
|
|
@@ -79848,7 +82622,7 @@ export type TicketGetActivityData = {
|
|
|
79848
82622
|
*/
|
|
79849
82623
|
page_token?: string;
|
|
79850
82624
|
/**
|
|
79851
|
-
*
|
|
82625
|
+
* Activity filter expression.
|
|
79852
82626
|
*/
|
|
79853
82627
|
filter?: string;
|
|
79854
82628
|
};
|