@deepraxis/sdk 0.1.1-dev.d73d5e4 → 0.1.1-dev.d8d3f52
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 +40 -1
- package/README.md +1 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +90 -6
- package/dist/generated/sdk.gen.js +253 -5
- package/dist/generated/types.gen.d.ts +2178 -190
- package/dist/helpers/browser-actions.d.ts +2 -2
- package/dist/helpers/browser-actions.js +2 -2
- package/dist/helpers/browser-connect.js +2 -1
- package/dist/operations.generated.d.ts +493 -29
- package/dist/operations.generated.js +646 -29
- package/dist/resources.generated.d.ts +22 -0
- package/dist/resources.generated.js +22 -0
- package/package.json +1 -1
|
@@ -12969,6 +12969,32 @@ export type CutMixAnalysis = {
|
|
|
12969
12969
|
*/
|
|
12970
12970
|
duration: number;
|
|
12971
12971
|
}>;
|
|
12972
|
+
/**
|
|
12973
|
+
* Where the music swells in a pause between sentences — the voice pauses for at most 3 seconds and the music rises 4 dB or more above its level under the speech on either side. That is a duck letting go between sentences and is heard as pumping; give the duck a longer hold, or use the default occupancy duck under continuous narration.
|
|
12974
|
+
*/
|
|
12975
|
+
music_swells?: Array<{
|
|
12976
|
+
/**
|
|
12977
|
+
* Interval start, in seconds relative to the measured range.
|
|
12978
|
+
*/
|
|
12979
|
+
start: number;
|
|
12980
|
+
/**
|
|
12981
|
+
* Interval length in whole seconds.
|
|
12982
|
+
*/
|
|
12983
|
+
duration: number;
|
|
12984
|
+
}>;
|
|
12985
|
+
/**
|
|
12986
|
+
* The music bed against the voice, as one move to make. Music should sit about 18 LU under the voice (15–24 is fine); a bed too loud for the voice is what makes a duck pump, because the music is pulled down hard under every sentence and springs back in every pause. Null when the range lacks either a voice or a music role.
|
|
12987
|
+
*/
|
|
12988
|
+
music_balance?: {
|
|
12989
|
+
/**
|
|
12990
|
+
* How many LU the music's integrated loudness sits under the voice's.
|
|
12991
|
+
*/
|
|
12992
|
+
music_below_voice_lu: number;
|
|
12993
|
+
/**
|
|
12994
|
+
* The dB to change the music track's volume by to sit 18 LU under the voice (negative lowers it); 0 when it already sits 15–24 LU under.
|
|
12995
|
+
*/
|
|
12996
|
+
adjust_music_db: number;
|
|
12997
|
+
} | null;
|
|
12972
12998
|
};
|
|
12973
12999
|
};
|
|
12974
13000
|
/**
|
|
@@ -12988,7 +13014,7 @@ export type CutAnalysisInput = {
|
|
|
12988
13014
|
*/
|
|
12989
13015
|
from?: number;
|
|
12990
13016
|
/**
|
|
12991
|
-
* Range end for kind mix, in seconds on the project clock, exclusive. A range longer than 120 seconds is refused; request several ranges instead.
|
|
13017
|
+
* Range end for kind mix, in seconds on the project clock, exclusive. An end up to 0.05 s past the timeline's end (a rounded duration) is read as the end; further past is refused. A range longer than 120 seconds is refused; request several ranges instead.
|
|
12992
13018
|
*/
|
|
12993
13019
|
to?: number;
|
|
12994
13020
|
/**
|
|
@@ -13141,9 +13167,9 @@ export type CutExport = {
|
|
|
13141
13167
|
*/
|
|
13142
13168
|
output: CutExportOutput;
|
|
13143
13169
|
/**
|
|
13144
|
-
*
|
|
13170
|
+
* Library the finished video is imported into. Present only when the request named a binding or a folder; an export that named neither is delivered as a file and has no target.
|
|
13145
13171
|
*/
|
|
13146
|
-
target
|
|
13172
|
+
target?: {
|
|
13147
13173
|
/**
|
|
13148
13174
|
* Project binding alias chosen for the output.
|
|
13149
13175
|
*/
|
|
@@ -13229,7 +13255,28 @@ export type CutExport = {
|
|
|
13229
13255
|
*/
|
|
13230
13256
|
poster_at?: number;
|
|
13231
13257
|
/**
|
|
13232
|
-
*
|
|
13258
|
+
* The finished video as a file. Present once the export is done, and kept even when the export was also imported into a library, where the file itself is then deleted and only its identity remains.
|
|
13259
|
+
*/
|
|
13260
|
+
file?: {
|
|
13261
|
+
/**
|
|
13262
|
+
* File id in the file service.
|
|
13263
|
+
*/
|
|
13264
|
+
id: string;
|
|
13265
|
+
/**
|
|
13266
|
+
* File name the export was uploaded under; the frozen display name with an .mp4 suffix.
|
|
13267
|
+
*/
|
|
13268
|
+
name: string;
|
|
13269
|
+
/**
|
|
13270
|
+
* Size of the finished video in bytes, as written by the renderer.
|
|
13271
|
+
*/
|
|
13272
|
+
bytes: number;
|
|
13273
|
+
/**
|
|
13274
|
+
* Short-lived reading link, valid one hour, minted on every read and never stored. Present only on a done export that was not imported: an imported export's file was deleted, so there is nothing to link to.
|
|
13275
|
+
*/
|
|
13276
|
+
url?: string;
|
|
13277
|
+
};
|
|
13278
|
+
/**
|
|
13279
|
+
* Output media reference, present only when the export was imported (the request named a binding or a folder).
|
|
13233
13280
|
*/
|
|
13234
13281
|
asset?: CutMediaRef;
|
|
13235
13282
|
/**
|
|
@@ -13284,7 +13331,7 @@ export type CutExport = {
|
|
|
13284
13331
|
*/
|
|
13285
13332
|
export type CutExportInput = {
|
|
13286
13333
|
/**
|
|
13287
|
-
* Optional destination path within the bound media library; omitted uses its default folder.
|
|
13334
|
+
* Optional destination path within the bound media library; omitted uses its default folder. Naming a binding or a folder also imports the finished video into that media library as an asset. Omit both and the export is a file only: read file.url to download it.
|
|
13288
13335
|
*/
|
|
13289
13336
|
folder?: string;
|
|
13290
13337
|
/**
|
|
@@ -13296,7 +13343,7 @@ export type CutExportInput = {
|
|
|
13296
13343
|
*/
|
|
13297
13344
|
output?: CutExportOutput;
|
|
13298
13345
|
/**
|
|
13299
|
-
* Writable binding name used as the export destination; omission uses default_upload.
|
|
13346
|
+
* Writable binding name used as the export destination; omission uses default_upload. Naming a binding or a folder also imports the finished video into that media library as an asset. Omit both and the export is a file only; read file.url to download it.
|
|
13300
13347
|
*/
|
|
13301
13348
|
binding?: string;
|
|
13302
13349
|
revision?: CutRevision;
|
|
@@ -15281,7 +15328,7 @@ export type MediaLibrary = {
|
|
|
15281
15328
|
};
|
|
15282
15329
|
export type MediaMediaError = {
|
|
15283
15330
|
error: {
|
|
15284
|
-
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';
|
|
15331
|
+
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' | 'OPERATION_NOT_SUPPORTED' | 'MODEL_PENDING' | 'REFERENCE_TYPE_MISMATCH' | 'CONSENT_REQUIRED' | 'LIBRARY_IS_DEFAULT' | 'JOB_INVALID_STATE' | 'VOICE_TRAINING' | 'INSUFFICIENT_BALANCE';
|
|
15285
15332
|
message: string;
|
|
15286
15333
|
details: string | null;
|
|
15287
15334
|
};
|
|
@@ -15364,6 +15411,10 @@ export type MediaPurgedLibrary = {
|
|
|
15364
15411
|
*/
|
|
15365
15412
|
purged: true;
|
|
15366
15413
|
};
|
|
15414
|
+
/**
|
|
15415
|
+
* What this asset is as a reusable material, as opposed to resource_type (its stored file category). Omitted on assets stored before this field existed and on raw assets that are not materials.
|
|
15416
|
+
*/
|
|
15417
|
+
export type MediaMaterialType = 'image' | 'video' | 'audio' | 'voice' | 'sticker' | 'font' | 'text_style' | 'text_template' | 'animation_preset' | 'lut' | 'transition_map';
|
|
15367
15418
|
/**
|
|
15368
15419
|
* Assets in this page, ordered by creation time descending.
|
|
15369
15420
|
*/
|
|
@@ -15614,6 +15665,34 @@ export type MediaAsset = {
|
|
|
15614
15665
|
*/
|
|
15615
15666
|
model: string;
|
|
15616
15667
|
};
|
|
15668
|
+
/**
|
|
15669
|
+
* What this asset is as a reusable material, independent of resource_type. Omitted on assets stored before this field existed and on raw assets that are not materials.
|
|
15670
|
+
*/
|
|
15671
|
+
material_type?: MediaMaterialType;
|
|
15672
|
+
/**
|
|
15673
|
+
* What an audio asset is used for when material_type is audio: voice, music or sfx. Omitted for assets that are not audio materials.
|
|
15674
|
+
*/
|
|
15675
|
+
audio_role?: MediaAudioRole;
|
|
15676
|
+
/**
|
|
15677
|
+
* True when an image asset contains animation, such as an animated GIF or animated WebP. Omitted for assets that are not animated images.
|
|
15678
|
+
*/
|
|
15679
|
+
animated?: true;
|
|
15680
|
+
/**
|
|
15681
|
+
* Asset this one was edited from; null when it was generated or uploaded rather than edited. Use assets.lineage for the whole tree.
|
|
15682
|
+
*/
|
|
15683
|
+
derived_from?: MediaAssetId | null;
|
|
15684
|
+
/**
|
|
15685
|
+
* Asset at the root of this asset’s edit tree; equals asset_id when this asset is itself a root. Omitted on assets stored before this field existed.
|
|
15686
|
+
*/
|
|
15687
|
+
root_id?: MediaAssetId;
|
|
15688
|
+
/**
|
|
15689
|
+
* True when the bytes carry an AI-generated content label and this asset was produced by a model. False for uploaded and imported assets.
|
|
15690
|
+
*/
|
|
15691
|
+
ai_generated?: boolean;
|
|
15692
|
+
/**
|
|
15693
|
+
* How this asset was generated or edited, including the model, prompt and references. Omitted on uploaded, imported and legacy assets.
|
|
15694
|
+
*/
|
|
15695
|
+
provenance?: MediaProvenance;
|
|
15617
15696
|
};
|
|
15618
15697
|
/**
|
|
15619
15698
|
* Receipt confirming that the asset was deleted.
|
|
@@ -15761,6 +15840,26 @@ export type MediaJob = {
|
|
|
15761
15840
|
* 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.
|
|
15762
15841
|
*/
|
|
15763
15842
|
status: MediaJobStatus;
|
|
15843
|
+
/**
|
|
15844
|
+
* Category of media this job produces. Image jobs answer image and video jobs answer video; omitted for batch jobs, which change existing assets rather than producing new media.
|
|
15845
|
+
*/
|
|
15846
|
+
type?: MediaGenerationType;
|
|
15847
|
+
/**
|
|
15848
|
+
* The operation this job performs: generate for a plain text-to-image or text-to-video job, or the edit operation an image edit applied to its source asset. Omitted for batch jobs.
|
|
15849
|
+
*/
|
|
15850
|
+
operation?: MediaGenerationOperation;
|
|
15851
|
+
/**
|
|
15852
|
+
* Asset this job edits, present on an image edit job and omitted on generation jobs. The produced asset records the same asset in its derived_from field; use assets.lineage for the whole edit tree.
|
|
15853
|
+
*/
|
|
15854
|
+
source_asset_id?: MediaAssetId;
|
|
15855
|
+
/**
|
|
15856
|
+
* Fraction of this job already processed, from 0 to 1. Poll the job or read its done and total counts to observe progress; do not treat this value as a percentage.
|
|
15857
|
+
*/
|
|
15858
|
+
progress?: number;
|
|
15859
|
+
/**
|
|
15860
|
+
* Why a queued generation job has not started yet. queue_reason is omitted once the job starts.
|
|
15861
|
+
*/
|
|
15862
|
+
queue_reason?: 'concurrency' | 'provider_throttled';
|
|
15764
15863
|
/**
|
|
15765
15864
|
* Number of distinct assets selected when the job was created.
|
|
15766
15865
|
*/
|
|
@@ -15940,6 +16039,297 @@ export type MediaDeliveryToken = {
|
|
|
15940
16039
|
*/
|
|
15941
16040
|
expires_at: string;
|
|
15942
16041
|
};
|
|
16042
|
+
/**
|
|
16043
|
+
* Identifier of a library belonging to the caller.
|
|
16044
|
+
*/
|
|
16045
|
+
export type MediaLibraryId = string;
|
|
16046
|
+
/**
|
|
16047
|
+
* The edit tree containing one asset: the root it descends from, the asset asked about, and every step between them, including deleted assets.
|
|
16048
|
+
*/
|
|
16049
|
+
export type MediaLineageTree = {
|
|
16050
|
+
/**
|
|
16051
|
+
* Asset at the root of this tree, the original the rest were edited from; equals focus_id when the asset is itself a root.
|
|
16052
|
+
*/
|
|
16053
|
+
root_id: MediaAssetId;
|
|
16054
|
+
/**
|
|
16055
|
+
* Asset this tree was requested for.
|
|
16056
|
+
*/
|
|
16057
|
+
focus_id: MediaAssetId;
|
|
16058
|
+
/**
|
|
16059
|
+
* Every asset in the tree, including the root and the focused asset; deleted assets are included so the tree stays connected.
|
|
16060
|
+
*/
|
|
16061
|
+
nodes: Array<MediaLineageNode>;
|
|
16062
|
+
};
|
|
16063
|
+
export type MediaAssetReference = {
|
|
16064
|
+
asset_id: MediaAssetId;
|
|
16065
|
+
role: MediaRefRole;
|
|
16066
|
+
/**
|
|
16067
|
+
* How strongly the reference asset influenced the result, from 0 to 1 on the Stability scale. Omitted when the model treats every reference equally.
|
|
16068
|
+
*/
|
|
16069
|
+
strength?: number;
|
|
16070
|
+
};
|
|
16071
|
+
/**
|
|
16072
|
+
* One edit to apply to the source asset. type selects the operation and the discriminating branch carries that operation’s fields. This release performs variations, inpaint, erase, replace_object, recolor, remove_background and replace_background on images; every other type here describes the operation vocabulary and is refused with OPERATION_NOT_SUPPORTED.
|
|
16073
|
+
*/
|
|
16074
|
+
export type MediaEditOperation = {
|
|
16075
|
+
/**
|
|
16076
|
+
* Edit operation discriminator; variations selects the variations branch of this union.
|
|
16077
|
+
*/
|
|
16078
|
+
type: 'variations';
|
|
16079
|
+
/**
|
|
16080
|
+
* Number of variations to produce; omit it to use the model default.
|
|
16081
|
+
*/
|
|
16082
|
+
n?: number;
|
|
16083
|
+
/**
|
|
16084
|
+
* How far the variation may move from the source: subtle or strong.
|
|
16085
|
+
*/
|
|
16086
|
+
strength?: 'subtle' | 'strong';
|
|
16087
|
+
/**
|
|
16088
|
+
* Seed for reproducible variations.
|
|
16089
|
+
*/
|
|
16090
|
+
seed?: number;
|
|
16091
|
+
} | {
|
|
16092
|
+
/**
|
|
16093
|
+
* Edit operation discriminator; upscale selects the upscale branch of this union.
|
|
16094
|
+
*/
|
|
16095
|
+
type: 'upscale';
|
|
16096
|
+
/**
|
|
16097
|
+
* Upscale strategy: fast, conservative or creative.
|
|
16098
|
+
*/
|
|
16099
|
+
mode?: 'fast' | 'conservative' | 'creative';
|
|
16100
|
+
/**
|
|
16101
|
+
* Upscale factor, 2 or 4.
|
|
16102
|
+
*/
|
|
16103
|
+
scale?: 2 | 4;
|
|
16104
|
+
/**
|
|
16105
|
+
* Target resolution: 1080p or 4k.
|
|
16106
|
+
*/
|
|
16107
|
+
resolution?: '1080p' | '4k';
|
|
16108
|
+
} | {
|
|
16109
|
+
/**
|
|
16110
|
+
* Edit operation discriminator; outpaint selects the outpaint branch of this union.
|
|
16111
|
+
*/
|
|
16112
|
+
type: 'outpaint';
|
|
16113
|
+
/**
|
|
16114
|
+
* Target aspect ratio to extend towards.
|
|
16115
|
+
*/
|
|
16116
|
+
aspect_ratio?: string;
|
|
16117
|
+
/**
|
|
16118
|
+
* Pixels to extend on the left edge.
|
|
16119
|
+
*/
|
|
16120
|
+
left?: number;
|
|
16121
|
+
/**
|
|
16122
|
+
* Pixels to extend on the right edge.
|
|
16123
|
+
*/
|
|
16124
|
+
right?: number;
|
|
16125
|
+
/**
|
|
16126
|
+
* Pixels to extend above.
|
|
16127
|
+
*/
|
|
16128
|
+
up?: number;
|
|
16129
|
+
/**
|
|
16130
|
+
* Pixels to extend below.
|
|
16131
|
+
*/
|
|
16132
|
+
down?: number;
|
|
16133
|
+
/**
|
|
16134
|
+
* Content that should appear in the extended area.
|
|
16135
|
+
*/
|
|
16136
|
+
prompt?: string;
|
|
16137
|
+
} | {
|
|
16138
|
+
/**
|
|
16139
|
+
* Edit operation discriminator; inpaint selects the inpaint branch of this union.
|
|
16140
|
+
*/
|
|
16141
|
+
type: 'inpaint';
|
|
16142
|
+
/**
|
|
16143
|
+
* PNG file identifier (file-…) whose transparent area marks the region to replace.
|
|
16144
|
+
*/
|
|
16145
|
+
mask: string;
|
|
16146
|
+
/**
|
|
16147
|
+
* Content that should replace the masked region.
|
|
16148
|
+
*/
|
|
16149
|
+
prompt: string;
|
|
16150
|
+
/**
|
|
16151
|
+
* Pixels to grow the mask by before applying the edit.
|
|
16152
|
+
*/
|
|
16153
|
+
grow_mask?: number;
|
|
16154
|
+
/**
|
|
16155
|
+
* Swap the meaning of the mask so the opaque area is the edit region.
|
|
16156
|
+
*/
|
|
16157
|
+
invert?: boolean;
|
|
16158
|
+
} | {
|
|
16159
|
+
/**
|
|
16160
|
+
* Edit operation discriminator; erase selects the erase branch of this union.
|
|
16161
|
+
*/
|
|
16162
|
+
type: 'erase';
|
|
16163
|
+
/**
|
|
16164
|
+
* PNG file identifier (file-…) whose transparent area marks the object to remove.
|
|
16165
|
+
*/
|
|
16166
|
+
mask?: string;
|
|
16167
|
+
/**
|
|
16168
|
+
* Name of the object to remove, used when no mask is supplied.
|
|
16169
|
+
*/
|
|
16170
|
+
target_prompt?: string;
|
|
16171
|
+
} | {
|
|
16172
|
+
/**
|
|
16173
|
+
* Edit operation discriminator; replace_object selects the replace_object branch of this union.
|
|
16174
|
+
*/
|
|
16175
|
+
type: 'replace_object';
|
|
16176
|
+
/**
|
|
16177
|
+
* Name of the object to replace.
|
|
16178
|
+
*/
|
|
16179
|
+
target_prompt: string;
|
|
16180
|
+
/**
|
|
16181
|
+
* Content that should replace it.
|
|
16182
|
+
*/
|
|
16183
|
+
prompt: string;
|
|
16184
|
+
} | {
|
|
16185
|
+
/**
|
|
16186
|
+
* Edit operation discriminator; recolor selects the recolor branch of this union.
|
|
16187
|
+
*/
|
|
16188
|
+
type: 'recolor';
|
|
16189
|
+
/**
|
|
16190
|
+
* Name of the object to recolour.
|
|
16191
|
+
*/
|
|
16192
|
+
target_prompt: string;
|
|
16193
|
+
/**
|
|
16194
|
+
* Colour or description the object should take.
|
|
16195
|
+
*/
|
|
16196
|
+
prompt: string;
|
|
16197
|
+
} | {
|
|
16198
|
+
/**
|
|
16199
|
+
* Edit operation discriminator; remove_background selects the remove_background branch of this union.
|
|
16200
|
+
*/
|
|
16201
|
+
type: 'remove_background';
|
|
16202
|
+
} | {
|
|
16203
|
+
/**
|
|
16204
|
+
* Edit operation discriminator; replace_background selects the replace_background branch of this union.
|
|
16205
|
+
*/
|
|
16206
|
+
type: 'replace_background';
|
|
16207
|
+
/**
|
|
16208
|
+
* Background that should appear behind the subject.
|
|
16209
|
+
*/
|
|
16210
|
+
prompt: string;
|
|
16211
|
+
/**
|
|
16212
|
+
* Existing assets the model may use for the new background, each with the role it plays.
|
|
16213
|
+
*/
|
|
16214
|
+
references?: Array<MediaAssetReference>;
|
|
16215
|
+
} | ({
|
|
16216
|
+
/**
|
|
16217
|
+
* Edit operation discriminator; to_video selects the to_video branch of this union.
|
|
16218
|
+
*/
|
|
16219
|
+
type: 'to_video';
|
|
16220
|
+
} & {
|
|
16221
|
+
/**
|
|
16222
|
+
* Text prompt describing the motion the video should show.
|
|
16223
|
+
*/
|
|
16224
|
+
prompt?: string;
|
|
16225
|
+
/**
|
|
16226
|
+
* What the video must not contain.
|
|
16227
|
+
*/
|
|
16228
|
+
negative_prompt?: string;
|
|
16229
|
+
/**
|
|
16230
|
+
* Asset used as the final frame of the generated video.
|
|
16231
|
+
*/
|
|
16232
|
+
last_frame?: MediaAssetId;
|
|
16233
|
+
/**
|
|
16234
|
+
* Existing assets the model may use, each with the role it plays.
|
|
16235
|
+
*/
|
|
16236
|
+
references?: Array<MediaAssetReference>;
|
|
16237
|
+
/**
|
|
16238
|
+
* Requested video length in seconds; Router validates the model’s supported durations.
|
|
16239
|
+
*/
|
|
16240
|
+
duration_seconds?: number;
|
|
16241
|
+
/**
|
|
16242
|
+
* Requested output resolution: 480p, 720p, 1080p or 4k.
|
|
16243
|
+
*/
|
|
16244
|
+
resolution?: '480p' | '720p' | '1080p' | '4k';
|
|
16245
|
+
/**
|
|
16246
|
+
* Requested output aspect ratio; Router validates model support.
|
|
16247
|
+
*/
|
|
16248
|
+
aspect_ratio?: string;
|
|
16249
|
+
/**
|
|
16250
|
+
* True to generate an audio track with the video.
|
|
16251
|
+
*/
|
|
16252
|
+
generate_audio?: boolean;
|
|
16253
|
+
/**
|
|
16254
|
+
* Container of the produced video: mp4 or gif.
|
|
16255
|
+
*/
|
|
16256
|
+
output?: 'mp4' | 'gif';
|
|
16257
|
+
/**
|
|
16258
|
+
* Videos to generate in one job.
|
|
16259
|
+
*/
|
|
16260
|
+
n?: number;
|
|
16261
|
+
/**
|
|
16262
|
+
* Seed for reproducible sampling; omit it to let the model choose one.
|
|
16263
|
+
*/
|
|
16264
|
+
seed?: number;
|
|
16265
|
+
}) | {
|
|
16266
|
+
/**
|
|
16267
|
+
* Edit operation discriminator; extend selects the extend branch of this union.
|
|
16268
|
+
*/
|
|
16269
|
+
type: 'extend';
|
|
16270
|
+
/**
|
|
16271
|
+
* Seconds to lengthen the video by.
|
|
16272
|
+
*/
|
|
16273
|
+
duration_seconds: number;
|
|
16274
|
+
/**
|
|
16275
|
+
* Content that should appear in the extension.
|
|
16276
|
+
*/
|
|
16277
|
+
prompt?: string;
|
|
16278
|
+
} | {
|
|
16279
|
+
/**
|
|
16280
|
+
* Edit operation discriminator; edit selects the edit branch of this union.
|
|
16281
|
+
*/
|
|
16282
|
+
type: 'edit';
|
|
16283
|
+
/**
|
|
16284
|
+
* Change to apply to the video.
|
|
16285
|
+
*/
|
|
16286
|
+
prompt: string;
|
|
16287
|
+
} | {
|
|
16288
|
+
/**
|
|
16289
|
+
* Edit operation discriminator; lip_sync selects the lip_sync branch of this union.
|
|
16290
|
+
*/
|
|
16291
|
+
type: 'lip_sync';
|
|
16292
|
+
/**
|
|
16293
|
+
* Audio asset whose speech should drive the speaker’s lips.
|
|
16294
|
+
*/
|
|
16295
|
+
audio_asset_id?: MediaAssetId;
|
|
16296
|
+
/**
|
|
16297
|
+
* Speech to synthesize for the speaker instead of an existing audio asset.
|
|
16298
|
+
*/
|
|
16299
|
+
speech?: MediaSpeechCreateInput;
|
|
16300
|
+
} | {
|
|
16301
|
+
/**
|
|
16302
|
+
* Edit operation discriminator; frame selects the frame branch of this union.
|
|
16303
|
+
*/
|
|
16304
|
+
type: 'frame';
|
|
16305
|
+
/**
|
|
16306
|
+
* Time in the video, in seconds, to take the frame from.
|
|
16307
|
+
*/
|
|
16308
|
+
at_seconds: number;
|
|
16309
|
+
} | {
|
|
16310
|
+
/**
|
|
16311
|
+
* Edit operation discriminator; to_gif selects the to_gif branch of this union.
|
|
16312
|
+
*/
|
|
16313
|
+
type: 'to_gif';
|
|
16314
|
+
} | {
|
|
16315
|
+
/**
|
|
16316
|
+
* Edit operation discriminator; voice_change selects the voice_change branch of this union.
|
|
16317
|
+
*/
|
|
16318
|
+
type: 'voice_change';
|
|
16319
|
+
/**
|
|
16320
|
+
* Voice identifier to switch to.
|
|
16321
|
+
*/
|
|
16322
|
+
voice: string;
|
|
16323
|
+
} | {
|
|
16324
|
+
/**
|
|
16325
|
+
* Edit operation discriminator; resynthesize selects the resynthesize branch of this union.
|
|
16326
|
+
*/
|
|
16327
|
+
type: 'resynthesize';
|
|
16328
|
+
/**
|
|
16329
|
+
* Voice identifier to synthesize with.
|
|
16330
|
+
*/
|
|
16331
|
+
voice: string;
|
|
16332
|
+
};
|
|
15943
16333
|
export type MediaFailureSummary = {
|
|
15944
16334
|
/**
|
|
15945
16335
|
* Number of current failed understanding entries, excluding deleted assets and superseded versions.
|
|
@@ -15955,9 +16345,9 @@ export type MediaFailureSummary = {
|
|
|
15955
16345
|
counts_complete: boolean;
|
|
15956
16346
|
};
|
|
15957
16347
|
/**
|
|
15958
|
-
* Current state of a batch
|
|
16348
|
+
* Current state of a job. Image generation and edits answer queued, in_progress, completed, failed and canceled; batch and video jobs also still answer running, completed_with_errors and cancelled while ADR-094 §9 retires those words.
|
|
15959
16349
|
*/
|
|
15960
|
-
export type MediaJobStatus = 'queued' | 'running' | 'completed' | 'completed_with_errors' | 'failed' | 'cancelled';
|
|
16350
|
+
export type MediaJobStatus = 'queued' | 'in_progress' | 'running' | 'completed' | 'completed_with_errors' | 'failed' | 'cancelled' | 'canceled';
|
|
15961
16351
|
/**
|
|
15962
16352
|
* Identifier returned when a batch job is created.
|
|
15963
16353
|
*/
|
|
@@ -16217,6 +16607,23 @@ export type OntologyUpdateNodeInput = {
|
|
|
16217
16607
|
*/
|
|
16218
16608
|
description?: string;
|
|
16219
16609
|
};
|
|
16610
|
+
/**
|
|
16611
|
+
* The subgraph around one node, bounded by the request's depth and limit. It is not a page, so it carries no cursor; truncated says whether there was more.
|
|
16612
|
+
*/
|
|
16613
|
+
export type OntologyNeighborhood = {
|
|
16614
|
+
/**
|
|
16615
|
+
* The nodes in BFS order — the start node first, then each hop ordered by node id, so the same request against the same graph returns the same sequence. A node you may reach but not read appears as a restricted entry.
|
|
16616
|
+
*/
|
|
16617
|
+
nodes: Array<OntologyNode | OntologyRestrictedNode>;
|
|
16618
|
+
/**
|
|
16619
|
+
* The relations whose both ends are in nodes, ordered by relation id. A relation touching a node you may not read is withheld, so this list never reveals content nodes.retrieve would withhold.
|
|
16620
|
+
*/
|
|
16621
|
+
relations: Array<OntologyRelation>;
|
|
16622
|
+
/**
|
|
16623
|
+
* True when the node limit stopped the walk before it reached its depth, so nodes is a sample rather than the whole neighborhood; raise limit or lower depth for a complete answer within the bounds.
|
|
16624
|
+
*/
|
|
16625
|
+
truncated: boolean;
|
|
16626
|
+
};
|
|
16220
16627
|
/**
|
|
16221
16628
|
* The survivor the merged node folds into.
|
|
16222
16629
|
*/
|
|
@@ -17077,20 +17484,20 @@ export type StudioPlatform = {
|
|
|
17077
17484
|
/**
|
|
17078
17485
|
* How closely the Console preview matches the published result; an approximate preview is labelled as such.
|
|
17079
17486
|
*/
|
|
17080
|
-
|
|
17487
|
+
preview_fidelity?: 'exact' | 'approximate' | 'none';
|
|
17081
17488
|
limits?: StudioPlatformLimits;
|
|
17082
17489
|
/**
|
|
17083
17490
|
* Whether a connected channel is required before this platform can receive a rendition.
|
|
17084
17491
|
*/
|
|
17085
|
-
|
|
17492
|
+
needs_channel?: boolean;
|
|
17086
17493
|
/**
|
|
17087
17494
|
* Channel permission tiers this platform accepts, one for staging a draft and one for publishing.
|
|
17088
17495
|
*/
|
|
17089
|
-
|
|
17496
|
+
channel_scopes?: Array<'draft' | 'publish'>;
|
|
17090
17497
|
/**
|
|
17091
17498
|
* Delivery stage that opened this platform; a value other than s3 means a rendition for it is still refused.
|
|
17092
17499
|
*/
|
|
17093
|
-
|
|
17500
|
+
available_from?: 's3' | 's5' | 's7';
|
|
17094
17501
|
/**
|
|
17095
17502
|
* Limit names still unconfirmed against the platform documentation; treat the listed values as provisional.
|
|
17096
17503
|
*/
|
|
@@ -17122,7 +17529,7 @@ export type StudioWorkCreateInput = {
|
|
|
17122
17529
|
/**
|
|
17123
17530
|
* Caller-chosen key that makes this create safe to repeat: the same value answers the first result instead of creating a second work.
|
|
17124
17531
|
*/
|
|
17125
|
-
|
|
17532
|
+
request_id?: string;
|
|
17126
17533
|
};
|
|
17127
17534
|
/**
|
|
17128
17535
|
* One work: a piece that can be delivered on its own, together with the goal it serves, the brief it came from, its drafts and the reference libraries it draws on.
|
|
@@ -17137,17 +17544,17 @@ export type StudioWork = {
|
|
|
17137
17544
|
*/
|
|
17138
17545
|
object: string;
|
|
17139
17546
|
/**
|
|
17140
|
-
* Creation time in RFC 3339 UTC; it never moves, unlike
|
|
17547
|
+
* Creation time in RFC 3339 UTC; it never moves, unlike update_time.
|
|
17141
17548
|
*/
|
|
17142
|
-
|
|
17549
|
+
create_time?: string;
|
|
17143
17550
|
/**
|
|
17144
|
-
* Time of the last work-level change in RFC 3339 UTC; content writes move
|
|
17551
|
+
* Time of the last work-level change in RFC 3339 UTC; content writes move content_revision instead and leave this alone.
|
|
17145
17552
|
*/
|
|
17146
|
-
|
|
17553
|
+
update_time?: string;
|
|
17147
17554
|
/**
|
|
17148
17555
|
* Console address of this work, ready to hand to a person; it opens the editing page rather than the API.
|
|
17149
17556
|
*/
|
|
17150
|
-
|
|
17557
|
+
viewer_url: string;
|
|
17151
17558
|
/**
|
|
17152
17559
|
* Organization-unique name of the work, usable in every call in place of the identifier; an old value still resolves after a rename.
|
|
17153
17560
|
*/
|
|
@@ -17160,7 +17567,7 @@ export type StudioWork = {
|
|
|
17160
17567
|
/**
|
|
17161
17568
|
* Revision of the goal message alone; a draft derived from the message records the value it was built on and turns stale when this moves past it.
|
|
17162
17569
|
*/
|
|
17163
|
-
|
|
17570
|
+
message_revision?: number;
|
|
17164
17571
|
brief: StudioBrief;
|
|
17165
17572
|
/**
|
|
17166
17573
|
* Reference libraries attached to this work; their entries are what the context pack draws on while a unit is written.
|
|
@@ -17170,7 +17577,7 @@ export type StudioWork = {
|
|
|
17170
17577
|
* Style attached to the work, which drafts inherit unless one overrides it; null means the work carries no style.
|
|
17171
17578
|
*/
|
|
17172
17579
|
style?: string;
|
|
17173
|
-
|
|
17580
|
+
adapted_from?: StudioDerivation;
|
|
17174
17581
|
labels?: StudioLabels;
|
|
17175
17582
|
/**
|
|
17176
17583
|
* Work-level settings revision; pass it as expected_revision when changing the title, goal, libraries or style.
|
|
@@ -17179,7 +17586,7 @@ export type StudioWork = {
|
|
|
17179
17586
|
/**
|
|
17180
17587
|
* Content revision of the whole work, moved by any unit or draft write; derivations, projections and versions compare against it.
|
|
17181
17588
|
*/
|
|
17182
|
-
|
|
17589
|
+
content_revision: number;
|
|
17183
17590
|
/**
|
|
17184
17591
|
* Whether the work is archived; an archived work stays readable and writable but is left out of the default list.
|
|
17185
17592
|
*/
|
|
@@ -17200,11 +17607,11 @@ export type StudioWorkPage = {
|
|
|
17200
17607
|
/**
|
|
17201
17608
|
* Cursor for the next page, empty when this was the last one; pass it back as page_token unchanged.
|
|
17202
17609
|
*/
|
|
17203
|
-
|
|
17610
|
+
next_page_token?: string;
|
|
17204
17611
|
/**
|
|
17205
17612
|
* Total number of works matching the request, when the service can count them cheaply; treat it as a hint, not a page count.
|
|
17206
17613
|
*/
|
|
17207
|
-
|
|
17614
|
+
total_size?: number;
|
|
17208
17615
|
};
|
|
17209
17616
|
/**
|
|
17210
17617
|
* What a loose reference resolved to, or the closest matches when it resolved to nothing.
|
|
@@ -17257,11 +17664,11 @@ export type StudioWorkUpdateInput = {
|
|
|
17257
17664
|
/**
|
|
17258
17665
|
* Field paths this call changes, spelled as they appear in the work, such as title or goal.message; a field left out keeps its value.
|
|
17259
17666
|
*/
|
|
17260
|
-
|
|
17667
|
+
update_mask: Array<string>;
|
|
17261
17668
|
/**
|
|
17262
17669
|
* Work revision the caller read; when the work moved past it the write is refused with REVISION_CONFLICT and nothing changes.
|
|
17263
17670
|
*/
|
|
17264
|
-
|
|
17671
|
+
expected_revision?: number;
|
|
17265
17672
|
/**
|
|
17266
17673
|
* New working title of the work, replacing the previous one when title is named in the update mask.
|
|
17267
17674
|
*/
|
|
@@ -17306,7 +17713,7 @@ export type StudioBriefUpdateInput = {
|
|
|
17306
17713
|
/**
|
|
17307
17714
|
* Brief revision the caller read; a mismatch is refused with REVISION_CONFLICT rather than merged.
|
|
17308
17715
|
*/
|
|
17309
|
-
|
|
17716
|
+
expected_revision?: number;
|
|
17310
17717
|
/**
|
|
17311
17718
|
* Text to append to the stored brief, added after what is already there and never replacing it.
|
|
17312
17719
|
*/
|
|
@@ -17316,17 +17723,17 @@ export type StudioBriefUpdateInput = {
|
|
|
17316
17723
|
*/
|
|
17317
17724
|
attachments?: Array<string>;
|
|
17318
17725
|
/**
|
|
17319
|
-
* New requirement points to split out of the brief; each receives the next free key in order.
|
|
17726
|
+
* New requirement points to split out of the brief; each receives the next free key in order. A plain string is a unit point; pass { text, scope: work } for a constraint on the whole piece (period, voice, point of view, cast, words to avoid).
|
|
17320
17727
|
*/
|
|
17321
|
-
|
|
17728
|
+
add_points?: Array<string | StudioBriefPointInput>;
|
|
17322
17729
|
/**
|
|
17323
17730
|
* Existing points to reword, each naming the key it keeps and the text that replaces it.
|
|
17324
17731
|
*/
|
|
17325
|
-
|
|
17732
|
+
edit_points?: Array<StudioBriefPointEdit>;
|
|
17326
17733
|
/**
|
|
17327
17734
|
* Keys of points to drop; a dropped key is never reused, so later points keep their own keys.
|
|
17328
17735
|
*/
|
|
17329
|
-
|
|
17736
|
+
remove_points?: Array<string>;
|
|
17330
17737
|
};
|
|
17331
17738
|
/**
|
|
17332
17739
|
* The updated brief with the checks it now fails and the next items of work, so the caller continues without re-reading.
|
|
@@ -17366,7 +17773,7 @@ export type StudioDraftCreateInput = {
|
|
|
17366
17773
|
* Unit tree to create the draft with, given by the caller instead of a template; children nest, and a unit without a kind takes the genre default for its position.
|
|
17367
17774
|
*/
|
|
17368
17775
|
outline?: Array<StudioOutlineInput>;
|
|
17369
|
-
|
|
17776
|
+
derived_from?: StudioDraftSourceInput;
|
|
17370
17777
|
/**
|
|
17371
17778
|
* Initial values for the genre properties, keyed by property key; a value the genre does not define is refused rather than stored.
|
|
17372
17779
|
*/
|
|
@@ -17376,7 +17783,7 @@ export type StudioDraftCreateInput = {
|
|
|
17376
17783
|
/**
|
|
17377
17784
|
* Caller-chosen key that makes this create safe to repeat: the same value answers the first draft instead of creating a second one.
|
|
17378
17785
|
*/
|
|
17379
|
-
|
|
17786
|
+
request_id?: string;
|
|
17380
17787
|
};
|
|
17381
17788
|
/**
|
|
17382
17789
|
* A draft together with the unit tree and the todo list a caller asked for in the same call.
|
|
@@ -17404,11 +17811,11 @@ export type StudioDraftUpdateInput = {
|
|
|
17404
17811
|
/**
|
|
17405
17812
|
* Field paths this call changes, such as title, key or props.topics; a field left out keeps its value.
|
|
17406
17813
|
*/
|
|
17407
|
-
|
|
17814
|
+
update_mask: Array<string>;
|
|
17408
17815
|
/**
|
|
17409
17816
|
* Draft revision the caller read; a mismatch is refused with REVISION_CONFLICT and nothing changes. Omit it only for structure calls that genuinely do not depend on the current state.
|
|
17410
17817
|
*/
|
|
17411
|
-
|
|
17818
|
+
expected_revision?: number;
|
|
17412
17819
|
/**
|
|
17413
17820
|
* New page title of the draft, replacing the previous one when title is named in the update mask.
|
|
17414
17821
|
*/
|
|
@@ -17503,7 +17910,7 @@ export type StudioReviewReport = {
|
|
|
17503
17910
|
/**
|
|
17504
17911
|
* Every requirement point of the brief with the units that claim it, so a gap is visible without reading the whole draft.
|
|
17505
17912
|
*/
|
|
17506
|
-
|
|
17913
|
+
brief_coverage: Array<StudioBriefCoverage>;
|
|
17507
17914
|
/**
|
|
17508
17915
|
* The body text to review: the full text when the draft is short, otherwise a synopsis with an excerpt around each unit.
|
|
17509
17916
|
*/
|
|
@@ -17511,7 +17918,7 @@ export type StudioReviewReport = {
|
|
|
17511
17918
|
/**
|
|
17512
17919
|
* Cursor for the next slice of body text, empty when this answer carried all of it; pass it back unchanged.
|
|
17513
17920
|
*/
|
|
17514
|
-
|
|
17921
|
+
next_page_token: string;
|
|
17515
17922
|
};
|
|
17516
17923
|
/**
|
|
17517
17924
|
* The revision the caller read before confirming a draft already follows its source.
|
|
@@ -17520,7 +17927,7 @@ export type StudioRebaseInput = {
|
|
|
17520
17927
|
/**
|
|
17521
17928
|
* Draft revision the caller read; a mismatch is refused rather than confirming a draft that changed under the caller.
|
|
17522
17929
|
*/
|
|
17523
|
-
|
|
17930
|
+
expected_revision?: number;
|
|
17524
17931
|
};
|
|
17525
17932
|
/**
|
|
17526
17933
|
* The whole draft as one document, in the format that was asked for.
|
|
@@ -17641,7 +18048,7 @@ export type StudioUnitContent = StudioUnit & {
|
|
|
17641
18048
|
* Whole body as Markdown with block anchors kept inline, so a rewrite can round-trip the block identifiers.
|
|
17642
18049
|
*/
|
|
17643
18050
|
markdown?: string;
|
|
17644
|
-
|
|
18051
|
+
intent_diff?: StudioIntentDiff;
|
|
17645
18052
|
};
|
|
17646
18053
|
/**
|
|
17647
18054
|
* The change to one unit: any of its intent fields, its status, its links, or its body as one Markdown text.
|
|
@@ -17824,15 +18231,15 @@ export type StudioCodex = {
|
|
|
17824
18231
|
/**
|
|
17825
18232
|
* Creation time in RFC 3339 UTC.
|
|
17826
18233
|
*/
|
|
17827
|
-
|
|
18234
|
+
create_time?: string;
|
|
17828
18235
|
/**
|
|
17829
18236
|
* Time of the last change to the library itself in RFC 3339 UTC; adding an entry moves the entry, not this.
|
|
17830
18237
|
*/
|
|
17831
|
-
|
|
18238
|
+
update_time?: string;
|
|
17832
18239
|
/**
|
|
17833
18240
|
* Console address of this library, which opens its entry list; the same address carries an entry parameter when one entry is open.
|
|
17834
18241
|
*/
|
|
17835
|
-
|
|
18242
|
+
viewer_url: string;
|
|
17836
18243
|
/**
|
|
17837
18244
|
* Name of the library, used by people to pick it when attaching it to a work; it is not unique across the organization.
|
|
17838
18245
|
*/
|
|
@@ -17844,7 +18251,7 @@ export type StudioCodex = {
|
|
|
17844
18251
|
/**
|
|
17845
18252
|
* How many entries the library holds right now, which is what tells a caller whether the entry list still needs paging.
|
|
17846
18253
|
*/
|
|
17847
|
-
|
|
18254
|
+
entry_count: number;
|
|
17848
18255
|
labels: StudioLabels;
|
|
17849
18256
|
};
|
|
17850
18257
|
/**
|
|
@@ -17858,7 +18265,7 @@ export type StudioCodexPage = {
|
|
|
17858
18265
|
/**
|
|
17859
18266
|
* Cursor for the next page, empty when this was the last one; pass it back as page_token unchanged.
|
|
17860
18267
|
*/
|
|
17861
|
-
|
|
18268
|
+
next_page_token?: string;
|
|
17862
18269
|
};
|
|
17863
18270
|
/**
|
|
17864
18271
|
* The change to a reference library: the fields named by the update mask.
|
|
@@ -17867,7 +18274,7 @@ export type StudioCodexUpdateInput = {
|
|
|
17867
18274
|
/**
|
|
17868
18275
|
* Field paths this call changes, such as name, description or labels; a field left out keeps its value.
|
|
17869
18276
|
*/
|
|
17870
|
-
|
|
18277
|
+
update_mask: Array<string>;
|
|
17871
18278
|
/**
|
|
17872
18279
|
* New name of the library, replacing the previous one when name is named in the update mask.
|
|
17873
18280
|
*/
|
|
@@ -17953,15 +18360,15 @@ export type StudioEntry = {
|
|
|
17953
18360
|
/**
|
|
17954
18361
|
* Creation time in RFC 3339 UTC.
|
|
17955
18362
|
*/
|
|
17956
|
-
|
|
18363
|
+
create_time?: string;
|
|
17957
18364
|
/**
|
|
17958
18365
|
* Time of the last change to this entry in RFC 3339 UTC.
|
|
17959
18366
|
*/
|
|
17960
|
-
|
|
18367
|
+
update_time?: string;
|
|
17961
18368
|
/**
|
|
17962
18369
|
* Console address that opens this entry inside its library, which is where its facts and mentions can be read side by side.
|
|
17963
18370
|
*/
|
|
17964
|
-
|
|
18371
|
+
viewer_url: string;
|
|
17965
18372
|
/**
|
|
17966
18373
|
* Library this entry belongs to; an entry never moves between libraries.
|
|
17967
18374
|
*/
|
|
@@ -17981,11 +18388,11 @@ export type StudioEntry = {
|
|
|
17981
18388
|
/**
|
|
17982
18389
|
* Whether matching distinguishes letter case; leave it false for Chinese text and turn it on for names that collide with ordinary words.
|
|
17983
18390
|
*/
|
|
17984
|
-
|
|
18391
|
+
case_sensitive: boolean;
|
|
17985
18392
|
/**
|
|
17986
18393
|
* Phrases in which this name must not count as a mention, such as an idiom that happens to contain it.
|
|
17987
18394
|
*/
|
|
17988
|
-
|
|
18395
|
+
exclude_phrases: Array<string>;
|
|
17989
18396
|
/**
|
|
17990
18397
|
* What a writer should know about this entry; it is the text that reaches the context pack when the entry is included.
|
|
17991
18398
|
*/
|
|
@@ -18024,7 +18431,7 @@ export type StudioEntryPage = {
|
|
|
18024
18431
|
/**
|
|
18025
18432
|
* Cursor for the next page, empty when this was the last one; pass it back as page_token unchanged.
|
|
18026
18433
|
*/
|
|
18027
|
-
|
|
18434
|
+
next_page_token?: string;
|
|
18028
18435
|
};
|
|
18029
18436
|
/**
|
|
18030
18437
|
* The change to one reference entry: the fields named by the update mask, plus the complete relation set when relations change.
|
|
@@ -18033,7 +18440,7 @@ export type StudioEntryUpdateInput = {
|
|
|
18033
18440
|
/**
|
|
18034
18441
|
* Field paths this call changes, such as name, description or facts.成立年份; a field left out keeps its value, and a list field named here is replaced whole.
|
|
18035
18442
|
*/
|
|
18036
|
-
|
|
18443
|
+
update_mask: Array<string>;
|
|
18037
18444
|
/**
|
|
18038
18445
|
* New kind for this entry, which changes how it is shown and how genres treat it.
|
|
18039
18446
|
*/
|
|
@@ -18127,15 +18534,15 @@ export type StudioStyle = {
|
|
|
18127
18534
|
/**
|
|
18128
18535
|
* Creation time in RFC 3339 UTC.
|
|
18129
18536
|
*/
|
|
18130
|
-
|
|
18537
|
+
create_time?: string;
|
|
18131
18538
|
/**
|
|
18132
18539
|
* Time of the last change to this style in RFC 3339 UTC.
|
|
18133
18540
|
*/
|
|
18134
|
-
|
|
18541
|
+
update_time?: string;
|
|
18135
18542
|
/**
|
|
18136
18543
|
* Console address that opens this style, where its samples can be read beside a piece written with it.
|
|
18137
18544
|
*/
|
|
18138
|
-
|
|
18545
|
+
viewer_url: string;
|
|
18139
18546
|
/**
|
|
18140
18547
|
* Name of the style, used by people to pick it when attaching it to a work or a draft.
|
|
18141
18548
|
*/
|
|
@@ -18174,7 +18581,7 @@ export type StudioStylePage = {
|
|
|
18174
18581
|
/**
|
|
18175
18582
|
* Cursor for the next page, empty when this was the last one; pass it back as page_token unchanged.
|
|
18176
18583
|
*/
|
|
18177
|
-
|
|
18584
|
+
next_page_token?: string;
|
|
18178
18585
|
};
|
|
18179
18586
|
/**
|
|
18180
18587
|
* The change to one style: the fields named by the update mask.
|
|
@@ -18183,7 +18590,7 @@ export type StudioStyleUpdateInput = {
|
|
|
18183
18590
|
/**
|
|
18184
18591
|
* Field paths this call changes, such as description, samples or avoid; a list named here is replaced whole and a field left out keeps its value.
|
|
18185
18592
|
*/
|
|
18186
|
-
|
|
18593
|
+
update_mask: Array<string>;
|
|
18187
18594
|
/**
|
|
18188
18595
|
* New name of the style, replacing the previous one when name is named in the update mask.
|
|
18189
18596
|
*/
|
|
@@ -18222,7 +18629,7 @@ export type StudioTemplatePage = {
|
|
|
18222
18629
|
/**
|
|
18223
18630
|
* Cursor for the next page, empty when this was the last one; the built-in templates ride the first page only, so a later page carries saved templates alone.
|
|
18224
18631
|
*/
|
|
18225
|
-
|
|
18632
|
+
next_page_token?: string;
|
|
18226
18633
|
};
|
|
18227
18634
|
/**
|
|
18228
18635
|
* The template to save: a starting unit tree for one genre.
|
|
@@ -18285,7 +18692,7 @@ export type StudioThemePage = {
|
|
|
18285
18692
|
/**
|
|
18286
18693
|
* Cursor for the next page, empty when this was the last one; pass it back as page_token unchanged.
|
|
18287
18694
|
*/
|
|
18288
|
-
|
|
18695
|
+
next_page_token?: string;
|
|
18289
18696
|
};
|
|
18290
18697
|
/**
|
|
18291
18698
|
* The rendition theme to create for one platform.
|
|
@@ -18336,11 +18743,11 @@ export type StudioTheme = {
|
|
|
18336
18743
|
/**
|
|
18337
18744
|
* Creation time in RFC 3339 UTC.
|
|
18338
18745
|
*/
|
|
18339
|
-
|
|
18746
|
+
create_time?: string;
|
|
18340
18747
|
/**
|
|
18341
18748
|
* Time of the last change to this theme in RFC 3339 UTC.
|
|
18342
18749
|
*/
|
|
18343
|
-
|
|
18750
|
+
update_time?: string;
|
|
18344
18751
|
/**
|
|
18345
18752
|
* Versioned platform key this theme renders for; a theme of another platform cannot produce that platform's rendition.
|
|
18346
18753
|
*/
|
|
@@ -18364,7 +18771,7 @@ export type StudioTheme = {
|
|
|
18364
18771
|
/**
|
|
18365
18772
|
* Reference document that gives a DOCX rendition its styles, referenced by its file identifier; present instead of the markup for a word-processor platform.
|
|
18366
18773
|
*/
|
|
18367
|
-
|
|
18774
|
+
reference_docx?: string;
|
|
18368
18775
|
/**
|
|
18369
18776
|
* Fragment placed at the top of every rendition, such as a publication name; it is fixed across the whole output.
|
|
18370
18777
|
*/
|
|
@@ -18386,7 +18793,7 @@ export type StudioThemeUpdateInput = {
|
|
|
18386
18793
|
/**
|
|
18387
18794
|
* Field paths this call changes, such as name, css or footer; a field left out keeps its value.
|
|
18388
18795
|
*/
|
|
18389
|
-
|
|
18796
|
+
update_mask: Array<string>;
|
|
18390
18797
|
/**
|
|
18391
18798
|
* New name of the theme, replacing the previous one when name is named in the update mask.
|
|
18392
18799
|
*/
|
|
@@ -18413,6 +18820,198 @@ export type StudioThemeUpdateInput = {
|
|
|
18413
18820
|
footer?: string;
|
|
18414
18821
|
card?: StudioCardSettings;
|
|
18415
18822
|
};
|
|
18823
|
+
/**
|
|
18824
|
+
* The rendition to create from the draft in the path.
|
|
18825
|
+
*/
|
|
18826
|
+
export type StudioRenditionCreateInput = {
|
|
18827
|
+
/**
|
|
18828
|
+
* Versioned platform key from the platform list. Export platforms today are markdown@1, docx@1 and xiaohongshu@1; a platform that only publishes to an account answers PLATFORM_NOT_AVAILABLE.
|
|
18829
|
+
*/
|
|
18830
|
+
platform: string;
|
|
18831
|
+
/**
|
|
18832
|
+
* Theme to render with, a thm_ identifier or a built-in key from the theme list; omit it to use the platform default.
|
|
18833
|
+
*/
|
|
18834
|
+
theme?: string;
|
|
18835
|
+
settings?: StudioRenditionSettings;
|
|
18836
|
+
/**
|
|
18837
|
+
* Whether to render in the same call. True returns a rendition that is already rendered, invalid or failed; false or omitted returns it pending, to be rendered by the render operation.
|
|
18838
|
+
*/
|
|
18839
|
+
render?: boolean;
|
|
18840
|
+
/**
|
|
18841
|
+
* Caller-chosen key that makes a repeated create return the first rendition instead of making another; use a new value for each distinct rendition.
|
|
18842
|
+
*/
|
|
18843
|
+
request_id?: string;
|
|
18844
|
+
};
|
|
18845
|
+
/**
|
|
18846
|
+
* The form of one draft for one platform: how it was rendered, what the render found, the parts and files it produced, and its export or publish state. Render state and publish state are separate: a rendition is rendered first and then exported.
|
|
18847
|
+
*/
|
|
18848
|
+
export type StudioRendition = {
|
|
18849
|
+
/**
|
|
18850
|
+
* Rendition identifier, the value the rendition path segment takes.
|
|
18851
|
+
*/
|
|
18852
|
+
id: string;
|
|
18853
|
+
/**
|
|
18854
|
+
* Resource kind marker, always studio.rendition for this shape.
|
|
18855
|
+
*/
|
|
18856
|
+
object: string;
|
|
18857
|
+
/**
|
|
18858
|
+
* Creation time in RFC 3339 UTC.
|
|
18859
|
+
*/
|
|
18860
|
+
create_time?: string;
|
|
18861
|
+
/**
|
|
18862
|
+
* Time of the last change to this rendition in RFC 3339 UTC.
|
|
18863
|
+
*/
|
|
18864
|
+
update_time?: string;
|
|
18865
|
+
/**
|
|
18866
|
+
* Console address of this rendition, which opens the work page on it.
|
|
18867
|
+
*/
|
|
18868
|
+
viewer_url?: string;
|
|
18869
|
+
/**
|
|
18870
|
+
* Identifier of the work this rendition belongs to.
|
|
18871
|
+
*/
|
|
18872
|
+
work: string;
|
|
18873
|
+
/**
|
|
18874
|
+
* Identifier of the draft this rendition is built from.
|
|
18875
|
+
*/
|
|
18876
|
+
draft: string;
|
|
18877
|
+
/**
|
|
18878
|
+
* Versioned platform key the rendition is for, such as xiaohongshu@1, docx@1 or markdown@1.
|
|
18879
|
+
*/
|
|
18880
|
+
platform: string;
|
|
18881
|
+
/**
|
|
18882
|
+
* File format the platform receives, decided by the platform.
|
|
18883
|
+
*/
|
|
18884
|
+
format: 'markdown' | 'text' | 'docx' | 'inline_html' | 'card_png' | 'post_text' | 'thread' | 'lexical_html' | 'epub' | 'video_meta';
|
|
18885
|
+
/**
|
|
18886
|
+
* Theme the rendition uses, a thm_ identifier or a built-in theme key; null means the platform default.
|
|
18887
|
+
*/
|
|
18888
|
+
theme?: string | null;
|
|
18889
|
+
settings?: StudioRenditionSettings;
|
|
18890
|
+
/**
|
|
18891
|
+
* Content revision of the draft this rendition was last rendered from; compared with the draft to derive stale.
|
|
18892
|
+
*/
|
|
18893
|
+
source_revision: number;
|
|
18894
|
+
/**
|
|
18895
|
+
* True when the draft has changed past source_revision. A stale rendition cannot be exported (RENDITION_STALE); call the render operation to rebuild it.
|
|
18896
|
+
*/
|
|
18897
|
+
stale: boolean;
|
|
18898
|
+
/**
|
|
18899
|
+
* Where the render stands.
|
|
18900
|
+
*/
|
|
18901
|
+
render_state: 'pending' | 'rendering' | 'rendered' | 'invalid' | 'failed';
|
|
18902
|
+
/**
|
|
18903
|
+
* Findings of the last render, errors and warnings; empty when there are none.
|
|
18904
|
+
*/
|
|
18905
|
+
issues: Array<StudioValidationIssue>;
|
|
18906
|
+
/**
|
|
18907
|
+
* The parts of the rendition in order: card pages and a final copy part for a card rendition. Empty before the first successful render.
|
|
18908
|
+
*/
|
|
18909
|
+
parts: Array<StudioRenditionPart>;
|
|
18910
|
+
/**
|
|
18911
|
+
* Identifiers of the whole-rendition files, such as the DOCX, or the ZIP a card rendition gains when exported. Use the content operation to download one.
|
|
18912
|
+
*/
|
|
18913
|
+
files: Array<string>;
|
|
18914
|
+
/**
|
|
18915
|
+
* Source images already uploaded to a platform, keyed by file identifier; empty for an export.
|
|
18916
|
+
*/
|
|
18917
|
+
assets?: {
|
|
18918
|
+
[key: string]: {
|
|
18919
|
+
/**
|
|
18920
|
+
* Media identifier or address on the platform.
|
|
18921
|
+
*/
|
|
18922
|
+
remote?: string;
|
|
18923
|
+
/**
|
|
18924
|
+
* Kind of media on the platform, such as image.
|
|
18925
|
+
*/
|
|
18926
|
+
kind?: string;
|
|
18927
|
+
/**
|
|
18928
|
+
* Upload time in RFC 3339 UTC.
|
|
18929
|
+
*/
|
|
18930
|
+
upload_time?: string;
|
|
18931
|
+
};
|
|
18932
|
+
};
|
|
18933
|
+
/**
|
|
18934
|
+
* How closely the Console preview matches what the platform shows.
|
|
18935
|
+
*/
|
|
18936
|
+
preview_fidelity?: 'exact' | 'approximate' | 'none';
|
|
18937
|
+
/**
|
|
18938
|
+
* Export and publish state, kept apart from the render state.
|
|
18939
|
+
*/
|
|
18940
|
+
publish: {
|
|
18941
|
+
/**
|
|
18942
|
+
* How this platform receives the rendition.
|
|
18943
|
+
*/
|
|
18944
|
+
method: 'api' | 'draft_box' | 'export';
|
|
18945
|
+
/**
|
|
18946
|
+
* Where export or publishing stands; every rendition starts at none and an export ends at exported.
|
|
18947
|
+
*/
|
|
18948
|
+
state: 'none' | 'scheduled' | 'exporting' | 'exported' | 'drafting' | 'drafted' | 'publishing' | 'published' | 'partial' | 'failed' | 'blocked_auth' | 'cancelled';
|
|
18949
|
+
/**
|
|
18950
|
+
* Channel account used for publishing; null for an export.
|
|
18951
|
+
*/
|
|
18952
|
+
channel?: string | null;
|
|
18953
|
+
/**
|
|
18954
|
+
* Scheduled publish time in RFC 3339 UTC; null for an export.
|
|
18955
|
+
*/
|
|
18956
|
+
scheduled_time?: string | null;
|
|
18957
|
+
/**
|
|
18958
|
+
* Time until which a running render or export holds the rendition; a second render or export before then answers REVISION_CONFLICT.
|
|
18959
|
+
*/
|
|
18960
|
+
lease_until?: string | null;
|
|
18961
|
+
/**
|
|
18962
|
+
* When the export or publish finished in RFC 3339 UTC; null until then.
|
|
18963
|
+
*/
|
|
18964
|
+
publish_time?: string | null;
|
|
18965
|
+
/**
|
|
18966
|
+
* Who ran the export or publish; null until then.
|
|
18967
|
+
*/
|
|
18968
|
+
by?: StudioActor;
|
|
18969
|
+
/**
|
|
18970
|
+
* Findings of the checks run before publishing, such as channel authorization.
|
|
18971
|
+
*/
|
|
18972
|
+
preflight?: Array<StudioValidationIssue>;
|
|
18973
|
+
};
|
|
18974
|
+
};
|
|
18975
|
+
/**
|
|
18976
|
+
* One page of renditions with the cursor that fetches the next page.
|
|
18977
|
+
*/
|
|
18978
|
+
export type StudioRenditionPage = {
|
|
18979
|
+
/**
|
|
18980
|
+
* Renditions on this page.
|
|
18981
|
+
*/
|
|
18982
|
+
items: Array<StudioRendition>;
|
|
18983
|
+
/**
|
|
18984
|
+
* Cursor for the next page, empty when this was the last one; pass it back as page_token unchanged.
|
|
18985
|
+
*/
|
|
18986
|
+
next_page_token?: string;
|
|
18987
|
+
};
|
|
18988
|
+
/**
|
|
18989
|
+
* The change to one rendition: the fields named by the update mask.
|
|
18990
|
+
*/
|
|
18991
|
+
export type StudioRenditionUpdateInput = {
|
|
18992
|
+
/**
|
|
18993
|
+
* Field paths this call changes: theme, settings or both; a field left out keeps its value.
|
|
18994
|
+
*/
|
|
18995
|
+
update_mask: Array<string>;
|
|
18996
|
+
/**
|
|
18997
|
+
* New theme, a thm_ identifier or a built-in key, used when theme is named in the update mask; render again to apply it.
|
|
18998
|
+
*/
|
|
18999
|
+
theme?: string;
|
|
19000
|
+
settings?: StudioRenditionSettings;
|
|
19001
|
+
};
|
|
19002
|
+
/**
|
|
19003
|
+
* A signed, short-lived download address for one file of a rendition.
|
|
19004
|
+
*/
|
|
19005
|
+
export type StudioRenditionContentUrl = {
|
|
19006
|
+
/**
|
|
19007
|
+
* Signed URL that downloads the file with a plain GET and no further credentials; treat it as a secret.
|
|
19008
|
+
*/
|
|
19009
|
+
url: string;
|
|
19010
|
+
/**
|
|
19011
|
+
* Time the URL stops working in RFC 3339 UTC; call the content operation again for a new one.
|
|
19012
|
+
*/
|
|
19013
|
+
expire_time: string;
|
|
19014
|
+
};
|
|
18416
19015
|
export type VaultVaultPage = {
|
|
18417
19016
|
/**
|
|
18418
19017
|
* Vaults in this page, ordered newest first.
|
|
@@ -29147,10 +29746,6 @@ export type MediaMediaModels = {
|
|
|
29147
29746
|
*/
|
|
29148
29747
|
readonly audio: string;
|
|
29149
29748
|
};
|
|
29150
|
-
/**
|
|
29151
|
-
* Identifier of a library belonging to the caller.
|
|
29152
|
-
*/
|
|
29153
|
-
export type MediaLibraryId = string;
|
|
29154
29749
|
/**
|
|
29155
29750
|
* Library lifecycle: provisioning initializes the library; active permits asset operations; deleting awaits purge and may be restored before purge_at; deleted has been purged; failed indicates initialization failure.
|
|
29156
29751
|
*/
|
|
@@ -29386,6 +29981,69 @@ export type MediaStoryboard = {
|
|
|
29386
29981
|
*/
|
|
29387
29982
|
tile_height: number;
|
|
29388
29983
|
};
|
|
29984
|
+
/**
|
|
29985
|
+
* What an audio asset is used for when material_type is audio. Music, effects and speech all use the same audio material type; this field separates them.
|
|
29986
|
+
*/
|
|
29987
|
+
export type MediaAudioRole = 'voice' | 'music' | 'sfx';
|
|
29988
|
+
/**
|
|
29989
|
+
* How this asset was generated or edited, recorded when the asset came from a generation or edit operation. Omitted on uploaded, imported and legacy assets.
|
|
29990
|
+
*/
|
|
29991
|
+
export type MediaProvenance = {
|
|
29992
|
+
/**
|
|
29993
|
+
* Generation or edit job that produced this asset; read it with assets and jobs to follow the operation.
|
|
29994
|
+
*/
|
|
29995
|
+
job_id: MediaJobId;
|
|
29996
|
+
/**
|
|
29997
|
+
* The generation or edit operation that produced this asset.
|
|
29998
|
+
*/
|
|
29999
|
+
operation: MediaGenerationOperation;
|
|
30000
|
+
/**
|
|
30001
|
+
* Prompt submitted for this operation, when the operation used one. Omitted for operations without a prompt, such as a plain edit.
|
|
30002
|
+
*/
|
|
30003
|
+
prompt?: string;
|
|
30004
|
+
/**
|
|
30005
|
+
* Assets this result was generated or edited from, each with the role it played. Empty when the operation used no reference asset.
|
|
30006
|
+
*/
|
|
30007
|
+
references: Array<MediaAssetReference>;
|
|
30008
|
+
/**
|
|
30009
|
+
* Model that performed the operation, as the model identifier Router reports.
|
|
30010
|
+
*/
|
|
30011
|
+
model: string;
|
|
30012
|
+
/**
|
|
30013
|
+
* Charge recorded for this operation, when pricing data is stored. Omitted when the operation was free or its cost was not recorded.
|
|
30014
|
+
*/
|
|
30015
|
+
cost?: {
|
|
30016
|
+
/**
|
|
30017
|
+
* Decimal amount charged for this operation, in the currency named by currency; a string, not a floating-point number.
|
|
30018
|
+
*/
|
|
30019
|
+
amount: string;
|
|
30020
|
+
/**
|
|
30021
|
+
* Currency code for amount.
|
|
30022
|
+
*/
|
|
30023
|
+
currency: string;
|
|
30024
|
+
};
|
|
30025
|
+
/**
|
|
30026
|
+
* Who started the operation this asset came from.
|
|
30027
|
+
*/
|
|
30028
|
+
actor: {
|
|
30029
|
+
/**
|
|
30030
|
+
* Whether the operation was started by a signed-in person or by an agent.
|
|
30031
|
+
*/
|
|
30032
|
+
kind: 'user' | 'agent';
|
|
30033
|
+
/**
|
|
30034
|
+
* Identifier of the person or agent that started the operation; pair it with kind to interpret it.
|
|
30035
|
+
*/
|
|
30036
|
+
id: string;
|
|
30037
|
+
/**
|
|
30038
|
+
* Session the operation was started from, when it came from a session. Omitted for operations started outside a session.
|
|
30039
|
+
*/
|
|
30040
|
+
session_id?: string;
|
|
30041
|
+
};
|
|
30042
|
+
/**
|
|
30043
|
+
* Automation run that performed the operation, when it came from a pipeline. Omitted when no pipeline was involved.
|
|
30044
|
+
*/
|
|
30045
|
+
pipeline_run_id?: string;
|
|
30046
|
+
};
|
|
29389
30047
|
/**
|
|
29390
30048
|
* An immutable understanding result for an asset version, including superseded history when requested.
|
|
29391
30049
|
*/
|
|
@@ -29723,6 +30381,34 @@ export type MediaSearchAsset = {
|
|
|
29723
30381
|
*/
|
|
29724
30382
|
model: string;
|
|
29725
30383
|
};
|
|
30384
|
+
/**
|
|
30385
|
+
* What this asset is as a reusable material, independent of resource_type. Omitted on assets stored before this field existed and on raw assets that are not materials.
|
|
30386
|
+
*/
|
|
30387
|
+
material_type?: MediaMaterialType;
|
|
30388
|
+
/**
|
|
30389
|
+
* What an audio asset is used for when material_type is audio: voice, music or sfx. Omitted for assets that are not audio materials.
|
|
30390
|
+
*/
|
|
30391
|
+
audio_role?: MediaAudioRole;
|
|
30392
|
+
/**
|
|
30393
|
+
* True when an image asset contains animation, such as an animated GIF or animated WebP. Omitted for assets that are not animated images.
|
|
30394
|
+
*/
|
|
30395
|
+
animated?: true;
|
|
30396
|
+
/**
|
|
30397
|
+
* Asset this one was edited from; null when it was generated or uploaded rather than edited. Use assets.lineage for the whole tree.
|
|
30398
|
+
*/
|
|
30399
|
+
derived_from?: MediaAssetId | null;
|
|
30400
|
+
/**
|
|
30401
|
+
* Asset at the root of this asset’s edit tree; equals asset_id when this asset is itself a root. Omitted on assets stored before this field existed.
|
|
30402
|
+
*/
|
|
30403
|
+
root_id?: MediaAssetId;
|
|
30404
|
+
/**
|
|
30405
|
+
* True when the bytes carry an AI-generated content label and this asset was produced by a model. False for uploaded and imported assets.
|
|
30406
|
+
*/
|
|
30407
|
+
ai_generated?: boolean;
|
|
30408
|
+
/**
|
|
30409
|
+
* How this asset was generated or edited, including the model, prompt and references. Omitted on uploaded, imported and legacy assets.
|
|
30410
|
+
*/
|
|
30411
|
+
provenance?: MediaProvenance;
|
|
29726
30412
|
};
|
|
29727
30413
|
/**
|
|
29728
30414
|
* A matching asset with its ranking score and supporting matches.
|
|
@@ -29744,8 +30430,24 @@ export type MediaSemanticHit = {
|
|
|
29744
30430
|
* Supporting content or metadata matches contributing to this asset’s hit.
|
|
29745
30431
|
*/
|
|
29746
30432
|
matches: Array<MediaSemanticMatch>;
|
|
30433
|
+
/**
|
|
30434
|
+
* How many other assets in this library matched as the same footage (the same file, or another export of the same Cut project) and were folded into this hit.
|
|
30435
|
+
*/
|
|
30436
|
+
similar_count?: number;
|
|
30437
|
+
/**
|
|
30438
|
+
* Asset ids folded into this hit, up to 10.
|
|
30439
|
+
*/
|
|
30440
|
+
similar_asset_ids?: Array<string>;
|
|
29747
30441
|
};
|
|
29748
|
-
|
|
30442
|
+
/**
|
|
30443
|
+
* Category of media a generation request produces.
|
|
30444
|
+
*/
|
|
30445
|
+
export type MediaGenerationType = 'image' | 'video' | 'speech' | 'music' | 'sound_effect' | 'voice';
|
|
30446
|
+
/**
|
|
30447
|
+
* Edit operations: the change this step applied to its parent asset.
|
|
30448
|
+
*/
|
|
30449
|
+
export type MediaGenerationOperation = 'generate' | 'clone' | 'tag' | 'untag' | 'set_context' | 'move' | 'delete' | 'reprocess' | 'variations' | 'upscale' | 'outpaint' | 'inpaint' | 'erase' | 'replace_object' | 'recolor' | 'remove_background' | 'replace_background' | 'to_video' | 'extend' | 'edit' | 'lip_sync' | 'frame' | 'to_gif' | 'voice_change' | 'resynthesize';
|
|
30450
|
+
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' | 'OPERATION_NOT_SUPPORTED' | 'MODEL_PENDING' | 'REFERENCE_TYPE_MISMATCH' | 'CONSENT_REQUIRED' | 'LIBRARY_IS_DEFAULT' | 'JOB_INVALID_STATE' | 'VOICE_TRAINING' | 'INSUFFICIENT_BALANCE';
|
|
29749
30451
|
/**
|
|
29750
30452
|
* State of a requested video output.
|
|
29751
30453
|
*/
|
|
@@ -29793,6 +30495,68 @@ export type MediaMediaEvent = {
|
|
|
29793
30495
|
[key: string]: unknown;
|
|
29794
30496
|
};
|
|
29795
30497
|
};
|
|
30498
|
+
/**
|
|
30499
|
+
* One asset in the edit tree, with the step that produced it.
|
|
30500
|
+
*/
|
|
30501
|
+
export type MediaLineageNode = {
|
|
30502
|
+
/**
|
|
30503
|
+
* Asset this step of the edit tree produced; deleted assets are still listed so the tree stays connected.
|
|
30504
|
+
*/
|
|
30505
|
+
asset_id: MediaAssetId;
|
|
30506
|
+
/**
|
|
30507
|
+
* Asset this one was edited from; null for the root of the tree.
|
|
30508
|
+
*/
|
|
30509
|
+
parent_id: MediaAssetId | null;
|
|
30510
|
+
/**
|
|
30511
|
+
* The edit or generation operation that produced this asset; null when the asset has no recorded operation.
|
|
30512
|
+
*/
|
|
30513
|
+
operation: MediaGenerationOperation | null;
|
|
30514
|
+
/**
|
|
30515
|
+
* Prompt submitted for this operation, when the operation used one.
|
|
30516
|
+
*/
|
|
30517
|
+
prompt?: string;
|
|
30518
|
+
/**
|
|
30519
|
+
* Time this asset was created, in UTC.
|
|
30520
|
+
*/
|
|
30521
|
+
created_at: MediaIsoTimestamp;
|
|
30522
|
+
/**
|
|
30523
|
+
* True when this asset has been deleted; deleted assets remain in the tree so earlier steps stay reachable.
|
|
30524
|
+
*/
|
|
30525
|
+
deleted: boolean;
|
|
30526
|
+
};
|
|
30527
|
+
/**
|
|
30528
|
+
* What a reference asset contributes to the generated or edited result.
|
|
30529
|
+
*/
|
|
30530
|
+
export type MediaRefRole = 'edit_target' | 'style' | 'structure' | 'subject';
|
|
30531
|
+
/**
|
|
30532
|
+
* Speech to synthesize for a lip-sync edit instead of an existing audio asset.
|
|
30533
|
+
*/
|
|
30534
|
+
export type MediaSpeechCreateInput = {
|
|
30535
|
+
/**
|
|
30536
|
+
* Text to synthesize; long text is synthesized paragraph by paragraph.
|
|
30537
|
+
*/
|
|
30538
|
+
input: string;
|
|
30539
|
+
/**
|
|
30540
|
+
* Voice identifier or platform voice name.
|
|
30541
|
+
*/
|
|
30542
|
+
voice: string;
|
|
30543
|
+
/**
|
|
30544
|
+
* Emotion and style guidance for the synthesized speech.
|
|
30545
|
+
*/
|
|
30546
|
+
instructions?: string;
|
|
30547
|
+
/**
|
|
30548
|
+
* Speaking-rate multiplier; 1 is the model default.
|
|
30549
|
+
*/
|
|
30550
|
+
speed?: number;
|
|
30551
|
+
/**
|
|
30552
|
+
* Audio encoding of the synthesized speech.
|
|
30553
|
+
*/
|
|
30554
|
+
response_format?: 'mp3' | 'wav' | 'opus' | 'aac' | 'flac' | 'pcm';
|
|
30555
|
+
/**
|
|
30556
|
+
* Language of the text, when the voice supports several.
|
|
30557
|
+
*/
|
|
30558
|
+
language?: string;
|
|
30559
|
+
};
|
|
29796
30560
|
export type MediaFailureGroup = {
|
|
29797
30561
|
/**
|
|
29798
30562
|
* Failure reason code. Unknown codes are retryable.
|
|
@@ -30131,11 +30895,11 @@ export type StudioGenre = {
|
|
|
30131
30895
|
/**
|
|
30132
30896
|
* Unit kinds allowed at the top level of a draft tree of this genre.
|
|
30133
30897
|
*/
|
|
30134
|
-
|
|
30898
|
+
top_kinds: Array<string>;
|
|
30135
30899
|
/**
|
|
30136
30900
|
* What the points inside a unit intent are called here, such as beats, arguments, selling points or shot notes.
|
|
30137
30901
|
*/
|
|
30138
|
-
|
|
30902
|
+
point_label: string;
|
|
30139
30903
|
/**
|
|
30140
30904
|
* Draft properties this genre defines, such as a title with a length limit or a list of images.
|
|
30141
30905
|
*/
|
|
@@ -30143,11 +30907,11 @@ export type StudioGenre = {
|
|
|
30143
30907
|
/**
|
|
30144
30908
|
* Reference entry types this genre draws on, taken from the shared entry vocabulary.
|
|
30145
30909
|
*/
|
|
30146
|
-
|
|
30910
|
+
entry_types: Array<string>;
|
|
30147
30911
|
/**
|
|
30148
30912
|
* Roles a unit link may carry in this genre, such as point-of-view character or main product.
|
|
30149
30913
|
*/
|
|
30150
|
-
|
|
30914
|
+
link_roles: Array<string>;
|
|
30151
30915
|
/**
|
|
30152
30916
|
* Block types a unit body of this genre may contain.
|
|
30153
30917
|
*/
|
|
@@ -30156,8 +30920,8 @@ export type StudioGenre = {
|
|
|
30156
30920
|
* Human description of the expected length, such as the size of one chapter and of the whole piece.
|
|
30157
30921
|
*/
|
|
30158
30922
|
length: string;
|
|
30159
|
-
|
|
30160
|
-
|
|
30923
|
+
total_chars?: StudioCharRange;
|
|
30924
|
+
total_seconds?: StudioSecondRange;
|
|
30161
30925
|
/**
|
|
30162
30926
|
* Deterministic checks the software runs for this genre, each reporting against a unit or a block.
|
|
30163
30927
|
*/
|
|
@@ -30169,31 +30933,31 @@ export type StudioGenre = {
|
|
|
30169
30933
|
/**
|
|
30170
30934
|
* The writing guidance for this genre, kept short and paired with its reason, handed to the writer in the context pack.
|
|
30171
30935
|
*/
|
|
30172
|
-
|
|
30936
|
+
writing_rules: string;
|
|
30173
30937
|
/**
|
|
30174
30938
|
* Named banned-word lists the banned_words check applies, such as the Chinese advertising law list.
|
|
30175
30939
|
*/
|
|
30176
|
-
|
|
30940
|
+
banned_word_lists?: Array<string>;
|
|
30177
30941
|
/**
|
|
30178
30942
|
* Platform keys this genre produces by default; passing this genre to the platform list returns exactly these.
|
|
30179
30943
|
*/
|
|
30180
|
-
|
|
30944
|
+
default_platforms: Array<string>;
|
|
30181
30945
|
/**
|
|
30182
30946
|
* Theme key a new rendition of this genre starts with when the caller names no theme.
|
|
30183
30947
|
*/
|
|
30184
|
-
|
|
30948
|
+
default_theme?: string;
|
|
30185
30949
|
/**
|
|
30186
30950
|
* Keys of the built-in templates that can seed a draft of this genre.
|
|
30187
30951
|
*/
|
|
30188
|
-
|
|
30952
|
+
builtin_templates?: Array<string>;
|
|
30189
30953
|
/**
|
|
30190
30954
|
* Console views this genre opens with, such as a tree or an outline table.
|
|
30191
30955
|
*/
|
|
30192
|
-
|
|
30956
|
+
default_views: Array<string>;
|
|
30193
30957
|
/**
|
|
30194
30958
|
* Delivery stage that opened this genre; a value other than s3 means it is catalogued but a draft of it is still refused.
|
|
30195
30959
|
*/
|
|
30196
|
-
|
|
30960
|
+
available_from: 's3' | 's5' | 's7';
|
|
30197
30961
|
};
|
|
30198
30962
|
/**
|
|
30199
30963
|
* The one error envelope every failure uses: a stable machine code, a message for a person, and the details that let a caller repair the request.
|
|
@@ -30226,15 +30990,15 @@ export type StudioPlatformLimits = {
|
|
|
30226
30990
|
/**
|
|
30227
30991
|
* Longest allowed title in characters; absent means the platform states no title limit.
|
|
30228
30992
|
*/
|
|
30229
|
-
|
|
30993
|
+
title_chars?: number;
|
|
30230
30994
|
/**
|
|
30231
30995
|
* Longest allowed body in characters; absent means the platform states no body limit.
|
|
30232
30996
|
*/
|
|
30233
|
-
|
|
30997
|
+
body_chars?: number;
|
|
30234
30998
|
/**
|
|
30235
30999
|
* Weighted character budget for one post, where a CJK character counts two and a URL counts as twenty-three.
|
|
30236
31000
|
*/
|
|
30237
|
-
|
|
31001
|
+
weighted_per_post?: number;
|
|
30238
31002
|
/**
|
|
30239
31003
|
* Most images one post may carry; absent means the platform states no image count.
|
|
30240
31004
|
*/
|
|
@@ -30242,11 +31006,11 @@ export type StudioPlatformLimits = {
|
|
|
30242
31006
|
/**
|
|
30243
31007
|
* Aspect ratio the platform expects for images, which the card renderer follows.
|
|
30244
31008
|
*/
|
|
30245
|
-
|
|
31009
|
+
image_aspect?: '3:4' | '1:1' | '4:5' | '16:9';
|
|
30246
31010
|
/**
|
|
30247
31011
|
* Image file formats the platform accepts; a card rendered in another format is converted first.
|
|
30248
31012
|
*/
|
|
30249
|
-
|
|
31013
|
+
image_formats?: Array<'jpeg' | 'png' | 'webp' | 'gif'>;
|
|
30250
31014
|
};
|
|
30251
31015
|
/**
|
|
30252
31016
|
* What this work is for: who reads it, what that reader should get or do, the one message it carries, and the limits it is written under.
|
|
@@ -30305,7 +31069,7 @@ export type StudioBrief = {
|
|
|
30305
31069
|
*/
|
|
30306
31070
|
attachments?: Array<string>;
|
|
30307
31071
|
/**
|
|
30308
|
-
* Requirements split out of the brief, each with a stable key
|
|
31072
|
+
* Requirements split out of the brief, each with a stable key. A unit point no unit claims is reported as unplaced; a work point (a constraint on the whole piece) is never claimed and is checked in review instead.
|
|
30309
31073
|
*/
|
|
30310
31074
|
points?: Array<StudioBriefPoint>;
|
|
30311
31075
|
/**
|
|
@@ -30353,7 +31117,7 @@ export type StudioDraftSummary = {
|
|
|
30353
31117
|
/**
|
|
30354
31118
|
* Number of units in the draft tree today, counted across every level.
|
|
30355
31119
|
*/
|
|
30356
|
-
|
|
31120
|
+
unit_count: number;
|
|
30357
31121
|
/**
|
|
30358
31122
|
* Total characters written across the draft bodies, with whitespace removed.
|
|
30359
31123
|
*/
|
|
@@ -30363,11 +31127,11 @@ export type StudioDraftSummary = {
|
|
|
30363
31127
|
*/
|
|
30364
31128
|
revision: number;
|
|
30365
31129
|
/**
|
|
30366
|
-
* Content revision of the draft; a draft derived from this one is stale once this passes its
|
|
31130
|
+
* Content revision of the draft; a draft derived from this one is stale once this passes its derived_from.revision.
|
|
30367
31131
|
*/
|
|
30368
|
-
|
|
30369
|
-
|
|
30370
|
-
|
|
31132
|
+
content_revision: number;
|
|
31133
|
+
derived_from?: StudioDraftSource;
|
|
31134
|
+
last_rendition?: StudioLastRendition;
|
|
30371
31135
|
};
|
|
30372
31136
|
/**
|
|
30373
31137
|
* One row of the work list: enough to choose a work and to see whether its drafts moved, without carrying any unit text.
|
|
@@ -30400,7 +31164,7 @@ export type StudioWorkSummary = {
|
|
|
30400
31164
|
/**
|
|
30401
31165
|
* Work this one was adapted from, or null when it was written from scratch; an adaptation keeps a link back to its source.
|
|
30402
31166
|
*/
|
|
30403
|
-
|
|
31167
|
+
adapted_from?: string;
|
|
30404
31168
|
/**
|
|
30405
31169
|
* Work revision as of the list projection; the list may trail a write by a few seconds, so read the work itself before using it as expected_revision.
|
|
30406
31170
|
*/
|
|
@@ -30408,11 +31172,11 @@ export type StudioWorkSummary = {
|
|
|
30408
31172
|
/**
|
|
30409
31173
|
* Last change time in RFC 3339 UTC, used to order the list newest first.
|
|
30410
31174
|
*/
|
|
30411
|
-
|
|
31175
|
+
update_time: string;
|
|
30412
31176
|
/**
|
|
30413
31177
|
* Console address of the work, safe to show to the person who asked for it.
|
|
30414
31178
|
*/
|
|
30415
|
-
|
|
31179
|
+
viewer_url: string;
|
|
30416
31180
|
};
|
|
30417
31181
|
/**
|
|
30418
31182
|
* One near match offered for a reference that resolved to nothing.
|
|
@@ -30508,11 +31272,11 @@ export type StudioUnit = {
|
|
|
30508
31272
|
/**
|
|
30509
31273
|
* Intent revision the current body was written against, or null when there is no body; an older value means the intent moved on.
|
|
30510
31274
|
*/
|
|
30511
|
-
|
|
31275
|
+
body_from_intent?: number;
|
|
30512
31276
|
/**
|
|
30513
31277
|
* Unit of the upstream draft this one was written from, present when the draft derives from another; a serial of a novel records it per section.
|
|
30514
31278
|
*/
|
|
30515
|
-
|
|
31279
|
+
source_unit?: string;
|
|
30516
31280
|
/**
|
|
30517
31281
|
* Reference entries this unit is tied to, including the mentions detected in its text.
|
|
30518
31282
|
*/
|
|
@@ -30529,7 +31293,7 @@ export type StudioUnit = {
|
|
|
30529
31293
|
* Unit revision, moved by any change to the unit; pass it as expected_revision when writing the body.
|
|
30530
31294
|
*/
|
|
30531
31295
|
revision: number;
|
|
30532
|
-
|
|
31296
|
+
last_editor?: StudioActor;
|
|
30533
31297
|
/**
|
|
30534
31298
|
* Body blocks, present only when the unit was read with its content; writing block by block needs their identifiers.
|
|
30535
31299
|
*/
|
|
@@ -30568,6 +31332,19 @@ export type StudioCheckResult = {
|
|
|
30568
31332
|
*/
|
|
30569
31333
|
hard: boolean;
|
|
30570
31334
|
};
|
|
31335
|
+
/**
|
|
31336
|
+
* A new brief point with its scope.
|
|
31337
|
+
*/
|
|
31338
|
+
export type StudioBriefPointInput = {
|
|
31339
|
+
/**
|
|
31340
|
+
* The requirement itself.
|
|
31341
|
+
*/
|
|
31342
|
+
text: string;
|
|
31343
|
+
/**
|
|
31344
|
+
* unit (the default) is a requirement that must land in some unit: a plot beat, a selling point, a fact the piece has to state; a unit claims it and the coverage check follows it. work is a constraint on the whole piece that no single unit can claim: the period, the voice, the point of view, the cast, words to avoid; it is handed to every context pack and listed among the review's semantic questions, and it is left out of the coverage check.
|
|
31345
|
+
*/
|
|
31346
|
+
scope?: 'unit' | 'work';
|
|
31347
|
+
};
|
|
30571
31348
|
/**
|
|
30572
31349
|
* One brief point to reword, keeping its key so units that already claimed it stay attached.
|
|
30573
31350
|
*/
|
|
@@ -30580,6 +31357,10 @@ export type StudioBriefPointEdit = {
|
|
|
30580
31357
|
* Text that replaces the current point, usually a more specific version of the same requirement.
|
|
30581
31358
|
*/
|
|
30582
31359
|
text: string;
|
|
31360
|
+
/**
|
|
31361
|
+
* Move the point to the other scope; leave it out to keep the scope it has.
|
|
31362
|
+
*/
|
|
31363
|
+
scope?: 'unit' | 'work';
|
|
30583
31364
|
};
|
|
30584
31365
|
/**
|
|
30585
31366
|
* One unit of an outline handed in by the caller, with its children nested inside it.
|
|
@@ -30608,7 +31389,7 @@ export type StudioOutlineInput = {
|
|
|
30608
31389
|
/**
|
|
30609
31390
|
* Keys of the brief points this unit claims, which is how the coverage check knows the requirement will land here.
|
|
30610
31391
|
*/
|
|
30611
|
-
|
|
31392
|
+
brief_points?: Array<string>;
|
|
30612
31393
|
/**
|
|
30613
31394
|
* Units nested under this one, in order; depth is limited by the genre, which refuses a kind that cannot sit here.
|
|
30614
31395
|
*/
|
|
@@ -30642,15 +31423,15 @@ export type StudioDraft = {
|
|
|
30642
31423
|
/**
|
|
30643
31424
|
* Creation time in RFC 3339 UTC.
|
|
30644
31425
|
*/
|
|
30645
|
-
|
|
31426
|
+
create_time?: string;
|
|
30646
31427
|
/**
|
|
30647
31428
|
* Time of the last change to this draft in RFC 3339 UTC.
|
|
30648
31429
|
*/
|
|
30649
|
-
|
|
31430
|
+
update_time?: string;
|
|
30650
31431
|
/**
|
|
30651
31432
|
* Console address of this draft, which opens the work page with the draft already selected.
|
|
30652
31433
|
*/
|
|
30653
|
-
|
|
31434
|
+
viewer_url: string;
|
|
30654
31435
|
/**
|
|
30655
31436
|
* Work this draft belongs to; drafts never move between works.
|
|
30656
31437
|
*/
|
|
@@ -30666,7 +31447,7 @@ export type StudioDraft = {
|
|
|
30666
31447
|
/**
|
|
30667
31448
|
* Genre configuration version this draft was created under, kept so later rule changes stay visible rather than silently applying.
|
|
30668
31449
|
*/
|
|
30669
|
-
|
|
31450
|
+
genre_version: number;
|
|
30670
31451
|
/**
|
|
30671
31452
|
* How much structure this draft requires: a skeleton draft needs an outline before writing, a space draft only enforces what publishing needs.
|
|
30672
31453
|
*/
|
|
@@ -30681,7 +31462,7 @@ export type StudioDraft = {
|
|
|
30681
31462
|
props: {
|
|
30682
31463
|
[key: string]: unknown;
|
|
30683
31464
|
};
|
|
30684
|
-
|
|
31465
|
+
derived_from?: StudioDraftSource;
|
|
30685
31466
|
/**
|
|
30686
31467
|
* Template that seeded this draft, recorded for reference only; changing the template later does not rewrite the draft.
|
|
30687
31468
|
*/
|
|
@@ -30697,11 +31478,11 @@ export type StudioDraft = {
|
|
|
30697
31478
|
/**
|
|
30698
31479
|
* Content revision of this draft, moved by any unit or property write; renditions and drafts derived from it compare against it.
|
|
30699
31480
|
*/
|
|
30700
|
-
|
|
31481
|
+
content_revision: number;
|
|
30701
31482
|
/**
|
|
30702
31483
|
* Keys this draft answered to before it was renamed, kept so an old link or an old reference still resolves.
|
|
30703
31484
|
*/
|
|
30704
|
-
|
|
31485
|
+
previous_keys: Array<string>;
|
|
30705
31486
|
/**
|
|
30706
31487
|
* Whether what this draft derives from moved past the revision recorded here, which a rebase clears after the text is brought up to date.
|
|
30707
31488
|
*/
|
|
@@ -30709,7 +31490,7 @@ export type StudioDraft = {
|
|
|
30709
31490
|
/**
|
|
30710
31491
|
* Whether the thing this draft derives from is itself out of date; it is a note for the reader and does not make this draft stale.
|
|
30711
31492
|
*/
|
|
30712
|
-
|
|
31493
|
+
upstream_pending: boolean;
|
|
30713
31494
|
};
|
|
30714
31495
|
/**
|
|
30715
31496
|
* One requirement point of the brief and the units that claim it.
|
|
@@ -30785,7 +31566,7 @@ export type StudioIntentDiff = {
|
|
|
30785
31566
|
/**
|
|
30786
31567
|
* Intent revision the current body was written against.
|
|
30787
31568
|
*/
|
|
30788
|
-
|
|
31569
|
+
from_revision?: number;
|
|
30789
31570
|
/**
|
|
30790
31571
|
* Synopsis at that revision, shown beside the newer one so a writer can see what moved.
|
|
30791
31572
|
*/
|
|
@@ -30975,12 +31756,147 @@ export type StudioCardSettings = {
|
|
|
30975
31756
|
/**
|
|
30976
31757
|
* Width the card is rendered at in pixels before any platform-side scaling, chosen above the platform minimum.
|
|
30977
31758
|
*/
|
|
30978
|
-
|
|
31759
|
+
width_px: number;
|
|
30979
31760
|
/**
|
|
30980
31761
|
* Font families the card expects; a font that is not available is reported rather than silently substituted.
|
|
30981
31762
|
*/
|
|
30982
31763
|
fonts: Array<string>;
|
|
30983
31764
|
};
|
|
31765
|
+
/**
|
|
31766
|
+
* Per-rendition settings; each platform reads only the settings that apply to it and ignores the rest.
|
|
31767
|
+
*/
|
|
31768
|
+
export type StudioRenditionSettings = {
|
|
31769
|
+
/**
|
|
31770
|
+
* Whether external links become footnotes at the end of the article, for platforms that do not allow links in the text.
|
|
31771
|
+
*/
|
|
31772
|
+
footnote_links?: boolean;
|
|
31773
|
+
/**
|
|
31774
|
+
* How the posts of a thread are numbered.
|
|
31775
|
+
*/
|
|
31776
|
+
thread_numbering?: 'none' | 'n/' | 'n/m';
|
|
31777
|
+
/**
|
|
31778
|
+
* How a card rendition arranges its text cards and photos.
|
|
31779
|
+
*/
|
|
31780
|
+
cards?: {
|
|
31781
|
+
/**
|
|
31782
|
+
* Order of text cards and photos.
|
|
31783
|
+
*/
|
|
31784
|
+
layout: 'text_then_photos' | 'interleave' | 'photos_only';
|
|
31785
|
+
/**
|
|
31786
|
+
* Name of the draft property whose image becomes the cover card.
|
|
31787
|
+
*/
|
|
31788
|
+
cover_from_prop?: string;
|
|
31789
|
+
};
|
|
31790
|
+
/**
|
|
31791
|
+
* For a book format, the chapters to include.
|
|
31792
|
+
*/
|
|
31793
|
+
chapter_range?: {
|
|
31794
|
+
/**
|
|
31795
|
+
* First chapter number to include.
|
|
31796
|
+
*/
|
|
31797
|
+
from: number;
|
|
31798
|
+
/**
|
|
31799
|
+
* Last chapter number to include.
|
|
31800
|
+
*/
|
|
31801
|
+
to: number;
|
|
31802
|
+
};
|
|
31803
|
+
};
|
|
31804
|
+
/**
|
|
31805
|
+
* One finding of a render or a check: how serious it is, a stable code, and where it is.
|
|
31806
|
+
*/
|
|
31807
|
+
export type StudioValidationIssue = {
|
|
31808
|
+
/**
|
|
31809
|
+
* Whether the finding blocks export.
|
|
31810
|
+
*/
|
|
31811
|
+
severity: 'error' | 'warning';
|
|
31812
|
+
/**
|
|
31813
|
+
* Stable machine code such as draft_empty, heading_missing or render_unavailable; branch on this value, never on the message text.
|
|
31814
|
+
*/
|
|
31815
|
+
code: string;
|
|
31816
|
+
/**
|
|
31817
|
+
* Human-readable explanation of what was found, written to be shown as is.
|
|
31818
|
+
*/
|
|
31819
|
+
message: string;
|
|
31820
|
+
/**
|
|
31821
|
+
* Identifier of the unit the finding is about, when it is about one unit.
|
|
31822
|
+
*/
|
|
31823
|
+
unit?: string;
|
|
31824
|
+
/**
|
|
31825
|
+
* Identifier of the block inside that unit the finding is about, when it is about one block.
|
|
31826
|
+
*/
|
|
31827
|
+
block?: string;
|
|
31828
|
+
/**
|
|
31829
|
+
* A suggested repair when the check knows one.
|
|
31830
|
+
*/
|
|
31831
|
+
suggestion?: string;
|
|
31832
|
+
};
|
|
31833
|
+
/**
|
|
31834
|
+
* One part of a rendition: a card page, a thread post or a chapter, with the files rendered for it and, once published, where it landed.
|
|
31835
|
+
*/
|
|
31836
|
+
export type StudioRenditionPart = {
|
|
31837
|
+
/**
|
|
31838
|
+
* Position of this part in the rendition; pass it as the part query of the content operation.
|
|
31839
|
+
*/
|
|
31840
|
+
index: number;
|
|
31841
|
+
/**
|
|
31842
|
+
* Identifiers of the units this part was built from.
|
|
31843
|
+
*/
|
|
31844
|
+
units: Array<string>;
|
|
31845
|
+
/**
|
|
31846
|
+
* Text of this part when it carries text, such as the copy part of a card rendition, whose text starts with the note title.
|
|
31847
|
+
*/
|
|
31848
|
+
text?: string;
|
|
31849
|
+
/**
|
|
31850
|
+
* Identifiers of the files rendered for this part, such as one card PNG of 1080 by 1440 pixels; empty for a text-only part.
|
|
31851
|
+
*/
|
|
31852
|
+
files: Array<string>;
|
|
31853
|
+
/**
|
|
31854
|
+
* Identifier of the post on the platform, present only after the part was published to an account; always null for an export.
|
|
31855
|
+
*/
|
|
31856
|
+
remote_id?: string | null;
|
|
31857
|
+
/**
|
|
31858
|
+
* Link of the post on the platform, present only after the part was published to an account; always null for an export.
|
|
31859
|
+
*/
|
|
31860
|
+
remote_url?: string | null;
|
|
31861
|
+
/**
|
|
31862
|
+
* Where this part is in publishing; an exported part stays pending because nothing was sent to an account.
|
|
31863
|
+
*/
|
|
31864
|
+
publish_state: 'pending' | 'sending' | 'sent' | 'failed' | 'uncertain';
|
|
31865
|
+
/**
|
|
31866
|
+
* Why this part failed, present only when publish_state is failed.
|
|
31867
|
+
*/
|
|
31868
|
+
error?: {
|
|
31869
|
+
/**
|
|
31870
|
+
* Stable machine code of the failure.
|
|
31871
|
+
*/
|
|
31872
|
+
code: string;
|
|
31873
|
+
/**
|
|
31874
|
+
* Human-readable explanation of the failure.
|
|
31875
|
+
*/
|
|
31876
|
+
message: string;
|
|
31877
|
+
};
|
|
31878
|
+
/**
|
|
31879
|
+
* Hash of the content of this part, used to recognise a part that was already sent.
|
|
31880
|
+
*/
|
|
31881
|
+
content_hash?: string;
|
|
31882
|
+
};
|
|
31883
|
+
/**
|
|
31884
|
+
* Who made a change, so a person and an agent appear the same way in the record.
|
|
31885
|
+
*/
|
|
31886
|
+
export type StudioActor = {
|
|
31887
|
+
/**
|
|
31888
|
+
* Whether the change came from a person, an agent or the platform itself; an agent session through the API is recorded as an agent.
|
|
31889
|
+
*/
|
|
31890
|
+
kind?: 'user' | 'agent' | 'system';
|
|
31891
|
+
/**
|
|
31892
|
+
* Identifier of that actor, such as a user identifier or an agent session identifier.
|
|
31893
|
+
*/
|
|
31894
|
+
id?: string;
|
|
31895
|
+
/**
|
|
31896
|
+
* Display name of the actor when one is known, shown beside the change.
|
|
31897
|
+
*/
|
|
31898
|
+
label?: string;
|
|
31899
|
+
};
|
|
30984
31900
|
export type VaultVaultEvent = {
|
|
30985
31901
|
/**
|
|
30986
31902
|
* Unique identifier of this recorded audit event.
|
|
@@ -35480,12 +36396,12 @@ export type StudioUnitKind = {
|
|
|
35480
36396
|
* Kinds allowed directly beneath this one; an empty list makes it a leaf of the tree.
|
|
35481
36397
|
*/
|
|
35482
36398
|
children?: Array<string>;
|
|
35483
|
-
|
|
35484
|
-
|
|
36399
|
+
target_chars?: StudioCharRange;
|
|
36400
|
+
target_seconds?: StudioSecondRange;
|
|
35485
36401
|
/**
|
|
35486
36402
|
* Whether the finished piece needs a heading for a unit of this kind; a required heading that is empty is reported as a warning.
|
|
35487
36403
|
*/
|
|
35488
|
-
|
|
36404
|
+
heading_in_rendition?: 'required' | 'optional' | 'never';
|
|
35489
36405
|
};
|
|
35490
36406
|
/**
|
|
35491
36407
|
* One property a draft of a genre carries, such as a title with a character limit or a list of images with an aspect ratio.
|
|
@@ -35510,11 +36426,11 @@ export type StudioDraftProp = {
|
|
|
35510
36426
|
/**
|
|
35511
36427
|
* Longest allowed text length in characters; absent means the genre sets no limit here.
|
|
35512
36428
|
*/
|
|
35513
|
-
|
|
36429
|
+
max_chars?: number;
|
|
35514
36430
|
/**
|
|
35515
36431
|
* Most allowed list entries for a tags or images property; absent means no count limit.
|
|
35516
36432
|
*/
|
|
35517
|
-
|
|
36433
|
+
max_items?: number;
|
|
35518
36434
|
/**
|
|
35519
36435
|
* Writing hint for the property, handed to the writer in the context pack rather than kept in a prompt.
|
|
35520
36436
|
*/
|
|
@@ -35558,6 +36474,10 @@ export type StudioBriefPoint = {
|
|
|
35558
36474
|
* The requirement itself, short enough to be claimed by one unit and specific enough to be checked.
|
|
35559
36475
|
*/
|
|
35560
36476
|
text: string;
|
|
36477
|
+
/**
|
|
36478
|
+
* unit (the default) is a requirement that must land in some unit: a plot beat, a selling point, a fact the piece has to state; a unit claims it and the coverage check follows it. work is a constraint on the whole piece that no single unit can claim: the period, the voice, the point of view, the cast, words to avoid; it is handed to every context pack and listed among the review's semantic questions, and it is left out of the coverage check.
|
|
36479
|
+
*/
|
|
36480
|
+
scope?: 'unit' | 'work';
|
|
35561
36481
|
};
|
|
35562
36482
|
/**
|
|
35563
36483
|
* What a draft was derived from, kept with the revision it was built on so staleness can be decided without guessing.
|
|
@@ -35604,7 +36524,7 @@ export type StudioIntent = {
|
|
|
35604
36524
|
/**
|
|
35605
36525
|
* Keys of the brief points this unit claims, which is how the requirement coverage check knows a point landed.
|
|
35606
36526
|
*/
|
|
35607
|
-
|
|
36527
|
+
brief_points: Array<string>;
|
|
35608
36528
|
/**
|
|
35609
36529
|
* Intent revision, moved whenever the synopsis or the points change; a body written against an older value is behind.
|
|
35610
36530
|
*/
|
|
@@ -35612,7 +36532,7 @@ export type StudioIntent = {
|
|
|
35612
36532
|
/**
|
|
35613
36533
|
* Whether the writer confirmed the synopsis matches what the body actually says, rather than what was planned.
|
|
35614
36534
|
*/
|
|
35615
|
-
|
|
36535
|
+
synopsis_from_body: boolean;
|
|
35616
36536
|
};
|
|
35617
36537
|
/**
|
|
35618
36538
|
* A tie between a unit and one reference entry, either detected in the text or attached by a writer.
|
|
@@ -35631,23 +36551,6 @@ export type StudioUnitLink = {
|
|
|
35631
36551
|
*/
|
|
35632
36552
|
role?: string;
|
|
35633
36553
|
};
|
|
35634
|
-
/**
|
|
35635
|
-
* Who made a change, so a person and an agent appear the same way in the record.
|
|
35636
|
-
*/
|
|
35637
|
-
export type StudioActor = {
|
|
35638
|
-
/**
|
|
35639
|
-
* Whether the change came from a person, an agent or the platform itself; an agent session through the API is recorded as an agent.
|
|
35640
|
-
*/
|
|
35641
|
-
kind?: 'user' | 'agent' | 'system';
|
|
35642
|
-
/**
|
|
35643
|
-
* Identifier of that actor, such as a user identifier or an agent session identifier.
|
|
35644
|
-
*/
|
|
35645
|
-
id?: string;
|
|
35646
|
-
/**
|
|
35647
|
-
* Display name of the actor when one is known, shown beside the change.
|
|
35648
|
-
*/
|
|
35649
|
-
label?: string;
|
|
35650
|
-
};
|
|
35651
36554
|
/**
|
|
35652
36555
|
* One piece of a unit body: a paragraph, a heading, an image or another element, with the identifier that survives a Markdown round trip.
|
|
35653
36556
|
*/
|
|
@@ -37658,6 +38561,34 @@ export type MediaAssetWritable = {
|
|
|
37658
38561
|
*/
|
|
37659
38562
|
model: string;
|
|
37660
38563
|
};
|
|
38564
|
+
/**
|
|
38565
|
+
* What this asset is as a reusable material, independent of resource_type. Omitted on assets stored before this field existed and on raw assets that are not materials.
|
|
38566
|
+
*/
|
|
38567
|
+
material_type?: MediaMaterialType;
|
|
38568
|
+
/**
|
|
38569
|
+
* What an audio asset is used for when material_type is audio: voice, music or sfx. Omitted for assets that are not audio materials.
|
|
38570
|
+
*/
|
|
38571
|
+
audio_role?: MediaAudioRole;
|
|
38572
|
+
/**
|
|
38573
|
+
* True when an image asset contains animation, such as an animated GIF or animated WebP. Omitted for assets that are not animated images.
|
|
38574
|
+
*/
|
|
38575
|
+
animated?: true;
|
|
38576
|
+
/**
|
|
38577
|
+
* Asset this one was edited from; null when it was generated or uploaded rather than edited. Use assets.lineage for the whole tree.
|
|
38578
|
+
*/
|
|
38579
|
+
derived_from?: MediaAssetId | null;
|
|
38580
|
+
/**
|
|
38581
|
+
* Asset at the root of this asset’s edit tree; equals asset_id when this asset is itself a root. Omitted on assets stored before this field existed.
|
|
38582
|
+
*/
|
|
38583
|
+
root_id?: MediaAssetId;
|
|
38584
|
+
/**
|
|
38585
|
+
* True when the bytes carry an AI-generated content label and this asset was produced by a model. False for uploaded and imported assets.
|
|
38586
|
+
*/
|
|
38587
|
+
ai_generated?: boolean;
|
|
38588
|
+
/**
|
|
38589
|
+
* How this asset was generated or edited, including the model, prompt and references. Omitted on uploaded, imported and legacy assets.
|
|
38590
|
+
*/
|
|
38591
|
+
provenance?: MediaProvenance;
|
|
37661
38592
|
};
|
|
37662
38593
|
/**
|
|
37663
38594
|
* Understanding results in this page, ordered by creation time ascending.
|
|
@@ -38284,6 +39215,34 @@ export type MediaSearchAssetWritable = {
|
|
|
38284
39215
|
*/
|
|
38285
39216
|
model: string;
|
|
38286
39217
|
};
|
|
39218
|
+
/**
|
|
39219
|
+
* What this asset is as a reusable material, independent of resource_type. Omitted on assets stored before this field existed and on raw assets that are not materials.
|
|
39220
|
+
*/
|
|
39221
|
+
material_type?: MediaMaterialType;
|
|
39222
|
+
/**
|
|
39223
|
+
* What an audio asset is used for when material_type is audio: voice, music or sfx. Omitted for assets that are not audio materials.
|
|
39224
|
+
*/
|
|
39225
|
+
audio_role?: MediaAudioRole;
|
|
39226
|
+
/**
|
|
39227
|
+
* True when an image asset contains animation, such as an animated GIF or animated WebP. Omitted for assets that are not animated images.
|
|
39228
|
+
*/
|
|
39229
|
+
animated?: true;
|
|
39230
|
+
/**
|
|
39231
|
+
* Asset this one was edited from; null when it was generated or uploaded rather than edited. Use assets.lineage for the whole tree.
|
|
39232
|
+
*/
|
|
39233
|
+
derived_from?: MediaAssetId | null;
|
|
39234
|
+
/**
|
|
39235
|
+
* Asset at the root of this asset’s edit tree; equals asset_id when this asset is itself a root. Omitted on assets stored before this field existed.
|
|
39236
|
+
*/
|
|
39237
|
+
root_id?: MediaAssetId;
|
|
39238
|
+
/**
|
|
39239
|
+
* True when the bytes carry an AI-generated content label and this asset was produced by a model. False for uploaded and imported assets.
|
|
39240
|
+
*/
|
|
39241
|
+
ai_generated?: boolean;
|
|
39242
|
+
/**
|
|
39243
|
+
* How this asset was generated or edited, including the model, prompt and references. Omitted on uploaded, imported and legacy assets.
|
|
39244
|
+
*/
|
|
39245
|
+
provenance?: MediaProvenance;
|
|
38287
39246
|
};
|
|
38288
39247
|
/**
|
|
38289
39248
|
* A matching asset with its ranking score and supporting matches.
|
|
@@ -38305,6 +39264,14 @@ export type MediaSemanticHitWritable = {
|
|
|
38305
39264
|
* Supporting content or metadata matches contributing to this asset’s hit.
|
|
38306
39265
|
*/
|
|
38307
39266
|
matches: Array<MediaSemanticMatch>;
|
|
39267
|
+
/**
|
|
39268
|
+
* How many other assets in this library matched as the same footage (the same file, or another export of the same Cut project) and were folded into this hit.
|
|
39269
|
+
*/
|
|
39270
|
+
similar_count?: number;
|
|
39271
|
+
/**
|
|
39272
|
+
* Asset ids folded into this hit, up to 10.
|
|
39273
|
+
*/
|
|
39274
|
+
similar_asset_ids?: Array<string>;
|
|
38308
39275
|
};
|
|
38309
39276
|
export type AgentManaged34Writable = {
|
|
38310
39277
|
[key: string]: unknown;
|
|
@@ -38488,6 +39455,10 @@ export type StudioTemplatePath = string;
|
|
|
38488
39455
|
* Theme being addressed: a saved one by its thm_ identifier, or a built-in one by its key; the identifier is what the theme list returns for an organization's own theme.
|
|
38489
39456
|
*/
|
|
38490
39457
|
export type StudioThemePath = string;
|
|
39458
|
+
/**
|
|
39459
|
+
* Rendition being addressed, by its rnd_ identifier from the rendition list or from the create answer.
|
|
39460
|
+
*/
|
|
39461
|
+
export type StudioRenditionPath = string;
|
|
38491
39462
|
export type ApplyAgentVersionData = {
|
|
38492
39463
|
body?: never;
|
|
38493
39464
|
path: {
|
|
@@ -79436,6 +80407,10 @@ export type MediaListLibrariesErrors = {
|
|
|
79436
80407
|
* Request failed; see the error code reference.
|
|
79437
80408
|
*/
|
|
79438
80409
|
400: MediaMediaError;
|
|
80410
|
+
/**
|
|
80411
|
+
* Request failed; see the error code reference.
|
|
80412
|
+
*/
|
|
80413
|
+
402: MediaMediaError;
|
|
79439
80414
|
/**
|
|
79440
80415
|
* Request failed; see the error code reference.
|
|
79441
80416
|
*/
|
|
@@ -79531,6 +80506,10 @@ export type MediaCreateLibraryErrors = {
|
|
|
79531
80506
|
* Request failed; see the error code reference.
|
|
79532
80507
|
*/
|
|
79533
80508
|
400: MediaMediaError;
|
|
80509
|
+
/**
|
|
80510
|
+
* Request failed; see the error code reference.
|
|
80511
|
+
*/
|
|
80512
|
+
402: MediaMediaError;
|
|
79534
80513
|
/**
|
|
79535
80514
|
* Request failed; see the error code reference.
|
|
79536
80515
|
*/
|
|
@@ -79609,6 +80588,10 @@ export type MediaCreateFrameUrlsErrors = {
|
|
|
79609
80588
|
* INVALID_PARAMS: supply 1–20 nonnegative integer timestamps below video duration and width 160, 320 or 640; images and audio cannot produce video frames.
|
|
79610
80589
|
*/
|
|
79611
80590
|
400: MediaMediaError;
|
|
80591
|
+
/**
|
|
80592
|
+
* Request failed; see the error code reference.
|
|
80593
|
+
*/
|
|
80594
|
+
402: MediaMediaError;
|
|
79612
80595
|
/**
|
|
79613
80596
|
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
79614
80597
|
*/
|
|
@@ -79674,6 +80657,10 @@ export type MediaDeleteLibraryErrors = {
|
|
|
79674
80657
|
* Request failed; see the error code reference.
|
|
79675
80658
|
*/
|
|
79676
80659
|
400: MediaMediaError;
|
|
80660
|
+
/**
|
|
80661
|
+
* Request failed; see the error code reference.
|
|
80662
|
+
*/
|
|
80663
|
+
402: MediaMediaError;
|
|
79677
80664
|
/**
|
|
79678
80665
|
* Request failed; see the error code reference.
|
|
79679
80666
|
*/
|
|
@@ -79739,6 +80726,10 @@ export type MediaGetLibraryErrors = {
|
|
|
79739
80726
|
* Request failed; see the error code reference.
|
|
79740
80727
|
*/
|
|
79741
80728
|
400: MediaMediaError;
|
|
80729
|
+
/**
|
|
80730
|
+
* Request failed; see the error code reference.
|
|
80731
|
+
*/
|
|
80732
|
+
402: MediaMediaError;
|
|
79742
80733
|
/**
|
|
79743
80734
|
* Request failed; see the error code reference.
|
|
79744
80735
|
*/
|
|
@@ -79843,6 +80834,10 @@ export type MediaUpdateLibraryErrors = {
|
|
|
79843
80834
|
* Request failed; see the error code reference.
|
|
79844
80835
|
*/
|
|
79845
80836
|
400: MediaMediaError;
|
|
80837
|
+
/**
|
|
80838
|
+
* Request failed; see the error code reference.
|
|
80839
|
+
*/
|
|
80840
|
+
402: MediaMediaError;
|
|
79846
80841
|
/**
|
|
79847
80842
|
* Request failed; see the error code reference.
|
|
79848
80843
|
*/
|
|
@@ -79908,6 +80903,10 @@ export type MediaRestoreLibraryErrors = {
|
|
|
79908
80903
|
* Request failed; see the error code reference.
|
|
79909
80904
|
*/
|
|
79910
80905
|
400: MediaMediaError;
|
|
80906
|
+
/**
|
|
80907
|
+
* Request failed; see the error code reference.
|
|
80908
|
+
*/
|
|
80909
|
+
402: MediaMediaError;
|
|
79911
80910
|
/**
|
|
79912
80911
|
* Request failed; see the error code reference.
|
|
79913
80912
|
*/
|
|
@@ -79973,6 +80972,10 @@ export type MediaPurgeLibraryErrors = {
|
|
|
79973
80972
|
* Request failed; see the error code reference.
|
|
79974
80973
|
*/
|
|
79975
80974
|
400: MediaMediaError;
|
|
80975
|
+
/**
|
|
80976
|
+
* Request failed; see the error code reference.
|
|
80977
|
+
*/
|
|
80978
|
+
402: MediaMediaError;
|
|
79976
80979
|
/**
|
|
79977
80980
|
* Request failed; see the error code reference.
|
|
79978
80981
|
*/
|
|
@@ -80039,6 +81042,10 @@ export type MediaListAssetsData = {
|
|
|
80039
81042
|
* image, video (including audio), raw; auto is accepted by Upload actions only, and listing with auto returns 400.
|
|
80040
81043
|
*/
|
|
80041
81044
|
resource_type?: 'image' | 'video' | 'raw';
|
|
81045
|
+
/**
|
|
81046
|
+
* Filter assets to one kind of material, independent of the stored resource_type. Omit to list every material type. Assets stored before this field existed match no material_type filter.
|
|
81047
|
+
*/
|
|
81048
|
+
material_type?: MediaMaterialType;
|
|
80042
81049
|
/**
|
|
80043
81050
|
* Cursor from the previous next_cursor.
|
|
80044
81051
|
*/
|
|
@@ -80055,6 +81062,10 @@ export type MediaListAssetsErrors = {
|
|
|
80055
81062
|
* Request failed; see the error code reference.
|
|
80056
81063
|
*/
|
|
80057
81064
|
400: MediaMediaError;
|
|
81065
|
+
/**
|
|
81066
|
+
* Request failed; see the error code reference.
|
|
81067
|
+
*/
|
|
81068
|
+
402: MediaMediaError;
|
|
80058
81069
|
/**
|
|
80059
81070
|
* Request failed; see the error code reference.
|
|
80060
81071
|
*/
|
|
@@ -80196,6 +81207,10 @@ export type MediaUploadAssetErrors = {
|
|
|
80196
81207
|
* Request failed; see the error code reference.
|
|
80197
81208
|
*/
|
|
80198
81209
|
400: MediaMediaError;
|
|
81210
|
+
/**
|
|
81211
|
+
* Request failed; see the error code reference.
|
|
81212
|
+
*/
|
|
81213
|
+
402: MediaMediaError;
|
|
80199
81214
|
/**
|
|
80200
81215
|
* Request failed; see the error code reference.
|
|
80201
81216
|
*/
|
|
@@ -80327,6 +81342,10 @@ export type MediaImportAssetErrors = {
|
|
|
80327
81342
|
* Request failed; see the error code reference.
|
|
80328
81343
|
*/
|
|
80329
81344
|
400: MediaMediaError;
|
|
81345
|
+
/**
|
|
81346
|
+
* Request failed; see the error code reference.
|
|
81347
|
+
*/
|
|
81348
|
+
402: MediaMediaError;
|
|
80330
81349
|
/**
|
|
80331
81350
|
* Request failed; see the error code reference.
|
|
80332
81351
|
*/
|
|
@@ -80396,6 +81415,10 @@ export type MediaDeleteAssetErrors = {
|
|
|
80396
81415
|
* Request failed; see the error code reference.
|
|
80397
81416
|
*/
|
|
80398
81417
|
400: MediaMediaError;
|
|
81418
|
+
/**
|
|
81419
|
+
* Request failed; see the error code reference.
|
|
81420
|
+
*/
|
|
81421
|
+
402: MediaMediaError;
|
|
80399
81422
|
/**
|
|
80400
81423
|
* Request failed; see the error code reference.
|
|
80401
81424
|
*/
|
|
@@ -80465,6 +81488,10 @@ export type MediaGetAssetErrors = {
|
|
|
80465
81488
|
* Request failed; see the error code reference.
|
|
80466
81489
|
*/
|
|
80467
81490
|
400: MediaMediaError;
|
|
81491
|
+
/**
|
|
81492
|
+
* Request failed; see the error code reference.
|
|
81493
|
+
*/
|
|
81494
|
+
402: MediaMediaError;
|
|
80468
81495
|
/**
|
|
80469
81496
|
* Request failed; see the error code reference.
|
|
80470
81497
|
*/
|
|
@@ -80556,6 +81583,10 @@ export type MediaUpdateAssetErrors = {
|
|
|
80556
81583
|
* Request failed; see the error code reference.
|
|
80557
81584
|
*/
|
|
80558
81585
|
400: MediaMediaError;
|
|
81586
|
+
/**
|
|
81587
|
+
* Request failed; see the error code reference.
|
|
81588
|
+
*/
|
|
81589
|
+
402: MediaMediaError;
|
|
80559
81590
|
/**
|
|
80560
81591
|
* Request failed; see the error code reference.
|
|
80561
81592
|
*/
|
|
@@ -80633,6 +81664,10 @@ export type MediaReprocessAssetErrors = {
|
|
|
80633
81664
|
* Request failed; see the error code reference.
|
|
80634
81665
|
*/
|
|
80635
81666
|
400: MediaMediaError;
|
|
81667
|
+
/**
|
|
81668
|
+
* Request failed; see the error code reference.
|
|
81669
|
+
*/
|
|
81670
|
+
402: MediaMediaError;
|
|
80636
81671
|
/**
|
|
80637
81672
|
* Request failed; see the error code reference.
|
|
80638
81673
|
*/
|
|
@@ -80719,6 +81754,10 @@ export type MediaListUnderstandingsErrors = {
|
|
|
80719
81754
|
* Request failed; see the error code reference.
|
|
80720
81755
|
*/
|
|
80721
81756
|
400: MediaMediaError;
|
|
81757
|
+
/**
|
|
81758
|
+
* Request failed; see the error code reference.
|
|
81759
|
+
*/
|
|
81760
|
+
402: MediaMediaError;
|
|
80722
81761
|
/**
|
|
80723
81762
|
* Request failed; see the error code reference.
|
|
80724
81763
|
*/
|
|
@@ -80814,6 +81853,10 @@ export type MediaExpressionSearchErrors = {
|
|
|
80814
81853
|
* Request failed; see the error code reference.
|
|
80815
81854
|
*/
|
|
80816
81855
|
400: MediaMediaError;
|
|
81856
|
+
/**
|
|
81857
|
+
* Request failed; see the error code reference.
|
|
81858
|
+
*/
|
|
81859
|
+
402: MediaMediaError;
|
|
80817
81860
|
/**
|
|
80818
81861
|
* Request failed; see the error code reference.
|
|
80819
81862
|
*/
|
|
@@ -80905,6 +81948,10 @@ export type MediaVisualSearchErrors = {
|
|
|
80905
81948
|
* Request failed; see the error code reference.
|
|
80906
81949
|
*/
|
|
80907
81950
|
400: MediaMediaError;
|
|
81951
|
+
/**
|
|
81952
|
+
* Request failed; see the error code reference.
|
|
81953
|
+
*/
|
|
81954
|
+
402: MediaMediaError;
|
|
80908
81955
|
/**
|
|
80909
81956
|
* Request failed; see the error code reference.
|
|
80910
81957
|
*/
|
|
@@ -80968,13 +82015,17 @@ export type MediaSemanticSearchData = {
|
|
|
80968
82015
|
*/
|
|
80969
82016
|
filter?: string;
|
|
80970
82017
|
/**
|
|
80971
|
-
* Maximum search hits, from 1 to 50; defaults to 20.
|
|
82018
|
+
* Maximum search hits, from 1 to 50; defaults to 20. top_k takes effect and bounds how many distinct hits come back, counting collapsed duplicates as one hit.
|
|
80972
82019
|
*/
|
|
80973
82020
|
top_k?: number;
|
|
80974
82021
|
/**
|
|
80975
82022
|
* Ranking mode: hybrid combines semantic and keyword matches; semantic uses vector similarity only. Defaults to hybrid.
|
|
80976
82023
|
*/
|
|
80977
82024
|
mode?: 'hybrid' | 'semantic';
|
|
82025
|
+
/**
|
|
82026
|
+
* Filter results to one kind of material, independent of the Cloudinary-face resource_type inside filter. Omit to search every material type.
|
|
82027
|
+
*/
|
|
82028
|
+
material_type?: MediaMaterialType;
|
|
80978
82029
|
};
|
|
80979
82030
|
path: {
|
|
80980
82031
|
/**
|
|
@@ -80990,6 +82041,10 @@ export type MediaSemanticSearchErrors = {
|
|
|
80990
82041
|
* Request failed; see the error code reference.
|
|
80991
82042
|
*/
|
|
80992
82043
|
400: MediaMediaError;
|
|
82044
|
+
/**
|
|
82045
|
+
* Request failed; see the error code reference.
|
|
82046
|
+
*/
|
|
82047
|
+
402: MediaMediaError;
|
|
80993
82048
|
/**
|
|
80994
82049
|
* Request failed; see the error code reference.
|
|
80995
82050
|
*/
|
|
@@ -81053,13 +82108,17 @@ export type MediaSearchData = {
|
|
|
81053
82108
|
*/
|
|
81054
82109
|
filter?: string;
|
|
81055
82110
|
/**
|
|
81056
|
-
* Maximum search hits, from 1 to 50; defaults to 20.
|
|
82111
|
+
* Maximum search hits, from 1 to 50; defaults to 20. top_k takes effect and bounds how many distinct hits come back, counting collapsed duplicates as one hit.
|
|
81057
82112
|
*/
|
|
81058
82113
|
top_k?: number;
|
|
81059
82114
|
/**
|
|
81060
82115
|
* Ranking mode: hybrid combines semantic and keyword matches; semantic uses vector similarity only. Defaults to hybrid.
|
|
81061
82116
|
*/
|
|
81062
82117
|
mode?: 'hybrid' | 'semantic';
|
|
82118
|
+
/**
|
|
82119
|
+
* Filter results to one kind of material, independent of the Cloudinary-face resource_type inside filter. Omit to search every material type.
|
|
82120
|
+
*/
|
|
82121
|
+
material_type?: MediaMaterialType;
|
|
81063
82122
|
};
|
|
81064
82123
|
path: {
|
|
81065
82124
|
/**
|
|
@@ -81075,6 +82134,10 @@ export type MediaSearchErrors = {
|
|
|
81075
82134
|
* Request failed; see the error code reference.
|
|
81076
82135
|
*/
|
|
81077
82136
|
400: MediaMediaError;
|
|
82137
|
+
/**
|
|
82138
|
+
* Request failed; see the error code reference.
|
|
82139
|
+
*/
|
|
82140
|
+
402: MediaMediaError;
|
|
81078
82141
|
/**
|
|
81079
82142
|
* Request failed; see the error code reference.
|
|
81080
82143
|
*/
|
|
@@ -81145,6 +82208,10 @@ export type MediaListFoldersErrors = {
|
|
|
81145
82208
|
* Request failed; see the error code reference.
|
|
81146
82209
|
*/
|
|
81147
82210
|
400: MediaMediaError;
|
|
82211
|
+
/**
|
|
82212
|
+
* Request failed; see the error code reference.
|
|
82213
|
+
*/
|
|
82214
|
+
402: MediaMediaError;
|
|
81148
82215
|
/**
|
|
81149
82216
|
* Request failed; see the error code reference.
|
|
81150
82217
|
*/
|
|
@@ -81222,6 +82289,10 @@ export type MediaCreateBatchErrors = {
|
|
|
81222
82289
|
* Request failed; see the error code reference.
|
|
81223
82290
|
*/
|
|
81224
82291
|
400: MediaMediaError;
|
|
82292
|
+
/**
|
|
82293
|
+
* Request failed; see the error code reference.
|
|
82294
|
+
*/
|
|
82295
|
+
402: MediaMediaError;
|
|
81225
82296
|
/**
|
|
81226
82297
|
* Request failed; see the error code reference.
|
|
81227
82298
|
*/
|
|
@@ -81291,6 +82362,10 @@ export type MediaGetBatchErrors = {
|
|
|
81291
82362
|
* Request failed; see the error code reference.
|
|
81292
82363
|
*/
|
|
81293
82364
|
400: MediaMediaError;
|
|
82365
|
+
/**
|
|
82366
|
+
* Request failed; see the error code reference.
|
|
82367
|
+
*/
|
|
82368
|
+
402: MediaMediaError;
|
|
81294
82369
|
/**
|
|
81295
82370
|
* Request failed; see the error code reference.
|
|
81296
82371
|
*/
|
|
@@ -81368,6 +82443,10 @@ export type MediaBatchAssetsErrors = {
|
|
|
81368
82443
|
* Request failed; see the error code reference.
|
|
81369
82444
|
*/
|
|
81370
82445
|
400: MediaMediaError;
|
|
82446
|
+
/**
|
|
82447
|
+
* Request failed; see the error code reference.
|
|
82448
|
+
*/
|
|
82449
|
+
402: MediaMediaError;
|
|
81371
82450
|
/**
|
|
81372
82451
|
* Request failed; see the error code reference.
|
|
81373
82452
|
*/
|
|
@@ -81437,6 +82516,313 @@ export type MediaGetJobErrors = {
|
|
|
81437
82516
|
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
81438
82517
|
*/
|
|
81439
82518
|
400: MediaMediaError;
|
|
82519
|
+
/**
|
|
82520
|
+
* Request failed; see the error code reference.
|
|
82521
|
+
*/
|
|
82522
|
+
402: MediaMediaError;
|
|
82523
|
+
/**
|
|
82524
|
+
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
82525
|
+
*/
|
|
82526
|
+
403: MediaMediaError;
|
|
82527
|
+
/**
|
|
82528
|
+
* The library or asset is missing, deleted or belongs to another tenant; verify its identifier and owner.
|
|
82529
|
+
*/
|
|
82530
|
+
404: MediaMediaError;
|
|
82531
|
+
/**
|
|
82532
|
+
* Request failed; see the error code reference.
|
|
82533
|
+
*/
|
|
82534
|
+
409: MediaMediaError;
|
|
82535
|
+
/**
|
|
82536
|
+
* The file exceeds an input limit; provide a smaller source file.
|
|
82537
|
+
*/
|
|
82538
|
+
413: MediaMediaError;
|
|
82539
|
+
/**
|
|
82540
|
+
* This media format is unsupported; provide a supported format.
|
|
82541
|
+
*/
|
|
82542
|
+
415: MediaMediaError;
|
|
82543
|
+
/**
|
|
82544
|
+
* Request failed; see the error code reference.
|
|
82545
|
+
*/
|
|
82546
|
+
422: MediaMediaError;
|
|
82547
|
+
/**
|
|
82548
|
+
* A rate limit was reached; wait before retrying.
|
|
82549
|
+
*/
|
|
82550
|
+
429: MediaMediaError;
|
|
82551
|
+
/**
|
|
82552
|
+
* The requested operation is unsupported; choose a supported method.
|
|
82553
|
+
*/
|
|
82554
|
+
501: MediaMediaError;
|
|
82555
|
+
/**
|
|
82556
|
+
* Request failed; see the error code reference.
|
|
82557
|
+
*/
|
|
82558
|
+
502: MediaMediaError;
|
|
82559
|
+
/**
|
|
82560
|
+
* Historical projections are still being initialized, or library storage is temporarily unavailable; retry shortly and check failureSummary counts_complete.
|
|
82561
|
+
*/
|
|
82562
|
+
503: MediaMediaError;
|
|
82563
|
+
};
|
|
82564
|
+
export type MediaGetJobError = MediaGetJobErrors[keyof MediaGetJobErrors];
|
|
82565
|
+
export type MediaGetJobResponses = {
|
|
82566
|
+
/**
|
|
82567
|
+
* Successful response.
|
|
82568
|
+
*/
|
|
82569
|
+
200: MediaJob;
|
|
82570
|
+
};
|
|
82571
|
+
export type MediaGetJobResponse = MediaGetJobResponses[keyof MediaGetJobResponses];
|
|
82572
|
+
export type MediaListEventsData = {
|
|
82573
|
+
body?: never;
|
|
82574
|
+
path: {
|
|
82575
|
+
/**
|
|
82576
|
+
* Library ID returned by creation.
|
|
82577
|
+
*/
|
|
82578
|
+
library_id: string;
|
|
82579
|
+
};
|
|
82580
|
+
query?: {
|
|
82581
|
+
/**
|
|
82582
|
+
* Events with a larger sequence. Use with asc; cannot combine with before_seq.
|
|
82583
|
+
*/
|
|
82584
|
+
after_seq?: number;
|
|
82585
|
+
/**
|
|
82586
|
+
* Events with a smaller sequence. Use with desc; cannot combine with after_seq.
|
|
82587
|
+
*/
|
|
82588
|
+
before_seq?: number;
|
|
82589
|
+
/**
|
|
82590
|
+
* Sequence order: asc is increasing; desc is decreasing.
|
|
82591
|
+
*/
|
|
82592
|
+
order?: 'asc' | 'desc';
|
|
82593
|
+
/**
|
|
82594
|
+
* Maximum items per page, from 1 to 200; defaults to 50.
|
|
82595
|
+
*/
|
|
82596
|
+
limit?: number;
|
|
82597
|
+
};
|
|
82598
|
+
url: '/media/v1/libraries/{library_id}/events';
|
|
82599
|
+
};
|
|
82600
|
+
export type MediaListEventsErrors = {
|
|
82601
|
+
/**
|
|
82602
|
+
* Request failed; see the error code reference.
|
|
82603
|
+
*/
|
|
82604
|
+
400: MediaMediaError;
|
|
82605
|
+
/**
|
|
82606
|
+
* Request failed; see the error code reference.
|
|
82607
|
+
*/
|
|
82608
|
+
402: MediaMediaError;
|
|
82609
|
+
/**
|
|
82610
|
+
* Request failed; see the error code reference.
|
|
82611
|
+
*/
|
|
82612
|
+
403: MediaMediaError;
|
|
82613
|
+
/**
|
|
82614
|
+
* Request failed; see the error code reference.
|
|
82615
|
+
*/
|
|
82616
|
+
404: MediaMediaError;
|
|
82617
|
+
/**
|
|
82618
|
+
* Request failed; see the error code reference.
|
|
82619
|
+
*/
|
|
82620
|
+
409: MediaMediaError;
|
|
82621
|
+
/**
|
|
82622
|
+
* Request failed; see the error code reference.
|
|
82623
|
+
*/
|
|
82624
|
+
413: MediaMediaError;
|
|
82625
|
+
/**
|
|
82626
|
+
* Request failed; see the error code reference.
|
|
82627
|
+
*/
|
|
82628
|
+
415: MediaMediaError;
|
|
82629
|
+
/**
|
|
82630
|
+
* Request failed; see the error code reference.
|
|
82631
|
+
*/
|
|
82632
|
+
422: MediaMediaError;
|
|
82633
|
+
/**
|
|
82634
|
+
* Request failed; see the error code reference.
|
|
82635
|
+
*/
|
|
82636
|
+
429: MediaMediaError;
|
|
82637
|
+
/**
|
|
82638
|
+
* Request failed; see the error code reference.
|
|
82639
|
+
*/
|
|
82640
|
+
501: MediaMediaError;
|
|
82641
|
+
/**
|
|
82642
|
+
* Request failed; see the error code reference.
|
|
82643
|
+
*/
|
|
82644
|
+
502: MediaMediaError;
|
|
82645
|
+
/**
|
|
82646
|
+
* Request failed; see the error code reference.
|
|
82647
|
+
*/
|
|
82648
|
+
503: MediaMediaError;
|
|
82649
|
+
};
|
|
82650
|
+
export type MediaListEventsError = MediaListEventsErrors[keyof MediaListEventsErrors];
|
|
82651
|
+
export type MediaListEventsResponses = {
|
|
82652
|
+
/**
|
|
82653
|
+
* Successful response.
|
|
82654
|
+
*/
|
|
82655
|
+
200: MediaMediaEventPage;
|
|
82656
|
+
};
|
|
82657
|
+
export type MediaListEventsResponse = MediaListEventsResponses[keyof MediaListEventsResponses];
|
|
82658
|
+
export type MediaCreateDeliveryTokenData = {
|
|
82659
|
+
/**
|
|
82660
|
+
* Options for authorizing private asset delivery within one active library.
|
|
82661
|
+
*/
|
|
82662
|
+
body: {
|
|
82663
|
+
/**
|
|
82664
|
+
* 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.
|
|
82665
|
+
*/
|
|
82666
|
+
acl?: string;
|
|
82667
|
+
/**
|
|
82668
|
+
* Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 900.
|
|
82669
|
+
*/
|
|
82670
|
+
expires_in?: number;
|
|
82671
|
+
};
|
|
82672
|
+
path: {
|
|
82673
|
+
/**
|
|
82674
|
+
* Library ID returned by creation.
|
|
82675
|
+
*/
|
|
82676
|
+
library_id: string;
|
|
82677
|
+
};
|
|
82678
|
+
query?: never;
|
|
82679
|
+
url: '/media/v1/libraries/{library_id}/delivery_tokens';
|
|
82680
|
+
};
|
|
82681
|
+
export type MediaCreateDeliveryTokenErrors = {
|
|
82682
|
+
/**
|
|
82683
|
+
* Request failed; see the error code reference.
|
|
82684
|
+
*/
|
|
82685
|
+
400: MediaMediaError;
|
|
82686
|
+
/**
|
|
82687
|
+
* Request failed; see the error code reference.
|
|
82688
|
+
*/
|
|
82689
|
+
402: MediaMediaError;
|
|
82690
|
+
/**
|
|
82691
|
+
* Request failed; see the error code reference.
|
|
82692
|
+
*/
|
|
82693
|
+
403: MediaMediaError;
|
|
82694
|
+
/**
|
|
82695
|
+
* Request failed; see the error code reference.
|
|
82696
|
+
*/
|
|
82697
|
+
404: MediaMediaError;
|
|
82698
|
+
/**
|
|
82699
|
+
* Request failed; see the error code reference.
|
|
82700
|
+
*/
|
|
82701
|
+
409: MediaMediaError;
|
|
82702
|
+
/**
|
|
82703
|
+
* Request failed; see the error code reference.
|
|
82704
|
+
*/
|
|
82705
|
+
413: MediaMediaError;
|
|
82706
|
+
/**
|
|
82707
|
+
* Request failed; see the error code reference.
|
|
82708
|
+
*/
|
|
82709
|
+
415: MediaMediaError;
|
|
82710
|
+
/**
|
|
82711
|
+
* Request failed; see the error code reference.
|
|
82712
|
+
*/
|
|
82713
|
+
422: MediaMediaError;
|
|
82714
|
+
/**
|
|
82715
|
+
* Request failed; see the error code reference.
|
|
82716
|
+
*/
|
|
82717
|
+
429: MediaMediaError;
|
|
82718
|
+
/**
|
|
82719
|
+
* Request failed; see the error code reference.
|
|
82720
|
+
*/
|
|
82721
|
+
501: MediaMediaError;
|
|
82722
|
+
/**
|
|
82723
|
+
* Request failed; see the error code reference.
|
|
82724
|
+
*/
|
|
82725
|
+
502: MediaMediaError;
|
|
82726
|
+
/**
|
|
82727
|
+
* Request failed; see the error code reference.
|
|
82728
|
+
*/
|
|
82729
|
+
503: MediaMediaError;
|
|
82730
|
+
};
|
|
82731
|
+
export type MediaCreateDeliveryTokenError = MediaCreateDeliveryTokenErrors[keyof MediaCreateDeliveryTokenErrors];
|
|
82732
|
+
export type MediaCreateDeliveryTokenResponses = {
|
|
82733
|
+
/**
|
|
82734
|
+
* Successful response.
|
|
82735
|
+
*/
|
|
82736
|
+
200: MediaDeliveryToken;
|
|
82737
|
+
};
|
|
82738
|
+
export type MediaCreateDeliveryTokenResponse = MediaCreateDeliveryTokenResponses[keyof MediaCreateDeliveryTokenResponses];
|
|
82739
|
+
export type MediaGetDefaultLibraryData = {
|
|
82740
|
+
body?: never;
|
|
82741
|
+
path?: never;
|
|
82742
|
+
query?: never;
|
|
82743
|
+
url: '/media/v1/libraries/default';
|
|
82744
|
+
};
|
|
82745
|
+
export type MediaGetDefaultLibraryErrors = {
|
|
82746
|
+
/**
|
|
82747
|
+
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
82748
|
+
*/
|
|
82749
|
+
400: MediaMediaError;
|
|
82750
|
+
/**
|
|
82751
|
+
* Request failed; see the error code reference.
|
|
82752
|
+
*/
|
|
82753
|
+
402: MediaMediaError;
|
|
82754
|
+
/**
|
|
82755
|
+
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
82756
|
+
*/
|
|
82757
|
+
403: MediaMediaError;
|
|
82758
|
+
/**
|
|
82759
|
+
* The library or asset is missing, deleted or belongs to another tenant; verify its identifier and owner.
|
|
82760
|
+
*/
|
|
82761
|
+
404: MediaMediaError;
|
|
82762
|
+
/**
|
|
82763
|
+
* Request failed; see the error code reference.
|
|
82764
|
+
*/
|
|
82765
|
+
409: MediaMediaError;
|
|
82766
|
+
/**
|
|
82767
|
+
* The file exceeds an input limit; provide a smaller source file.
|
|
82768
|
+
*/
|
|
82769
|
+
413: MediaMediaError;
|
|
82770
|
+
/**
|
|
82771
|
+
* This media format is unsupported; provide a supported format.
|
|
82772
|
+
*/
|
|
82773
|
+
415: MediaMediaError;
|
|
82774
|
+
/**
|
|
82775
|
+
* Request failed; see the error code reference.
|
|
82776
|
+
*/
|
|
82777
|
+
422: MediaMediaError;
|
|
82778
|
+
/**
|
|
82779
|
+
* A rate limit was reached; wait before retrying.
|
|
82780
|
+
*/
|
|
82781
|
+
429: MediaMediaError;
|
|
82782
|
+
/**
|
|
82783
|
+
* The requested operation is unsupported; choose a supported method.
|
|
82784
|
+
*/
|
|
82785
|
+
501: MediaMediaError;
|
|
82786
|
+
/**
|
|
82787
|
+
* Request failed; see the error code reference.
|
|
82788
|
+
*/
|
|
82789
|
+
502: MediaMediaError;
|
|
82790
|
+
/**
|
|
82791
|
+
* Historical projections are still being initialized, or library storage is temporarily unavailable; retry shortly and check failureSummary counts_complete.
|
|
82792
|
+
*/
|
|
82793
|
+
503: MediaMediaError;
|
|
82794
|
+
};
|
|
82795
|
+
export type MediaGetDefaultLibraryError = MediaGetDefaultLibraryErrors[keyof MediaGetDefaultLibraryErrors];
|
|
82796
|
+
export type MediaGetDefaultLibraryResponses = {
|
|
82797
|
+
/**
|
|
82798
|
+
* Successful response.
|
|
82799
|
+
*/
|
|
82800
|
+
200: MediaLibrary;
|
|
82801
|
+
};
|
|
82802
|
+
export type MediaGetDefaultLibraryResponse = MediaGetDefaultLibraryResponses[keyof MediaGetDefaultLibraryResponses];
|
|
82803
|
+
export type MediaSetDefaultLibraryData = {
|
|
82804
|
+
/**
|
|
82805
|
+
* Points the organization’s default library at an existing library (ADR-093).
|
|
82806
|
+
*/
|
|
82807
|
+
body: {
|
|
82808
|
+
/**
|
|
82809
|
+
* Library to make this organization’s default, from library creation or listing. The library must be active and belong to the organization.
|
|
82810
|
+
*/
|
|
82811
|
+
library_id: MediaLibraryId;
|
|
82812
|
+
};
|
|
82813
|
+
path?: never;
|
|
82814
|
+
query?: never;
|
|
82815
|
+
url: '/media/v1/libraries/default';
|
|
82816
|
+
};
|
|
82817
|
+
export type MediaSetDefaultLibraryErrors = {
|
|
82818
|
+
/**
|
|
82819
|
+
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
82820
|
+
*/
|
|
82821
|
+
400: MediaMediaError;
|
|
82822
|
+
/**
|
|
82823
|
+
* Request failed; see the error code reference.
|
|
82824
|
+
*/
|
|
82825
|
+
402: MediaMediaError;
|
|
81440
82826
|
/**
|
|
81441
82827
|
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
81442
82828
|
*/
|
|
@@ -81478,77 +82864,199 @@ export type MediaGetJobErrors = {
|
|
|
81478
82864
|
*/
|
|
81479
82865
|
503: MediaMediaError;
|
|
81480
82866
|
};
|
|
81481
|
-
export type
|
|
81482
|
-
export type
|
|
82867
|
+
export type MediaSetDefaultLibraryError = MediaSetDefaultLibraryErrors[keyof MediaSetDefaultLibraryErrors];
|
|
82868
|
+
export type MediaSetDefaultLibraryResponses = {
|
|
81483
82869
|
/**
|
|
81484
82870
|
* Successful response.
|
|
81485
82871
|
*/
|
|
81486
|
-
200:
|
|
82872
|
+
200: MediaLibrary;
|
|
81487
82873
|
};
|
|
81488
|
-
export type
|
|
81489
|
-
export type
|
|
82874
|
+
export type MediaSetDefaultLibraryResponse = MediaSetDefaultLibraryResponses[keyof MediaSetDefaultLibraryResponses];
|
|
82875
|
+
export type MediaGetAssetLineageData = {
|
|
81490
82876
|
body?: never;
|
|
81491
82877
|
path: {
|
|
81492
82878
|
/**
|
|
81493
82879
|
* Library ID returned by creation.
|
|
81494
82880
|
*/
|
|
81495
82881
|
library_id: string;
|
|
82882
|
+
/**
|
|
82883
|
+
* 32-character asset ID.
|
|
82884
|
+
*/
|
|
82885
|
+
asset_id: string;
|
|
81496
82886
|
};
|
|
81497
|
-
query?:
|
|
82887
|
+
query?: never;
|
|
82888
|
+
url: '/media/v1/libraries/{library_id}/assets/{asset_id}/lineage';
|
|
82889
|
+
};
|
|
82890
|
+
export type MediaGetAssetLineageErrors = {
|
|
82891
|
+
/**
|
|
82892
|
+
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
82893
|
+
*/
|
|
82894
|
+
400: MediaMediaError;
|
|
82895
|
+
/**
|
|
82896
|
+
* Request failed; see the error code reference.
|
|
82897
|
+
*/
|
|
82898
|
+
402: MediaMediaError;
|
|
82899
|
+
/**
|
|
82900
|
+
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
82901
|
+
*/
|
|
82902
|
+
403: MediaMediaError;
|
|
82903
|
+
/**
|
|
82904
|
+
* The library or asset is missing, deleted or belongs to another tenant; verify its identifier and owner.
|
|
82905
|
+
*/
|
|
82906
|
+
404: MediaMediaError;
|
|
82907
|
+
/**
|
|
82908
|
+
* Request failed; see the error code reference.
|
|
82909
|
+
*/
|
|
82910
|
+
409: MediaMediaError;
|
|
82911
|
+
/**
|
|
82912
|
+
* The file exceeds an input limit; provide a smaller source file.
|
|
82913
|
+
*/
|
|
82914
|
+
413: MediaMediaError;
|
|
82915
|
+
/**
|
|
82916
|
+
* This media format is unsupported; provide a supported format.
|
|
82917
|
+
*/
|
|
82918
|
+
415: MediaMediaError;
|
|
82919
|
+
/**
|
|
82920
|
+
* Request failed; see the error code reference.
|
|
82921
|
+
*/
|
|
82922
|
+
422: MediaMediaError;
|
|
82923
|
+
/**
|
|
82924
|
+
* A rate limit was reached; wait before retrying.
|
|
82925
|
+
*/
|
|
82926
|
+
429: MediaMediaError;
|
|
82927
|
+
/**
|
|
82928
|
+
* The requested operation is unsupported; choose a supported method.
|
|
82929
|
+
*/
|
|
82930
|
+
501: MediaMediaError;
|
|
82931
|
+
/**
|
|
82932
|
+
* Request failed; see the error code reference.
|
|
82933
|
+
*/
|
|
82934
|
+
502: MediaMediaError;
|
|
82935
|
+
/**
|
|
82936
|
+
* Historical projections are still being initialized, or library storage is temporarily unavailable; retry shortly and check failureSummary counts_complete.
|
|
82937
|
+
*/
|
|
82938
|
+
503: MediaMediaError;
|
|
82939
|
+
};
|
|
82940
|
+
export type MediaGetAssetLineageError = MediaGetAssetLineageErrors[keyof MediaGetAssetLineageErrors];
|
|
82941
|
+
export type MediaGetAssetLineageResponses = {
|
|
82942
|
+
/**
|
|
82943
|
+
* Successful response.
|
|
82944
|
+
*/
|
|
82945
|
+
200: MediaLineageTree;
|
|
82946
|
+
};
|
|
82947
|
+
export type MediaGetAssetLineageResponse = MediaGetAssetLineageResponses[keyof MediaGetAssetLineageResponses];
|
|
82948
|
+
export type MediaGenerateImageData = {
|
|
82949
|
+
/**
|
|
82950
|
+
* Generate images from a text prompt directly into a library. The response is a queued Job; poll it and read the produced assets from the library.
|
|
82951
|
+
*/
|
|
82952
|
+
body: {
|
|
81498
82953
|
/**
|
|
81499
|
-
*
|
|
82954
|
+
* Text prompt describing the image to generate; Router forwards it to the image model unchanged.
|
|
81500
82955
|
*/
|
|
81501
|
-
|
|
82956
|
+
prompt: string;
|
|
81502
82957
|
/**
|
|
81503
|
-
*
|
|
82958
|
+
* What the image must not contain. Models without a negative-prompt control ignore it.
|
|
81504
82959
|
*/
|
|
81505
|
-
|
|
82960
|
+
negative_prompt?: string;
|
|
81506
82961
|
/**
|
|
81507
|
-
*
|
|
82962
|
+
* Images to generate in one job, from 1 to 10; defaults to 1. Each produced image is charged separately.
|
|
81508
82963
|
*/
|
|
81509
|
-
|
|
82964
|
+
n?: number;
|
|
81510
82965
|
/**
|
|
81511
|
-
*
|
|
82966
|
+
* Requested pixel size written as width x height. Router validates it against the chosen model and rejects an unsupported size with INVALID_PARAMS.
|
|
81512
82967
|
*/
|
|
81513
|
-
|
|
82968
|
+
size?: string;
|
|
82969
|
+
/**
|
|
82970
|
+
* Background handling; defaults to auto. Whether transparency is honoured depends on the model.
|
|
82971
|
+
*/
|
|
82972
|
+
background?: 'transparent' | 'opaque' | 'auto';
|
|
82973
|
+
/**
|
|
82974
|
+
* Encoding of the stored image; defaults to png. Transparency requires png or webp.
|
|
82975
|
+
*/
|
|
82976
|
+
output_format?: 'png' | 'jpeg' | 'webp';
|
|
82977
|
+
/**
|
|
82978
|
+
* How the result is stored: image for a normal picture, or sticker for a cut-out committed with material_type sticker; defaults to image.
|
|
82979
|
+
*/
|
|
82980
|
+
output?: 'image' | 'sticker';
|
|
82981
|
+
/**
|
|
82982
|
+
* Existing assets the model may use, each with the role it plays. Router answers REFERENCE_TYPE_MISMATCH when the chosen model cannot honour a role.
|
|
82983
|
+
*/
|
|
82984
|
+
references?: Array<MediaAssetReference>;
|
|
82985
|
+
/**
|
|
82986
|
+
* Seed for reproducible sampling; omit it to let the model choose one.
|
|
82987
|
+
*/
|
|
82988
|
+
seed?: number;
|
|
82989
|
+
/**
|
|
82990
|
+
* Router model with image-generation capability; omit it to use the library default image model.
|
|
82991
|
+
*/
|
|
82992
|
+
model?: string;
|
|
82993
|
+
/**
|
|
82994
|
+
* Folder the produced asset is filed under; 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.
|
|
82995
|
+
*/
|
|
82996
|
+
asset_folder?: string;
|
|
82997
|
+
/**
|
|
82998
|
+
* Understanding behavior for the produced asset; defaults to auto.
|
|
82999
|
+
*/
|
|
83000
|
+
understanding?: 'auto' | 'skip';
|
|
83001
|
+
/**
|
|
83002
|
+
* Stable key so a retried request reuses the same job instead of generating and charging again; reusing it with different content is rejected.
|
|
83003
|
+
*/
|
|
83004
|
+
idempotency_key?: string;
|
|
81514
83005
|
};
|
|
81515
|
-
|
|
83006
|
+
headers?: {
|
|
83007
|
+
/**
|
|
83008
|
+
* Stable key for retrying the same request without creating or charging for another job; reusing it with different request content is rejected. Send it here or as idempotency_key in the body, never both with different values.
|
|
83009
|
+
*/
|
|
83010
|
+
'Idempotency-Key'?: string;
|
|
83011
|
+
};
|
|
83012
|
+
path: {
|
|
83013
|
+
/**
|
|
83014
|
+
* Library ID returned by creation.
|
|
83015
|
+
*/
|
|
83016
|
+
library_id: string;
|
|
83017
|
+
};
|
|
83018
|
+
query?: never;
|
|
83019
|
+
url: '/media/v1/libraries/{library_id}/images/generations';
|
|
81516
83020
|
};
|
|
81517
|
-
export type
|
|
83021
|
+
export type MediaGenerateImageErrors = {
|
|
81518
83022
|
/**
|
|
81519
|
-
*
|
|
83023
|
+
* INVALID_PARAMS: prompt is missing or a size, n or other field is out of range; REFERENCE_TYPE_MISMATCH: the chosen model cannot honour a reference role, or a referenced asset is not an image. Correct the reported field, or choose a supported model or reference role. Note that aspect_ratio is not accepted for images; name size instead.
|
|
81520
83024
|
*/
|
|
81521
83025
|
400: MediaMediaError;
|
|
81522
83026
|
/**
|
|
81523
|
-
*
|
|
83027
|
+
* INSUFFICIENT_BALANCE: the organization balance cannot cover the estimated cost of this generation or edit; top up and resubmit. Nothing was generated and nothing was charged for this request.
|
|
83028
|
+
*/
|
|
83029
|
+
402: MediaMediaError;
|
|
83030
|
+
/**
|
|
83031
|
+
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
81524
83032
|
*/
|
|
81525
83033
|
403: MediaMediaError;
|
|
81526
83034
|
/**
|
|
81527
|
-
*
|
|
83035
|
+
* ASSET_NOT_FOUND: the edited asset is missing, deleted or belongs to another library, or the addressed library was not found; verify the identifiers with libraries and assets. A reference asset that cannot be reached answers the same way, never as a hint that it exists elsewhere.
|
|
81528
83036
|
*/
|
|
81529
83037
|
404: MediaMediaError;
|
|
81530
83038
|
/**
|
|
81531
|
-
*
|
|
83039
|
+
* MODEL_PENDING or JOB_INVALID_STATE: the chosen model is not ready for this library, or the job cannot start from its current state; wait for the model to become available, or start a new job rather than resuming this one.
|
|
81532
83040
|
*/
|
|
81533
83041
|
409: MediaMediaError;
|
|
81534
83042
|
/**
|
|
81535
|
-
*
|
|
83043
|
+
* The file exceeds an input limit; provide a smaller source file.
|
|
81536
83044
|
*/
|
|
81537
83045
|
413: MediaMediaError;
|
|
81538
83046
|
/**
|
|
81539
|
-
*
|
|
83047
|
+
* This media format is unsupported; provide a supported format.
|
|
81540
83048
|
*/
|
|
81541
83049
|
415: MediaMediaError;
|
|
81542
83050
|
/**
|
|
81543
|
-
*
|
|
83051
|
+
* CONTENT_REJECTED: the provider refused the prompt or the source image under its content policy; change the prompt or the source before retrying. Nothing was generated and nothing was charged.
|
|
81544
83052
|
*/
|
|
81545
83053
|
422: MediaMediaError;
|
|
81546
83054
|
/**
|
|
81547
|
-
*
|
|
83055
|
+
* RATE_LIMITED: this library already has its maximum number of queued or running jobs, or the provider is throttling requests; Retry-After gives the seconds to wait before retrying.
|
|
81548
83056
|
*/
|
|
81549
83057
|
429: MediaMediaError;
|
|
81550
83058
|
/**
|
|
81551
|
-
*
|
|
83059
|
+
* The requested operation is unsupported; choose a supported method.
|
|
81552
83060
|
*/
|
|
81553
83061
|
501: MediaMediaError;
|
|
81554
83062
|
/**
|
|
@@ -81556,76 +83064,102 @@ export type MediaListEventsErrors = {
|
|
|
81556
83064
|
*/
|
|
81557
83065
|
502: MediaMediaError;
|
|
81558
83066
|
/**
|
|
81559
|
-
*
|
|
83067
|
+
* Historical projections are still being initialized, or library storage is temporarily unavailable; retry shortly and check failureSummary counts_complete.
|
|
81560
83068
|
*/
|
|
81561
83069
|
503: MediaMediaError;
|
|
81562
83070
|
};
|
|
81563
|
-
export type
|
|
81564
|
-
export type
|
|
83071
|
+
export type MediaGenerateImageError = MediaGenerateImageErrors[keyof MediaGenerateImageErrors];
|
|
83072
|
+
export type MediaGenerateImageResponses = {
|
|
81565
83073
|
/**
|
|
81566
|
-
*
|
|
83074
|
+
* The job is queued. Poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until its status is completed or failed; the produced assets are stored in the library as they finish.
|
|
81567
83075
|
*/
|
|
81568
|
-
|
|
83076
|
+
202: MediaJob;
|
|
81569
83077
|
};
|
|
81570
|
-
export type
|
|
81571
|
-
export type
|
|
83078
|
+
export type MediaGenerateImageResponse = MediaGenerateImageResponses[keyof MediaGenerateImageResponses];
|
|
83079
|
+
export type MediaEditAssetData = {
|
|
81572
83080
|
/**
|
|
81573
|
-
*
|
|
83081
|
+
* Apply one edit to an existing asset. The result is a new asset in the source’s edit chain; the original is never overwritten.
|
|
81574
83082
|
*/
|
|
81575
83083
|
body: {
|
|
81576
83084
|
/**
|
|
81577
|
-
*
|
|
83085
|
+
* The edit to apply; type selects the operation and its fields.
|
|
81578
83086
|
*/
|
|
81579
|
-
|
|
83087
|
+
operation: MediaEditOperation;
|
|
81580
83088
|
/**
|
|
81581
|
-
*
|
|
83089
|
+
* Router model that performs the edit; omit it to use the library default image model.
|
|
81582
83090
|
*/
|
|
81583
|
-
|
|
83091
|
+
model?: string;
|
|
83092
|
+
/**
|
|
83093
|
+
* Folder the produced asset is filed under; defaults to the source asset’s folder. 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.
|
|
83094
|
+
*/
|
|
83095
|
+
asset_folder?: string;
|
|
83096
|
+
/**
|
|
83097
|
+
* Understanding behavior for the produced asset; defaults to auto.
|
|
83098
|
+
*/
|
|
83099
|
+
understanding?: 'auto' | 'skip';
|
|
83100
|
+
/**
|
|
83101
|
+
* Stable key so a retried request reuses the same job instead of editing and charging again; reusing it with different content is rejected.
|
|
83102
|
+
*/
|
|
83103
|
+
idempotency_key?: string;
|
|
83104
|
+
};
|
|
83105
|
+
headers?: {
|
|
83106
|
+
/**
|
|
83107
|
+
* Stable key for retrying the same request without creating or charging for another job; reusing it with different request content is rejected. Send it here or as idempotency_key in the body, never both with different values.
|
|
83108
|
+
*/
|
|
83109
|
+
'Idempotency-Key'?: string;
|
|
81584
83110
|
};
|
|
81585
83111
|
path: {
|
|
81586
83112
|
/**
|
|
81587
83113
|
* Library ID returned by creation.
|
|
81588
83114
|
*/
|
|
81589
83115
|
library_id: string;
|
|
83116
|
+
/**
|
|
83117
|
+
* 32-character asset ID.
|
|
83118
|
+
*/
|
|
83119
|
+
asset_id: string;
|
|
81590
83120
|
};
|
|
81591
83121
|
query?: never;
|
|
81592
|
-
url: '/media/v1/libraries/{library_id}/
|
|
83122
|
+
url: '/media/v1/libraries/{library_id}/assets/{asset_id}/edits';
|
|
81593
83123
|
};
|
|
81594
|
-
export type
|
|
83124
|
+
export type MediaEditAssetErrors = {
|
|
81595
83125
|
/**
|
|
81596
|
-
*
|
|
83126
|
+
* OPERATION_NOT_SUPPORTED: the requested operation type is not performed on this asset type in this release — image edits support variations, inpaint, erase, replace_object, recolor, remove_background and replace_background. REFERENCE_TYPE_MISMATCH: the source asset or a referenced asset has a material type the chosen model cannot edit, or the edit’s mask is not a PNG file identifier; INVALID_PARAMS: the operation is missing a field it requires. Select a supported operation and correct the reported field.
|
|
81597
83127
|
*/
|
|
81598
83128
|
400: MediaMediaError;
|
|
81599
83129
|
/**
|
|
81600
|
-
*
|
|
83130
|
+
* INSUFFICIENT_BALANCE: the organization balance cannot cover the estimated cost of this generation or edit; top up and resubmit. Nothing was generated and nothing was charged for this request.
|
|
83131
|
+
*/
|
|
83132
|
+
402: MediaMediaError;
|
|
83133
|
+
/**
|
|
83134
|
+
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
81601
83135
|
*/
|
|
81602
83136
|
403: MediaMediaError;
|
|
81603
83137
|
/**
|
|
81604
|
-
*
|
|
83138
|
+
* ASSET_NOT_FOUND: the edited asset is missing, deleted or belongs to another library, or the addressed library was not found; verify the identifiers with libraries and assets. A reference asset that cannot be reached answers the same way, never as a hint that it exists elsewhere.
|
|
81605
83139
|
*/
|
|
81606
83140
|
404: MediaMediaError;
|
|
81607
83141
|
/**
|
|
81608
|
-
*
|
|
83142
|
+
* MODEL_PENDING or JOB_INVALID_STATE: the chosen model is not ready for this library, or the job cannot start from its current state; wait for the model to become available, or start a new job rather than resuming this one.
|
|
81609
83143
|
*/
|
|
81610
83144
|
409: MediaMediaError;
|
|
81611
83145
|
/**
|
|
81612
|
-
*
|
|
83146
|
+
* The file exceeds an input limit; provide a smaller source file.
|
|
81613
83147
|
*/
|
|
81614
83148
|
413: MediaMediaError;
|
|
81615
83149
|
/**
|
|
81616
|
-
*
|
|
83150
|
+
* This media format is unsupported; provide a supported format.
|
|
81617
83151
|
*/
|
|
81618
83152
|
415: MediaMediaError;
|
|
81619
83153
|
/**
|
|
81620
|
-
*
|
|
83154
|
+
* CONTENT_REJECTED: the provider refused the prompt or the source image under its content policy; change the prompt or the source before retrying. Nothing was generated and nothing was charged.
|
|
81621
83155
|
*/
|
|
81622
83156
|
422: MediaMediaError;
|
|
81623
83157
|
/**
|
|
81624
|
-
*
|
|
83158
|
+
* RATE_LIMITED: this library already has its maximum number of queued or running jobs, or the provider is throttling requests; Retry-After gives the seconds to wait before retrying.
|
|
81625
83159
|
*/
|
|
81626
83160
|
429: MediaMediaError;
|
|
81627
83161
|
/**
|
|
81628
|
-
*
|
|
83162
|
+
* The requested operation is unsupported; choose a supported method.
|
|
81629
83163
|
*/
|
|
81630
83164
|
501: MediaMediaError;
|
|
81631
83165
|
/**
|
|
@@ -81633,18 +83167,18 @@ export type MediaCreateDeliveryTokenErrors = {
|
|
|
81633
83167
|
*/
|
|
81634
83168
|
502: MediaMediaError;
|
|
81635
83169
|
/**
|
|
81636
|
-
*
|
|
83170
|
+
* Historical projections are still being initialized, or library storage is temporarily unavailable; retry shortly and check failureSummary counts_complete.
|
|
81637
83171
|
*/
|
|
81638
83172
|
503: MediaMediaError;
|
|
81639
83173
|
};
|
|
81640
|
-
export type
|
|
81641
|
-
export type
|
|
83174
|
+
export type MediaEditAssetError = MediaEditAssetErrors[keyof MediaEditAssetErrors];
|
|
83175
|
+
export type MediaEditAssetResponses = {
|
|
81642
83176
|
/**
|
|
81643
|
-
*
|
|
83177
|
+
* The edit job is queued. Poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until its status is completed or failed; the produced asset is a new asset in the source asset’s edit chain, and the source is unchanged.
|
|
81644
83178
|
*/
|
|
81645
|
-
|
|
83179
|
+
202: MediaJob;
|
|
81646
83180
|
};
|
|
81647
|
-
export type
|
|
83181
|
+
export type MediaEditAssetResponse = MediaEditAssetResponses[keyof MediaEditAssetResponses];
|
|
81648
83182
|
export type MediaUnderstandingFailureSummaryData = {
|
|
81649
83183
|
body?: never;
|
|
81650
83184
|
path: {
|
|
@@ -81661,6 +83195,10 @@ export type MediaUnderstandingFailureSummaryErrors = {
|
|
|
81661
83195
|
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
81662
83196
|
*/
|
|
81663
83197
|
400: MediaMediaError;
|
|
83198
|
+
/**
|
|
83199
|
+
* Request failed; see the error code reference.
|
|
83200
|
+
*/
|
|
83201
|
+
402: MediaMediaError;
|
|
81664
83202
|
/**
|
|
81665
83203
|
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
81666
83204
|
*/
|
|
@@ -81743,6 +83281,10 @@ export type MediaListUnderstandingsByLibraryErrors = {
|
|
|
81743
83281
|
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
81744
83282
|
*/
|
|
81745
83283
|
400: MediaMediaError;
|
|
83284
|
+
/**
|
|
83285
|
+
* Request failed; see the error code reference.
|
|
83286
|
+
*/
|
|
83287
|
+
402: MediaMediaError;
|
|
81746
83288
|
/**
|
|
81747
83289
|
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
81748
83290
|
*/
|
|
@@ -81844,7 +83386,7 @@ export type MediaCreateGenerationData = {
|
|
|
81844
83386
|
};
|
|
81845
83387
|
headers?: {
|
|
81846
83388
|
/**
|
|
81847
|
-
* Stable key for retrying the same request without creating or charging for another job; reusing it with different request content is rejected.
|
|
83389
|
+
* Stable key for retrying the same request without creating or charging for another job; reusing it with different request content is rejected. Send it here or as idempotency_key in the body, never both with different values.
|
|
81848
83390
|
*/
|
|
81849
83391
|
'Idempotency-Key'?: string;
|
|
81850
83392
|
};
|
|
@@ -81862,6 +83404,10 @@ export type MediaCreateGenerationErrors = {
|
|
|
81862
83404
|
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
81863
83405
|
*/
|
|
81864
83406
|
400: MediaMediaError;
|
|
83407
|
+
/**
|
|
83408
|
+
* Request failed; see the error code reference.
|
|
83409
|
+
*/
|
|
83410
|
+
402: MediaMediaError;
|
|
81865
83411
|
/**
|
|
81866
83412
|
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
81867
83413
|
*/
|
|
@@ -81940,6 +83486,10 @@ export type MediaListJobsErrors = {
|
|
|
81940
83486
|
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
81941
83487
|
*/
|
|
81942
83488
|
400: MediaMediaError;
|
|
83489
|
+
/**
|
|
83490
|
+
* Request failed; see the error code reference.
|
|
83491
|
+
*/
|
|
83492
|
+
402: MediaMediaError;
|
|
81943
83493
|
/**
|
|
81944
83494
|
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
81945
83495
|
*/
|
|
@@ -82009,6 +83559,10 @@ export type MediaCancelJobErrors = {
|
|
|
82009
83559
|
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
82010
83560
|
*/
|
|
82011
83561
|
400: MediaMediaError;
|
|
83562
|
+
/**
|
|
83563
|
+
* Request failed; see the error code reference.
|
|
83564
|
+
*/
|
|
83565
|
+
402: MediaMediaError;
|
|
82012
83566
|
/**
|
|
82013
83567
|
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
82014
83568
|
*/
|
|
@@ -82102,6 +83656,10 @@ export type MediaSaveGenerationOutputErrors = {
|
|
|
82102
83656
|
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
82103
83657
|
*/
|
|
82104
83658
|
400: MediaMediaError;
|
|
83659
|
+
/**
|
|
83660
|
+
* Request failed; see the error code reference.
|
|
83661
|
+
*/
|
|
83662
|
+
402: MediaMediaError;
|
|
82105
83663
|
/**
|
|
82106
83664
|
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
82107
83665
|
*/
|
|
@@ -82162,6 +83720,10 @@ export type MediaGetGenerationCapabilitiesErrors = {
|
|
|
82162
83720
|
* A selector, cursor, limit or other parameter is invalid; correct the reported field before retrying.
|
|
82163
83721
|
*/
|
|
82164
83722
|
400: MediaMediaError;
|
|
83723
|
+
/**
|
|
83724
|
+
* Request failed; see the error code reference.
|
|
83725
|
+
*/
|
|
83726
|
+
402: MediaMediaError;
|
|
82165
83727
|
/**
|
|
82166
83728
|
* This credential has read-only access to the library; use a write-capable binding for mutations.
|
|
82167
83729
|
*/
|
|
@@ -82508,6 +84070,68 @@ export type OntologyUpdateNodeResponses = {
|
|
|
82508
84070
|
200: OntologyNode;
|
|
82509
84071
|
};
|
|
82510
84072
|
export type OntologyUpdateNodeResponse = OntologyUpdateNodeResponses[keyof OntologyUpdateNodeResponses];
|
|
84073
|
+
export type OntologyNeighborhoodData = {
|
|
84074
|
+
body?: never;
|
|
84075
|
+
path: {
|
|
84076
|
+
/**
|
|
84077
|
+
* 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.
|
|
84078
|
+
*/
|
|
84079
|
+
node_id: string;
|
|
84080
|
+
};
|
|
84081
|
+
query?: {
|
|
84082
|
+
/**
|
|
84083
|
+
* How many hops from the given node to walk, 1 to 3; defaults to 1. A value outside that range is refused 400 rather than clamped, so the answer is never a smaller graph than the one asked for.
|
|
84084
|
+
*/
|
|
84085
|
+
depth?: number;
|
|
84086
|
+
/**
|
|
84087
|
+
* Maximum nodes to return, 1 to 500; defaults to 200. When the walk reaches this many nodes it stops and reports truncated true, so treat a truncated answer as a sample of the neighborhood rather than all of it. This bound is not the list routes' page size, and there is no cursor to resume from.
|
|
84088
|
+
*/
|
|
84089
|
+
limit?: number;
|
|
84090
|
+
/**
|
|
84091
|
+
* Which way to follow relations from each node walked; out follows relations the node is the source of, in follows those it is the target of, both follows either. Defaults to both. Relations between two returned nodes are included whichever direction brought the second node in.
|
|
84092
|
+
*/
|
|
84093
|
+
direction?: 'out' | 'in' | 'both';
|
|
84094
|
+
/**
|
|
84095
|
+
* ISO 8601 timestamp; walk the graph as it was then — a node recorded later is absent and a relation invalidated since still counts. Omit to read current state.
|
|
84096
|
+
*/
|
|
84097
|
+
as_of?: string;
|
|
84098
|
+
/**
|
|
84099
|
+
* Set true to walk relations whose invalid_at has passed, which is how a fact that stopped being true stays reachable. Omit or false to walk currently valid relations only.
|
|
84100
|
+
*/
|
|
84101
|
+
include_invalid?: boolean;
|
|
84102
|
+
};
|
|
84103
|
+
url: '/ontology/v1/nodes/{node_id}/neighborhood';
|
|
84104
|
+
};
|
|
84105
|
+
export type OntologyNeighborhoodErrors = {
|
|
84106
|
+
/**
|
|
84107
|
+
* 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.
|
|
84108
|
+
*/
|
|
84109
|
+
400: OntologyOntologyError;
|
|
84110
|
+
/**
|
|
84111
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
84112
|
+
*/
|
|
84113
|
+
401: OntologyOntologyError;
|
|
84114
|
+
/**
|
|
84115
|
+
* The API key lacks permission for this operation, or carries no organization; use a key with the required ontology access in the owning organization.
|
|
84116
|
+
*/
|
|
84117
|
+
403: OntologyOntologyError;
|
|
84118
|
+
/**
|
|
84119
|
+
* 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.
|
|
84120
|
+
*/
|
|
84121
|
+
404: OntologyOntologyError;
|
|
84122
|
+
/**
|
|
84123
|
+
* 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.
|
|
84124
|
+
*/
|
|
84125
|
+
500: OntologyOntologyError;
|
|
84126
|
+
};
|
|
84127
|
+
export type OntologyNeighborhoodError = OntologyNeighborhoodErrors[keyof OntologyNeighborhoodErrors];
|
|
84128
|
+
export type OntologyNeighborhoodResponses = {
|
|
84129
|
+
/**
|
|
84130
|
+
* The neighborhood in BFS order — the start node first, then each hop ordered by node id — with truncated true when the limit cut it short.
|
|
84131
|
+
*/
|
|
84132
|
+
200: OntologyNeighborhood;
|
|
84133
|
+
};
|
|
84134
|
+
export type OntologyNeighborhoodResponse = OntologyNeighborhoodResponses[keyof OntologyNeighborhoodResponses];
|
|
82511
84135
|
export type OntologyMergeNodeData = {
|
|
82512
84136
|
/**
|
|
82513
84137
|
* The node the merged one folds into.
|
|
@@ -86903,6 +88527,370 @@ export type StudioThemesUpdateResponses = {
|
|
|
86903
88527
|
200: StudioTheme;
|
|
86904
88528
|
};
|
|
86905
88529
|
export type StudioThemesUpdateResponse = StudioThemesUpdateResponses[keyof StudioThemesUpdateResponses];
|
|
88530
|
+
export type StudioRenditionsCreateData = {
|
|
88531
|
+
/**
|
|
88532
|
+
* The rendition to create: its platform, and optionally a theme, settings, whether to render at once and a request id.
|
|
88533
|
+
*/
|
|
88534
|
+
body: StudioRenditionCreateInput;
|
|
88535
|
+
path: {
|
|
88536
|
+
/**
|
|
88537
|
+
* The work being addressed, either its organization-unique slug or its wk_ identifier; a slug case is what a person would say, and a renamed slug still resolves through its old value.
|
|
88538
|
+
*/
|
|
88539
|
+
work: string;
|
|
88540
|
+
/**
|
|
88541
|
+
* Draft being addressed, either its in-work key such as novel or its drf_ identifier; a key renamed earlier still resolves through its previous value.
|
|
88542
|
+
*/
|
|
88543
|
+
draft: string;
|
|
88544
|
+
};
|
|
88545
|
+
query?: never;
|
|
88546
|
+
url: '/studio/v1/works/{work}/drafts/{draft}/renditions';
|
|
88547
|
+
};
|
|
88548
|
+
export type StudioRenditionsCreateErrors = {
|
|
88549
|
+
/**
|
|
88550
|
+
* INVALID_PARAMS means a field is missing, malformed or not allowed; correct the named field and repeat the call. PLATFORM_NOT_AVAILABLE means the platform cannot be used yet, for example publishing to an account: choose an export platform such as markdown@1, docx@1 or xiaohongshu@1, or export the rendition instead of publishing it.
|
|
88551
|
+
*/
|
|
88552
|
+
400: StudioStudioError;
|
|
88553
|
+
/**
|
|
88554
|
+
* The API key is missing, invalid or carries no organization; send a valid organization key in the Authorization header.
|
|
88555
|
+
*/
|
|
88556
|
+
401: StudioStudioError;
|
|
88557
|
+
/**
|
|
88558
|
+
* WORK_NOT_FOUND, DRAFT_NOT_FOUND, PLATFORM_NOT_FOUND or THEME_NOT_FOUND means the work, the draft, the platform key or the theme is not reachable; use the slug and draft key from the lists, a versioned platform key from the platform list and a theme from the theme list.
|
|
88559
|
+
*/
|
|
88560
|
+
404: StudioStudioError;
|
|
88561
|
+
/**
|
|
88562
|
+
* INTERNAL means the request could not complete; re-read the resource before retrying a write, because the write may already have landed.
|
|
88563
|
+
*/
|
|
88564
|
+
500: StudioStudioError;
|
|
88565
|
+
};
|
|
88566
|
+
export type StudioRenditionsCreateError = StudioRenditionsCreateErrors[keyof StudioRenditionsCreateErrors];
|
|
88567
|
+
export type StudioRenditionsCreateResponses = {
|
|
88568
|
+
/**
|
|
88569
|
+
* The new rendition. With render true it already carries render_state, issues, parts and files; otherwise render_state is pending.
|
|
88570
|
+
*/
|
|
88571
|
+
201: StudioRendition;
|
|
88572
|
+
};
|
|
88573
|
+
export type StudioRenditionsCreateResponse = StudioRenditionsCreateResponses[keyof StudioRenditionsCreateResponses];
|
|
88574
|
+
export type StudioRenditionsListData = {
|
|
88575
|
+
body?: never;
|
|
88576
|
+
path: {
|
|
88577
|
+
/**
|
|
88578
|
+
* The work being addressed, either its organization-unique slug or its wk_ identifier; a slug case is what a person would say, and a renamed slug still resolves through its old value.
|
|
88579
|
+
*/
|
|
88580
|
+
work: string;
|
|
88581
|
+
};
|
|
88582
|
+
query?: {
|
|
88583
|
+
/**
|
|
88584
|
+
* Draft key such as novel or its drf_ identifier; when given, only the renditions of that draft are returned. Omit it to list the renditions of every draft in the work.
|
|
88585
|
+
*/
|
|
88586
|
+
draft?: string;
|
|
88587
|
+
/**
|
|
88588
|
+
* How many items this page returns, 1 to 100; omitted uses the service default. Treat the answer as one page, not the whole set, and keep following next_page_token while it is present.
|
|
88589
|
+
*/
|
|
88590
|
+
page_size?: number;
|
|
88591
|
+
/**
|
|
88592
|
+
* Cursor from the previous answer's next_page_token; it is opaque, so pass it back unchanged and never build one from an id or an offset.
|
|
88593
|
+
*/
|
|
88594
|
+
page_token?: string;
|
|
88595
|
+
};
|
|
88596
|
+
url: '/studio/v1/works/{work}/renditions';
|
|
88597
|
+
};
|
|
88598
|
+
export type StudioRenditionsListErrors = {
|
|
88599
|
+
/**
|
|
88600
|
+
* INVALID_PARAMS means a field is missing, malformed or not allowed for this resource; correct the named field and repeat the call.
|
|
88601
|
+
*/
|
|
88602
|
+
400: StudioStudioError;
|
|
88603
|
+
/**
|
|
88604
|
+
* The API key is missing, invalid or carries no organization; send a valid organization key in the Authorization header.
|
|
88605
|
+
*/
|
|
88606
|
+
401: StudioStudioError;
|
|
88607
|
+
/**
|
|
88608
|
+
* WORK_NOT_FOUND or DRAFT_NOT_FOUND means the work or the draft inside it is not reachable; use the slug and the draft key from the lists, or resolve a loose name first. A draft renamed earlier still answers under its previous key.
|
|
88609
|
+
*/
|
|
88610
|
+
404: StudioStudioError;
|
|
88611
|
+
/**
|
|
88612
|
+
* INTERNAL means the request could not complete; re-read the resource before retrying a write, because the write may already have landed.
|
|
88613
|
+
*/
|
|
88614
|
+
500: StudioStudioError;
|
|
88615
|
+
};
|
|
88616
|
+
export type StudioRenditionsListError = StudioRenditionsListErrors[keyof StudioRenditionsListErrors];
|
|
88617
|
+
export type StudioRenditionsListResponses = {
|
|
88618
|
+
/**
|
|
88619
|
+
* One page of renditions and the cursor for the next page.
|
|
88620
|
+
*/
|
|
88621
|
+
200: StudioRenditionPage;
|
|
88622
|
+
};
|
|
88623
|
+
export type StudioRenditionsListResponse = StudioRenditionsListResponses[keyof StudioRenditionsListResponses];
|
|
88624
|
+
export type StudioRenditionsDeleteData = {
|
|
88625
|
+
body?: never;
|
|
88626
|
+
path: {
|
|
88627
|
+
/**
|
|
88628
|
+
* The work being addressed, either its organization-unique slug or its wk_ identifier; a slug case is what a person would say, and a renamed slug still resolves through its old value.
|
|
88629
|
+
*/
|
|
88630
|
+
work: string;
|
|
88631
|
+
/**
|
|
88632
|
+
* Rendition being addressed, by its rnd_ identifier from the rendition list or from the create answer.
|
|
88633
|
+
*/
|
|
88634
|
+
rendition: string;
|
|
88635
|
+
};
|
|
88636
|
+
query?: never;
|
|
88637
|
+
url: '/studio/v1/works/{work}/renditions/{rendition}';
|
|
88638
|
+
};
|
|
88639
|
+
export type StudioRenditionsDeleteErrors = {
|
|
88640
|
+
/**
|
|
88641
|
+
* INVALID_PARAMS means a field is missing, malformed or not allowed for this resource; correct the named field and repeat the call.
|
|
88642
|
+
*/
|
|
88643
|
+
400: StudioStudioError;
|
|
88644
|
+
/**
|
|
88645
|
+
* The API key is missing, invalid or carries no organization; send a valid organization key in the Authorization header.
|
|
88646
|
+
*/
|
|
88647
|
+
401: StudioStudioError;
|
|
88648
|
+
/**
|
|
88649
|
+
* RENDITION_NOT_FOUND or WORK_NOT_FOUND means the rendition or its work is not reachable; use the rnd_ identifier from the rendition list and the work slug, since a deleted rendition never returns.
|
|
88650
|
+
*/
|
|
88651
|
+
404: StudioStudioError;
|
|
88652
|
+
/**
|
|
88653
|
+
* INTERNAL means the request could not complete; re-read the resource before retrying a write, because the write may already have landed.
|
|
88654
|
+
*/
|
|
88655
|
+
500: StudioStudioError;
|
|
88656
|
+
};
|
|
88657
|
+
export type StudioRenditionsDeleteError = StudioRenditionsDeleteErrors[keyof StudioRenditionsDeleteErrors];
|
|
88658
|
+
export type StudioRenditionsDeleteResponses = {
|
|
88659
|
+
/**
|
|
88660
|
+
* Confirmation that the rendition was deleted.
|
|
88661
|
+
*/
|
|
88662
|
+
200: StudioDeleted;
|
|
88663
|
+
};
|
|
88664
|
+
export type StudioRenditionsDeleteResponse = StudioRenditionsDeleteResponses[keyof StudioRenditionsDeleteResponses];
|
|
88665
|
+
export type StudioRenditionsGetData = {
|
|
88666
|
+
body?: never;
|
|
88667
|
+
path: {
|
|
88668
|
+
/**
|
|
88669
|
+
* The work being addressed, either its organization-unique slug or its wk_ identifier; a slug case is what a person would say, and a renamed slug still resolves through its old value.
|
|
88670
|
+
*/
|
|
88671
|
+
work: string;
|
|
88672
|
+
/**
|
|
88673
|
+
* Rendition being addressed, by its rnd_ identifier from the rendition list or from the create answer.
|
|
88674
|
+
*/
|
|
88675
|
+
rendition: string;
|
|
88676
|
+
};
|
|
88677
|
+
query?: never;
|
|
88678
|
+
url: '/studio/v1/works/{work}/renditions/{rendition}';
|
|
88679
|
+
};
|
|
88680
|
+
export type StudioRenditionsGetErrors = {
|
|
88681
|
+
/**
|
|
88682
|
+
* INVALID_PARAMS means a field is missing, malformed or not allowed for this resource; correct the named field and repeat the call.
|
|
88683
|
+
*/
|
|
88684
|
+
400: StudioStudioError;
|
|
88685
|
+
/**
|
|
88686
|
+
* The API key is missing, invalid or carries no organization; send a valid organization key in the Authorization header.
|
|
88687
|
+
*/
|
|
88688
|
+
401: StudioStudioError;
|
|
88689
|
+
/**
|
|
88690
|
+
* RENDITION_NOT_FOUND or WORK_NOT_FOUND means the rendition or its work is not reachable; use the rnd_ identifier from the rendition list and the work slug, since a deleted rendition never returns.
|
|
88691
|
+
*/
|
|
88692
|
+
404: StudioStudioError;
|
|
88693
|
+
/**
|
|
88694
|
+
* INTERNAL means the request could not complete; re-read the resource before retrying a write, because the write may already have landed.
|
|
88695
|
+
*/
|
|
88696
|
+
500: StudioStudioError;
|
|
88697
|
+
};
|
|
88698
|
+
export type StudioRenditionsGetError = StudioRenditionsGetErrors[keyof StudioRenditionsGetErrors];
|
|
88699
|
+
export type StudioRenditionsGetResponses = {
|
|
88700
|
+
/**
|
|
88701
|
+
* The rendition with its render state, issues, parts, files and publish state.
|
|
88702
|
+
*/
|
|
88703
|
+
200: StudioRendition;
|
|
88704
|
+
};
|
|
88705
|
+
export type StudioRenditionsGetResponse = StudioRenditionsGetResponses[keyof StudioRenditionsGetResponses];
|
|
88706
|
+
export type StudioRenditionsUpdateData = {
|
|
88707
|
+
/**
|
|
88708
|
+
* The fields to change, with the update mask that names them.
|
|
88709
|
+
*/
|
|
88710
|
+
body: StudioRenditionUpdateInput;
|
|
88711
|
+
path: {
|
|
88712
|
+
/**
|
|
88713
|
+
* The work being addressed, either its organization-unique slug or its wk_ identifier; a slug case is what a person would say, and a renamed slug still resolves through its old value.
|
|
88714
|
+
*/
|
|
88715
|
+
work: string;
|
|
88716
|
+
/**
|
|
88717
|
+
* Rendition being addressed, by its rnd_ identifier from the rendition list or from the create answer.
|
|
88718
|
+
*/
|
|
88719
|
+
rendition: string;
|
|
88720
|
+
};
|
|
88721
|
+
query?: never;
|
|
88722
|
+
url: '/studio/v1/works/{work}/renditions/{rendition}';
|
|
88723
|
+
};
|
|
88724
|
+
export type StudioRenditionsUpdateErrors = {
|
|
88725
|
+
/**
|
|
88726
|
+
* INVALID_PARAMS means a field is missing, malformed or not allowed for this resource; correct the named field and repeat the call.
|
|
88727
|
+
*/
|
|
88728
|
+
400: StudioStudioError;
|
|
88729
|
+
/**
|
|
88730
|
+
* The API key is missing, invalid or carries no organization; send a valid organization key in the Authorization header.
|
|
88731
|
+
*/
|
|
88732
|
+
401: StudioStudioError;
|
|
88733
|
+
/**
|
|
88734
|
+
* RENDITION_NOT_FOUND or WORK_NOT_FOUND means the rendition or its work is not reachable; use the rnd_ identifier from the rendition list and the work slug, since a deleted rendition never returns.
|
|
88735
|
+
*/
|
|
88736
|
+
404: StudioStudioError;
|
|
88737
|
+
/**
|
|
88738
|
+
* RENDITION_PUBLISH_LOCKED means this rendition's export or publish has started and its parts are frozen, so it cannot change; create a new rendition for the new content.
|
|
88739
|
+
*/
|
|
88740
|
+
409: StudioStudioError;
|
|
88741
|
+
/**
|
|
88742
|
+
* INTERNAL means the request could not complete; re-read the resource before retrying a write, because the write may already have landed.
|
|
88743
|
+
*/
|
|
88744
|
+
500: StudioStudioError;
|
|
88745
|
+
};
|
|
88746
|
+
export type StudioRenditionsUpdateError = StudioRenditionsUpdateErrors[keyof StudioRenditionsUpdateErrors];
|
|
88747
|
+
export type StudioRenditionsUpdateResponses = {
|
|
88748
|
+
/**
|
|
88749
|
+
* The updated rendition.
|
|
88750
|
+
*/
|
|
88751
|
+
200: StudioRendition;
|
|
88752
|
+
};
|
|
88753
|
+
export type StudioRenditionsUpdateResponse = StudioRenditionsUpdateResponses[keyof StudioRenditionsUpdateResponses];
|
|
88754
|
+
export type StudioRenditionsRenderData = {
|
|
88755
|
+
body?: never;
|
|
88756
|
+
path: {
|
|
88757
|
+
/**
|
|
88758
|
+
* The work being addressed, either its organization-unique slug or its wk_ identifier; a slug case is what a person would say, and a renamed slug still resolves through its old value.
|
|
88759
|
+
*/
|
|
88760
|
+
work: string;
|
|
88761
|
+
/**
|
|
88762
|
+
* Rendition being addressed, by its rnd_ identifier from the rendition list or from the create answer.
|
|
88763
|
+
*/
|
|
88764
|
+
rendition: string;
|
|
88765
|
+
};
|
|
88766
|
+
query?: never;
|
|
88767
|
+
url: '/studio/v1/works/{work}/renditions/{rendition}:render';
|
|
88768
|
+
};
|
|
88769
|
+
export type StudioRenditionsRenderErrors = {
|
|
88770
|
+
/**
|
|
88771
|
+
* INVALID_PARAMS means a field is missing, malformed or not allowed for this resource; correct the named field and repeat the call.
|
|
88772
|
+
*/
|
|
88773
|
+
400: StudioStudioError;
|
|
88774
|
+
/**
|
|
88775
|
+
* The API key is missing, invalid or carries no organization; send a valid organization key in the Authorization header.
|
|
88776
|
+
*/
|
|
88777
|
+
401: StudioStudioError;
|
|
88778
|
+
/**
|
|
88779
|
+
* RENDITION_NOT_FOUND or WORK_NOT_FOUND means the rendition or its work is not reachable; use the rnd_ identifier from the rendition list and the work slug, since a deleted rendition never returns.
|
|
88780
|
+
*/
|
|
88781
|
+
404: StudioStudioError;
|
|
88782
|
+
/**
|
|
88783
|
+
* REVISION_CONFLICT means this rendition is already being rendered or exported, so nothing was changed; wait a few seconds and repeat the call. RENDITION_PUBLISH_LOCKED means its export has started and its parts are frozen; create a new rendition for new content.
|
|
88784
|
+
*/
|
|
88785
|
+
409: StudioStudioError;
|
|
88786
|
+
/**
|
|
88787
|
+
* INTERNAL means the request could not complete; re-read the resource before retrying a write, because the write may already have landed.
|
|
88788
|
+
*/
|
|
88789
|
+
500: StudioStudioError;
|
|
88790
|
+
};
|
|
88791
|
+
export type StudioRenditionsRenderError = StudioRenditionsRenderErrors[keyof StudioRenditionsRenderErrors];
|
|
88792
|
+
export type StudioRenditionsRenderResponses = {
|
|
88793
|
+
/**
|
|
88794
|
+
* The rendition after rendering, with its render_state, issues, parts and files.
|
|
88795
|
+
*/
|
|
88796
|
+
200: StudioRendition;
|
|
88797
|
+
};
|
|
88798
|
+
export type StudioRenditionsRenderResponse = StudioRenditionsRenderResponses[keyof StudioRenditionsRenderResponses];
|
|
88799
|
+
export type StudioRenditionsPublishData = {
|
|
88800
|
+
body?: never;
|
|
88801
|
+
path: {
|
|
88802
|
+
/**
|
|
88803
|
+
* The work being addressed, either its organization-unique slug or its wk_ identifier; a slug case is what a person would say, and a renamed slug still resolves through its old value.
|
|
88804
|
+
*/
|
|
88805
|
+
work: string;
|
|
88806
|
+
/**
|
|
88807
|
+
* Rendition being addressed, by its rnd_ identifier from the rendition list or from the create answer.
|
|
88808
|
+
*/
|
|
88809
|
+
rendition: string;
|
|
88810
|
+
};
|
|
88811
|
+
query?: never;
|
|
88812
|
+
url: '/studio/v1/works/{work}/renditions/{rendition}:publish';
|
|
88813
|
+
};
|
|
88814
|
+
export type StudioRenditionsPublishErrors = {
|
|
88815
|
+
/**
|
|
88816
|
+
* INVALID_PARAMS means a field is missing, malformed or not allowed; correct the named field and repeat the call. PLATFORM_NOT_AVAILABLE means the platform cannot be used yet, for example publishing to an account: choose an export platform such as markdown@1, docx@1 or xiaohongshu@1, or export the rendition instead of publishing it.
|
|
88817
|
+
*/
|
|
88818
|
+
400: StudioStudioError;
|
|
88819
|
+
/**
|
|
88820
|
+
* The API key is missing, invalid or carries no organization; send a valid organization key in the Authorization header.
|
|
88821
|
+
*/
|
|
88822
|
+
401: StudioStudioError;
|
|
88823
|
+
/**
|
|
88824
|
+
* RENDITION_NOT_FOUND or WORK_NOT_FOUND means the rendition or its work is not reachable; use the rnd_ identifier from the rendition list and the work slug, since a deleted rendition never returns.
|
|
88825
|
+
*/
|
|
88826
|
+
404: StudioStudioError;
|
|
88827
|
+
/**
|
|
88828
|
+
* RENDITION_NOT_RENDERED means the rendition has not finished rendering, so call the render operation first. RENDITION_STALE means the draft changed after the last render, so render again before exporting. RENDITION_INVALID means the render found error-level issues, so fix what the issues list and render again. RENDITION_PUBLISH_LOCKED means the export already started. REVISION_CONFLICT means it is being rendered or exported right now: wait a few seconds and repeat the call.
|
|
88829
|
+
*/
|
|
88830
|
+
409: StudioStudioError;
|
|
88831
|
+
/**
|
|
88832
|
+
* INTERNAL means the request could not complete; re-read the resource before retrying a write, because the write may already have landed.
|
|
88833
|
+
*/
|
|
88834
|
+
500: StudioStudioError;
|
|
88835
|
+
};
|
|
88836
|
+
export type StudioRenditionsPublishError = StudioRenditionsPublishErrors[keyof StudioRenditionsPublishErrors];
|
|
88837
|
+
export type StudioRenditionsPublishResponses = {
|
|
88838
|
+
/**
|
|
88839
|
+
* The rendition after the export, with publish.state exported and the produced files.
|
|
88840
|
+
*/
|
|
88841
|
+
200: StudioRendition;
|
|
88842
|
+
};
|
|
88843
|
+
export type StudioRenditionsPublishResponse = StudioRenditionsPublishResponses[keyof StudioRenditionsPublishResponses];
|
|
88844
|
+
export type StudioRenditionsContentUrlData = {
|
|
88845
|
+
body?: never;
|
|
88846
|
+
path: {
|
|
88847
|
+
/**
|
|
88848
|
+
* The work being addressed, either its organization-unique slug or its wk_ identifier; a slug case is what a person would say, and a renamed slug still resolves through its old value.
|
|
88849
|
+
*/
|
|
88850
|
+
work: string;
|
|
88851
|
+
/**
|
|
88852
|
+
* Rendition being addressed, by its rnd_ identifier from the rendition list or from the create answer.
|
|
88853
|
+
*/
|
|
88854
|
+
rendition: string;
|
|
88855
|
+
};
|
|
88856
|
+
query?: {
|
|
88857
|
+
/**
|
|
88858
|
+
* Index of the part to download, the index value of an entry in the rendition's parts list; omit it to get the rendition's own first file.
|
|
88859
|
+
*/
|
|
88860
|
+
part?: number;
|
|
88861
|
+
};
|
|
88862
|
+
url: '/studio/v1/works/{work}/renditions/{rendition}/content';
|
|
88863
|
+
};
|
|
88864
|
+
export type StudioRenditionsContentUrlErrors = {
|
|
88865
|
+
/**
|
|
88866
|
+
* INVALID_PARAMS means a field is missing, malformed or not allowed for this resource; correct the named field and repeat the call.
|
|
88867
|
+
*/
|
|
88868
|
+
400: StudioStudioError;
|
|
88869
|
+
/**
|
|
88870
|
+
* The API key is missing, invalid or carries no organization; send a valid organization key in the Authorization header.
|
|
88871
|
+
*/
|
|
88872
|
+
401: StudioStudioError;
|
|
88873
|
+
/**
|
|
88874
|
+
* RENDITION_NOT_FOUND or WORK_NOT_FOUND means the rendition or its work is not reachable; use the rnd_ identifier from the rendition list and the work slug, since a deleted rendition never returns.
|
|
88875
|
+
*/
|
|
88876
|
+
404: StudioStudioError;
|
|
88877
|
+
/**
|
|
88878
|
+
* RENDITION_NOT_RENDERED means the rendition or the requested part has no produced file yet; call the render operation, check render_state, and ask again once it is rendered.
|
|
88879
|
+
*/
|
|
88880
|
+
409: StudioStudioError;
|
|
88881
|
+
/**
|
|
88882
|
+
* INTERNAL means the request could not complete; re-read the resource before retrying a write, because the write may already have landed.
|
|
88883
|
+
*/
|
|
88884
|
+
500: StudioStudioError;
|
|
88885
|
+
};
|
|
88886
|
+
export type StudioRenditionsContentUrlError = StudioRenditionsContentUrlErrors[keyof StudioRenditionsContentUrlErrors];
|
|
88887
|
+
export type StudioRenditionsContentUrlResponses = {
|
|
88888
|
+
/**
|
|
88889
|
+
* The signed download URL and the time it stops working.
|
|
88890
|
+
*/
|
|
88891
|
+
200: StudioRenditionContentUrl;
|
|
88892
|
+
};
|
|
88893
|
+
export type StudioRenditionsContentUrlResponse = StudioRenditionsContentUrlResponses[keyof StudioRenditionsContentUrlResponses];
|
|
86906
88894
|
export type VaultListVaultsData = {
|
|
86907
88895
|
body?: never;
|
|
86908
88896
|
path?: never;
|