@deepraxis/sdk 0.1.1-dev.ea219e1 → 0.1.1-dev.ea4a5dd
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 +100 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +204 -7
- package/dist/generated/sdk.gen.js +579 -6
- package/dist/generated/types.gen.d.ts +3200 -81
- package/dist/operations.generated.d.ts +813 -35
- package/dist/operations.generated.js +1104 -151
- package/dist/resources.generated.d.ts +116 -24
- package/dist/resources.generated.js +66 -0
- package/package.json +1 -1
|
@@ -7948,9 +7948,9 @@ export type ApplicationApplicationError = {
|
|
|
7948
7948
|
*/
|
|
7949
7949
|
error: {
|
|
7950
7950
|
/**
|
|
7951
|
-
* Error code: *_NOT_FOUND (404; also for objects of another account), WORKER_NAME_TAKEN (409), WORKER_INVALID_STATE (409), DEPLOYMENT_IN_PROGRESS (409, retry later), INVALID_PARAMS (400), UNSUPPORTED (400, a Cloudflare feature this platform does not offer), LIMIT_EXCEEDED (400), DEPLOY_TIMEOUT (504), PROVIDER_FAILED (502), PROVIDER_CAPACITY (503), NOT_IMPLEMENTED (501).
|
|
7951
|
+
* Error code: *_NOT_FOUND (404; also for objects of another account), WORKER_NAME_TAKEN (409), GRANT_ALIAS_CONFLICT (409), GRANT_CONFLICT (409), WORKER_INVALID_STATE (409), DEPLOYMENT_IN_PROGRESS (409, retry later), INVALID_PARAMS (400), UNSUPPORTED (400, a Cloudflare feature this platform does not offer), LIMIT_EXCEEDED (400), DEPLOY_TIMEOUT (504), PROVIDER_FAILED (502), PROVIDER_CAPACITY (503), NOT_IMPLEMENTED (501).
|
|
7952
7952
|
*/
|
|
7953
|
-
code: 'WORKER_NOT_FOUND' | 'VERSION_NOT_FOUND' | 'DEPLOYMENT_NOT_FOUND' | 'COMPONENT_NOT_FOUND' | 'SECRET_NOT_FOUND' | 'GRANT_NOT_FOUND' | 'RESOURCE_NOT_FOUND' | 'WORKER_NAME_TAKEN' | 'WORKER_INVALID_STATE' | 'DEPLOYMENT_IN_PROGRESS' | 'INVALID_PARAMS' | 'UNSUPPORTED' | 'LIMIT_EXCEEDED' | 'DEPLOY_TIMEOUT' | 'PROVIDER_FAILED' | 'PROVIDER_CAPACITY' | 'NOT_IMPLEMENTED';
|
|
7953
|
+
code: 'WORKER_NOT_FOUND' | 'VERSION_NOT_FOUND' | 'DEPLOYMENT_NOT_FOUND' | 'COMPONENT_NOT_FOUND' | 'SECRET_NOT_FOUND' | 'GRANT_NOT_FOUND' | 'GRANT_ALIAS_CONFLICT' | 'GRANT_CONFLICT' | 'RESOURCE_NOT_FOUND' | 'WORKER_NAME_TAKEN' | 'WORKER_INVALID_STATE' | 'DEPLOYMENT_IN_PROGRESS' | 'INVALID_PARAMS' | 'UNSUPPORTED' | 'LIMIT_EXCEEDED' | 'DEPLOY_TIMEOUT' | 'PROVIDER_FAILED' | 'PROVIDER_CAPACITY' | 'NOT_IMPLEMENTED';
|
|
7954
7954
|
/**
|
|
7955
7955
|
* What went wrong.
|
|
7956
7956
|
*/
|
|
@@ -8614,14 +8614,18 @@ export type ApplicationGrant = {
|
|
|
8614
8614
|
/**
|
|
8615
8615
|
* Resource type.
|
|
8616
8616
|
*/
|
|
8617
|
-
type: 'database' | '
|
|
8617
|
+
type: 'database' | 'files' | 'knowledge' | 'models';
|
|
8618
8618
|
/**
|
|
8619
|
-
*
|
|
8619
|
+
* Database or knowledge base ID; * for files and models.
|
|
8620
8620
|
*/
|
|
8621
8621
|
id: string;
|
|
8622
8622
|
};
|
|
8623
8623
|
/**
|
|
8624
|
-
*
|
|
8624
|
+
* Optional name, unique within this Worker. Conflicts return GRANT_ALIAS_CONFLICT (409).
|
|
8625
|
+
*/
|
|
8626
|
+
alias?: string;
|
|
8627
|
+
/**
|
|
8628
|
+
* Access level; models accepts read only.
|
|
8625
8629
|
*/
|
|
8626
8630
|
access: 'read' | 'read_write';
|
|
8627
8631
|
/**
|
|
@@ -8631,20 +8635,24 @@ export type ApplicationGrant = {
|
|
|
8631
8635
|
};
|
|
8632
8636
|
export type ApplicationCreateGrantInput = {
|
|
8633
8637
|
/**
|
|
8634
|
-
* Resource to grant.
|
|
8638
|
+
* Resource to grant. Each (type, id) may be granted once per Worker; duplicates return GRANT_CONFLICT (409).
|
|
8635
8639
|
*/
|
|
8636
8640
|
resource: {
|
|
8637
8641
|
/**
|
|
8638
8642
|
* Resource type.
|
|
8639
8643
|
*/
|
|
8640
|
-
type: 'database' | '
|
|
8644
|
+
type: 'database' | 'files' | 'knowledge' | 'models';
|
|
8641
8645
|
/**
|
|
8642
|
-
*
|
|
8646
|
+
* Database or knowledge base ID in your organization; * for files and models.
|
|
8643
8647
|
*/
|
|
8644
8648
|
id: string;
|
|
8645
8649
|
};
|
|
8646
8650
|
/**
|
|
8647
|
-
*
|
|
8651
|
+
* Optional name, unique within this Worker. Available for reuse after the grant is deleted.
|
|
8652
|
+
*/
|
|
8653
|
+
alias?: string;
|
|
8654
|
+
/**
|
|
8655
|
+
* Access level; models accepts read only.
|
|
8648
8656
|
*/
|
|
8649
8657
|
access: 'read' | 'read_write';
|
|
8650
8658
|
};
|
|
@@ -10945,6 +10953,848 @@ export type AutomationHumanTaskDelegateInput = {
|
|
|
10945
10953
|
*/
|
|
10946
10954
|
to_user: string;
|
|
10947
10955
|
};
|
|
10956
|
+
export type CanvasCreateCanvasInput = {
|
|
10957
|
+
/**
|
|
10958
|
+
* Display name for the new canvas, at most 200 characters; omission uses Untitled.
|
|
10959
|
+
*/
|
|
10960
|
+
name?: string;
|
|
10961
|
+
};
|
|
10962
|
+
export type CanvasCanvas = {
|
|
10963
|
+
/**
|
|
10964
|
+
* Assigned canvas identifier, cvs_ followed by 16 lowercase letters or digits; reuse it as canvas_id in subsequent requests.
|
|
10965
|
+
*/
|
|
10966
|
+
id: string;
|
|
10967
|
+
/**
|
|
10968
|
+
* Resource discriminator; canvas identifies a design canvas.
|
|
10969
|
+
*/
|
|
10970
|
+
object: 'canvas';
|
|
10971
|
+
/**
|
|
10972
|
+
* Display name supplied at creation; defaults to Untitled if omitted and is not an API identifier.
|
|
10973
|
+
*/
|
|
10974
|
+
name: string;
|
|
10975
|
+
version: CanvasVersion;
|
|
10976
|
+
/**
|
|
10977
|
+
* Number of visible top-level frames in this canvas; hidden frames do not contribute.
|
|
10978
|
+
*/
|
|
10979
|
+
page_count: number;
|
|
10980
|
+
/**
|
|
10981
|
+
* Total number of design nodes currently in the canvas.
|
|
10982
|
+
*/
|
|
10983
|
+
node_count: number;
|
|
10984
|
+
/**
|
|
10985
|
+
* ISO 8601 timestamp recording when this canvas was created.
|
|
10986
|
+
*/
|
|
10987
|
+
created_at: string;
|
|
10988
|
+
/**
|
|
10989
|
+
* ISO 8601 timestamp of the latest canvas update; list orders canvases newest first by this value.
|
|
10990
|
+
*/
|
|
10991
|
+
updated_at: string;
|
|
10992
|
+
/**
|
|
10993
|
+
* Console URL where a person can watch this canvas update live; open it to review drawing results.
|
|
10994
|
+
*/
|
|
10995
|
+
viewer_url: string;
|
|
10996
|
+
};
|
|
10997
|
+
export type CanvasCanvasPage = {
|
|
10998
|
+
/**
|
|
10999
|
+
* Canvases accessible to the API key's organization, ordered by updated_at descending.
|
|
11000
|
+
*/
|
|
11001
|
+
data: Array<CanvasCanvas>;
|
|
11002
|
+
/**
|
|
11003
|
+
* Opaque cursor to pass as cursor on the next list request; null means no more results.
|
|
11004
|
+
*/
|
|
11005
|
+
next_cursor: string | null;
|
|
11006
|
+
};
|
|
11007
|
+
export type CanvasCanvasDetail = CanvasCanvas & {
|
|
11008
|
+
/**
|
|
11009
|
+
* Summaries of top-level nodes in canvas order; use their ids to read full node documents or render images.
|
|
11010
|
+
*/
|
|
11011
|
+
frames: Array<CanvasFrame>;
|
|
11012
|
+
/**
|
|
11013
|
+
* Reusable components in this canvas; use their ids when inspecting or referencing component designs.
|
|
11014
|
+
*/
|
|
11015
|
+
components: Array<{
|
|
11016
|
+
/**
|
|
11017
|
+
* Node identifier of the reusable component; usable in node reads and script references.
|
|
11018
|
+
*/
|
|
11019
|
+
id: string;
|
|
11020
|
+
/**
|
|
11021
|
+
* Display name of the reusable component for choosing which design to reuse.
|
|
11022
|
+
*/
|
|
11023
|
+
name: string;
|
|
11024
|
+
}>;
|
|
11025
|
+
};
|
|
11026
|
+
export type CanvasDeletedCanvas = {
|
|
11027
|
+
/**
|
|
11028
|
+
* Identifier of the canvas that was permanently deleted by this request.
|
|
11029
|
+
*/
|
|
11030
|
+
id: string;
|
|
11031
|
+
/**
|
|
11032
|
+
* Resource discriminator; canvas identifies the deleted design canvas.
|
|
11033
|
+
*/
|
|
11034
|
+
object: 'canvas';
|
|
11035
|
+
/**
|
|
11036
|
+
* Always true on successful permanent deletion; this content cannot be restored.
|
|
11037
|
+
*/
|
|
11038
|
+
deleted: true;
|
|
11039
|
+
};
|
|
11040
|
+
export type CanvasNodesResult = {
|
|
11041
|
+
version: CanvasVersion;
|
|
11042
|
+
/**
|
|
11043
|
+
* Map keyed by each requested node id or instance path; null means that id was not found.
|
|
11044
|
+
*/
|
|
11045
|
+
nodes: {
|
|
11046
|
+
[key: string]: {
|
|
11047
|
+
/**
|
|
11048
|
+
* Pencil .pen 2.21 node content, with descendants limited by depth when specified; use these design properties when preparing edits.
|
|
11049
|
+
*/
|
|
11050
|
+
document: CanvasPenNode;
|
|
11051
|
+
} | null;
|
|
11052
|
+
};
|
|
11053
|
+
};
|
|
11054
|
+
export type CanvasImagesResult = {
|
|
11055
|
+
/**
|
|
11056
|
+
* Always null for a successful render response; request failures use the error envelope with a non-2xx status.
|
|
11057
|
+
*/
|
|
11058
|
+
err: null;
|
|
11059
|
+
/**
|
|
11060
|
+
* Map keyed by requested node id, containing a PNG data URL or null when an image is unavailable; these are inline images rather than hosted URLs.
|
|
11061
|
+
*/
|
|
11062
|
+
images: {
|
|
11063
|
+
[key: string]: string | null;
|
|
11064
|
+
};
|
|
11065
|
+
};
|
|
11066
|
+
export type CanvasCanvasError = {
|
|
11067
|
+
/**
|
|
11068
|
+
* Failure details for a non-2xx response; choose a recovery action using the operation's status and code description.
|
|
11069
|
+
*/
|
|
11070
|
+
error: {
|
|
11071
|
+
/**
|
|
11072
|
+
* Machine-readable failure category; see this operation's error responses for triggering conditions and recovery actions.
|
|
11073
|
+
*/
|
|
11074
|
+
code: string;
|
|
11075
|
+
/**
|
|
11076
|
+
* Human-readable explanation of why the request failed; use code and details for programmatic recovery.
|
|
11077
|
+
*/
|
|
11078
|
+
message: string;
|
|
11079
|
+
/**
|
|
11080
|
+
* Optional error-specific context; script failures provide edit_id with optional line, column and rejection, and REVISION_CONFLICT provides the current version.
|
|
11081
|
+
*/
|
|
11082
|
+
details?: {
|
|
11083
|
+
/**
|
|
11084
|
+
* Saved failed script id, valid for ten minutes; send it with edits to repair and rerun without resending the complete source.
|
|
11085
|
+
*/
|
|
11086
|
+
edit_id?: string;
|
|
11087
|
+
/**
|
|
11088
|
+
* Optional source line reported for the script failure; use it to locate text for an edit.
|
|
11089
|
+
*/
|
|
11090
|
+
line?: number;
|
|
11091
|
+
/**
|
|
11092
|
+
* Optional source column reported for the script failure; use it with line to locate the problem.
|
|
11093
|
+
*/
|
|
11094
|
+
column?: number;
|
|
11095
|
+
/**
|
|
11096
|
+
* Optional operation rejection information; inspect it to correct the rejected design operation.
|
|
11097
|
+
*/
|
|
11098
|
+
rejection?: unknown;
|
|
11099
|
+
/**
|
|
11100
|
+
* Current decimal revision on REVISION_CONFLICT; retrieve and merge the current canvas before retrying a guarded write.
|
|
11101
|
+
*/
|
|
11102
|
+
version?: string;
|
|
11103
|
+
[key: string]: unknown;
|
|
11104
|
+
};
|
|
11105
|
+
};
|
|
11106
|
+
};
|
|
11107
|
+
export type CanvasExecuteInput = unknown & {
|
|
11108
|
+
/**
|
|
11109
|
+
* New synchronous Pencil execute source using document as the root; provide this or edit_id, never both. See the operation's first-frame example.
|
|
11110
|
+
*/
|
|
11111
|
+
script?: string;
|
|
11112
|
+
/**
|
|
11113
|
+
* Saved failed-script identifier from error.details.edit_id; use with edits instead of script within ten minutes of the failure.
|
|
11114
|
+
*/
|
|
11115
|
+
edit_id?: string;
|
|
11116
|
+
/**
|
|
11117
|
+
* Text replacements applied to the source identified by edit_id before rerunning; use error line, column or rejection to choose the correction.
|
|
11118
|
+
*/
|
|
11119
|
+
edits?: Array<{
|
|
11120
|
+
/**
|
|
11121
|
+
* Literal text to locate in the failed source saved under edit_id.
|
|
11122
|
+
*/
|
|
11123
|
+
find: string;
|
|
11124
|
+
/**
|
|
11125
|
+
* Corrected text to substitute for the matched find text before execution.
|
|
11126
|
+
*/
|
|
11127
|
+
replace: string;
|
|
11128
|
+
/**
|
|
11129
|
+
* Set true to replace every occurrence of find; omitted or false requires find to occur exactly once, and a missing or repeated match fails the retry without applying anything.
|
|
11130
|
+
*/
|
|
11131
|
+
all?: boolean;
|
|
11132
|
+
}>;
|
|
11133
|
+
/**
|
|
11134
|
+
* Revision from retrieve, nodes.list or the previous execute response; omit for an unguarded write. A mismatch returns 409 REVISION_CONFLICT with details.version.
|
|
11135
|
+
*/
|
|
11136
|
+
expected_version?: string;
|
|
11137
|
+
};
|
|
11138
|
+
export type CanvasExecuteResult = {
|
|
11139
|
+
version: CanvasVersion;
|
|
11140
|
+
/**
|
|
11141
|
+
* Number of design operations performed by the committed script.
|
|
11142
|
+
*/
|
|
11143
|
+
operation_count: number;
|
|
11144
|
+
/**
|
|
11145
|
+
* Map from created result names to node identifiers; reuse the ids in nodes.list, images.list or subsequent scripts.
|
|
11146
|
+
*/
|
|
11147
|
+
created: {
|
|
11148
|
+
[key: string]: string;
|
|
11149
|
+
};
|
|
11150
|
+
/**
|
|
11151
|
+
* String outputs produced by Print calls in script execution order.
|
|
11152
|
+
*/
|
|
11153
|
+
prints: Array<string>;
|
|
11154
|
+
/**
|
|
11155
|
+
* Non-fatal design warnings from this execution; writes have committed, so inspect the affected nodes before making another edit.
|
|
11156
|
+
*/
|
|
11157
|
+
warnings: Array<{
|
|
11158
|
+
/**
|
|
11159
|
+
* Machine-readable warning category identifying what to inspect in the design.
|
|
11160
|
+
*/
|
|
11161
|
+
code: string;
|
|
11162
|
+
/**
|
|
11163
|
+
* Identifier of the node to inspect with nodes.list or images.list.
|
|
11164
|
+
*/
|
|
11165
|
+
node_id: string;
|
|
11166
|
+
/**
|
|
11167
|
+
* Human-readable explanation of the design issue and its context.
|
|
11168
|
+
*/
|
|
11169
|
+
message: string;
|
|
11170
|
+
}>;
|
|
11171
|
+
/**
|
|
11172
|
+
* Node ids requested through TakeScreenshot; call images.list with up to four ids to obtain the actual PNG images.
|
|
11173
|
+
*/
|
|
11174
|
+
screenshots: Array<string>;
|
|
11175
|
+
/**
|
|
11176
|
+
* Identifiers of top-level frames affected by the script; render these frames to review the edit.
|
|
11177
|
+
*/
|
|
11178
|
+
touched_frames: Array<string>;
|
|
11179
|
+
/**
|
|
11180
|
+
* Global variable names still available for reuse in the next execute call on this canvas.
|
|
11181
|
+
*/
|
|
11182
|
+
globals: Array<string>;
|
|
11183
|
+
/**
|
|
11184
|
+
* Console URL where a person can watch the canvas and inspect the committed visual result live.
|
|
11185
|
+
*/
|
|
11186
|
+
viewer_url: string;
|
|
11187
|
+
};
|
|
11188
|
+
/**
|
|
11189
|
+
* Organization-owned editing project; reuse its id for project operations.
|
|
11190
|
+
*/
|
|
11191
|
+
export type CutProject = {
|
|
11192
|
+
/**
|
|
11193
|
+
* Project id assigned by create; pass as project_id on subsequent requests.
|
|
11194
|
+
*/
|
|
11195
|
+
id: string;
|
|
11196
|
+
/**
|
|
11197
|
+
* Human-readable editing project name; not an API identifier.
|
|
11198
|
+
*/
|
|
11199
|
+
name: string;
|
|
11200
|
+
/**
|
|
11201
|
+
* Organization that owns the project and its editing history.
|
|
11202
|
+
*/
|
|
11203
|
+
owner: string;
|
|
11204
|
+
/**
|
|
11205
|
+
* User-defined string labels for organizing projects; label keys retain their original spelling.
|
|
11206
|
+
*/
|
|
11207
|
+
labels: {
|
|
11208
|
+
[key: string]: string;
|
|
11209
|
+
};
|
|
11210
|
+
/**
|
|
11211
|
+
* active projects can be edited; deleted projects are retained until purge_time and may be undeleted.
|
|
11212
|
+
*/
|
|
11213
|
+
state: 'active' | 'deleted';
|
|
11214
|
+
revision: CutRevision;
|
|
11215
|
+
/**
|
|
11216
|
+
* Rendering dimensions, frame rate and audio sample rate for this project.
|
|
11217
|
+
*/
|
|
11218
|
+
settings: CutSettings;
|
|
11219
|
+
/**
|
|
11220
|
+
* Named library bindings available to scripts, imports and exports.
|
|
11221
|
+
*/
|
|
11222
|
+
bindings: Array<CutBinding>;
|
|
11223
|
+
/**
|
|
11224
|
+
* ISO 8601 timestamp when this project was created.
|
|
11225
|
+
*/
|
|
11226
|
+
create_time: string;
|
|
11227
|
+
/**
|
|
11228
|
+
* ISO 8601 timestamp of the latest committed project update.
|
|
11229
|
+
*/
|
|
11230
|
+
update_time: string;
|
|
11231
|
+
/**
|
|
11232
|
+
* ISO 8601 deadline for permanent removal of a deleted project; absent for active projects.
|
|
11233
|
+
*/
|
|
11234
|
+
purge_time?: string;
|
|
11235
|
+
};
|
|
11236
|
+
/**
|
|
11237
|
+
* Create a blank project bound to the media libraries it may use.
|
|
11238
|
+
*/
|
|
11239
|
+
export type CutCreateProjectInput = {
|
|
11240
|
+
/**
|
|
11241
|
+
* Human-readable project name; required and must contain non-whitespace text.
|
|
11242
|
+
*/
|
|
11243
|
+
name: string;
|
|
11244
|
+
/**
|
|
11245
|
+
* User-defined string labels for organizing projects; label keys retain their original spelling.
|
|
11246
|
+
*/
|
|
11247
|
+
labels?: {
|
|
11248
|
+
[key: string]: string;
|
|
11249
|
+
};
|
|
11250
|
+
settings: CutSettingsInput;
|
|
11251
|
+
/**
|
|
11252
|
+
* Accessible library bindings; exactly one read_write entry must have default_upload true.
|
|
11253
|
+
*/
|
|
11254
|
+
bindings: Array<CutBinding>;
|
|
11255
|
+
};
|
|
11256
|
+
/**
|
|
11257
|
+
* One page of organization-accessible projects.
|
|
11258
|
+
*/
|
|
11259
|
+
export type CutProjectPage = {
|
|
11260
|
+
/**
|
|
11261
|
+
* Resources in this page; continue with next_page_token when present.
|
|
11262
|
+
*/
|
|
11263
|
+
projects: Array<CutProject>;
|
|
11264
|
+
/**
|
|
11265
|
+
* Opaque continuation token for page_token on the next request; absent when no more results remain.
|
|
11266
|
+
*/
|
|
11267
|
+
next_page_token?: string;
|
|
11268
|
+
};
|
|
11269
|
+
export type CutProjectDetail = CutProject & {
|
|
11270
|
+
/**
|
|
11271
|
+
* Complete second-based timeline, present when expand includes timeline.
|
|
11272
|
+
*/
|
|
11273
|
+
timeline?: CutTimeline;
|
|
11274
|
+
/**
|
|
11275
|
+
* Project exports, present when expand includes exports.
|
|
11276
|
+
*/
|
|
11277
|
+
exports?: Array<CutExport>;
|
|
11278
|
+
/**
|
|
11279
|
+
* Saved project versions, present when expand includes versions.
|
|
11280
|
+
*/
|
|
11281
|
+
versions?: Array<CutVersion>;
|
|
11282
|
+
};
|
|
11283
|
+
/**
|
|
11284
|
+
* Update only the named project metadata fields; timeline edits use execute.
|
|
11285
|
+
*/
|
|
11286
|
+
export type CutUpdateProjectInput = {
|
|
11287
|
+
/**
|
|
11288
|
+
* Replacement display name when update_mask includes name.
|
|
11289
|
+
*/
|
|
11290
|
+
name?: string;
|
|
11291
|
+
/**
|
|
11292
|
+
* User-defined string labels for organizing projects; label keys retain their original spelling.
|
|
11293
|
+
*/
|
|
11294
|
+
labels?: {
|
|
11295
|
+
[key: string]: string;
|
|
11296
|
+
};
|
|
11297
|
+
/**
|
|
11298
|
+
* Metadata fields to replace; name changes the display name and labels replaces all labels.
|
|
11299
|
+
*/
|
|
11300
|
+
update_mask: Array<'name' | 'labels'>;
|
|
11301
|
+
};
|
|
11302
|
+
/**
|
|
11303
|
+
* Committed revision and outputs from a successful synchronous editing script.
|
|
11304
|
+
*/
|
|
11305
|
+
export type CutExecuteResult = {
|
|
11306
|
+
revision: CutRevision;
|
|
11307
|
+
/**
|
|
11308
|
+
* Committed edit counts and second-based duration changes.
|
|
11309
|
+
*/
|
|
11310
|
+
summary: CutSummary;
|
|
11311
|
+
/**
|
|
11312
|
+
* Script result names mapped to newly created clip or track ids; keys retain their original spelling.
|
|
11313
|
+
*/
|
|
11314
|
+
created: {
|
|
11315
|
+
[key: string]: string;
|
|
11316
|
+
};
|
|
11317
|
+
/**
|
|
11318
|
+
* String output from Print calls in execution order.
|
|
11319
|
+
*/
|
|
11320
|
+
prints: Array<string>;
|
|
11321
|
+
/**
|
|
11322
|
+
* Non-fatal issues to inspect after the edit committed.
|
|
11323
|
+
*/
|
|
11324
|
+
warnings: Array<{
|
|
11325
|
+
/**
|
|
11326
|
+
* Machine-readable warning category used to select a follow-up check.
|
|
11327
|
+
*/
|
|
11328
|
+
code: string;
|
|
11329
|
+
/**
|
|
11330
|
+
* Affected clip identifier; use GetItem or inspect the timeline.
|
|
11331
|
+
*/
|
|
11332
|
+
clip_id?: string;
|
|
11333
|
+
/**
|
|
11334
|
+
* Human-readable explanation of the warning.
|
|
11335
|
+
*/
|
|
11336
|
+
message: string;
|
|
11337
|
+
}>;
|
|
11338
|
+
/**
|
|
11339
|
+
* Optional rendered previews keyed by requested time in seconds.
|
|
11340
|
+
*/
|
|
11341
|
+
frames?: {
|
|
11342
|
+
[key: string]: CutRenderRef;
|
|
11343
|
+
};
|
|
11344
|
+
};
|
|
11345
|
+
export type CutExecuteInput = unknown & {
|
|
11346
|
+
/**
|
|
11347
|
+
* Synchronous editing source using Cut execute functions; submit this or edit_id, never both. Script source is opaque: function names and object fields inside JavaScript use their documented camelCase spelling.
|
|
11348
|
+
*/
|
|
11349
|
+
script?: string;
|
|
11350
|
+
/**
|
|
11351
|
+
* Saved failed script identifier from error.details.edit_id; valid for ten minutes.
|
|
11352
|
+
*/
|
|
11353
|
+
edit_id?: string;
|
|
11354
|
+
/**
|
|
11355
|
+
* Literal replacements applied to the saved source before rerunning.
|
|
11356
|
+
*/
|
|
11357
|
+
edits?: Array<{
|
|
11358
|
+
/**
|
|
11359
|
+
* Literal source text to locate in the saved script.
|
|
11360
|
+
*/
|
|
11361
|
+
find: string;
|
|
11362
|
+
/**
|
|
11363
|
+
* Replacement source text; passed to the script without renaming fields.
|
|
11364
|
+
*/
|
|
11365
|
+
replace: string;
|
|
11366
|
+
/**
|
|
11367
|
+
* True replaces every occurrence; false or omission requires exactly one match.
|
|
11368
|
+
*/
|
|
11369
|
+
all?: boolean;
|
|
11370
|
+
}>;
|
|
11371
|
+
expected_revision?: CutRevision;
|
|
11372
|
+
};
|
|
11373
|
+
/**
|
|
11374
|
+
* Lightweight editing context before preparing a script.
|
|
11375
|
+
*/
|
|
11376
|
+
export type CutState = {
|
|
11377
|
+
revision: CutRevision;
|
|
11378
|
+
/**
|
|
11379
|
+
* Current rendering settings for the project.
|
|
11380
|
+
*/
|
|
11381
|
+
settings: CutSettings;
|
|
11382
|
+
/**
|
|
11383
|
+
* Current project duration. In seconds, not frames or microseconds.
|
|
11384
|
+
*/
|
|
11385
|
+
duration_sec: number;
|
|
11386
|
+
/**
|
|
11387
|
+
* Track summaries and clip counts.
|
|
11388
|
+
*/
|
|
11389
|
+
tracks: Array<CutTrackSummary>;
|
|
11390
|
+
/**
|
|
11391
|
+
* Libraries currently available to the project.
|
|
11392
|
+
*/
|
|
11393
|
+
bindings: Array<CutBinding>;
|
|
11394
|
+
/**
|
|
11395
|
+
* Number of clips with unavailable media requiring attention.
|
|
11396
|
+
*/
|
|
11397
|
+
offline_count: number;
|
|
11398
|
+
};
|
|
11399
|
+
export type CutTimelineResult = {
|
|
11400
|
+
revision: CutRevision;
|
|
11401
|
+
/**
|
|
11402
|
+
* full returns the structured timeline.
|
|
11403
|
+
*/
|
|
11404
|
+
view: 'full';
|
|
11405
|
+
timeline: CutTimeline;
|
|
11406
|
+
} | {
|
|
11407
|
+
revision: CutRevision;
|
|
11408
|
+
/**
|
|
11409
|
+
* compact returns human-readable editing context.
|
|
11410
|
+
*/
|
|
11411
|
+
view: 'compact';
|
|
11412
|
+
/**
|
|
11413
|
+
* Compact timeline description with second-based positions, suitable as context for an editing script.
|
|
11414
|
+
*/
|
|
11415
|
+
text: string;
|
|
11416
|
+
};
|
|
11417
|
+
/**
|
|
11418
|
+
* Rendered images from one project revision.
|
|
11419
|
+
*/
|
|
11420
|
+
export type CutFramesResult = {
|
|
11421
|
+
revision: CutRevision;
|
|
11422
|
+
/**
|
|
11423
|
+
* Requested times in seconds mapped to rendered images; keys retain their numeric spelling.
|
|
11424
|
+
*/
|
|
11425
|
+
images: {
|
|
11426
|
+
[key: string]: CutRenderRef;
|
|
11427
|
+
};
|
|
11428
|
+
};
|
|
11429
|
+
/**
|
|
11430
|
+
* Analysis status and available ranges for each source asset and kind.
|
|
11431
|
+
*/
|
|
11432
|
+
export type CutAnalysisResult = {
|
|
11433
|
+
/**
|
|
11434
|
+
* Per-asset analysis outcomes.
|
|
11435
|
+
*/
|
|
11436
|
+
results: Array<{
|
|
11437
|
+
media: CutMediaRef;
|
|
11438
|
+
/**
|
|
11439
|
+
* Source asset version analyzed; changes when that asset is overwritten.
|
|
11440
|
+
*/
|
|
11441
|
+
version: number;
|
|
11442
|
+
/**
|
|
11443
|
+
* silence identifies quiet spans; filler identifies filler-word spans; scenes identifies scene ranges.
|
|
11444
|
+
*/
|
|
11445
|
+
kind: 'silence' | 'filler' | 'scenes';
|
|
11446
|
+
/**
|
|
11447
|
+
* pending means analysis is still running; ready means segments are available; unsupported means this asset or analysis kind is inapplicable; failed means analysis did not complete.
|
|
11448
|
+
*/
|
|
11449
|
+
status: 'pending' | 'ready' | 'unsupported' | 'failed';
|
|
11450
|
+
/**
|
|
11451
|
+
* Detected source ranges in seconds, available when status is ready.
|
|
11452
|
+
*/
|
|
11453
|
+
segments?: Array<{
|
|
11454
|
+
/**
|
|
11455
|
+
* Inclusive source range start. In seconds, not frames or microseconds.
|
|
11456
|
+
*/
|
|
11457
|
+
from: number;
|
|
11458
|
+
/**
|
|
11459
|
+
* Source range end. In seconds, not frames or microseconds.
|
|
11460
|
+
*/
|
|
11461
|
+
to: number;
|
|
11462
|
+
/**
|
|
11463
|
+
* Optional human-readable classification for this range.
|
|
11464
|
+
*/
|
|
11465
|
+
label?: string;
|
|
11466
|
+
/**
|
|
11467
|
+
* Optional confidence score for this detection.
|
|
11468
|
+
*/
|
|
11469
|
+
confidence?: number;
|
|
11470
|
+
}>;
|
|
11471
|
+
/**
|
|
11472
|
+
* Suggested delay before checking a pending analysis again. In seconds, not frames or microseconds.
|
|
11473
|
+
*/
|
|
11474
|
+
retry_after_sec?: number;
|
|
11475
|
+
}>;
|
|
11476
|
+
};
|
|
11477
|
+
/**
|
|
11478
|
+
* Select analysis kinds and optionally limit source assets.
|
|
11479
|
+
*/
|
|
11480
|
+
export type CutAnalysisInput = {
|
|
11481
|
+
/**
|
|
11482
|
+
* Bound-library assets to analyze; omission selects project media.
|
|
11483
|
+
*/
|
|
11484
|
+
media?: Array<CutMediaRef>;
|
|
11485
|
+
/**
|
|
11486
|
+
* Analysis types to request for the selected source assets.
|
|
11487
|
+
*/
|
|
11488
|
+
kinds: Array<'silence' | 'filler' | 'scenes'>;
|
|
11489
|
+
};
|
|
11490
|
+
/**
|
|
11491
|
+
* Current project media library bindings.
|
|
11492
|
+
*/
|
|
11493
|
+
export type CutBindingsResult = {
|
|
11494
|
+
/**
|
|
11495
|
+
* Named libraries available to scripts and media operations.
|
|
11496
|
+
*/
|
|
11497
|
+
bindings: Array<CutBinding>;
|
|
11498
|
+
};
|
|
11499
|
+
/**
|
|
11500
|
+
* A named project link to a media library. Exactly one read_write binding must be default_upload.
|
|
11501
|
+
*/
|
|
11502
|
+
export type CutBinding = {
|
|
11503
|
+
/**
|
|
11504
|
+
* Unique binding alias used in imports and exports; begins with a lowercase letter.
|
|
11505
|
+
*/
|
|
11506
|
+
name: string;
|
|
11507
|
+
/**
|
|
11508
|
+
* Media library id from praxis.media.libraries.create or list; must be accessible to this organization.
|
|
11509
|
+
*/
|
|
11510
|
+
library_id: string;
|
|
11511
|
+
/**
|
|
11512
|
+
* read permits using library assets; read_write also permits imports and exports into the library.
|
|
11513
|
+
*/
|
|
11514
|
+
access: 'read' | 'read_write';
|
|
11515
|
+
/**
|
|
11516
|
+
* True selects the one read_write library used when an import or export omits binding.
|
|
11517
|
+
*/
|
|
11518
|
+
default_upload: boolean;
|
|
11519
|
+
};
|
|
11520
|
+
/**
|
|
11521
|
+
* Attach a media library using a project-local name.
|
|
11522
|
+
*/
|
|
11523
|
+
export type CutBindingInput = {
|
|
11524
|
+
binding: CutBinding;
|
|
11525
|
+
};
|
|
11526
|
+
/**
|
|
11527
|
+
* Confirmation that the unused binding was detached.
|
|
11528
|
+
*/
|
|
11529
|
+
export type CutDeletedBinding = {
|
|
11530
|
+
/**
|
|
11531
|
+
* Always true after the requested binding has been removed.
|
|
11532
|
+
*/
|
|
11533
|
+
deleted: boolean;
|
|
11534
|
+
};
|
|
11535
|
+
export type CutImportedMedia = CutMediaRef & {
|
|
11536
|
+
/**
|
|
11537
|
+
* Source media facts returned after import.
|
|
11538
|
+
*/
|
|
11539
|
+
info: {
|
|
11540
|
+
/**
|
|
11541
|
+
* Destination library containing the imported asset.
|
|
11542
|
+
*/
|
|
11543
|
+
library_id: string;
|
|
11544
|
+
/**
|
|
11545
|
+
* New asset identifier to use in execute script MediaRef objects.
|
|
11546
|
+
*/
|
|
11547
|
+
asset_id: string;
|
|
11548
|
+
/**
|
|
11549
|
+
* Current source asset version after import.
|
|
11550
|
+
*/
|
|
11551
|
+
version: number;
|
|
11552
|
+
/**
|
|
11553
|
+
* video is moving footage; audio is sound-only; image is a still visual.
|
|
11554
|
+
*/
|
|
11555
|
+
kind: 'video' | 'audio' | 'image';
|
|
11556
|
+
/**
|
|
11557
|
+
* Source media duration, when time-based. In seconds, not frames or microseconds.
|
|
11558
|
+
*/
|
|
11559
|
+
duration_sec?: number;
|
|
11560
|
+
/**
|
|
11561
|
+
* Source visual width in pixels, if available.
|
|
11562
|
+
*/
|
|
11563
|
+
width?: number;
|
|
11564
|
+
/**
|
|
11565
|
+
* Source visual height in pixels, if available.
|
|
11566
|
+
*/
|
|
11567
|
+
height?: number;
|
|
11568
|
+
/**
|
|
11569
|
+
* Source frames per second, if the source is video.
|
|
11570
|
+
*/
|
|
11571
|
+
fps?: number;
|
|
11572
|
+
/**
|
|
11573
|
+
* True when the source includes an audio stream.
|
|
11574
|
+
*/
|
|
11575
|
+
has_audio: boolean;
|
|
11576
|
+
};
|
|
11577
|
+
};
|
|
11578
|
+
/**
|
|
11579
|
+
* Import one external asset into a writable project library.
|
|
11580
|
+
*/
|
|
11581
|
+
export type CutMediaImportInput = {
|
|
11582
|
+
/**
|
|
11583
|
+
* Writable binding name from project bindings; omission uses default_upload.
|
|
11584
|
+
*/
|
|
11585
|
+
binding?: string;
|
|
11586
|
+
source: unknown & {
|
|
11587
|
+
/**
|
|
11588
|
+
* Publicly readable source URL to import.
|
|
11589
|
+
*/
|
|
11590
|
+
url?: string;
|
|
11591
|
+
/**
|
|
11592
|
+
* Inline data URI containing the source bytes.
|
|
11593
|
+
*/
|
|
11594
|
+
data_uri?: string;
|
|
11595
|
+
/**
|
|
11596
|
+
* Existing platform file id whose bytes should be imported.
|
|
11597
|
+
*/
|
|
11598
|
+
file_id?: string;
|
|
11599
|
+
};
|
|
11600
|
+
/**
|
|
11601
|
+
* Optional human-readable display name for the new media asset.
|
|
11602
|
+
*/
|
|
11603
|
+
display_name?: string;
|
|
11604
|
+
};
|
|
11605
|
+
/**
|
|
11606
|
+
* Asynchronous rendering job; retrieve by id until it reaches a terminal state.
|
|
11607
|
+
*/
|
|
11608
|
+
export type CutExport = {
|
|
11609
|
+
/**
|
|
11610
|
+
* Export id returned by create; use as export_id for retrieve or cancel.
|
|
11611
|
+
*/
|
|
11612
|
+
id: string;
|
|
11613
|
+
/**
|
|
11614
|
+
* Project id whose timeline is being exported.
|
|
11615
|
+
*/
|
|
11616
|
+
project_id: string;
|
|
11617
|
+
/**
|
|
11618
|
+
* Organization that owns this export job.
|
|
11619
|
+
*/
|
|
11620
|
+
owner: string;
|
|
11621
|
+
revision: CutRevision;
|
|
11622
|
+
/**
|
|
11623
|
+
* queued awaits capacity; fetching loads sources; rendering renders chunks; stitching joins chunks; saving writes the asset; done means output is ready; failed means inspect error; canceled means no further output is expected.
|
|
11624
|
+
*/
|
|
11625
|
+
status: 'queued' | 'fetching' | 'rendering' | 'stitching' | 'saving' | 'done' | 'failed' | 'canceled';
|
|
11626
|
+
/**
|
|
11627
|
+
* Effective video rendering options for this job.
|
|
11628
|
+
*/
|
|
11629
|
+
output: CutExportOutput;
|
|
11630
|
+
/**
|
|
11631
|
+
* Bound library receiving the completed export.
|
|
11632
|
+
*/
|
|
11633
|
+
target: {
|
|
11634
|
+
/**
|
|
11635
|
+
* Project binding alias chosen for the output.
|
|
11636
|
+
*/
|
|
11637
|
+
binding: string;
|
|
11638
|
+
/**
|
|
11639
|
+
* Destination media library identifier.
|
|
11640
|
+
*/
|
|
11641
|
+
library_id: string;
|
|
11642
|
+
};
|
|
11643
|
+
/**
|
|
11644
|
+
* Rendering progress; partial progress is not successful completion.
|
|
11645
|
+
*/
|
|
11646
|
+
progress: {
|
|
11647
|
+
/**
|
|
11648
|
+
* Number of render work units completed.
|
|
11649
|
+
*/
|
|
11650
|
+
done: number;
|
|
11651
|
+
/**
|
|
11652
|
+
* Total render work units planned.
|
|
11653
|
+
*/
|
|
11654
|
+
total: number;
|
|
11655
|
+
/**
|
|
11656
|
+
* pending means audio processing has not finished; done means audio is ready.
|
|
11657
|
+
*/
|
|
11658
|
+
audio: 'pending' | 'done';
|
|
11659
|
+
};
|
|
11660
|
+
/**
|
|
11661
|
+
* Output media reference, available after the export reaches done.
|
|
11662
|
+
*/
|
|
11663
|
+
asset?: CutMediaRef;
|
|
11664
|
+
/**
|
|
11665
|
+
* Failure information, present when the export failed.
|
|
11666
|
+
*/
|
|
11667
|
+
error?: {
|
|
11668
|
+
/**
|
|
11669
|
+
* Machine-readable failure code used to choose a recovery action.
|
|
11670
|
+
*/
|
|
11671
|
+
code: string;
|
|
11672
|
+
/**
|
|
11673
|
+
* Human-readable explanation of the export failure.
|
|
11674
|
+
*/
|
|
11675
|
+
message: string;
|
|
11676
|
+
/**
|
|
11677
|
+
* Optional index of the failed render chunk.
|
|
11678
|
+
*/
|
|
11679
|
+
chunk?: number;
|
|
11680
|
+
/**
|
|
11681
|
+
* Optional lower-level explanation of the render failure.
|
|
11682
|
+
*/
|
|
11683
|
+
cause?: string;
|
|
11684
|
+
};
|
|
11685
|
+
/**
|
|
11686
|
+
* ISO 8601 timestamp when this export was accepted.
|
|
11687
|
+
*/
|
|
11688
|
+
create_time: string;
|
|
11689
|
+
/**
|
|
11690
|
+
* ISO 8601 timestamp when this export reached a terminal state.
|
|
11691
|
+
*/
|
|
11692
|
+
finish_time?: string;
|
|
11693
|
+
/**
|
|
11694
|
+
* Elapsed wall-clock rendering time in milliseconds, when available.
|
|
11695
|
+
*/
|
|
11696
|
+
wall_ms?: number;
|
|
11697
|
+
};
|
|
11698
|
+
/**
|
|
11699
|
+
* Start an export from a project revision into a bound library.
|
|
11700
|
+
*/
|
|
11701
|
+
export type CutExportInput = {
|
|
11702
|
+
/**
|
|
11703
|
+
* Optional render settings; omitted fields use the project export defaults.
|
|
11704
|
+
*/
|
|
11705
|
+
output?: CutExportOutput;
|
|
11706
|
+
/**
|
|
11707
|
+
* Writable binding name used as the export destination; omission uses default_upload.
|
|
11708
|
+
*/
|
|
11709
|
+
binding?: string;
|
|
11710
|
+
revision?: CutRevision;
|
|
11711
|
+
};
|
|
11712
|
+
/**
|
|
11713
|
+
* One page of organization-accessible exports.
|
|
11714
|
+
*/
|
|
11715
|
+
export type CutExportPage = {
|
|
11716
|
+
/**
|
|
11717
|
+
* Resources in this page; continue with next_page_token when present.
|
|
11718
|
+
*/
|
|
11719
|
+
exports: Array<CutExport>;
|
|
11720
|
+
/**
|
|
11721
|
+
* Opaque continuation token for page_token on the next request; absent when no more results remain.
|
|
11722
|
+
*/
|
|
11723
|
+
next_page_token?: string;
|
|
11724
|
+
};
|
|
11725
|
+
/**
|
|
11726
|
+
* One page of organization-accessible versions.
|
|
11727
|
+
*/
|
|
11728
|
+
export type CutVersionPage = {
|
|
11729
|
+
/**
|
|
11730
|
+
* Resources in this page; continue with next_page_token when present.
|
|
11731
|
+
*/
|
|
11732
|
+
versions: Array<CutVersion>;
|
|
11733
|
+
/**
|
|
11734
|
+
* Opaque continuation token for page_token on the next request; absent when no more results remain.
|
|
11735
|
+
*/
|
|
11736
|
+
next_page_token?: string;
|
|
11737
|
+
};
|
|
11738
|
+
/**
|
|
11739
|
+
* Saved project snapshot; restore its id to create a new current revision.
|
|
11740
|
+
*/
|
|
11741
|
+
export type CutVersion = {
|
|
11742
|
+
/**
|
|
11743
|
+
* Version id returned by versions.create or list; pass as version_id to restore.
|
|
11744
|
+
*/
|
|
11745
|
+
id: string;
|
|
11746
|
+
/**
|
|
11747
|
+
* Identifier of the project this version belongs to.
|
|
11748
|
+
*/
|
|
11749
|
+
project_id: string;
|
|
11750
|
+
revision: CutRevision;
|
|
11751
|
+
/**
|
|
11752
|
+
* Optional human-readable label supplied when saving this version.
|
|
11753
|
+
*/
|
|
11754
|
+
label?: string;
|
|
11755
|
+
/**
|
|
11756
|
+
* ISO 8601 timestamp when this version was saved.
|
|
11757
|
+
*/
|
|
11758
|
+
create_time: string;
|
|
11759
|
+
/**
|
|
11760
|
+
* Creator identity recorded as human:<user-id> or agent:<user-id>.
|
|
11761
|
+
*/
|
|
11762
|
+
actor: string;
|
|
11763
|
+
};
|
|
11764
|
+
/**
|
|
11765
|
+
* Save the current project revision with an optional label.
|
|
11766
|
+
*/
|
|
11767
|
+
export type CutVersionInput = {
|
|
11768
|
+
/**
|
|
11769
|
+
* Human-readable snapshot label, such as Before captions.
|
|
11770
|
+
*/
|
|
11771
|
+
label?: string;
|
|
11772
|
+
};
|
|
11773
|
+
/**
|
|
11774
|
+
* Committed transaction produced by restoring a saved version.
|
|
11775
|
+
*/
|
|
11776
|
+
export type CutTransaction = {
|
|
11777
|
+
revision: CutRevision;
|
|
11778
|
+
/**
|
|
11779
|
+
* Identity that restored the version, as human:<id> or agent:<id>.
|
|
11780
|
+
*/
|
|
11781
|
+
actor: string;
|
|
11782
|
+
/**
|
|
11783
|
+
* Applied operation records; time values are seconds and other fields depend on op.
|
|
11784
|
+
*/
|
|
11785
|
+
ops: Array<{
|
|
11786
|
+
/**
|
|
11787
|
+
* Operation name such as insert, update, delete, split, trim, move, track_add or settings_update.
|
|
11788
|
+
*/
|
|
11789
|
+
op: string;
|
|
11790
|
+
[key: string]: unknown;
|
|
11791
|
+
}>;
|
|
11792
|
+
summary: CutSummary;
|
|
11793
|
+
/**
|
|
11794
|
+
* ISO 8601 timestamp when this transaction committed.
|
|
11795
|
+
*/
|
|
11796
|
+
time: string;
|
|
11797
|
+
};
|
|
10948
11798
|
export type DatabaseCreateDatabaseInput = {
|
|
10949
11799
|
/**
|
|
10950
11800
|
* Display name for the database: 1–64 visible characters after trimming; control characters are rejected. It is not an identifier, so later calls still use the returned id.
|
|
@@ -19097,7 +19947,7 @@ export type AgentManaged89 = {
|
|
|
19097
19947
|
type: 'text';
|
|
19098
19948
|
};
|
|
19099
19949
|
/**
|
|
19100
|
-
*
|
|
19950
|
+
* Conversation model; required on creation except for kind assume. Forbidden and omitted on assume agents, which are driven by an external MCP client.
|
|
19101
19951
|
*/
|
|
19102
19952
|
export type AgentManaged38 = {
|
|
19103
19953
|
/**
|
|
@@ -21625,6 +22475,315 @@ export type AutomationHumanTaskOutcome = {
|
|
|
21625
22475
|
*/
|
|
21626
22476
|
responses: Array<AutomationHumanTaskResponse>;
|
|
21627
22477
|
};
|
|
22478
|
+
/**
|
|
22479
|
+
* Current revision as a decimal string, incremented by one after each successful write; pass it as expected_version to guard a subsequent execute call.
|
|
22480
|
+
*/
|
|
22481
|
+
export type CanvasVersion = string;
|
|
22482
|
+
export type CanvasFrame = {
|
|
22483
|
+
/**
|
|
22484
|
+
* Top-level node identifier; use in nodes.list, images.list or an execute script.
|
|
22485
|
+
*/
|
|
22486
|
+
id: string;
|
|
22487
|
+
/**
|
|
22488
|
+
* Human-readable node name, or null if no name is assigned.
|
|
22489
|
+
*/
|
|
22490
|
+
name: string | null;
|
|
22491
|
+
/**
|
|
22492
|
+
* Pencil node kind for this top-level item, such as frame or group; read nodes.list for its full content.
|
|
22493
|
+
*/
|
|
22494
|
+
type: string;
|
|
22495
|
+
/**
|
|
22496
|
+
* Horizontal position of the top-level node on the canvas, in design pixels.
|
|
22497
|
+
*/
|
|
22498
|
+
x: number;
|
|
22499
|
+
/**
|
|
22500
|
+
* Vertical position of the top-level node on the canvas, in design pixels.
|
|
22501
|
+
*/
|
|
22502
|
+
y: number;
|
|
22503
|
+
/**
|
|
22504
|
+
* Current width of the top-level node in design pixels.
|
|
22505
|
+
*/
|
|
22506
|
+
width: number;
|
|
22507
|
+
/**
|
|
22508
|
+
* Current height of the top-level node in design pixels.
|
|
22509
|
+
*/
|
|
22510
|
+
height: number;
|
|
22511
|
+
/**
|
|
22512
|
+
* Number of design nodes in this top-level node's subtree.
|
|
22513
|
+
*/
|
|
22514
|
+
node_count: number;
|
|
22515
|
+
/**
|
|
22516
|
+
* Whether this top-level node defines a reusable component.
|
|
22517
|
+
*/
|
|
22518
|
+
component: boolean;
|
|
22519
|
+
/**
|
|
22520
|
+
* Whether this top-level node is a placeholder awaiting design content.
|
|
22521
|
+
*/
|
|
22522
|
+
placeholder: boolean;
|
|
22523
|
+
/**
|
|
22524
|
+
* Whether this top-level node is visible on the canvas.
|
|
22525
|
+
*/
|
|
22526
|
+
visible: boolean;
|
|
22527
|
+
};
|
|
22528
|
+
/**
|
|
22529
|
+
* A node document in pen.dev (Pencil) .pen schema 2.21, not a Figma node. Node-specific design properties are preserved as open fields; frame/group/rectangle/ellipse/polygon/path/text/icon/ref/note use their .pen properties.
|
|
22530
|
+
*/
|
|
22531
|
+
export type CanvasPenNode = {
|
|
22532
|
+
[key: string]: unknown;
|
|
22533
|
+
};
|
|
22534
|
+
/**
|
|
22535
|
+
* Committed project revision from retrieve, state, timeline or execute; increases after each successful write.
|
|
22536
|
+
*/
|
|
22537
|
+
export type CutRevision = number;
|
|
22538
|
+
/**
|
|
22539
|
+
* Current project rendering settings, including the normalized rational frame rate.
|
|
22540
|
+
*/
|
|
22541
|
+
export type CutSettings = {
|
|
22542
|
+
/**
|
|
22543
|
+
* Output width in pixels; even integer between 16 and 4096.
|
|
22544
|
+
*/
|
|
22545
|
+
width: number;
|
|
22546
|
+
/**
|
|
22547
|
+
* Output height in pixels; even integer between 16 and 4096.
|
|
22548
|
+
*/
|
|
22549
|
+
height: number;
|
|
22550
|
+
/**
|
|
22551
|
+
* Exact frames-per-second fraction used to snap second-based edits to project frames.
|
|
22552
|
+
*/
|
|
22553
|
+
fps: CutFrameRate;
|
|
22554
|
+
/**
|
|
22555
|
+
* Background color as #RRGGBB or #RRGGBBAA; omission uses black.
|
|
22556
|
+
*/
|
|
22557
|
+
background: string;
|
|
22558
|
+
/**
|
|
22559
|
+
* Project audio sample rate in hertz; fixed at 48000.
|
|
22560
|
+
*/
|
|
22561
|
+
sample_rate: 48000;
|
|
22562
|
+
};
|
|
22563
|
+
/**
|
|
22564
|
+
* Failure envelope returned with a non-success HTTP status.
|
|
22565
|
+
*/
|
|
22566
|
+
export type CutCutError = {
|
|
22567
|
+
/**
|
|
22568
|
+
* Domain failure and optional recovery context.
|
|
22569
|
+
*/
|
|
22570
|
+
error: {
|
|
22571
|
+
/**
|
|
22572
|
+
* Machine-readable Cut error code; use the operation status description to choose recovery.
|
|
22573
|
+
*/
|
|
22574
|
+
code: string;
|
|
22575
|
+
/**
|
|
22576
|
+
* Human-readable explanation of the failed request.
|
|
22577
|
+
*/
|
|
22578
|
+
message: string;
|
|
22579
|
+
/**
|
|
22580
|
+
* Error-specific context; script failures may include an edit_id for a source-patch retry.
|
|
22581
|
+
*/
|
|
22582
|
+
details?: {
|
|
22583
|
+
/**
|
|
22584
|
+
* Saved failed script id; use with edits within ten minutes.
|
|
22585
|
+
*/
|
|
22586
|
+
edit_id?: string;
|
|
22587
|
+
/**
|
|
22588
|
+
* Committed project revision from retrieve, state, timeline or execute; increases after each successful write.
|
|
22589
|
+
*/
|
|
22590
|
+
revision?: number;
|
|
22591
|
+
/**
|
|
22592
|
+
* Optional source line where script evaluation failed.
|
|
22593
|
+
*/
|
|
22594
|
+
line?: number;
|
|
22595
|
+
/**
|
|
22596
|
+
* Optional source column where script evaluation failed.
|
|
22597
|
+
*/
|
|
22598
|
+
column?: number;
|
|
22599
|
+
/**
|
|
22600
|
+
* Number of timeline references preventing the requested binding removal.
|
|
22601
|
+
*/
|
|
22602
|
+
references?: number;
|
|
22603
|
+
/**
|
|
22604
|
+
* Rejected editing operations; the whole transaction was rolled back.
|
|
22605
|
+
*/
|
|
22606
|
+
rejections?: Array<{
|
|
22607
|
+
/**
|
|
22608
|
+
* Zero-based index of the rejected operation in the transaction.
|
|
22609
|
+
*/
|
|
22610
|
+
op_index: number;
|
|
22611
|
+
/**
|
|
22612
|
+
* Machine-readable rejection cause, such as LOCKED_TRACK or OUT_OF_SOURCE.
|
|
22613
|
+
*/
|
|
22614
|
+
code: string;
|
|
22615
|
+
/**
|
|
22616
|
+
* Human-readable explanation of the rejected operation.
|
|
22617
|
+
*/
|
|
22618
|
+
message: string;
|
|
22619
|
+
}>;
|
|
22620
|
+
[key: string]: unknown;
|
|
22621
|
+
};
|
|
22622
|
+
};
|
|
22623
|
+
};
|
|
22624
|
+
/**
|
|
22625
|
+
* Dimensions and frame rate for a new editing project.
|
|
22626
|
+
*/
|
|
22627
|
+
export type CutSettingsInput = {
|
|
22628
|
+
/**
|
|
22629
|
+
* Output width in pixels; even integer between 16 and 4096.
|
|
22630
|
+
*/
|
|
22631
|
+
width: number;
|
|
22632
|
+
/**
|
|
22633
|
+
* Output height in pixels; even integer between 16 and 4096.
|
|
22634
|
+
*/
|
|
22635
|
+
height: number;
|
|
22636
|
+
/**
|
|
22637
|
+
* Project frames per second, as a positive number or an exact num/den fraction.
|
|
22638
|
+
*/
|
|
22639
|
+
fps: number | CutFrameRate;
|
|
22640
|
+
/**
|
|
22641
|
+
* Background color as #RRGGBB or #RRGGBBAA; omission uses black.
|
|
22642
|
+
*/
|
|
22643
|
+
background?: string;
|
|
22644
|
+
};
|
|
22645
|
+
/**
|
|
22646
|
+
* Full timeline at one revision; positions and lengths are seconds.
|
|
22647
|
+
*/
|
|
22648
|
+
export type CutTimeline = {
|
|
22649
|
+
/**
|
|
22650
|
+
* Total duration derived from the latest clip end. In seconds, not frames or microseconds.
|
|
22651
|
+
*/
|
|
22652
|
+
duration: number;
|
|
22653
|
+
/**
|
|
22654
|
+
* Ordered tracks, topmost visual layer first.
|
|
22655
|
+
*/
|
|
22656
|
+
tracks: Array<CutTrack>;
|
|
22657
|
+
/**
|
|
22658
|
+
* Named points on the timeline.
|
|
22659
|
+
*/
|
|
22660
|
+
markers: Array<CutMarker>;
|
|
22661
|
+
};
|
|
22662
|
+
/**
|
|
22663
|
+
* Counts and duration changes committed by an editing transaction.
|
|
22664
|
+
*/
|
|
22665
|
+
export type CutSummary = {
|
|
22666
|
+
/**
|
|
22667
|
+
* Number of clips added by the transaction.
|
|
22668
|
+
*/
|
|
22669
|
+
added: number;
|
|
22670
|
+
/**
|
|
22671
|
+
* Number of clips removed by the transaction.
|
|
22672
|
+
*/
|
|
22673
|
+
removed: number;
|
|
22674
|
+
/**
|
|
22675
|
+
* Number of clips changed by the transaction.
|
|
22676
|
+
*/
|
|
22677
|
+
modified: number;
|
|
22678
|
+
/**
|
|
22679
|
+
* Project duration before the transaction. In seconds, not frames or microseconds.
|
|
22680
|
+
*/
|
|
22681
|
+
duration_before: number;
|
|
22682
|
+
/**
|
|
22683
|
+
* Project duration after the transaction. In seconds, not frames or microseconds.
|
|
22684
|
+
*/
|
|
22685
|
+
duration_after: number;
|
|
22686
|
+
/**
|
|
22687
|
+
* Human-readable descriptions of the committed edits.
|
|
22688
|
+
*/
|
|
22689
|
+
lines: Array<string>;
|
|
22690
|
+
};
|
|
22691
|
+
/**
|
|
22692
|
+
* Rendered image available until its signed URL expires.
|
|
22693
|
+
*/
|
|
22694
|
+
export type CutRenderRef = {
|
|
22695
|
+
/**
|
|
22696
|
+
* Fetchable image URL for this render result.
|
|
22697
|
+
*/
|
|
22698
|
+
url: string;
|
|
22699
|
+
/**
|
|
22700
|
+
* Rendered image width in pixels.
|
|
22701
|
+
*/
|
|
22702
|
+
width: number;
|
|
22703
|
+
/**
|
|
22704
|
+
* Rendered image height in pixels.
|
|
22705
|
+
*/
|
|
22706
|
+
height: number;
|
|
22707
|
+
/**
|
|
22708
|
+
* ISO 8601 timestamp after which the image URL must be refreshed.
|
|
22709
|
+
*/
|
|
22710
|
+
expires_at: string;
|
|
22711
|
+
};
|
|
22712
|
+
/**
|
|
22713
|
+
* Compact track metadata without individual clip documents.
|
|
22714
|
+
*/
|
|
22715
|
+
export type CutTrackSummary = {
|
|
22716
|
+
/**
|
|
22717
|
+
* Track id created by AddTrack; reuse in Insert, UpdateTrack or DeleteTrack.
|
|
22718
|
+
*/
|
|
22719
|
+
id: string;
|
|
22720
|
+
/**
|
|
22721
|
+
* Human-readable track name chosen by the editing script.
|
|
22722
|
+
*/
|
|
22723
|
+
name: string;
|
|
22724
|
+
/**
|
|
22725
|
+
* video contains visual clips; audio contains sound clips; caption contains timed text.
|
|
22726
|
+
*/
|
|
22727
|
+
kind: 'video' | 'audio' | 'caption';
|
|
22728
|
+
/**
|
|
22729
|
+
* True prevents editing clips on this track.
|
|
22730
|
+
*/
|
|
22731
|
+
locked: boolean;
|
|
22732
|
+
/**
|
|
22733
|
+
* True hides a visual or caption track from the rendered output.
|
|
22734
|
+
*/
|
|
22735
|
+
hidden?: boolean;
|
|
22736
|
+
/**
|
|
22737
|
+
* True silences an audio track.
|
|
22738
|
+
*/
|
|
22739
|
+
muted?: boolean;
|
|
22740
|
+
/**
|
|
22741
|
+
* Zero-based layer order; zero is topmost.
|
|
22742
|
+
*/
|
|
22743
|
+
index: number;
|
|
22744
|
+
/**
|
|
22745
|
+
* Number of clips on this track.
|
|
22746
|
+
*/
|
|
22747
|
+
items: number;
|
|
22748
|
+
};
|
|
22749
|
+
/**
|
|
22750
|
+
* Reference to an asset in a bound library; follows asset overwrites to the latest version rather than pinning a version.
|
|
22751
|
+
*/
|
|
22752
|
+
export type CutMediaRef = {
|
|
22753
|
+
/**
|
|
22754
|
+
* Identifier of a library present in the project bindings.
|
|
22755
|
+
*/
|
|
22756
|
+
library_id: string;
|
|
22757
|
+
/**
|
|
22758
|
+
* Asset identifier returned by media import or praxis.media asset operations.
|
|
22759
|
+
*/
|
|
22760
|
+
asset_id: string;
|
|
22761
|
+
};
|
|
22762
|
+
/**
|
|
22763
|
+
* Rendering options for an exported video.
|
|
22764
|
+
*/
|
|
22765
|
+
export type CutExportOutput = {
|
|
22766
|
+
/**
|
|
22767
|
+
* mp4 produces an MPEG-4 video file.
|
|
22768
|
+
*/
|
|
22769
|
+
format?: 'mp4';
|
|
22770
|
+
/**
|
|
22771
|
+
* Output video width in pixels.
|
|
22772
|
+
*/
|
|
22773
|
+
width?: number;
|
|
22774
|
+
/**
|
|
22775
|
+
* Output video height in pixels.
|
|
22776
|
+
*/
|
|
22777
|
+
height?: number;
|
|
22778
|
+
/**
|
|
22779
|
+
* Output frames per second.
|
|
22780
|
+
*/
|
|
22781
|
+
fps?: number;
|
|
22782
|
+
/**
|
|
22783
|
+
* draft favors faster review renders; high favors final delivery quality.
|
|
22784
|
+
*/
|
|
22785
|
+
quality?: 'draft' | 'high';
|
|
22786
|
+
};
|
|
21628
22787
|
export type DatabaseField = {
|
|
21629
22788
|
/**
|
|
21630
22789
|
* Field identifier, prefixed fld_. Stable across renames; accepted wherever a field path parameter takes an id or name.
|
|
@@ -26517,6 +27676,77 @@ export type AutomationHumanTaskActor = {
|
|
|
26517
27676
|
*/
|
|
26518
27677
|
display_name: string | null;
|
|
26519
27678
|
};
|
|
27679
|
+
/**
|
|
27680
|
+
* Exact project frame rate; num divided by den gives frames per second.
|
|
27681
|
+
*/
|
|
27682
|
+
export type CutFrameRate = {
|
|
27683
|
+
/**
|
|
27684
|
+
* Positive numerator of the project frame rate.
|
|
27685
|
+
*/
|
|
27686
|
+
num: number;
|
|
27687
|
+
/**
|
|
27688
|
+
* Positive denominator of the project frame rate.
|
|
27689
|
+
*/
|
|
27690
|
+
den: number;
|
|
27691
|
+
};
|
|
27692
|
+
/**
|
|
27693
|
+
* Ordered timeline layer; index zero is the topmost layer.
|
|
27694
|
+
*/
|
|
27695
|
+
export type CutTrack = {
|
|
27696
|
+
/**
|
|
27697
|
+
* Track id created by AddTrack; reuse in Insert, UpdateTrack or DeleteTrack.
|
|
27698
|
+
*/
|
|
27699
|
+
id: string;
|
|
27700
|
+
/**
|
|
27701
|
+
* Human-readable track name chosen by the editing script.
|
|
27702
|
+
*/
|
|
27703
|
+
name: string;
|
|
27704
|
+
/**
|
|
27705
|
+
* video contains visual clips; audio contains sound clips; caption contains timed text.
|
|
27706
|
+
*/
|
|
27707
|
+
kind: 'video' | 'audio' | 'caption';
|
|
27708
|
+
/**
|
|
27709
|
+
* True prevents editing clips on this track.
|
|
27710
|
+
*/
|
|
27711
|
+
locked: boolean;
|
|
27712
|
+
/**
|
|
27713
|
+
* True hides a visual or caption track from the rendered output.
|
|
27714
|
+
*/
|
|
27715
|
+
hidden?: boolean;
|
|
27716
|
+
/**
|
|
27717
|
+
* True silences an audio track.
|
|
27718
|
+
*/
|
|
27719
|
+
muted?: boolean;
|
|
27720
|
+
/**
|
|
27721
|
+
* Audio track gain in decibels; added to the clip audio level.
|
|
27722
|
+
*/
|
|
27723
|
+
gain_db?: number;
|
|
27724
|
+
/**
|
|
27725
|
+
* Default caption styling for this track.
|
|
27726
|
+
*/
|
|
27727
|
+
style?: CutTextStyle;
|
|
27728
|
+
/**
|
|
27729
|
+
* Clips on the track in timeline order.
|
|
27730
|
+
*/
|
|
27731
|
+
items: Array<CutItem>;
|
|
27732
|
+
};
|
|
27733
|
+
/**
|
|
27734
|
+
* A named point on the project timeline.
|
|
27735
|
+
*/
|
|
27736
|
+
export type CutMarker = {
|
|
27737
|
+
/**
|
|
27738
|
+
* Marker identifier used in the editing transaction.
|
|
27739
|
+
*/
|
|
27740
|
+
id: string;
|
|
27741
|
+
/**
|
|
27742
|
+
* Marker position on the project timeline. In seconds, not frames or microseconds.
|
|
27743
|
+
*/
|
|
27744
|
+
at: number;
|
|
27745
|
+
/**
|
|
27746
|
+
* Human-readable annotation shown at this timeline point.
|
|
27747
|
+
*/
|
|
27748
|
+
label: string;
|
|
27749
|
+
};
|
|
26520
27750
|
export type KnowledgeStaticChunking = {
|
|
26521
27751
|
/**
|
|
26522
27752
|
* static selects explicit chunk-size and overlap settings.
|
|
@@ -27253,6 +28483,166 @@ export type AnthropicToolReferenceBlock = {
|
|
|
27253
28483
|
*/
|
|
27254
28484
|
type: 'tool_reference';
|
|
27255
28485
|
};
|
|
28486
|
+
/**
|
|
28487
|
+
* Text and caption styling in output pixels.
|
|
28488
|
+
*/
|
|
28489
|
+
export type CutTextStyle = {
|
|
28490
|
+
/**
|
|
28491
|
+
* Geist is the Latin typeface; Noto Sans SC is the simplified Chinese typeface.
|
|
28492
|
+
*/
|
|
28493
|
+
font_family?: 'Geist' | 'Noto Sans SC';
|
|
28494
|
+
/**
|
|
28495
|
+
* Text size in output pixels.
|
|
28496
|
+
*/
|
|
28497
|
+
font_size?: number;
|
|
28498
|
+
/**
|
|
28499
|
+
* Font weight: 400 is regular, 500 is medium and 700 is bold.
|
|
28500
|
+
*/
|
|
28501
|
+
font_weight?: 400 | 500 | 700;
|
|
28502
|
+
/**
|
|
28503
|
+
* Text color in #RRGGBB or #RRGGBBAA notation.
|
|
28504
|
+
*/
|
|
28505
|
+
color?: string;
|
|
28506
|
+
/**
|
|
28507
|
+
* Optional text outline.
|
|
28508
|
+
*/
|
|
28509
|
+
stroke?: {
|
|
28510
|
+
/**
|
|
28511
|
+
* Outline color as a hexadecimal RGB or RGBA color.
|
|
28512
|
+
*/
|
|
28513
|
+
color?: string;
|
|
28514
|
+
/**
|
|
28515
|
+
* Outline width in output pixels.
|
|
28516
|
+
*/
|
|
28517
|
+
width?: number;
|
|
28518
|
+
};
|
|
28519
|
+
/**
|
|
28520
|
+
* Optional text background color as hexadecimal RGB or RGBA.
|
|
28521
|
+
*/
|
|
28522
|
+
background?: string;
|
|
28523
|
+
/**
|
|
28524
|
+
* left aligns the text to its left edge; center centers it; right aligns its right edge.
|
|
28525
|
+
*/
|
|
28526
|
+
align?: 'left' | 'center' | 'right';
|
|
28527
|
+
/**
|
|
28528
|
+
* Maximum text width as a fraction of the output canvas width.
|
|
28529
|
+
*/
|
|
28530
|
+
max_width?: number;
|
|
28531
|
+
/**
|
|
28532
|
+
* Caption placement: top is near the upper edge, middle is centered, bottom is near the lower edge.
|
|
28533
|
+
*/
|
|
28534
|
+
position?: 'top' | 'middle' | 'bottom';
|
|
28535
|
+
/**
|
|
28536
|
+
* Optional color applied to the currently spoken caption word.
|
|
28537
|
+
*/
|
|
28538
|
+
highlight_color?: string;
|
|
28539
|
+
/**
|
|
28540
|
+
* Maximum caption line count; fixed at 2.
|
|
28541
|
+
*/
|
|
28542
|
+
max_lines?: 2;
|
|
28543
|
+
};
|
|
28544
|
+
/**
|
|
28545
|
+
* Timeline clip or caption; fields depend on type and all media positions use seconds.
|
|
28546
|
+
*/
|
|
28547
|
+
export type CutItem = {
|
|
28548
|
+
/**
|
|
28549
|
+
* Clip identifier used by GetItem, Update, Delete, Split, Trim and Move.
|
|
28550
|
+
*/
|
|
28551
|
+
id: string;
|
|
28552
|
+
/**
|
|
28553
|
+
* video references moving footage; image references a still; text displays styled text; color fills a region; audio plays sound; caption displays transcript text.
|
|
28554
|
+
*/
|
|
28555
|
+
type: 'video' | 'image' | 'text' | 'color' | 'audio' | 'caption';
|
|
28556
|
+
/**
|
|
28557
|
+
* Clip start on the project timeline. In seconds, not frames or microseconds.
|
|
28558
|
+
*/
|
|
28559
|
+
start: number;
|
|
28560
|
+
/**
|
|
28561
|
+
* Clip duration on the project timeline. In seconds, not frames or microseconds.
|
|
28562
|
+
*/
|
|
28563
|
+
length: number;
|
|
28564
|
+
/**
|
|
28565
|
+
* Bound-library source asset used by video, image or audio clips.
|
|
28566
|
+
*/
|
|
28567
|
+
media?: CutMediaRef;
|
|
28568
|
+
/**
|
|
28569
|
+
* Source media offset where this clip starts reading. In seconds, not frames or microseconds.
|
|
28570
|
+
*/
|
|
28571
|
+
source_in?: number;
|
|
28572
|
+
/**
|
|
28573
|
+
* Playback speed multiplier; fixed at 1.
|
|
28574
|
+
*/
|
|
28575
|
+
speed?: 1;
|
|
28576
|
+
/**
|
|
28577
|
+
* Clip audio level in decibels; 0 preserves the source level.
|
|
28578
|
+
*/
|
|
28579
|
+
volume_db?: number;
|
|
28580
|
+
/**
|
|
28581
|
+
* Visual placement for this clip.
|
|
28582
|
+
*/
|
|
28583
|
+
transform?: CutTransform;
|
|
28584
|
+
/**
|
|
28585
|
+
* contain preserves all content with possible empty margins; cover crops to fill; fill stretches; none keeps natural size.
|
|
28586
|
+
*/
|
|
28587
|
+
fit?: 'contain' | 'cover' | 'fill' | 'none';
|
|
28588
|
+
/**
|
|
28589
|
+
* asset_deleted means the asset is gone; library_unbound means the binding was removed; access_denied means the caller cannot read it; source_shorter means the source no longer covers this clip.
|
|
28590
|
+
*/
|
|
28591
|
+
offline?: 'asset_deleted' | 'library_unbound' | 'access_denied' | 'source_shorter';
|
|
28592
|
+
/**
|
|
28593
|
+
* Visible text for a text clip or caption.
|
|
28594
|
+
*/
|
|
28595
|
+
text?: string;
|
|
28596
|
+
/**
|
|
28597
|
+
* Per-clip text styling where this clip type supports it.
|
|
28598
|
+
*/
|
|
28599
|
+
style?: CutTextStyle;
|
|
28600
|
+
/**
|
|
28601
|
+
* Fill color for a color clip as #RRGGBB or #RRGGBBAA.
|
|
28602
|
+
*/
|
|
28603
|
+
color?: string;
|
|
28604
|
+
/**
|
|
28605
|
+
* Audio fade-in duration. In seconds, not frames or microseconds.
|
|
28606
|
+
*/
|
|
28607
|
+
fade_in?: number;
|
|
28608
|
+
/**
|
|
28609
|
+
* Audio fade-out duration. In seconds, not frames or microseconds.
|
|
28610
|
+
*/
|
|
28611
|
+
fade_out?: number;
|
|
28612
|
+
/**
|
|
28613
|
+
* Audio ducking relative to another track.
|
|
28614
|
+
*/
|
|
28615
|
+
duck?: {
|
|
28616
|
+
/**
|
|
28617
|
+
* Track id whose activity triggers ducking.
|
|
28618
|
+
*/
|
|
28619
|
+
under?: string;
|
|
28620
|
+
/**
|
|
28621
|
+
* Attenuated level in decibels while the other track is active.
|
|
28622
|
+
*/
|
|
28623
|
+
to_db?: number;
|
|
28624
|
+
/**
|
|
28625
|
+
* Time to reach the attenuated level. In seconds, not frames or microseconds.
|
|
28626
|
+
*/
|
|
28627
|
+
attack?: number;
|
|
28628
|
+
/**
|
|
28629
|
+
* Time to recover the original level. In seconds, not frames or microseconds.
|
|
28630
|
+
*/
|
|
28631
|
+
release?: number;
|
|
28632
|
+
};
|
|
28633
|
+
/**
|
|
28634
|
+
* Transition at the incoming clip edge.
|
|
28635
|
+
*/
|
|
28636
|
+
transition_in?: CutTransition;
|
|
28637
|
+
/**
|
|
28638
|
+
* Transition at the outgoing clip edge.
|
|
28639
|
+
*/
|
|
28640
|
+
transition_out?: CutTransition;
|
|
28641
|
+
/**
|
|
28642
|
+
* Optional per-word timing for a caption.
|
|
28643
|
+
*/
|
|
28644
|
+
words?: Array<CutCaptionWord>;
|
|
28645
|
+
};
|
|
27256
28646
|
export type SandboxSandboxIamToken = {
|
|
27257
28647
|
/**
|
|
27258
28648
|
* Audience of the workload token, stored exactly as provided.
|
|
@@ -27438,6 +28828,82 @@ export type AnthropicCitationsConfig = {
|
|
|
27438
28828
|
*/
|
|
27439
28829
|
enabled: boolean;
|
|
27440
28830
|
};
|
|
28831
|
+
/**
|
|
28832
|
+
* Visual placement; coordinates are normalized canvas centers.
|
|
28833
|
+
*/
|
|
28834
|
+
export type CutTransform = {
|
|
28835
|
+
/**
|
|
28836
|
+
* Horizontal center as a fraction of the canvas width.
|
|
28837
|
+
*/
|
|
28838
|
+
x?: number;
|
|
28839
|
+
/**
|
|
28840
|
+
* Vertical center as a fraction of the canvas height.
|
|
28841
|
+
*/
|
|
28842
|
+
y?: number;
|
|
28843
|
+
/**
|
|
28844
|
+
* Scale multiplier relative to the fitted visual size; 1 keeps fitted size.
|
|
28845
|
+
*/
|
|
28846
|
+
scale?: number;
|
|
28847
|
+
/**
|
|
28848
|
+
* Clockwise visual rotation in degrees.
|
|
28849
|
+
*/
|
|
28850
|
+
rotation?: number;
|
|
28851
|
+
/**
|
|
28852
|
+
* Visible opacity from 0 for transparent to 1 for opaque.
|
|
28853
|
+
*/
|
|
28854
|
+
opacity?: number;
|
|
28855
|
+
/**
|
|
28856
|
+
* Crop inset fractions for each edge.
|
|
28857
|
+
*/
|
|
28858
|
+
crop?: {
|
|
28859
|
+
/**
|
|
28860
|
+
* Normalized crop inset at the top edge.
|
|
28861
|
+
*/
|
|
28862
|
+
top?: number;
|
|
28863
|
+
/**
|
|
28864
|
+
* Normalized crop inset at the right edge.
|
|
28865
|
+
*/
|
|
28866
|
+
right?: number;
|
|
28867
|
+
/**
|
|
28868
|
+
* Normalized crop inset at the bottom edge.
|
|
28869
|
+
*/
|
|
28870
|
+
bottom?: number;
|
|
28871
|
+
/**
|
|
28872
|
+
* Normalized crop inset at the left edge.
|
|
28873
|
+
*/
|
|
28874
|
+
left?: number;
|
|
28875
|
+
};
|
|
28876
|
+
};
|
|
28877
|
+
/**
|
|
28878
|
+
* Transition attached to the incoming or outgoing edge of a clip.
|
|
28879
|
+
*/
|
|
28880
|
+
export type CutTransition = {
|
|
28881
|
+
/**
|
|
28882
|
+
* fade blends with the background; dissolve blends clips; push_left and push_right slide clips; wipe_left reveals the next clip.
|
|
28883
|
+
*/
|
|
28884
|
+
kind: 'fade' | 'dissolve' | 'push_left' | 'push_right' | 'wipe_left';
|
|
28885
|
+
/**
|
|
28886
|
+
* Transition duration. In seconds, not frames or microseconds.
|
|
28887
|
+
*/
|
|
28888
|
+
length: number;
|
|
28889
|
+
};
|
|
28890
|
+
/**
|
|
28891
|
+
* One word positioned on the caption timeline.
|
|
28892
|
+
*/
|
|
28893
|
+
export type CutCaptionWord = {
|
|
28894
|
+
/**
|
|
28895
|
+
* Displayed word text from the selected transcript.
|
|
28896
|
+
*/
|
|
28897
|
+
text: string;
|
|
28898
|
+
/**
|
|
28899
|
+
* Word start on the project timeline. In seconds, not frames or microseconds.
|
|
28900
|
+
*/
|
|
28901
|
+
start: number;
|
|
28902
|
+
/**
|
|
28903
|
+
* Word display duration. In seconds, not frames or microseconds.
|
|
28904
|
+
*/
|
|
28905
|
+
length: number;
|
|
28906
|
+
};
|
|
27441
28907
|
export type PraxisSdkSseGetBrowserV1SessionsSessionIdStream = BrowserStreamMessage;
|
|
27442
28908
|
/**
|
|
27443
28909
|
* One decoded SSE event. The data field contains the decoded JSON payload, or a documented string sentinel. SSE comments are keepalives, not events. Optional id/event fields are absent when the server does not send them.
|
|
@@ -27847,6 +29313,26 @@ export type AgentManaged34Writable = {
|
|
|
27847
29313
|
* Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404.
|
|
27848
29314
|
*/
|
|
27849
29315
|
export type SandboxSandboxId = string;
|
|
29316
|
+
/**
|
|
29317
|
+
* Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted.
|
|
29318
|
+
*/
|
|
29319
|
+
export type CanvasCanvasId = string;
|
|
29320
|
+
/**
|
|
29321
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
29322
|
+
*/
|
|
29323
|
+
export type CutProjectId = string;
|
|
29324
|
+
/**
|
|
29325
|
+
* Project-local binding alias from bindings.list; detach only after removing all clips that reference its library.
|
|
29326
|
+
*/
|
|
29327
|
+
export type CutBindingName = string;
|
|
29328
|
+
/**
|
|
29329
|
+
* Export identifier returned by its create or list operation; use the id, not a display name.
|
|
29330
|
+
*/
|
|
29331
|
+
export type CutExportId = string;
|
|
29332
|
+
/**
|
|
29333
|
+
* Version identifier returned by its create or list operation; use the id, not a display name.
|
|
29334
|
+
*/
|
|
29335
|
+
export type CutVersionId = string;
|
|
27850
29336
|
/**
|
|
27851
29337
|
* Cursor to start the list from
|
|
27852
29338
|
*/
|
|
@@ -27863,7 +29349,7 @@ export type ApplyAgentVersionData = {
|
|
|
27863
29349
|
body?: never;
|
|
27864
29350
|
path: {
|
|
27865
29351
|
/**
|
|
27866
|
-
* Agent identifier from agents.create or agents.list.
|
|
29352
|
+
* Agent identifier from agents.create or agents.list. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
27867
29353
|
*/
|
|
27868
29354
|
agent_id: string;
|
|
27869
29355
|
/**
|
|
@@ -27926,7 +29412,7 @@ export type ApplyAgentVersionResponses = {
|
|
|
27926
29412
|
/**
|
|
27927
29413
|
* Model identifier and configuration.
|
|
27928
29414
|
*/
|
|
27929
|
-
model
|
|
29415
|
+
model?: {
|
|
27930
29416
|
/**
|
|
27931
29417
|
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
27932
29418
|
*/
|
|
@@ -27960,7 +29446,7 @@ export type ApplyAgentVersionResponses = {
|
|
|
27960
29446
|
/**
|
|
27961
29447
|
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
27962
29448
|
*/
|
|
27963
|
-
multiagent
|
|
29449
|
+
multiagent?: null | AgentManaged39;
|
|
27964
29450
|
/**
|
|
27965
29451
|
* Display name of the agent, as set on create or update. It is a label, not a unique key.
|
|
27966
29452
|
*/
|
|
@@ -28070,9 +29556,9 @@ export type ApplyAgentVersionResponses = {
|
|
|
28070
29556
|
enabled?: boolean;
|
|
28071
29557
|
}>;
|
|
28072
29558
|
/**
|
|
28073
|
-
* Immutable agent kind. general uses a durable computer and acts for its owner; personal behaves like general for now and is reserved for the personal agent; service uses a clean environment per session. Historical agents infer kind from their computer binding and read as general.
|
|
29559
|
+
* Immutable agent kind. general uses a durable computer and acts for its owner; personal behaves like general for now and is reserved for the personal agent; service uses a clean environment per session. Historical agents infer kind from their computer binding and read as general. Assume agents use a durable computer driven over MCP without a conversation model; model, models, subagent_model, subagents and multiagent are forbidden and omitted.
|
|
28074
29560
|
*/
|
|
28075
|
-
kind: 'general' | 'personal' | 'service';
|
|
29561
|
+
kind: 'general' | 'personal' | 'service' | 'assume';
|
|
28076
29562
|
/**
|
|
28077
29563
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined. Omitted when no computer is selected.
|
|
28078
29564
|
*/
|
|
@@ -28454,7 +29940,7 @@ export type ApplyAgentVersionResponses = {
|
|
|
28454
29940
|
*/
|
|
28455
29941
|
environment_id?: string | null;
|
|
28456
29942
|
/**
|
|
28457
|
-
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service agents
|
|
29943
|
+
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service and assume agents. Follows the version like other configuration: a version saved with apply=false does not change the vaults in effect. Versions saved before this field existed read as []. /agent/v1 only.
|
|
28458
29944
|
*/
|
|
28459
29945
|
vault_ids?: Array<string>;
|
|
28460
29946
|
/**
|
|
@@ -28468,7 +29954,7 @@ export type UnarchiveAgentData = {
|
|
|
28468
29954
|
body?: never;
|
|
28469
29955
|
path: {
|
|
28470
29956
|
/**
|
|
28471
|
-
* Agent id from creation or listing.
|
|
29957
|
+
* Agent id from creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
28472
29958
|
*/
|
|
28473
29959
|
agent_id: string;
|
|
28474
29960
|
};
|
|
@@ -28597,7 +30083,7 @@ export type UnarchiveAgentResponses = {
|
|
|
28597
30083
|
/**
|
|
28598
30084
|
* Model identifier and configuration.
|
|
28599
30085
|
*/
|
|
28600
|
-
model
|
|
30086
|
+
model?: {
|
|
28601
30087
|
/**
|
|
28602
30088
|
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
28603
30089
|
*/
|
|
@@ -28656,7 +30142,7 @@ export type UnarchiveAgentResponses = {
|
|
|
28656
30142
|
/**
|
|
28657
30143
|
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
28658
30144
|
*/
|
|
28659
|
-
multiagent
|
|
30145
|
+
multiagent?: null | {
|
|
28660
30146
|
/**
|
|
28661
30147
|
* Agents the coordinator may spawn as session threads, each resolved to a specific
|
|
28662
30148
|
* version.
|
|
@@ -29262,9 +30748,9 @@ export type UnarchiveAgentResponses = {
|
|
|
29262
30748
|
enabled?: boolean;
|
|
29263
30749
|
}>;
|
|
29264
30750
|
/**
|
|
29265
|
-
* Immutable agent kind. general uses a durable computer and acts for its owner; personal behaves like general for now and is reserved for the personal agent; service uses a clean environment per session. Historical agents infer kind from their computer binding and read as general.
|
|
30751
|
+
* Immutable agent kind. general uses a durable computer and acts for its owner; personal behaves like general for now and is reserved for the personal agent; service uses a clean environment per session. Historical agents infer kind from their computer binding and read as general. Assume agents use a durable computer driven over MCP without a conversation model; model, models, subagent_model, subagents and multiagent are forbidden and omitted.
|
|
29266
30752
|
*/
|
|
29267
|
-
kind: 'general' | 'personal' | 'service';
|
|
30753
|
+
kind: 'general' | 'personal' | 'service' | 'assume';
|
|
29268
30754
|
/**
|
|
29269
30755
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined. Omitted when no computer is selected.
|
|
29270
30756
|
*/
|
|
@@ -29646,7 +31132,7 @@ export type UnarchiveAgentResponses = {
|
|
|
29646
31132
|
*/
|
|
29647
31133
|
environment_id?: string | null;
|
|
29648
31134
|
/**
|
|
29649
|
-
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service agents
|
|
31135
|
+
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service and assume agents. Follows the version like other configuration: a version saved with apply=false does not change the vaults in effect. Versions saved before this field existed read as []. /agent/v1 only.
|
|
29650
31136
|
*/
|
|
29651
31137
|
vault_ids?: Array<string>;
|
|
29652
31138
|
/**
|
|
@@ -29780,7 +31266,7 @@ export type ListCustomersData = {
|
|
|
29780
31266
|
body?: never;
|
|
29781
31267
|
path: {
|
|
29782
31268
|
/**
|
|
29783
|
-
* Active service agent id from agent creation or listing.
|
|
31269
|
+
* Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
29784
31270
|
*/
|
|
29785
31271
|
agent_id: string;
|
|
29786
31272
|
};
|
|
@@ -29889,7 +31375,7 @@ export type DeleteCustomerData = {
|
|
|
29889
31375
|
body?: never;
|
|
29890
31376
|
path: {
|
|
29891
31377
|
/**
|
|
29892
|
-
* Active service agent id from agent creation or listing.
|
|
31378
|
+
* Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
29893
31379
|
*/
|
|
29894
31380
|
agent_id: string;
|
|
29895
31381
|
/**
|
|
@@ -29944,7 +31430,7 @@ export type GetCustomerData = {
|
|
|
29944
31430
|
body?: never;
|
|
29945
31431
|
path: {
|
|
29946
31432
|
/**
|
|
29947
|
-
* Active service agent id from agent creation or listing.
|
|
31433
|
+
* Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
29948
31434
|
*/
|
|
29949
31435
|
agent_id: string;
|
|
29950
31436
|
/**
|
|
@@ -30048,7 +31534,7 @@ export type GetCustomerDeletionData = {
|
|
|
30048
31534
|
body?: never;
|
|
30049
31535
|
path: {
|
|
30050
31536
|
/**
|
|
30051
|
-
* Active service agent id from agent creation or listing.
|
|
31537
|
+
* Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
30052
31538
|
*/
|
|
30053
31539
|
agent_id: string;
|
|
30054
31540
|
/**
|
|
@@ -30135,7 +31621,7 @@ export type BlockCustomerData = {
|
|
|
30135
31621
|
body?: never;
|
|
30136
31622
|
path: {
|
|
30137
31623
|
/**
|
|
30138
|
-
* Active service agent id from agent creation or listing.
|
|
31624
|
+
* Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
30139
31625
|
*/
|
|
30140
31626
|
agent_id: string;
|
|
30141
31627
|
/**
|
|
@@ -30218,7 +31704,7 @@ export type UnblockCustomerData = {
|
|
|
30218
31704
|
body?: never;
|
|
30219
31705
|
path: {
|
|
30220
31706
|
/**
|
|
30221
|
-
* Active service agent id from agent creation or listing.
|
|
31707
|
+
* Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
30222
31708
|
*/
|
|
30223
31709
|
agent_id: string;
|
|
30224
31710
|
/**
|
|
@@ -30297,7 +31783,7 @@ export type RevokeCustomerTokensData = {
|
|
|
30297
31783
|
body?: never;
|
|
30298
31784
|
path: {
|
|
30299
31785
|
/**
|
|
30300
|
-
* Active service agent id from agent creation or listing.
|
|
31786
|
+
* Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
30301
31787
|
*/
|
|
30302
31788
|
agent_id: string;
|
|
30303
31789
|
/**
|
|
@@ -30343,7 +31829,7 @@ export type GetAgentAppearanceData = {
|
|
|
30343
31829
|
body?: never;
|
|
30344
31830
|
path: {
|
|
30345
31831
|
/**
|
|
30346
|
-
* Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for.
|
|
31832
|
+
* Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
30347
31833
|
*/
|
|
30348
31834
|
agent_id: string;
|
|
30349
31835
|
};
|
|
@@ -30654,7 +32140,7 @@ export type CreateCustomerGrantCodeData = {
|
|
|
30654
32140
|
};
|
|
30655
32141
|
path: {
|
|
30656
32142
|
/**
|
|
30657
|
-
* Service agent id (agent_…) or its short identity number, from agent creation or listing.
|
|
32143
|
+
* Service agent id (agent_…) or its short identity number, from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
30658
32144
|
*/
|
|
30659
32145
|
agent_id: string;
|
|
30660
32146
|
};
|
|
@@ -30730,7 +32216,7 @@ export type CreateCustomerAccessTokenData = {
|
|
|
30730
32216
|
};
|
|
30731
32217
|
path: {
|
|
30732
32218
|
/**
|
|
30733
|
-
* Service agent id (agent_…) or its short identity number, from agent creation or listing.
|
|
32219
|
+
* Service agent id (agent_…) or its short identity number, from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
30734
32220
|
*/
|
|
30735
32221
|
agent_id: string;
|
|
30736
32222
|
};
|
|
@@ -30804,7 +32290,7 @@ export type RenewCustomerAccessTokenData = {
|
|
|
30804
32290
|
body?: never;
|
|
30805
32291
|
path: {
|
|
30806
32292
|
/**
|
|
30807
|
-
* Service agent id (agent_…) or its short identity number, from agent creation or listing.
|
|
32293
|
+
* Service agent id (agent_…) or its short identity number, from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
30808
32294
|
*/
|
|
30809
32295
|
agent_id: string;
|
|
30810
32296
|
};
|
|
@@ -30866,7 +32352,7 @@ export type DeleteCurrentCustomerAccessTokenData = {
|
|
|
30866
32352
|
body?: never;
|
|
30867
32353
|
path: {
|
|
30868
32354
|
/**
|
|
30869
|
-
* Service agent id (agent_…) or its short identity number, from agent creation or listing.
|
|
32355
|
+
* Service agent id (agent_…) or its short identity number, from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
30870
32356
|
*/
|
|
30871
32357
|
agent_id: string;
|
|
30872
32358
|
};
|
|
@@ -38550,7 +40036,7 @@ export type ListModelsData = {
|
|
|
38550
40036
|
/**
|
|
38551
40037
|
* Match any comma-separated declared protocol ID; omitted or empty includes all models. Combined with type and output_modalities using AND. Invalid IDs return 400 with all legal values.
|
|
38552
40038
|
*/
|
|
38553
|
-
supported_api?: Array<'anthropic.messages' | 'cohere.rerank' | 'google.generateContent' | 'mistral.ocr' | 'openai.audio.speech' | 'openai.audio.transcriptions' | 'openai.chat.completions' | 'openai.embeddings' | 'openai.images.edits' | 'openai.images.generations' | 'openai.responses' | 'openai.videos'>;
|
|
40039
|
+
supported_api?: Array<'anthropic.messages' | 'cohere.rerank' | 'google.generateContent' | 'mistral.ocr' | 'openai.audio.speech' | 'openai.audio.transcriptions' | 'openai.chat.completions' | 'openai.embeddings' | 'openai.images.edits' | 'openai.images.generations' | 'openai.responses' | 'openai.videos' | 'typesafe.systemone'>;
|
|
38554
40040
|
/**
|
|
38555
40041
|
* Filter by one or more model types (comma-separated).
|
|
38556
40042
|
*/
|
|
@@ -39534,6 +41020,251 @@ export type RemixVideoErrors = {
|
|
|
39534
41020
|
*/
|
|
39535
41021
|
400: unknown;
|
|
39536
41022
|
};
|
|
41023
|
+
export type CreateSystemoneData = {
|
|
41024
|
+
body: {
|
|
41025
|
+
/**
|
|
41026
|
+
* Published model id from model.models.list with supported_apis containing typesafe.systemone; returned unchanged in the response.
|
|
41027
|
+
*/
|
|
41028
|
+
model: string;
|
|
41029
|
+
/**
|
|
41030
|
+
* Shared content evaluated by every question, supplied as text, a JSON object or an array.
|
|
41031
|
+
*/
|
|
41032
|
+
state: string | {
|
|
41033
|
+
[key: string]: unknown;
|
|
41034
|
+
} | Array<unknown>;
|
|
41035
|
+
/**
|
|
41036
|
+
* Non-empty map of caller-chosen question ids to typed questions; answers preserve these ids. noul evaluates yes/no, choice selects a named option, score rates ordered levels. box is unsupported.
|
|
41037
|
+
*/
|
|
41038
|
+
questions: {
|
|
41039
|
+
[key: string]: {
|
|
41040
|
+
/**
|
|
41041
|
+
* noul asks a yes/no question and returns the probability of yes.
|
|
41042
|
+
*/
|
|
41043
|
+
type: 'noul';
|
|
41044
|
+
/**
|
|
41045
|
+
* Optional instructions for this question; text, object, array or null. Omit to let the criteria supply the question context.
|
|
41046
|
+
*/
|
|
41047
|
+
instructions?: string | {
|
|
41048
|
+
[key: string]: unknown;
|
|
41049
|
+
} | Array<unknown> | null;
|
|
41050
|
+
/**
|
|
41051
|
+
* Optional descriptions of the true and false outcomes; only these two keys are accepted.
|
|
41052
|
+
*/
|
|
41053
|
+
criteria?: {
|
|
41054
|
+
/**
|
|
41055
|
+
* Description of the yes outcome used to evaluate this noul question.
|
|
41056
|
+
*/
|
|
41057
|
+
true?: string | {
|
|
41058
|
+
[key: string]: unknown;
|
|
41059
|
+
} | Array<unknown> | null;
|
|
41060
|
+
/**
|
|
41061
|
+
* Description of the no outcome used to evaluate this noul question.
|
|
41062
|
+
*/
|
|
41063
|
+
false?: string | {
|
|
41064
|
+
[key: string]: unknown;
|
|
41065
|
+
} | Array<unknown> | null;
|
|
41066
|
+
};
|
|
41067
|
+
} | {
|
|
41068
|
+
/**
|
|
41069
|
+
* choice selects an option from the named criteria and returns every option probability.
|
|
41070
|
+
*/
|
|
41071
|
+
type: 'choice';
|
|
41072
|
+
/**
|
|
41073
|
+
* Optional instructions for this question; text, object, array or null. Omit to let the criteria supply the question context.
|
|
41074
|
+
*/
|
|
41075
|
+
instructions?: string | {
|
|
41076
|
+
[key: string]: unknown;
|
|
41077
|
+
} | Array<unknown> | null;
|
|
41078
|
+
/**
|
|
41079
|
+
* One to 255 named options; each value describes that option as text, object, array or null. The selected choice is one of these keys.
|
|
41080
|
+
*/
|
|
41081
|
+
criteria: {
|
|
41082
|
+
[key: string]: string | {
|
|
41083
|
+
[key: string]: unknown;
|
|
41084
|
+
} | Array<unknown> | null;
|
|
41085
|
+
};
|
|
41086
|
+
} | {
|
|
41087
|
+
/**
|
|
41088
|
+
* score evaluates ordered criteria from low to high and returns a normalized score.
|
|
41089
|
+
*/
|
|
41090
|
+
type: 'score';
|
|
41091
|
+
/**
|
|
41092
|
+
* Optional instructions for this question; text, object, array or null. Omit to let the criteria supply the question context.
|
|
41093
|
+
*/
|
|
41094
|
+
instructions?: string | {
|
|
41095
|
+
[key: string]: unknown;
|
|
41096
|
+
} | Array<unknown> | null;
|
|
41097
|
+
/**
|
|
41098
|
+
* One to ten descriptive levels ordered from low to high; each is text, an object or an array. Legend keys in the answer index these levels.
|
|
41099
|
+
*/
|
|
41100
|
+
criteria: Array<string | {
|
|
41101
|
+
[key: string]: unknown;
|
|
41102
|
+
} | Array<unknown>>;
|
|
41103
|
+
};
|
|
41104
|
+
};
|
|
41105
|
+
/**
|
|
41106
|
+
* Unsupported image assets. Supplying this field, including null or an empty collection, returns 400: images are not supported.
|
|
41107
|
+
*/
|
|
41108
|
+
assets?: {
|
|
41109
|
+
[key: string]: unknown;
|
|
41110
|
+
};
|
|
41111
|
+
[key: string]: unknown;
|
|
41112
|
+
};
|
|
41113
|
+
path?: never;
|
|
41114
|
+
query?: never;
|
|
41115
|
+
url: '/model/v1/systemone';
|
|
41116
|
+
};
|
|
41117
|
+
export type CreateSystemoneErrors = {
|
|
41118
|
+
/**
|
|
41119
|
+
* Missing model, state or questions; invalid question type or criteria size; box or assets unsupported. Correct the named field before retrying.
|
|
41120
|
+
*/
|
|
41121
|
+
400: {
|
|
41122
|
+
type: string;
|
|
41123
|
+
title: string;
|
|
41124
|
+
status: number;
|
|
41125
|
+
detail: string;
|
|
41126
|
+
[key: string]: unknown;
|
|
41127
|
+
};
|
|
41128
|
+
/**
|
|
41129
|
+
* Missing or invalid API credentials; supply a valid platform API key in Authorization: Bearer.
|
|
41130
|
+
*/
|
|
41131
|
+
401: {
|
|
41132
|
+
type: string;
|
|
41133
|
+
title: string;
|
|
41134
|
+
status: number;
|
|
41135
|
+
detail: string;
|
|
41136
|
+
[key: string]: unknown;
|
|
41137
|
+
};
|
|
41138
|
+
/**
|
|
41139
|
+
* Unknown model or MODEL_PROTOCOL_NOT_OFFERED; select a catalog model declaring typesafe.systemone.
|
|
41140
|
+
*/
|
|
41141
|
+
404: {
|
|
41142
|
+
type: string;
|
|
41143
|
+
title: string;
|
|
41144
|
+
status: number;
|
|
41145
|
+
detail: string;
|
|
41146
|
+
[key: string]: unknown;
|
|
41147
|
+
};
|
|
41148
|
+
/**
|
|
41149
|
+
* The platform or upstream is rate limited; wait before retrying the request.
|
|
41150
|
+
*/
|
|
41151
|
+
429: {
|
|
41152
|
+
type: string;
|
|
41153
|
+
title: string;
|
|
41154
|
+
status: number;
|
|
41155
|
+
detail: string;
|
|
41156
|
+
[key: string]: unknown;
|
|
41157
|
+
};
|
|
41158
|
+
/**
|
|
41159
|
+
* Upstream credentials, transport or response failed; retry later or choose another declared model.
|
|
41160
|
+
*/
|
|
41161
|
+
502: {
|
|
41162
|
+
type: string;
|
|
41163
|
+
title: string;
|
|
41164
|
+
status: number;
|
|
41165
|
+
detail: string;
|
|
41166
|
+
[key: string]: unknown;
|
|
41167
|
+
};
|
|
41168
|
+
/**
|
|
41169
|
+
* No available native System One line; retry later or choose another declared model.
|
|
41170
|
+
*/
|
|
41171
|
+
503: {
|
|
41172
|
+
type: string;
|
|
41173
|
+
title: string;
|
|
41174
|
+
status: number;
|
|
41175
|
+
detail: string;
|
|
41176
|
+
[key: string]: unknown;
|
|
41177
|
+
};
|
|
41178
|
+
};
|
|
41179
|
+
export type CreateSystemoneError = CreateSystemoneErrors[keyof CreateSystemoneErrors];
|
|
41180
|
+
export type CreateSystemoneResponses = {
|
|
41181
|
+
/**
|
|
41182
|
+
* Typed answers keyed by the original question ids, token usage, and the actual customer charge in USD.
|
|
41183
|
+
*/
|
|
41184
|
+
200: {
|
|
41185
|
+
/**
|
|
41186
|
+
* Model id exactly as supplied in the request, including any public alias or creator prefix.
|
|
41187
|
+
*/
|
|
41188
|
+
model: string;
|
|
41189
|
+
/**
|
|
41190
|
+
* Results mapped by the caller's question ids; each discriminator matches that question's type.
|
|
41191
|
+
*/
|
|
41192
|
+
answers: {
|
|
41193
|
+
[key: string]: {
|
|
41194
|
+
/**
|
|
41195
|
+
* Answer discriminator: noul corresponds to the question of the same type.
|
|
41196
|
+
*/
|
|
41197
|
+
type: 'noul';
|
|
41198
|
+
/**
|
|
41199
|
+
* Calibrated probability that the answer to the yes/no question is yes.
|
|
41200
|
+
*/
|
|
41201
|
+
noul: number;
|
|
41202
|
+
} | {
|
|
41203
|
+
/**
|
|
41204
|
+
* Answer discriminator: choice corresponds to the question of the same type.
|
|
41205
|
+
*/
|
|
41206
|
+
type: 'choice';
|
|
41207
|
+
/**
|
|
41208
|
+
* Selected option name, always a key from this question's criteria.
|
|
41209
|
+
*/
|
|
41210
|
+
choice: string;
|
|
41211
|
+
/**
|
|
41212
|
+
* Certainty of the selected choice or score, distinct from the per-option probabilities.
|
|
41213
|
+
*/
|
|
41214
|
+
confidence: number;
|
|
41215
|
+
/**
|
|
41216
|
+
* Probability of each caller-defined choice or zero-based score level; the probabilities sum to one.
|
|
41217
|
+
*/
|
|
41218
|
+
probabilities: {
|
|
41219
|
+
[key: string]: number;
|
|
41220
|
+
};
|
|
41221
|
+
} | {
|
|
41222
|
+
/**
|
|
41223
|
+
* Answer discriminator: score corresponds to the question of the same type.
|
|
41224
|
+
*/
|
|
41225
|
+
type: 'score';
|
|
41226
|
+
/**
|
|
41227
|
+
* Normalized rating across the ordered criteria, from the lowest to the highest level.
|
|
41228
|
+
*/
|
|
41229
|
+
score: number;
|
|
41230
|
+
/**
|
|
41231
|
+
* Certainty of the selected choice or score, distinct from the per-option probabilities.
|
|
41232
|
+
*/
|
|
41233
|
+
confidence: number;
|
|
41234
|
+
/**
|
|
41235
|
+
* Zero-based level keys mapped to their descriptions, with one key per request criterion.
|
|
41236
|
+
*/
|
|
41237
|
+
legend: {
|
|
41238
|
+
[key: string]: unknown;
|
|
41239
|
+
};
|
|
41240
|
+
/**
|
|
41241
|
+
* Probability of each caller-defined choice or zero-based score level; the probabilities sum to one.
|
|
41242
|
+
*/
|
|
41243
|
+
probabilities: {
|
|
41244
|
+
[key: string]: number;
|
|
41245
|
+
};
|
|
41246
|
+
};
|
|
41247
|
+
};
|
|
41248
|
+
/**
|
|
41249
|
+
* Provider token counts and the actual input-only customer charge; output tokens are free.
|
|
41250
|
+
*/
|
|
41251
|
+
usage: {
|
|
41252
|
+
/**
|
|
41253
|
+
* Authoritative upstream count of input tokens; the sole billed quantity for this operation.
|
|
41254
|
+
*/
|
|
41255
|
+
input_tokens: number;
|
|
41256
|
+
/**
|
|
41257
|
+
* Upstream count of output tokens, returned for visibility and never charged.
|
|
41258
|
+
*/
|
|
41259
|
+
output_tokens: number;
|
|
41260
|
+
/**
|
|
41261
|
+
* Actual customer charge in USD after micro-dollar rounding; exactly the value in X-Praxis-Cost-Usd, never upstream procurement cost.
|
|
41262
|
+
*/
|
|
41263
|
+
cost: number;
|
|
41264
|
+
};
|
|
41265
|
+
};
|
|
41266
|
+
};
|
|
41267
|
+
export type CreateSystemoneResponse = CreateSystemoneResponses[keyof CreateSystemoneResponses];
|
|
39537
41268
|
export type CreateAudioTranscriptionData = {
|
|
39538
41269
|
body: {
|
|
39539
41270
|
/**
|
|
@@ -45152,15 +46883,15 @@ export type AgentsListData = {
|
|
|
45152
46883
|
limit?: number;
|
|
45153
46884
|
page?: null | string;
|
|
45154
46885
|
/**
|
|
45155
|
-
* General agents use a durable computer and act for their owner; personal agents behave like general agents for now and are reserved for the personal agent; service agents use a clean environment per session.
|
|
46886
|
+
* General agents use a durable computer and act for their owner; personal agents behave like general agents for now and are reserved for the personal agent; service agents use a clean environment per session. Assume agents use a durable computer driven over MCP without a conversation model; model, models, subagent_model, subagents and multiagent are forbidden and omitted.
|
|
45156
46887
|
*/
|
|
45157
|
-
kind?: 'general' | 'personal' | 'service';
|
|
46888
|
+
kind?: 'general' | 'personal' | 'service' | 'assume';
|
|
45158
46889
|
};
|
|
45159
46890
|
url: '/agent/v1/agents';
|
|
45160
46891
|
};
|
|
45161
46892
|
export type AgentsListErrors = {
|
|
45162
46893
|
/**
|
|
45163
|
-
* include_archived is not true or false, kind is not general, personal or
|
|
46894
|
+
* include_archived is not true or false, kind is not general, personal, service or assume, a created_at bound is not an RFC 3339 timestamp, or INVALID_PARAMS when limit is not an integer from 1 to 100 (limit must be an integer between 1 and 100), or INVALID_PAGE_TOKEN when page is not a cursor from this same query (restart from the first page). Pass next_page unchanged, with the same filters, to continue.
|
|
45164
46895
|
*/
|
|
45165
46896
|
400: AgentError;
|
|
45166
46897
|
/**
|
|
@@ -45206,7 +46937,7 @@ export type AgentsListResponses = {
|
|
|
45206
46937
|
/**
|
|
45207
46938
|
* Model identifier and configuration.
|
|
45208
46939
|
*/
|
|
45209
|
-
model
|
|
46940
|
+
model?: {
|
|
45210
46941
|
/**
|
|
45211
46942
|
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
45212
46943
|
*/
|
|
@@ -45240,7 +46971,7 @@ export type AgentsListResponses = {
|
|
|
45240
46971
|
/**
|
|
45241
46972
|
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
45242
46973
|
*/
|
|
45243
|
-
multiagent
|
|
46974
|
+
multiagent?: null | AgentManaged39;
|
|
45244
46975
|
/**
|
|
45245
46976
|
* Display name of the agent, as set on create or update. It is a label, not a unique key.
|
|
45246
46977
|
*/
|
|
@@ -45346,9 +47077,9 @@ export type AgentsListResponses = {
|
|
|
45346
47077
|
enabled?: boolean;
|
|
45347
47078
|
}>;
|
|
45348
47079
|
/**
|
|
45349
|
-
* Immutable agent kind. general uses a durable computer and acts for its owner; personal behaves like general for now and is reserved for the personal agent; service uses a clean environment per session. Historical agents infer kind from their computer binding and read as general.
|
|
47080
|
+
* Immutable agent kind. general uses a durable computer and acts for its owner; personal behaves like general for now and is reserved for the personal agent; service uses a clean environment per session. Historical agents infer kind from their computer binding and read as general. Assume agents use a durable computer driven over MCP without a conversation model; model, models, subagent_model, subagents and multiagent are forbidden and omitted.
|
|
45350
47081
|
*/
|
|
45351
|
-
kind: 'general' | 'personal' | 'service';
|
|
47082
|
+
kind: 'general' | 'personal' | 'service' | 'assume';
|
|
45352
47083
|
/**
|
|
45353
47084
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined. Omitted when no computer is selected.
|
|
45354
47085
|
*/
|
|
@@ -45730,7 +47461,7 @@ export type AgentsListResponses = {
|
|
|
45730
47461
|
*/
|
|
45731
47462
|
environment_id?: string | null;
|
|
45732
47463
|
/**
|
|
45733
|
-
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service agents
|
|
47464
|
+
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service and assume agents. Follows the version like other configuration: a version saved with apply=false does not change the vaults in effect. Versions saved before this field existed read as []. /agent/v1 only.
|
|
45734
47465
|
*/
|
|
45735
47466
|
vault_ids?: Array<string>;
|
|
45736
47467
|
/**
|
|
@@ -45748,9 +47479,9 @@ export type AgentsListResponse = AgentsListResponses[keyof AgentsListResponses];
|
|
|
45748
47479
|
export type AgentsCreateData = {
|
|
45749
47480
|
body: {
|
|
45750
47481
|
/**
|
|
45751
|
-
* A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
47482
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected. Forbidden and omitted on assume agents.
|
|
45752
47483
|
*/
|
|
45753
|
-
model
|
|
47484
|
+
model?: string | {
|
|
45754
47485
|
/**
|
|
45755
47486
|
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
45756
47487
|
*/
|
|
@@ -45860,9 +47591,9 @@ export type AgentsCreateData = {
|
|
|
45860
47591
|
enabled?: boolean;
|
|
45861
47592
|
}>;
|
|
45862
47593
|
/**
|
|
45863
|
-
* Immutable agent kind. general and personal require computer_id; service cannot bind a computer. Omit on create to infer from computer_id (general with a computer, service without). On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error.
|
|
47594
|
+
* Immutable agent kind. general and personal require computer_id; service cannot bind a computer. Omit on create to infer from computer_id (general with a computer, service without). On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error. Assume agents use a durable computer driven over MCP without a conversation model; model, models, subagent_model, subagents and multiagent are forbidden and omitted.
|
|
45864
47595
|
*/
|
|
45865
|
-
kind?: 'general' | 'personal' | 'service';
|
|
47596
|
+
kind?: 'general' | 'personal' | 'service' | 'assume';
|
|
45866
47597
|
/**
|
|
45867
47598
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined.
|
|
45868
47599
|
*/
|
|
@@ -46250,7 +47981,7 @@ export type AgentsCreateData = {
|
|
|
46250
47981
|
};
|
|
46251
47982
|
export type AgentsCreateErrors = {
|
|
46252
47983
|
/**
|
|
46253
|
-
* The body failed validation and the message names the field: an unknown field, name outside 1 to 256 characters, a model that is not in the catalog or cannot run an agent, invalid tools or tools: null, a skill that is anthropic, repeated or not found, invalid bindings or vault_ids, or an environment_id that does not exist. Correct the field and retry.
|
|
47984
|
+
* The body failed validation and the message names the field: an unknown field, name outside 1 to 256 characters, a model that is not in the catalog or cannot run an agent, invalid tools or tools: null, a skill that is anthropic, repeated or not found, invalid bindings or vault_ids, or an environment_id that does not exist, or model, models, subagent_model, subagents or multiagent supplied on an assume agent. Correct the field and retry.
|
|
46254
47985
|
*/
|
|
46255
47986
|
400: AgentError;
|
|
46256
47987
|
/**
|
|
@@ -46296,7 +48027,7 @@ export type AgentsCreateResponses = {
|
|
|
46296
48027
|
/**
|
|
46297
48028
|
* Model identifier and configuration.
|
|
46298
48029
|
*/
|
|
46299
|
-
model
|
|
48030
|
+
model?: {
|
|
46300
48031
|
/**
|
|
46301
48032
|
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
46302
48033
|
*/
|
|
@@ -46330,7 +48061,7 @@ export type AgentsCreateResponses = {
|
|
|
46330
48061
|
/**
|
|
46331
48062
|
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
46332
48063
|
*/
|
|
46333
|
-
multiagent
|
|
48064
|
+
multiagent?: null | AgentManaged39;
|
|
46334
48065
|
/**
|
|
46335
48066
|
* Display name of the agent, as set on create or update. It is a label, not a unique key.
|
|
46336
48067
|
*/
|
|
@@ -46436,9 +48167,9 @@ export type AgentsCreateResponses = {
|
|
|
46436
48167
|
enabled?: boolean;
|
|
46437
48168
|
}>;
|
|
46438
48169
|
/**
|
|
46439
|
-
* Immutable agent kind. general uses a durable computer and acts for its owner; personal behaves like general for now and is reserved for the personal agent; service uses a clean environment per session. Historical agents infer kind from their computer binding and read as general.
|
|
48170
|
+
* Immutable agent kind. general uses a durable computer and acts for its owner; personal behaves like general for now and is reserved for the personal agent; service uses a clean environment per session. Historical agents infer kind from their computer binding and read as general. Assume agents use a durable computer driven over MCP without a conversation model; model, models, subagent_model, subagents and multiagent are forbidden and omitted.
|
|
46440
48171
|
*/
|
|
46441
|
-
kind: 'general' | 'personal' | 'service';
|
|
48172
|
+
kind: 'general' | 'personal' | 'service' | 'assume';
|
|
46442
48173
|
/**
|
|
46443
48174
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined. Omitted when no computer is selected.
|
|
46444
48175
|
*/
|
|
@@ -46820,7 +48551,7 @@ export type AgentsCreateResponses = {
|
|
|
46820
48551
|
*/
|
|
46821
48552
|
environment_id?: string | null;
|
|
46822
48553
|
/**
|
|
46823
|
-
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service agents
|
|
48554
|
+
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service and assume agents. Follows the version like other configuration: a version saved with apply=false does not change the vaults in effect. Versions saved before this field existed read as []. /agent/v1 only.
|
|
46824
48555
|
*/
|
|
46825
48556
|
vault_ids?: Array<string>;
|
|
46826
48557
|
/**
|
|
@@ -46834,7 +48565,7 @@ export type AgentsRetrieveData = {
|
|
|
46834
48565
|
body?: never;
|
|
46835
48566
|
path: {
|
|
46836
48567
|
/**
|
|
46837
|
-
* Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name.
|
|
48568
|
+
* Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
46838
48569
|
*/
|
|
46839
48570
|
agent_id: string;
|
|
46840
48571
|
};
|
|
@@ -46895,7 +48626,7 @@ export type AgentsRetrieveResponses = {
|
|
|
46895
48626
|
/**
|
|
46896
48627
|
* Model identifier and configuration.
|
|
46897
48628
|
*/
|
|
46898
|
-
model
|
|
48629
|
+
model?: {
|
|
46899
48630
|
/**
|
|
46900
48631
|
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
46901
48632
|
*/
|
|
@@ -46929,7 +48660,7 @@ export type AgentsRetrieveResponses = {
|
|
|
46929
48660
|
/**
|
|
46930
48661
|
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
46931
48662
|
*/
|
|
46932
|
-
multiagent
|
|
48663
|
+
multiagent?: null | AgentManaged39;
|
|
46933
48664
|
/**
|
|
46934
48665
|
* Display name of the agent, as set on create or update. It is a label, not a unique key.
|
|
46935
48666
|
*/
|
|
@@ -47039,9 +48770,9 @@ export type AgentsRetrieveResponses = {
|
|
|
47039
48770
|
enabled?: boolean;
|
|
47040
48771
|
}>;
|
|
47041
48772
|
/**
|
|
47042
|
-
* Immutable agent kind. general uses a durable computer and acts for its owner; personal behaves like general for now and is reserved for the personal agent; service uses a clean environment per session. Historical agents infer kind from their computer binding and read as general.
|
|
48773
|
+
* Immutable agent kind. general uses a durable computer and acts for its owner; personal behaves like general for now and is reserved for the personal agent; service uses a clean environment per session. Historical agents infer kind from their computer binding and read as general. Assume agents use a durable computer driven over MCP without a conversation model; model, models, subagent_model, subagents and multiagent are forbidden and omitted.
|
|
47043
48774
|
*/
|
|
47044
|
-
kind: 'general' | 'personal' | 'service';
|
|
48775
|
+
kind: 'general' | 'personal' | 'service' | 'assume';
|
|
47045
48776
|
/**
|
|
47046
48777
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined. Omitted when no computer is selected.
|
|
47047
48778
|
*/
|
|
@@ -47423,7 +49154,7 @@ export type AgentsRetrieveResponses = {
|
|
|
47423
49154
|
*/
|
|
47424
49155
|
environment_id?: string | null;
|
|
47425
49156
|
/**
|
|
47426
|
-
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service agents
|
|
49157
|
+
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service and assume agents. Follows the version like other configuration: a version saved with apply=false does not change the vaults in effect. Versions saved before this field existed read as []. /agent/v1 only.
|
|
47427
49158
|
*/
|
|
47428
49159
|
vault_ids?: Array<string>;
|
|
47429
49160
|
/**
|
|
@@ -47450,7 +49181,7 @@ export type AgentsUpdateData = {
|
|
|
47450
49181
|
*/
|
|
47451
49182
|
metadata?: null | AgentManaged58Writable;
|
|
47452
49183
|
/**
|
|
47453
|
-
* A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
49184
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected. Forbidden and omitted on assume agents.
|
|
47454
49185
|
*/
|
|
47455
49186
|
model?: string | {
|
|
47456
49187
|
/**
|
|
@@ -47562,9 +49293,9 @@ export type AgentsUpdateData = {
|
|
|
47562
49293
|
enabled?: boolean;
|
|
47563
49294
|
}> | null;
|
|
47564
49295
|
/**
|
|
47565
|
-
* Immutable agent kind. general and personal require computer_id; service cannot bind a computer. Omit on create to infer from computer_id (general with a computer, service without). On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error.
|
|
49296
|
+
* Immutable agent kind. general and personal require computer_id; service cannot bind a computer. Omit on create to infer from computer_id (general with a computer, service without). On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error. Assume agents use a durable computer driven over MCP without a conversation model; model, models, subagent_model, subagents and multiagent are forbidden and omitted.
|
|
47566
49297
|
*/
|
|
47567
|
-
kind?: 'general' | 'personal' | 'service';
|
|
49298
|
+
kind?: 'general' | 'personal' | 'service' | 'assume';
|
|
47568
49299
|
/**
|
|
47569
49300
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined.
|
|
47570
49301
|
*/
|
|
@@ -47948,7 +49679,7 @@ export type AgentsUpdateData = {
|
|
|
47948
49679
|
};
|
|
47949
49680
|
path: {
|
|
47950
49681
|
/**
|
|
47951
|
-
* Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name.
|
|
49682
|
+
* Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
47952
49683
|
*/
|
|
47953
49684
|
agent_id: string;
|
|
47954
49685
|
};
|
|
@@ -48007,7 +49738,7 @@ export type AgentsUpdateResponses = {
|
|
|
48007
49738
|
/**
|
|
48008
49739
|
* Model identifier and configuration.
|
|
48009
49740
|
*/
|
|
48010
|
-
model
|
|
49741
|
+
model?: {
|
|
48011
49742
|
/**
|
|
48012
49743
|
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
48013
49744
|
*/
|
|
@@ -48041,7 +49772,7 @@ export type AgentsUpdateResponses = {
|
|
|
48041
49772
|
/**
|
|
48042
49773
|
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
48043
49774
|
*/
|
|
48044
|
-
multiagent
|
|
49775
|
+
multiagent?: null | AgentManaged39;
|
|
48045
49776
|
/**
|
|
48046
49777
|
* Display name of the agent, as set on create or update. It is a label, not a unique key.
|
|
48047
49778
|
*/
|
|
@@ -48151,9 +49882,9 @@ export type AgentsUpdateResponses = {
|
|
|
48151
49882
|
enabled?: boolean;
|
|
48152
49883
|
}>;
|
|
48153
49884
|
/**
|
|
48154
|
-
* Immutable agent kind. general uses a durable computer and acts for its owner; personal behaves like general for now and is reserved for the personal agent; service uses a clean environment per session. Historical agents infer kind from their computer binding and read as general.
|
|
49885
|
+
* Immutable agent kind. general uses a durable computer and acts for its owner; personal behaves like general for now and is reserved for the personal agent; service uses a clean environment per session. Historical agents infer kind from their computer binding and read as general. Assume agents use a durable computer driven over MCP without a conversation model; model, models, subagent_model, subagents and multiagent are forbidden and omitted.
|
|
48155
49886
|
*/
|
|
48156
|
-
kind: 'general' | 'personal' | 'service';
|
|
49887
|
+
kind: 'general' | 'personal' | 'service' | 'assume';
|
|
48157
49888
|
/**
|
|
48158
49889
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined. Omitted when no computer is selected.
|
|
48159
49890
|
*/
|
|
@@ -48535,7 +50266,7 @@ export type AgentsUpdateResponses = {
|
|
|
48535
50266
|
*/
|
|
48536
50267
|
environment_id?: string | null;
|
|
48537
50268
|
/**
|
|
48538
|
-
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service agents
|
|
50269
|
+
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service and assume agents. Follows the version like other configuration: a version saved with apply=false does not change the vaults in effect. Versions saved before this field existed read as []. /agent/v1 only.
|
|
48539
50270
|
*/
|
|
48540
50271
|
vault_ids?: Array<string>;
|
|
48541
50272
|
/**
|
|
@@ -48549,7 +50280,7 @@ export type AgentsArchiveData = {
|
|
|
48549
50280
|
body?: never;
|
|
48550
50281
|
path: {
|
|
48551
50282
|
/**
|
|
48552
|
-
* Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name.
|
|
50283
|
+
* Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
48553
50284
|
*/
|
|
48554
50285
|
agent_id: string;
|
|
48555
50286
|
};
|
|
@@ -48600,7 +50331,7 @@ export type AgentsArchiveResponses = {
|
|
|
48600
50331
|
/**
|
|
48601
50332
|
* Model identifier and configuration.
|
|
48602
50333
|
*/
|
|
48603
|
-
model
|
|
50334
|
+
model?: {
|
|
48604
50335
|
/**
|
|
48605
50336
|
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
48606
50337
|
*/
|
|
@@ -48634,7 +50365,7 @@ export type AgentsArchiveResponses = {
|
|
|
48634
50365
|
/**
|
|
48635
50366
|
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
48636
50367
|
*/
|
|
48637
|
-
multiagent
|
|
50368
|
+
multiagent?: null | AgentManaged39;
|
|
48638
50369
|
/**
|
|
48639
50370
|
* Display name of the agent, as set on create or update. It is a label, not a unique key.
|
|
48640
50371
|
*/
|
|
@@ -48740,9 +50471,9 @@ export type AgentsArchiveResponses = {
|
|
|
48740
50471
|
enabled?: boolean;
|
|
48741
50472
|
}>;
|
|
48742
50473
|
/**
|
|
48743
|
-
* Immutable agent kind. general uses a durable computer and acts for its owner; personal behaves like general for now and is reserved for the personal agent; service uses a clean environment per session. Historical agents infer kind from their computer binding and read as general.
|
|
50474
|
+
* Immutable agent kind. general uses a durable computer and acts for its owner; personal behaves like general for now and is reserved for the personal agent; service uses a clean environment per session. Historical agents infer kind from their computer binding and read as general. Assume agents use a durable computer driven over MCP without a conversation model; model, models, subagent_model, subagents and multiagent are forbidden and omitted.
|
|
48744
50475
|
*/
|
|
48745
|
-
kind: 'general' | 'personal' | 'service';
|
|
50476
|
+
kind: 'general' | 'personal' | 'service' | 'assume';
|
|
48746
50477
|
/**
|
|
48747
50478
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined. Omitted when no computer is selected.
|
|
48748
50479
|
*/
|
|
@@ -49124,7 +50855,7 @@ export type AgentsArchiveResponses = {
|
|
|
49124
50855
|
*/
|
|
49125
50856
|
environment_id?: string | null;
|
|
49126
50857
|
/**
|
|
49127
|
-
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service agents
|
|
50858
|
+
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service and assume agents. Follows the version like other configuration: a version saved with apply=false does not change the vaults in effect. Versions saved before this field existed read as []. /agent/v1 only.
|
|
49128
50859
|
*/
|
|
49129
50860
|
vault_ids?: Array<string>;
|
|
49130
50861
|
/**
|
|
@@ -49138,7 +50869,7 @@ export type AgentsVersionsListData = {
|
|
|
49138
50869
|
body?: never;
|
|
49139
50870
|
path: {
|
|
49140
50871
|
/**
|
|
49141
|
-
* Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name.
|
|
50872
|
+
* Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….
|
|
49142
50873
|
*/
|
|
49143
50874
|
agent_id: string;
|
|
49144
50875
|
};
|
|
@@ -49203,7 +50934,7 @@ export type AgentsVersionsListResponses = {
|
|
|
49203
50934
|
/**
|
|
49204
50935
|
* Model identifier and configuration.
|
|
49205
50936
|
*/
|
|
49206
|
-
model
|
|
50937
|
+
model?: {
|
|
49207
50938
|
/**
|
|
49208
50939
|
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
49209
50940
|
*/
|
|
@@ -49237,7 +50968,7 @@ export type AgentsVersionsListResponses = {
|
|
|
49237
50968
|
/**
|
|
49238
50969
|
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
49239
50970
|
*/
|
|
49240
|
-
multiagent
|
|
50971
|
+
multiagent?: null | AgentManaged39;
|
|
49241
50972
|
/**
|
|
49242
50973
|
* Display name of the agent, as set on create or update. It is a label, not a unique key.
|
|
49243
50974
|
*/
|
|
@@ -49347,9 +51078,9 @@ export type AgentsVersionsListResponses = {
|
|
|
49347
51078
|
enabled?: boolean;
|
|
49348
51079
|
}>;
|
|
49349
51080
|
/**
|
|
49350
|
-
* Immutable agent kind. general uses a durable computer and acts for its owner; personal behaves like general for now and is reserved for the personal agent; service uses a clean environment per session. Historical agents infer kind from their computer binding and read as general.
|
|
51081
|
+
* Immutable agent kind. general uses a durable computer and acts for its owner; personal behaves like general for now and is reserved for the personal agent; service uses a clean environment per session. Historical agents infer kind from their computer binding and read as general. Assume agents use a durable computer driven over MCP without a conversation model; model, models, subagent_model, subagents and multiagent are forbidden and omitted.
|
|
49351
51082
|
*/
|
|
49352
|
-
kind: 'general' | 'personal' | 'service';
|
|
51083
|
+
kind: 'general' | 'personal' | 'service' | 'assume';
|
|
49353
51084
|
/**
|
|
49354
51085
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined. Omitted when no computer is selected.
|
|
49355
51086
|
*/
|
|
@@ -49731,7 +51462,7 @@ export type AgentsVersionsListResponses = {
|
|
|
49731
51462
|
*/
|
|
49732
51463
|
environment_id?: string | null;
|
|
49733
51464
|
/**
|
|
49734
|
-
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service agents
|
|
51465
|
+
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service and assume agents. Follows the version like other configuration: a version saved with apply=false does not change the vaults in effect. Versions saved before this field existed read as []. /agent/v1 only.
|
|
49735
51466
|
*/
|
|
49736
51467
|
vault_ids?: Array<string>;
|
|
49737
51468
|
/**
|
|
@@ -50138,7 +51869,7 @@ export type SessionsCreateData = {
|
|
|
50138
51869
|
};
|
|
50139
51870
|
export type SessionsCreateErrors = {
|
|
50140
51871
|
/**
|
|
50141
|
-
* The body failed validation and the message names the field: an unknown field, environment_id together with computer_id, a model or thinking selection the agent does not allow, an invalid budget or vault_ids, invalid initial_events, or an agent reference with an unsupported override.
|
|
51872
|
+
* The body failed validation and the message names the field: an unknown field, environment_id together with computer_id, a model or thinking selection the agent does not allow, an invalid budget or vault_ids, invalid initial_events, or an agent reference with an unsupported override, or an assume agent (use /agent/v1/agents/{id}/mcp; assume agents do not take sessions).
|
|
50142
51873
|
*/
|
|
50143
51874
|
400: AgentError;
|
|
50144
51875
|
/**
|
|
@@ -60140,6 +61871,1394 @@ export type AutomationHumanTasksDelegateResponses = {
|
|
|
60140
61871
|
200: AutomationHumanTask;
|
|
60141
61872
|
};
|
|
60142
61873
|
export type AutomationHumanTasksDelegateResponse = AutomationHumanTasksDelegateResponses[keyof AutomationHumanTasksDelegateResponses];
|
|
61874
|
+
export type CanvasListCanvasesData = {
|
|
61875
|
+
body?: never;
|
|
61876
|
+
path?: never;
|
|
61877
|
+
query?: {
|
|
61878
|
+
/**
|
|
61879
|
+
* Maximum canvases to return per page, from 1 to 100; defaults to 50 when omitted.
|
|
61880
|
+
*/
|
|
61881
|
+
limit?: number;
|
|
61882
|
+
/**
|
|
61883
|
+
* Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null.
|
|
61884
|
+
*/
|
|
61885
|
+
cursor?: string;
|
|
61886
|
+
};
|
|
61887
|
+
url: '/canvas/v1/canvases';
|
|
61888
|
+
};
|
|
61889
|
+
export type CanvasListCanvasesErrors = {
|
|
61890
|
+
/**
|
|
61891
|
+
* INVALID_PARAMS means a field, query value or identifier violates the documented format or range; correct the indicated input before retrying.
|
|
61892
|
+
*/
|
|
61893
|
+
400: CanvasCanvasError;
|
|
61894
|
+
/**
|
|
61895
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
61896
|
+
*/
|
|
61897
|
+
401: CanvasCanvasError;
|
|
61898
|
+
/**
|
|
61899
|
+
* The API key lacks permission for this operation; use a key with the required canvas access in the owning organization.
|
|
61900
|
+
*/
|
|
61901
|
+
403: CanvasCanvasError;
|
|
61902
|
+
/**
|
|
61903
|
+
* INTERNAL means the service could not complete the request; inspect the current canvas before retrying a write to avoid duplicating an already committed edit.
|
|
61904
|
+
*/
|
|
61905
|
+
500: CanvasCanvasError;
|
|
61906
|
+
};
|
|
61907
|
+
export type CanvasListCanvasesError = CanvasListCanvasesErrors[keyof CanvasListCanvasesErrors];
|
|
61908
|
+
export type CanvasListCanvasesResponses = {
|
|
61909
|
+
/**
|
|
61910
|
+
* One page of organization canvases, ordered by most recently updated first.
|
|
61911
|
+
*/
|
|
61912
|
+
200: CanvasCanvasPage;
|
|
61913
|
+
};
|
|
61914
|
+
export type CanvasListCanvasesResponse = CanvasListCanvasesResponses[keyof CanvasListCanvasesResponses];
|
|
61915
|
+
export type CanvasCreateCanvasData = {
|
|
61916
|
+
/**
|
|
61917
|
+
* Optional display name for the new canvas; omit the body or send an empty object to use Untitled.
|
|
61918
|
+
*/
|
|
61919
|
+
body?: CanvasCreateCanvasInput;
|
|
61920
|
+
path?: never;
|
|
61921
|
+
query?: never;
|
|
61922
|
+
url: '/canvas/v1/canvases';
|
|
61923
|
+
};
|
|
61924
|
+
export type CanvasCreateCanvasErrors = {
|
|
61925
|
+
/**
|
|
61926
|
+
* INVALID_PARAMS means a field, query value or identifier violates the documented format or range; correct the indicated input before retrying.
|
|
61927
|
+
*/
|
|
61928
|
+
400: CanvasCanvasError;
|
|
61929
|
+
/**
|
|
61930
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
61931
|
+
*/
|
|
61932
|
+
401: CanvasCanvasError;
|
|
61933
|
+
/**
|
|
61934
|
+
* The API key lacks permission for this operation; use a key with the required canvas access in the owning organization.
|
|
61935
|
+
*/
|
|
61936
|
+
403: CanvasCanvasError;
|
|
61937
|
+
/**
|
|
61938
|
+
* INTERNAL means the service could not complete the request; inspect the current canvas before retrying a write to avoid duplicating an already committed edit.
|
|
61939
|
+
*/
|
|
61940
|
+
500: CanvasCanvasError;
|
|
61941
|
+
};
|
|
61942
|
+
export type CanvasCreateCanvasError = CanvasCreateCanvasErrors[keyof CanvasCreateCanvasErrors];
|
|
61943
|
+
export type CanvasCreateCanvasResponses = {
|
|
61944
|
+
/**
|
|
61945
|
+
* The newly created canvas; use id for API calls and viewer_url to watch it in Console.
|
|
61946
|
+
*/
|
|
61947
|
+
201: CanvasCanvas;
|
|
61948
|
+
};
|
|
61949
|
+
export type CanvasCreateCanvasResponse = CanvasCreateCanvasResponses[keyof CanvasCreateCanvasResponses];
|
|
61950
|
+
export type CanvasDeleteCanvasData = {
|
|
61951
|
+
body?: never;
|
|
61952
|
+
path: {
|
|
61953
|
+
/**
|
|
61954
|
+
* Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted.
|
|
61955
|
+
*/
|
|
61956
|
+
canvas_id: string;
|
|
61957
|
+
};
|
|
61958
|
+
query?: never;
|
|
61959
|
+
url: '/canvas/v1/canvases/{canvas_id}';
|
|
61960
|
+
};
|
|
61961
|
+
export type CanvasDeleteCanvasErrors = {
|
|
61962
|
+
/**
|
|
61963
|
+
* INVALID_PARAMS means a field, query value or identifier violates the documented format or range; correct the indicated input before retrying.
|
|
61964
|
+
*/
|
|
61965
|
+
400: CanvasCanvasError;
|
|
61966
|
+
/**
|
|
61967
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
61968
|
+
*/
|
|
61969
|
+
401: CanvasCanvasError;
|
|
61970
|
+
/**
|
|
61971
|
+
* The API key lacks permission for this operation; use a key with the required canvas access in the owning organization.
|
|
61972
|
+
*/
|
|
61973
|
+
403: CanvasCanvasError;
|
|
61974
|
+
/**
|
|
61975
|
+
* CANVAS_NOT_FOUND means the canvas does not exist, was deleted or belongs to another organization; choose an accessible canvas id from list or create a new canvas.
|
|
61976
|
+
*/
|
|
61977
|
+
404: CanvasCanvasError;
|
|
61978
|
+
/**
|
|
61979
|
+
* INTERNAL means the service could not complete the request; inspect the current canvas before retrying a write to avoid duplicating an already committed edit.
|
|
61980
|
+
*/
|
|
61981
|
+
500: CanvasCanvasError;
|
|
61982
|
+
};
|
|
61983
|
+
export type CanvasDeleteCanvasError = CanvasDeleteCanvasErrors[keyof CanvasDeleteCanvasErrors];
|
|
61984
|
+
export type CanvasDeleteCanvasResponses = {
|
|
61985
|
+
/**
|
|
61986
|
+
* Confirmation that this canvas has been permanently deleted.
|
|
61987
|
+
*/
|
|
61988
|
+
200: CanvasDeletedCanvas;
|
|
61989
|
+
};
|
|
61990
|
+
export type CanvasDeleteCanvasResponse = CanvasDeleteCanvasResponses[keyof CanvasDeleteCanvasResponses];
|
|
61991
|
+
export type CanvasRetrieveCanvasData = {
|
|
61992
|
+
body?: never;
|
|
61993
|
+
path: {
|
|
61994
|
+
/**
|
|
61995
|
+
* Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted.
|
|
61996
|
+
*/
|
|
61997
|
+
canvas_id: string;
|
|
61998
|
+
};
|
|
61999
|
+
query?: never;
|
|
62000
|
+
url: '/canvas/v1/canvases/{canvas_id}';
|
|
62001
|
+
};
|
|
62002
|
+
export type CanvasRetrieveCanvasErrors = {
|
|
62003
|
+
/**
|
|
62004
|
+
* INVALID_PARAMS means a field, query value or identifier violates the documented format or range; correct the indicated input before retrying.
|
|
62005
|
+
*/
|
|
62006
|
+
400: CanvasCanvasError;
|
|
62007
|
+
/**
|
|
62008
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
62009
|
+
*/
|
|
62010
|
+
401: CanvasCanvasError;
|
|
62011
|
+
/**
|
|
62012
|
+
* The API key lacks permission for this operation; use a key with the required canvas access in the owning organization.
|
|
62013
|
+
*/
|
|
62014
|
+
403: CanvasCanvasError;
|
|
62015
|
+
/**
|
|
62016
|
+
* CANVAS_NOT_FOUND means the canvas does not exist, was deleted or belongs to another organization; choose an accessible canvas id from list or create a new canvas.
|
|
62017
|
+
*/
|
|
62018
|
+
404: CanvasCanvasError;
|
|
62019
|
+
/**
|
|
62020
|
+
* INTERNAL means the service could not complete the request; inspect the current canvas before retrying a write to avoid duplicating an already committed edit.
|
|
62021
|
+
*/
|
|
62022
|
+
500: CanvasCanvasError;
|
|
62023
|
+
};
|
|
62024
|
+
export type CanvasRetrieveCanvasError = CanvasRetrieveCanvasErrors[keyof CanvasRetrieveCanvasErrors];
|
|
62025
|
+
export type CanvasRetrieveCanvasResponses = {
|
|
62026
|
+
/**
|
|
62027
|
+
* Current canvas metadata, top-level frame summaries and reusable components.
|
|
62028
|
+
*/
|
|
62029
|
+
200: CanvasCanvasDetail;
|
|
62030
|
+
};
|
|
62031
|
+
export type CanvasRetrieveCanvasResponse = CanvasRetrieveCanvasResponses[keyof CanvasRetrieveCanvasResponses];
|
|
62032
|
+
export type CanvasListNodesData = {
|
|
62033
|
+
body?: never;
|
|
62034
|
+
path: {
|
|
62035
|
+
/**
|
|
62036
|
+
* Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted.
|
|
62037
|
+
*/
|
|
62038
|
+
canvas_id: string;
|
|
62039
|
+
};
|
|
62040
|
+
query: {
|
|
62041
|
+
/**
|
|
62042
|
+
* Comma-separated list of 1–100 node ids from retrieve or execute, or instance paths such as a/b; missing ids map to null.
|
|
62043
|
+
*/
|
|
62044
|
+
ids: string;
|
|
62045
|
+
/**
|
|
62046
|
+
* Maximum child depth below each requested node, as an integer at least 0; 0 returns the node without descendants, and omission returns the complete subtree.
|
|
62047
|
+
*/
|
|
62048
|
+
depth?: number;
|
|
62049
|
+
};
|
|
62050
|
+
url: '/canvas/v1/canvases/{canvas_id}/nodes';
|
|
62051
|
+
};
|
|
62052
|
+
export type CanvasListNodesErrors = {
|
|
62053
|
+
/**
|
|
62054
|
+
* INVALID_PARAMS means a field, query value or identifier violates the documented format or range; correct the indicated input before retrying.
|
|
62055
|
+
*/
|
|
62056
|
+
400: CanvasCanvasError;
|
|
62057
|
+
/**
|
|
62058
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
62059
|
+
*/
|
|
62060
|
+
401: CanvasCanvasError;
|
|
62061
|
+
/**
|
|
62062
|
+
* The API key lacks permission for this operation; use a key with the required canvas access in the owning organization.
|
|
62063
|
+
*/
|
|
62064
|
+
403: CanvasCanvasError;
|
|
62065
|
+
/**
|
|
62066
|
+
* CANVAS_NOT_FOUND means the canvas does not exist, was deleted or belongs to another organization; choose an accessible canvas id from list or create a new canvas.
|
|
62067
|
+
*/
|
|
62068
|
+
404: CanvasCanvasError;
|
|
62069
|
+
/**
|
|
62070
|
+
* INTERNAL means the service could not complete the request; inspect the current canvas before retrying a write to avoid duplicating an already committed edit.
|
|
62071
|
+
*/
|
|
62072
|
+
500: CanvasCanvasError;
|
|
62073
|
+
};
|
|
62074
|
+
export type CanvasListNodesError = CanvasListNodesErrors[keyof CanvasListNodesErrors];
|
|
62075
|
+
export type CanvasListNodesResponses = {
|
|
62076
|
+
/**
|
|
62077
|
+
* Current revision and requested node documents; absent ids map to null rather than failing the request.
|
|
62078
|
+
*/
|
|
62079
|
+
200: CanvasNodesResult;
|
|
62080
|
+
};
|
|
62081
|
+
export type CanvasListNodesResponse = CanvasListNodesResponses[keyof CanvasListNodesResponses];
|
|
62082
|
+
export type CanvasListImagesData = {
|
|
62083
|
+
body?: never;
|
|
62084
|
+
path: {
|
|
62085
|
+
/**
|
|
62086
|
+
* Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted.
|
|
62087
|
+
*/
|
|
62088
|
+
canvas_id: string;
|
|
62089
|
+
};
|
|
62090
|
+
query: {
|
|
62091
|
+
/**
|
|
62092
|
+
* Comma-separated list of 1–4 node ids to render, from retrieve, execute.created or execute.screenshots.
|
|
62093
|
+
*/
|
|
62094
|
+
ids: string;
|
|
62095
|
+
/**
|
|
62096
|
+
* Output pixel scale relative to canvas dimensions, from 0.25 to 4 inclusive; defaults to 1 when omitted.
|
|
62097
|
+
*/
|
|
62098
|
+
scale?: number;
|
|
62099
|
+
/**
|
|
62100
|
+
* Image encoding; png produces a PNG data URL and is the only supported value. Omit to use png.
|
|
62101
|
+
*/
|
|
62102
|
+
format?: 'png';
|
|
62103
|
+
};
|
|
62104
|
+
url: '/canvas/v1/canvases/{canvas_id}/images';
|
|
62105
|
+
};
|
|
62106
|
+
export type CanvasListImagesErrors = {
|
|
62107
|
+
/**
|
|
62108
|
+
* INVALID_PARAMS means a field, query value or identifier violates the documented format or range; correct the indicated input before retrying.
|
|
62109
|
+
*/
|
|
62110
|
+
400: CanvasCanvasError;
|
|
62111
|
+
/**
|
|
62112
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
62113
|
+
*/
|
|
62114
|
+
401: CanvasCanvasError;
|
|
62115
|
+
/**
|
|
62116
|
+
* The API key lacks permission for this operation; use a key with the required canvas access in the owning organization.
|
|
62117
|
+
*/
|
|
62118
|
+
403: CanvasCanvasError;
|
|
62119
|
+
/**
|
|
62120
|
+
* CANVAS_NOT_FOUND means the canvas does not exist, was deleted or belongs to another organization; choose an accessible canvas id from list or create a new canvas.
|
|
62121
|
+
*/
|
|
62122
|
+
404: CanvasCanvasError;
|
|
62123
|
+
/**
|
|
62124
|
+
* INTERNAL means the service could not complete the request; inspect the current canvas before retrying a write to avoid duplicating an already committed edit.
|
|
62125
|
+
*/
|
|
62126
|
+
500: CanvasCanvasError;
|
|
62127
|
+
/**
|
|
62128
|
+
* RENDER_FAILED occurs when rendering cannot complete; retry the render later, using nodes.list to inspect the design in the meantime.
|
|
62129
|
+
*/
|
|
62130
|
+
503: CanvasCanvasError;
|
|
62131
|
+
};
|
|
62132
|
+
export type CanvasListImagesError = CanvasListImagesErrors[keyof CanvasListImagesErrors];
|
|
62133
|
+
export type CanvasListImagesResponses = {
|
|
62134
|
+
/**
|
|
62135
|
+
* A node-id-to-PNG-data-URL map, with err=null; individual unavailable images have null values.
|
|
62136
|
+
*/
|
|
62137
|
+
200: CanvasImagesResult;
|
|
62138
|
+
};
|
|
62139
|
+
export type CanvasListImagesResponse = CanvasListImagesResponses[keyof CanvasListImagesResponses];
|
|
62140
|
+
export type CanvasExecuteData = {
|
|
62141
|
+
/**
|
|
62142
|
+
* Either new script source or the edit_id of a failed script with replacement edits; expected_version optionally guards against concurrent changes.
|
|
62143
|
+
*/
|
|
62144
|
+
body: CanvasExecuteInput;
|
|
62145
|
+
path: {
|
|
62146
|
+
/**
|
|
62147
|
+
* Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted.
|
|
62148
|
+
*/
|
|
62149
|
+
canvas_id: string;
|
|
62150
|
+
};
|
|
62151
|
+
query?: never;
|
|
62152
|
+
url: '/canvas/v1/canvases/{canvas_id}:execute';
|
|
62153
|
+
};
|
|
62154
|
+
export type CanvasExecuteErrors = {
|
|
62155
|
+
/**
|
|
62156
|
+
* INVALID_PARAMS: script and edit_id are not exclusive or fields violate constraints; correct the request. SCRIPT_ERROR, SCRIPT_LIMIT or OPS_REJECTED: execution failed and all writes rolled back; patch the saved source with details.edit_id and edits, using line, column or rejection if supplied. EDIT_EXPIRED: edit_id is older than ten minutes; submit a corrected new script.
|
|
62157
|
+
*/
|
|
62158
|
+
400: CanvasCanvasError;
|
|
62159
|
+
/**
|
|
62160
|
+
* The bearer API key is missing or invalid; provide a valid Praxis API key before retrying.
|
|
62161
|
+
*/
|
|
62162
|
+
401: CanvasCanvasError;
|
|
62163
|
+
/**
|
|
62164
|
+
* The API key lacks permission for this operation; use a key with the required canvas access in the owning organization.
|
|
62165
|
+
*/
|
|
62166
|
+
403: CanvasCanvasError;
|
|
62167
|
+
/**
|
|
62168
|
+
* CANVAS_NOT_FOUND means the canvas is missing, deleted or outside your organization; select an id from list. NODE_NOT_FOUND means a script targets a missing node; retrieve current frames or nodes and correct the node reference before retrying.
|
|
62169
|
+
*/
|
|
62170
|
+
404: CanvasCanvasError;
|
|
62171
|
+
/**
|
|
62172
|
+
* REVISION_CONFLICT means expected_version differs from the current revision in error.details.version; retrieve the latest canvas, merge concurrent changes and retry with that version.
|
|
62173
|
+
*/
|
|
62174
|
+
409: CanvasCanvasError;
|
|
62175
|
+
/**
|
|
62176
|
+
* CANVAS_BUSY means the same canvas has more than four calls queued; wait for pending work to finish before retrying.
|
|
62177
|
+
*/
|
|
62178
|
+
429: CanvasCanvasError;
|
|
62179
|
+
/**
|
|
62180
|
+
* INTERNAL means the service could not complete the request; inspect the current canvas before retrying a write to avoid duplicating an already committed edit.
|
|
62181
|
+
*/
|
|
62182
|
+
500: CanvasCanvasError;
|
|
62183
|
+
};
|
|
62184
|
+
export type CanvasExecuteError = CanvasExecuteErrors[keyof CanvasExecuteErrors];
|
|
62185
|
+
export type CanvasExecuteResponses = {
|
|
62186
|
+
/**
|
|
62187
|
+
* Committed revision, operation results and viewer URL; screenshots contains node ids to pass to images.list.
|
|
62188
|
+
*/
|
|
62189
|
+
200: CanvasExecuteResult;
|
|
62190
|
+
};
|
|
62191
|
+
export type CanvasExecuteResponse = CanvasExecuteResponses[keyof CanvasExecuteResponses];
|
|
62192
|
+
export type CutListProjectsData = {
|
|
62193
|
+
body?: never;
|
|
62194
|
+
path?: never;
|
|
62195
|
+
query?: {
|
|
62196
|
+
/**
|
|
62197
|
+
* Maximum resources in one page, from 1 to 100; defaults to 50.
|
|
62198
|
+
*/
|
|
62199
|
+
page_size?: number;
|
|
62200
|
+
/**
|
|
62201
|
+
* Opaque next_page_token from the preceding page; omit on the first request.
|
|
62202
|
+
*/
|
|
62203
|
+
page_token?: string;
|
|
62204
|
+
/**
|
|
62205
|
+
* Optional resource filter; projects supports state = "active" or state = "deleted".
|
|
62206
|
+
*/
|
|
62207
|
+
filter?: string;
|
|
62208
|
+
/**
|
|
62209
|
+
* Optional ordering expression; projects supports updateTime desc.
|
|
62210
|
+
*/
|
|
62211
|
+
order_by?: string;
|
|
62212
|
+
};
|
|
62213
|
+
url: '/cut/v1/projects';
|
|
62214
|
+
};
|
|
62215
|
+
export type CutListProjectsErrors = {
|
|
62216
|
+
/**
|
|
62217
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
62218
|
+
*/
|
|
62219
|
+
400: CutCutError;
|
|
62220
|
+
/**
|
|
62221
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62222
|
+
*/
|
|
62223
|
+
401: CutCutError;
|
|
62224
|
+
/**
|
|
62225
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
62226
|
+
*/
|
|
62227
|
+
403: CutCutError;
|
|
62228
|
+
/**
|
|
62229
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
62230
|
+
*/
|
|
62231
|
+
500: CutCutError;
|
|
62232
|
+
};
|
|
62233
|
+
export type CutListProjectsError = CutListProjectsErrors[keyof CutListProjectsErrors];
|
|
62234
|
+
export type CutListProjectsResponses = {
|
|
62235
|
+
/**
|
|
62236
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
62237
|
+
*/
|
|
62238
|
+
200: CutProjectPage;
|
|
62239
|
+
};
|
|
62240
|
+
export type CutListProjectsResponse = CutListProjectsResponses[keyof CutListProjectsResponses];
|
|
62241
|
+
export type CutCreateProjectData = {
|
|
62242
|
+
/**
|
|
62243
|
+
* Create a blank project bound to the media libraries it may use.
|
|
62244
|
+
*/
|
|
62245
|
+
body: CutCreateProjectInput;
|
|
62246
|
+
path?: never;
|
|
62247
|
+
query?: never;
|
|
62248
|
+
url: '/cut/v1/projects';
|
|
62249
|
+
};
|
|
62250
|
+
export type CutCreateProjectErrors = {
|
|
62251
|
+
/**
|
|
62252
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
62253
|
+
*/
|
|
62254
|
+
400: CutCutError;
|
|
62255
|
+
/**
|
|
62256
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62257
|
+
*/
|
|
62258
|
+
401: CutCutError;
|
|
62259
|
+
/**
|
|
62260
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
62261
|
+
*/
|
|
62262
|
+
403: CutCutError;
|
|
62263
|
+
/**
|
|
62264
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
62265
|
+
*/
|
|
62266
|
+
404: CutCutError;
|
|
62267
|
+
/**
|
|
62268
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
62269
|
+
*/
|
|
62270
|
+
500: CutCutError;
|
|
62271
|
+
};
|
|
62272
|
+
export type CutCreateProjectError = CutCreateProjectErrors[keyof CutCreateProjectErrors];
|
|
62273
|
+
export type CutCreateProjectResponses = {
|
|
62274
|
+
/**
|
|
62275
|
+
* New resource; save its id for subsequent calls.
|
|
62276
|
+
*/
|
|
62277
|
+
201: CutProject;
|
|
62278
|
+
};
|
|
62279
|
+
export type CutCreateProjectResponse = CutCreateProjectResponses[keyof CutCreateProjectResponses];
|
|
62280
|
+
export type CutDeleteProjectData = {
|
|
62281
|
+
body?: never;
|
|
62282
|
+
path: {
|
|
62283
|
+
/**
|
|
62284
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
62285
|
+
*/
|
|
62286
|
+
project_id: string;
|
|
62287
|
+
};
|
|
62288
|
+
query?: never;
|
|
62289
|
+
url: '/cut/v1/projects/{project_id}';
|
|
62290
|
+
};
|
|
62291
|
+
export type CutDeleteProjectErrors = {
|
|
62292
|
+
/**
|
|
62293
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
62294
|
+
*/
|
|
62295
|
+
400: CutCutError;
|
|
62296
|
+
/**
|
|
62297
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62298
|
+
*/
|
|
62299
|
+
401: CutCutError;
|
|
62300
|
+
/**
|
|
62301
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
62302
|
+
*/
|
|
62303
|
+
403: CutCutError;
|
|
62304
|
+
/**
|
|
62305
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
62306
|
+
*/
|
|
62307
|
+
404: CutCutError;
|
|
62308
|
+
/**
|
|
62309
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
62310
|
+
*/
|
|
62311
|
+
500: CutCutError;
|
|
62312
|
+
};
|
|
62313
|
+
export type CutDeleteProjectError = CutDeleteProjectErrors[keyof CutDeleteProjectErrors];
|
|
62314
|
+
export type CutDeleteProjectResponses = {
|
|
62315
|
+
/**
|
|
62316
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
62317
|
+
*/
|
|
62318
|
+
200: CutProject;
|
|
62319
|
+
};
|
|
62320
|
+
export type CutDeleteProjectResponse = CutDeleteProjectResponses[keyof CutDeleteProjectResponses];
|
|
62321
|
+
export type CutRetrieveProjectData = {
|
|
62322
|
+
body?: never;
|
|
62323
|
+
path: {
|
|
62324
|
+
/**
|
|
62325
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
62326
|
+
*/
|
|
62327
|
+
project_id: string;
|
|
62328
|
+
};
|
|
62329
|
+
query?: {
|
|
62330
|
+
/**
|
|
62331
|
+
* Comma-separated expansions: timeline includes clips, exports includes render jobs, versions includes saved snapshots.
|
|
62332
|
+
*/
|
|
62333
|
+
expand?: string;
|
|
62334
|
+
};
|
|
62335
|
+
url: '/cut/v1/projects/{project_id}';
|
|
62336
|
+
};
|
|
62337
|
+
export type CutRetrieveProjectErrors = {
|
|
62338
|
+
/**
|
|
62339
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
62340
|
+
*/
|
|
62341
|
+
400: CutCutError;
|
|
62342
|
+
/**
|
|
62343
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62344
|
+
*/
|
|
62345
|
+
401: CutCutError;
|
|
62346
|
+
/**
|
|
62347
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
62348
|
+
*/
|
|
62349
|
+
403: CutCutError;
|
|
62350
|
+
/**
|
|
62351
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
62352
|
+
*/
|
|
62353
|
+
404: CutCutError;
|
|
62354
|
+
/**
|
|
62355
|
+
* PROJECT_TOO_LARGE or RESPONSE_TOO_LARGE means an edit or response exceeds its size limit; reduce the edit batch or narrow the requested timeline range.
|
|
62356
|
+
*/
|
|
62357
|
+
413: CutCutError;
|
|
62358
|
+
/**
|
|
62359
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
62360
|
+
*/
|
|
62361
|
+
500: CutCutError;
|
|
62362
|
+
};
|
|
62363
|
+
export type CutRetrieveProjectError = CutRetrieveProjectErrors[keyof CutRetrieveProjectErrors];
|
|
62364
|
+
export type CutRetrieveProjectResponses = {
|
|
62365
|
+
/**
|
|
62366
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
62367
|
+
*/
|
|
62368
|
+
200: CutProjectDetail;
|
|
62369
|
+
};
|
|
62370
|
+
export type CutRetrieveProjectResponse = CutRetrieveProjectResponses[keyof CutRetrieveProjectResponses];
|
|
62371
|
+
export type CutUpdateProjectData = {
|
|
62372
|
+
/**
|
|
62373
|
+
* Update only the named project metadata fields; timeline edits use execute.
|
|
62374
|
+
*/
|
|
62375
|
+
body: CutUpdateProjectInput;
|
|
62376
|
+
path: {
|
|
62377
|
+
/**
|
|
62378
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
62379
|
+
*/
|
|
62380
|
+
project_id: string;
|
|
62381
|
+
};
|
|
62382
|
+
query?: never;
|
|
62383
|
+
url: '/cut/v1/projects/{project_id}';
|
|
62384
|
+
};
|
|
62385
|
+
export type CutUpdateProjectErrors = {
|
|
62386
|
+
/**
|
|
62387
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
62388
|
+
*/
|
|
62389
|
+
400: CutCutError;
|
|
62390
|
+
/**
|
|
62391
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62392
|
+
*/
|
|
62393
|
+
401: CutCutError;
|
|
62394
|
+
/**
|
|
62395
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
62396
|
+
*/
|
|
62397
|
+
403: CutCutError;
|
|
62398
|
+
/**
|
|
62399
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
62400
|
+
*/
|
|
62401
|
+
404: CutCutError;
|
|
62402
|
+
/**
|
|
62403
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
62404
|
+
*/
|
|
62405
|
+
500: CutCutError;
|
|
62406
|
+
};
|
|
62407
|
+
export type CutUpdateProjectError = CutUpdateProjectErrors[keyof CutUpdateProjectErrors];
|
|
62408
|
+
export type CutUpdateProjectResponses = {
|
|
62409
|
+
/**
|
|
62410
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
62411
|
+
*/
|
|
62412
|
+
200: CutProject;
|
|
62413
|
+
};
|
|
62414
|
+
export type CutUpdateProjectResponse = CutUpdateProjectResponses[keyof CutUpdateProjectResponses];
|
|
62415
|
+
export type CutUndeleteProjectData = {
|
|
62416
|
+
body?: never;
|
|
62417
|
+
path: {
|
|
62418
|
+
/**
|
|
62419
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
62420
|
+
*/
|
|
62421
|
+
project_id: string;
|
|
62422
|
+
};
|
|
62423
|
+
query?: never;
|
|
62424
|
+
url: '/cut/v1/projects/{project_id}:undelete';
|
|
62425
|
+
};
|
|
62426
|
+
export type CutUndeleteProjectErrors = {
|
|
62427
|
+
/**
|
|
62428
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
62429
|
+
*/
|
|
62430
|
+
400: CutCutError;
|
|
62431
|
+
/**
|
|
62432
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62433
|
+
*/
|
|
62434
|
+
401: CutCutError;
|
|
62435
|
+
/**
|
|
62436
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
62437
|
+
*/
|
|
62438
|
+
403: CutCutError;
|
|
62439
|
+
/**
|
|
62440
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
62441
|
+
*/
|
|
62442
|
+
404: CutCutError;
|
|
62443
|
+
/**
|
|
62444
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
62445
|
+
*/
|
|
62446
|
+
500: CutCutError;
|
|
62447
|
+
};
|
|
62448
|
+
export type CutUndeleteProjectError = CutUndeleteProjectErrors[keyof CutUndeleteProjectErrors];
|
|
62449
|
+
export type CutUndeleteProjectResponses = {
|
|
62450
|
+
/**
|
|
62451
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
62452
|
+
*/
|
|
62453
|
+
200: CutProject;
|
|
62454
|
+
};
|
|
62455
|
+
export type CutUndeleteProjectResponse = CutUndeleteProjectResponses[keyof CutUndeleteProjectResponses];
|
|
62456
|
+
export type CutExecuteData = {
|
|
62457
|
+
/**
|
|
62458
|
+
* Submit new synchronous source or patch a saved failed script; script and edit_id are exclusive.
|
|
62459
|
+
*/
|
|
62460
|
+
body: CutExecuteInput;
|
|
62461
|
+
path: {
|
|
62462
|
+
/**
|
|
62463
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
62464
|
+
*/
|
|
62465
|
+
project_id: string;
|
|
62466
|
+
};
|
|
62467
|
+
query?: never;
|
|
62468
|
+
url: '/cut/v1/projects/{project_id}:execute';
|
|
62469
|
+
};
|
|
62470
|
+
export type CutExecuteErrors = {
|
|
62471
|
+
/**
|
|
62472
|
+
* SCRIPT_ERROR, SCRIPT_LIMIT or OPS_REJECTED means the script failed and its writes rolled back; correct the source using error.details.edit_id and edits when provided. EDIT_EXPIRED means the saved source is older than ten minutes; resubmit corrected script source.
|
|
62473
|
+
*/
|
|
62474
|
+
400: CutCutError;
|
|
62475
|
+
/**
|
|
62476
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62477
|
+
*/
|
|
62478
|
+
401: CutCutError;
|
|
62479
|
+
/**
|
|
62480
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
62481
|
+
*/
|
|
62482
|
+
403: CutCutError;
|
|
62483
|
+
/**
|
|
62484
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
62485
|
+
*/
|
|
62486
|
+
404: CutCutError;
|
|
62487
|
+
/**
|
|
62488
|
+
* REVISION_CONFLICT means the project changed since expected_revision or while preparing the second-based response; retrieve the current state and inspect whether a write committed before retrying, then merge concurrent edits.
|
|
62489
|
+
*/
|
|
62490
|
+
409: CutCutError;
|
|
62491
|
+
/**
|
|
62492
|
+
* PROJECT_TOO_LARGE or RESPONSE_TOO_LARGE means an edit or response exceeds its size limit; reduce the edit batch or narrow the requested timeline range.
|
|
62493
|
+
*/
|
|
62494
|
+
413: CutCutError;
|
|
62495
|
+
/**
|
|
62496
|
+
* CUT_BUSY means too much work is queued for this project; let pending work complete before retrying.
|
|
62497
|
+
*/
|
|
62498
|
+
429: CutCutError;
|
|
62499
|
+
/**
|
|
62500
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
62501
|
+
*/
|
|
62502
|
+
500: CutCutError;
|
|
62503
|
+
/**
|
|
62504
|
+
* MEDIA_OFFLINE, MEDIA_UNAVAILABLE, MEDIA_IMPORT_FAILED or EXPORT_FAILED means required media or rendering could not complete; inspect source availability or the export error before retrying.
|
|
62505
|
+
*/
|
|
62506
|
+
503: CutCutError;
|
|
62507
|
+
};
|
|
62508
|
+
export type CutExecuteError = CutExecuteErrors[keyof CutExecuteErrors];
|
|
62509
|
+
export type CutExecuteResponses = {
|
|
62510
|
+
/**
|
|
62511
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
62512
|
+
*/
|
|
62513
|
+
200: CutExecuteResult;
|
|
62514
|
+
};
|
|
62515
|
+
export type CutExecuteResponse = CutExecuteResponses[keyof CutExecuteResponses];
|
|
62516
|
+
export type CutRetrieveStateData = {
|
|
62517
|
+
body?: never;
|
|
62518
|
+
path: {
|
|
62519
|
+
/**
|
|
62520
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
62521
|
+
*/
|
|
62522
|
+
project_id: string;
|
|
62523
|
+
};
|
|
62524
|
+
query?: never;
|
|
62525
|
+
url: '/cut/v1/projects/{project_id}/state';
|
|
62526
|
+
};
|
|
62527
|
+
export type CutRetrieveStateErrors = {
|
|
62528
|
+
/**
|
|
62529
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
62530
|
+
*/
|
|
62531
|
+
400: CutCutError;
|
|
62532
|
+
/**
|
|
62533
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62534
|
+
*/
|
|
62535
|
+
401: CutCutError;
|
|
62536
|
+
/**
|
|
62537
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
62538
|
+
*/
|
|
62539
|
+
403: CutCutError;
|
|
62540
|
+
/**
|
|
62541
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
62542
|
+
*/
|
|
62543
|
+
404: CutCutError;
|
|
62544
|
+
/**
|
|
62545
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
62546
|
+
*/
|
|
62547
|
+
500: CutCutError;
|
|
62548
|
+
};
|
|
62549
|
+
export type CutRetrieveStateError = CutRetrieveStateErrors[keyof CutRetrieveStateErrors];
|
|
62550
|
+
export type CutRetrieveStateResponses = {
|
|
62551
|
+
/**
|
|
62552
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
62553
|
+
*/
|
|
62554
|
+
200: CutState;
|
|
62555
|
+
};
|
|
62556
|
+
export type CutRetrieveStateResponse = CutRetrieveStateResponses[keyof CutRetrieveStateResponses];
|
|
62557
|
+
export type CutRetrieveTimelineData = {
|
|
62558
|
+
body?: never;
|
|
62559
|
+
path: {
|
|
62560
|
+
/**
|
|
62561
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
62562
|
+
*/
|
|
62563
|
+
project_id: string;
|
|
62564
|
+
};
|
|
62565
|
+
query?: {
|
|
62566
|
+
/**
|
|
62567
|
+
* full returns structured clips; compact returns compact textual editing context.
|
|
62568
|
+
*/
|
|
62569
|
+
view?: 'full' | 'compact';
|
|
62570
|
+
/**
|
|
62571
|
+
* Optional start of the selected project range in seconds; omit for the beginning.
|
|
62572
|
+
*/
|
|
62573
|
+
from?: number;
|
|
62574
|
+
/**
|
|
62575
|
+
* Optional end of the selected project range in seconds; omit for the end.
|
|
62576
|
+
*/
|
|
62577
|
+
to?: number;
|
|
62578
|
+
/**
|
|
62579
|
+
* Comma-separated track ids from state to include; omit to include every track.
|
|
62580
|
+
*/
|
|
62581
|
+
tracks?: string;
|
|
62582
|
+
};
|
|
62583
|
+
url: '/cut/v1/projects/{project_id}/timeline';
|
|
62584
|
+
};
|
|
62585
|
+
export type CutRetrieveTimelineErrors = {
|
|
62586
|
+
/**
|
|
62587
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
62588
|
+
*/
|
|
62589
|
+
400: CutCutError;
|
|
62590
|
+
/**
|
|
62591
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62592
|
+
*/
|
|
62593
|
+
401: CutCutError;
|
|
62594
|
+
/**
|
|
62595
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
62596
|
+
*/
|
|
62597
|
+
403: CutCutError;
|
|
62598
|
+
/**
|
|
62599
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
62600
|
+
*/
|
|
62601
|
+
404: CutCutError;
|
|
62602
|
+
/**
|
|
62603
|
+
* REVISION_CONFLICT means the project changed since expected_revision or while preparing the second-based response; retrieve the current state and inspect whether a write committed before retrying, then merge concurrent edits.
|
|
62604
|
+
*/
|
|
62605
|
+
409: CutCutError;
|
|
62606
|
+
/**
|
|
62607
|
+
* PROJECT_TOO_LARGE or RESPONSE_TOO_LARGE means an edit or response exceeds its size limit; reduce the edit batch or narrow the requested timeline range.
|
|
62608
|
+
*/
|
|
62609
|
+
413: CutCutError;
|
|
62610
|
+
/**
|
|
62611
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
62612
|
+
*/
|
|
62613
|
+
500: CutCutError;
|
|
62614
|
+
};
|
|
62615
|
+
export type CutRetrieveTimelineError = CutRetrieveTimelineErrors[keyof CutRetrieveTimelineErrors];
|
|
62616
|
+
export type CutRetrieveTimelineResponses = {
|
|
62617
|
+
/**
|
|
62618
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
62619
|
+
*/
|
|
62620
|
+
200: CutTimelineResult;
|
|
62621
|
+
};
|
|
62622
|
+
export type CutRetrieveTimelineResponse = CutRetrieveTimelineResponses[keyof CutRetrieveTimelineResponses];
|
|
62623
|
+
export type CutListFramesData = {
|
|
62624
|
+
body?: never;
|
|
62625
|
+
path: {
|
|
62626
|
+
/**
|
|
62627
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
62628
|
+
*/
|
|
62629
|
+
project_id: string;
|
|
62630
|
+
};
|
|
62631
|
+
query: {
|
|
62632
|
+
/**
|
|
62633
|
+
* Required comma-separated non-negative project times in seconds, for example 12,15.5.
|
|
62634
|
+
*/
|
|
62635
|
+
at: string;
|
|
62636
|
+
/**
|
|
62637
|
+
* Positive image size multiplier; 0.5 renders at half the project dimensions.
|
|
62638
|
+
*/
|
|
62639
|
+
scale?: number;
|
|
62640
|
+
/**
|
|
62641
|
+
* Committed project revision from retrieve, state, timeline or execute; increases after each successful write.
|
|
62642
|
+
*/
|
|
62643
|
+
revision?: number;
|
|
62644
|
+
};
|
|
62645
|
+
url: '/cut/v1/projects/{project_id}/frames';
|
|
62646
|
+
};
|
|
62647
|
+
export type CutListFramesErrors = {
|
|
62648
|
+
/**
|
|
62649
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
62650
|
+
*/
|
|
62651
|
+
400: CutCutError;
|
|
62652
|
+
/**
|
|
62653
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62654
|
+
*/
|
|
62655
|
+
401: CutCutError;
|
|
62656
|
+
/**
|
|
62657
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
62658
|
+
*/
|
|
62659
|
+
403: CutCutError;
|
|
62660
|
+
/**
|
|
62661
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
62662
|
+
*/
|
|
62663
|
+
404: CutCutError;
|
|
62664
|
+
/**
|
|
62665
|
+
* PROJECT_TOO_LARGE or RESPONSE_TOO_LARGE means an edit or response exceeds its size limit; reduce the edit batch or narrow the requested timeline range.
|
|
62666
|
+
*/
|
|
62667
|
+
413: CutCutError;
|
|
62668
|
+
/**
|
|
62669
|
+
* CUT_BUSY means too much work is queued for this project; let pending work complete before retrying.
|
|
62670
|
+
*/
|
|
62671
|
+
429: CutCutError;
|
|
62672
|
+
/**
|
|
62673
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
62674
|
+
*/
|
|
62675
|
+
500: CutCutError;
|
|
62676
|
+
/**
|
|
62677
|
+
* MEDIA_OFFLINE, MEDIA_UNAVAILABLE, MEDIA_IMPORT_FAILED or EXPORT_FAILED means required media or rendering could not complete; inspect source availability or the export error before retrying.
|
|
62678
|
+
*/
|
|
62679
|
+
503: CutCutError;
|
|
62680
|
+
};
|
|
62681
|
+
export type CutListFramesError = CutListFramesErrors[keyof CutListFramesErrors];
|
|
62682
|
+
export type CutListFramesResponses = {
|
|
62683
|
+
/**
|
|
62684
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
62685
|
+
*/
|
|
62686
|
+
200: CutFramesResult;
|
|
62687
|
+
};
|
|
62688
|
+
export type CutListFramesResponse = CutListFramesResponses[keyof CutListFramesResponses];
|
|
62689
|
+
export type CutCreateAnalysisData = {
|
|
62690
|
+
/**
|
|
62691
|
+
* Select analysis kinds and optionally limit source assets.
|
|
62692
|
+
*/
|
|
62693
|
+
body: CutAnalysisInput;
|
|
62694
|
+
path: {
|
|
62695
|
+
/**
|
|
62696
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
62697
|
+
*/
|
|
62698
|
+
project_id: string;
|
|
62699
|
+
};
|
|
62700
|
+
query?: never;
|
|
62701
|
+
url: '/cut/v1/projects/{project_id}/analysis';
|
|
62702
|
+
};
|
|
62703
|
+
export type CutCreateAnalysisErrors = {
|
|
62704
|
+
/**
|
|
62705
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
62706
|
+
*/
|
|
62707
|
+
400: CutCutError;
|
|
62708
|
+
/**
|
|
62709
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62710
|
+
*/
|
|
62711
|
+
401: CutCutError;
|
|
62712
|
+
/**
|
|
62713
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
62714
|
+
*/
|
|
62715
|
+
403: CutCutError;
|
|
62716
|
+
/**
|
|
62717
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
62718
|
+
*/
|
|
62719
|
+
404: CutCutError;
|
|
62720
|
+
/**
|
|
62721
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
62722
|
+
*/
|
|
62723
|
+
500: CutCutError;
|
|
62724
|
+
/**
|
|
62725
|
+
* MEDIA_OFFLINE, MEDIA_UNAVAILABLE, MEDIA_IMPORT_FAILED or EXPORT_FAILED means required media or rendering could not complete; inspect source availability or the export error before retrying.
|
|
62726
|
+
*/
|
|
62727
|
+
503: CutCutError;
|
|
62728
|
+
};
|
|
62729
|
+
export type CutCreateAnalysisError = CutCreateAnalysisErrors[keyof CutCreateAnalysisErrors];
|
|
62730
|
+
export type CutCreateAnalysisResponses = {
|
|
62731
|
+
/**
|
|
62732
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
62733
|
+
*/
|
|
62734
|
+
200: CutAnalysisResult;
|
|
62735
|
+
};
|
|
62736
|
+
export type CutCreateAnalysisResponse = CutCreateAnalysisResponses[keyof CutCreateAnalysisResponses];
|
|
62737
|
+
export type CutListBindingsData = {
|
|
62738
|
+
body?: never;
|
|
62739
|
+
path: {
|
|
62740
|
+
/**
|
|
62741
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
62742
|
+
*/
|
|
62743
|
+
project_id: string;
|
|
62744
|
+
};
|
|
62745
|
+
query?: never;
|
|
62746
|
+
url: '/cut/v1/projects/{project_id}/bindings';
|
|
62747
|
+
};
|
|
62748
|
+
export type CutListBindingsErrors = {
|
|
62749
|
+
/**
|
|
62750
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
62751
|
+
*/
|
|
62752
|
+
400: CutCutError;
|
|
62753
|
+
/**
|
|
62754
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62755
|
+
*/
|
|
62756
|
+
401: CutCutError;
|
|
62757
|
+
/**
|
|
62758
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
62759
|
+
*/
|
|
62760
|
+
403: CutCutError;
|
|
62761
|
+
/**
|
|
62762
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
62763
|
+
*/
|
|
62764
|
+
404: CutCutError;
|
|
62765
|
+
/**
|
|
62766
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
62767
|
+
*/
|
|
62768
|
+
500: CutCutError;
|
|
62769
|
+
};
|
|
62770
|
+
export type CutListBindingsError = CutListBindingsErrors[keyof CutListBindingsErrors];
|
|
62771
|
+
export type CutListBindingsResponses = {
|
|
62772
|
+
/**
|
|
62773
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
62774
|
+
*/
|
|
62775
|
+
200: CutBindingsResult;
|
|
62776
|
+
};
|
|
62777
|
+
export type CutListBindingsResponse = CutListBindingsResponses[keyof CutListBindingsResponses];
|
|
62778
|
+
export type CutCreateBindingData = {
|
|
62779
|
+
/**
|
|
62780
|
+
* Attach a media library using a project-local name.
|
|
62781
|
+
*/
|
|
62782
|
+
body: CutBindingInput;
|
|
62783
|
+
path: {
|
|
62784
|
+
/**
|
|
62785
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
62786
|
+
*/
|
|
62787
|
+
project_id: string;
|
|
62788
|
+
};
|
|
62789
|
+
query?: never;
|
|
62790
|
+
url: '/cut/v1/projects/{project_id}/bindings';
|
|
62791
|
+
};
|
|
62792
|
+
export type CutCreateBindingErrors = {
|
|
62793
|
+
/**
|
|
62794
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
62795
|
+
*/
|
|
62796
|
+
400: CutCutError;
|
|
62797
|
+
/**
|
|
62798
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62799
|
+
*/
|
|
62800
|
+
401: CutCutError;
|
|
62801
|
+
/**
|
|
62802
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
62803
|
+
*/
|
|
62804
|
+
403: CutCutError;
|
|
62805
|
+
/**
|
|
62806
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
62807
|
+
*/
|
|
62808
|
+
404: CutCutError;
|
|
62809
|
+
/**
|
|
62810
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
62811
|
+
*/
|
|
62812
|
+
500: CutCutError;
|
|
62813
|
+
};
|
|
62814
|
+
export type CutCreateBindingError = CutCreateBindingErrors[keyof CutCreateBindingErrors];
|
|
62815
|
+
export type CutCreateBindingResponses = {
|
|
62816
|
+
/**
|
|
62817
|
+
* New resource; save its id for subsequent calls.
|
|
62818
|
+
*/
|
|
62819
|
+
201: CutBinding;
|
|
62820
|
+
};
|
|
62821
|
+
export type CutCreateBindingResponse = CutCreateBindingResponses[keyof CutCreateBindingResponses];
|
|
62822
|
+
export type CutDeleteBindingData = {
|
|
62823
|
+
body?: never;
|
|
62824
|
+
path: {
|
|
62825
|
+
/**
|
|
62826
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
62827
|
+
*/
|
|
62828
|
+
project_id: string;
|
|
62829
|
+
/**
|
|
62830
|
+
* Project-local binding alias from bindings.list; detach only after removing all clips that reference its library.
|
|
62831
|
+
*/
|
|
62832
|
+
name: string;
|
|
62833
|
+
};
|
|
62834
|
+
query?: never;
|
|
62835
|
+
url: '/cut/v1/projects/{project_id}/bindings/{name}';
|
|
62836
|
+
};
|
|
62837
|
+
export type CutDeleteBindingErrors = {
|
|
62838
|
+
/**
|
|
62839
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
62840
|
+
*/
|
|
62841
|
+
400: CutCutError;
|
|
62842
|
+
/**
|
|
62843
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62844
|
+
*/
|
|
62845
|
+
401: CutCutError;
|
|
62846
|
+
/**
|
|
62847
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
62848
|
+
*/
|
|
62849
|
+
403: CutCutError;
|
|
62850
|
+
/**
|
|
62851
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
62852
|
+
*/
|
|
62853
|
+
404: CutCutError;
|
|
62854
|
+
/**
|
|
62855
|
+
* BINDING_IN_USE means timeline clips still reference this library; remove or replace those clips before detaching the binding.
|
|
62856
|
+
*/
|
|
62857
|
+
409: CutCutError;
|
|
62858
|
+
/**
|
|
62859
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
62860
|
+
*/
|
|
62861
|
+
500: CutCutError;
|
|
62862
|
+
};
|
|
62863
|
+
export type CutDeleteBindingError = CutDeleteBindingErrors[keyof CutDeleteBindingErrors];
|
|
62864
|
+
export type CutDeleteBindingResponses = {
|
|
62865
|
+
/**
|
|
62866
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
62867
|
+
*/
|
|
62868
|
+
200: CutDeletedBinding;
|
|
62869
|
+
};
|
|
62870
|
+
export type CutDeleteBindingResponse = CutDeleteBindingResponses[keyof CutDeleteBindingResponses];
|
|
62871
|
+
export type CutImportMediaData = {
|
|
62872
|
+
/**
|
|
62873
|
+
* Import one external asset into a writable project library.
|
|
62874
|
+
*/
|
|
62875
|
+
body: CutMediaImportInput;
|
|
62876
|
+
path: {
|
|
62877
|
+
/**
|
|
62878
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
62879
|
+
*/
|
|
62880
|
+
project_id: string;
|
|
62881
|
+
};
|
|
62882
|
+
query?: never;
|
|
62883
|
+
url: '/cut/v1/projects/{project_id}/media:import';
|
|
62884
|
+
};
|
|
62885
|
+
export type CutImportMediaErrors = {
|
|
62886
|
+
/**
|
|
62887
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
62888
|
+
*/
|
|
62889
|
+
400: CutCutError;
|
|
62890
|
+
/**
|
|
62891
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62892
|
+
*/
|
|
62893
|
+
401: CutCutError;
|
|
62894
|
+
/**
|
|
62895
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
62896
|
+
*/
|
|
62897
|
+
403: CutCutError;
|
|
62898
|
+
/**
|
|
62899
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
62900
|
+
*/
|
|
62901
|
+
404: CutCutError;
|
|
62902
|
+
/**
|
|
62903
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
62904
|
+
*/
|
|
62905
|
+
500: CutCutError;
|
|
62906
|
+
/**
|
|
62907
|
+
* MEDIA_OFFLINE, MEDIA_UNAVAILABLE, MEDIA_IMPORT_FAILED or EXPORT_FAILED means required media or rendering could not complete; inspect source availability or the export error before retrying.
|
|
62908
|
+
*/
|
|
62909
|
+
503: CutCutError;
|
|
62910
|
+
};
|
|
62911
|
+
export type CutImportMediaError = CutImportMediaErrors[keyof CutImportMediaErrors];
|
|
62912
|
+
export type CutImportMediaResponses = {
|
|
62913
|
+
/**
|
|
62914
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
62915
|
+
*/
|
|
62916
|
+
200: CutImportedMedia;
|
|
62917
|
+
};
|
|
62918
|
+
export type CutImportMediaResponse = CutImportMediaResponses[keyof CutImportMediaResponses];
|
|
62919
|
+
export type CutListExportsData = {
|
|
62920
|
+
body?: never;
|
|
62921
|
+
path: {
|
|
62922
|
+
/**
|
|
62923
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
62924
|
+
*/
|
|
62925
|
+
project_id: string;
|
|
62926
|
+
};
|
|
62927
|
+
query?: {
|
|
62928
|
+
/**
|
|
62929
|
+
* Maximum resources in one page, from 1 to 100; defaults to 50.
|
|
62930
|
+
*/
|
|
62931
|
+
page_size?: number;
|
|
62932
|
+
/**
|
|
62933
|
+
* Opaque next_page_token from the preceding page; omit on the first request.
|
|
62934
|
+
*/
|
|
62935
|
+
page_token?: string;
|
|
62936
|
+
/**
|
|
62937
|
+
* Optional resource filter; projects supports state = "active" or state = "deleted".
|
|
62938
|
+
*/
|
|
62939
|
+
filter?: string;
|
|
62940
|
+
/**
|
|
62941
|
+
* Optional ordering expression; projects supports updateTime desc.
|
|
62942
|
+
*/
|
|
62943
|
+
order_by?: string;
|
|
62944
|
+
};
|
|
62945
|
+
url: '/cut/v1/projects/{project_id}/exports';
|
|
62946
|
+
};
|
|
62947
|
+
export type CutListExportsErrors = {
|
|
62948
|
+
/**
|
|
62949
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
62950
|
+
*/
|
|
62951
|
+
400: CutCutError;
|
|
62952
|
+
/**
|
|
62953
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62954
|
+
*/
|
|
62955
|
+
401: CutCutError;
|
|
62956
|
+
/**
|
|
62957
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
62958
|
+
*/
|
|
62959
|
+
403: CutCutError;
|
|
62960
|
+
/**
|
|
62961
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
62962
|
+
*/
|
|
62963
|
+
404: CutCutError;
|
|
62964
|
+
/**
|
|
62965
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
62966
|
+
*/
|
|
62967
|
+
500: CutCutError;
|
|
62968
|
+
};
|
|
62969
|
+
export type CutListExportsError = CutListExportsErrors[keyof CutListExportsErrors];
|
|
62970
|
+
export type CutListExportsResponses = {
|
|
62971
|
+
/**
|
|
62972
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
62973
|
+
*/
|
|
62974
|
+
200: CutExportPage;
|
|
62975
|
+
};
|
|
62976
|
+
export type CutListExportsResponse = CutListExportsResponses[keyof CutListExportsResponses];
|
|
62977
|
+
export type CutCreateExportData = {
|
|
62978
|
+
/**
|
|
62979
|
+
* Start an export from a project revision into a bound library.
|
|
62980
|
+
*/
|
|
62981
|
+
body: CutExportInput;
|
|
62982
|
+
path: {
|
|
62983
|
+
/**
|
|
62984
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
62985
|
+
*/
|
|
62986
|
+
project_id: string;
|
|
62987
|
+
};
|
|
62988
|
+
query?: never;
|
|
62989
|
+
url: '/cut/v1/projects/{project_id}/exports';
|
|
62990
|
+
};
|
|
62991
|
+
export type CutCreateExportErrors = {
|
|
62992
|
+
/**
|
|
62993
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
62994
|
+
*/
|
|
62995
|
+
400: CutCutError;
|
|
62996
|
+
/**
|
|
62997
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
62998
|
+
*/
|
|
62999
|
+
401: CutCutError;
|
|
63000
|
+
/**
|
|
63001
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
63002
|
+
*/
|
|
63003
|
+
403: CutCutError;
|
|
63004
|
+
/**
|
|
63005
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
63006
|
+
*/
|
|
63007
|
+
404: CutCutError;
|
|
63008
|
+
/**
|
|
63009
|
+
* CUT_BUSY means too much work is queued for this project; let pending work complete before retrying.
|
|
63010
|
+
*/
|
|
63011
|
+
429: CutCutError;
|
|
63012
|
+
/**
|
|
63013
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
63014
|
+
*/
|
|
63015
|
+
500: CutCutError;
|
|
63016
|
+
/**
|
|
63017
|
+
* MEDIA_OFFLINE, MEDIA_UNAVAILABLE, MEDIA_IMPORT_FAILED or EXPORT_FAILED means required media or rendering could not complete; inspect source availability or the export error before retrying.
|
|
63018
|
+
*/
|
|
63019
|
+
503: CutCutError;
|
|
63020
|
+
};
|
|
63021
|
+
export type CutCreateExportError = CutCreateExportErrors[keyof CutCreateExportErrors];
|
|
63022
|
+
export type CutCreateExportResponses = {
|
|
63023
|
+
/**
|
|
63024
|
+
* Export accepted; poll exports.retrieve until status is done, failed or canceled.
|
|
63025
|
+
*/
|
|
63026
|
+
202: CutExport;
|
|
63027
|
+
};
|
|
63028
|
+
export type CutCreateExportResponse = CutCreateExportResponses[keyof CutCreateExportResponses];
|
|
63029
|
+
export type CutRetrieveExportData = {
|
|
63030
|
+
body?: never;
|
|
63031
|
+
path: {
|
|
63032
|
+
/**
|
|
63033
|
+
* Export identifier returned by its create or list operation; use the id, not a display name.
|
|
63034
|
+
*/
|
|
63035
|
+
export_id: string;
|
|
63036
|
+
};
|
|
63037
|
+
query?: never;
|
|
63038
|
+
url: '/cut/v1/exports/{export_id}';
|
|
63039
|
+
};
|
|
63040
|
+
export type CutRetrieveExportErrors = {
|
|
63041
|
+
/**
|
|
63042
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
63043
|
+
*/
|
|
63044
|
+
400: CutCutError;
|
|
63045
|
+
/**
|
|
63046
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
63047
|
+
*/
|
|
63048
|
+
401: CutCutError;
|
|
63049
|
+
/**
|
|
63050
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
63051
|
+
*/
|
|
63052
|
+
403: CutCutError;
|
|
63053
|
+
/**
|
|
63054
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
63055
|
+
*/
|
|
63056
|
+
404: CutCutError;
|
|
63057
|
+
/**
|
|
63058
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
63059
|
+
*/
|
|
63060
|
+
500: CutCutError;
|
|
63061
|
+
};
|
|
63062
|
+
export type CutRetrieveExportError = CutRetrieveExportErrors[keyof CutRetrieveExportErrors];
|
|
63063
|
+
export type CutRetrieveExportResponses = {
|
|
63064
|
+
/**
|
|
63065
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
63066
|
+
*/
|
|
63067
|
+
200: CutExport;
|
|
63068
|
+
};
|
|
63069
|
+
export type CutRetrieveExportResponse = CutRetrieveExportResponses[keyof CutRetrieveExportResponses];
|
|
63070
|
+
export type CutCancelExportData = {
|
|
63071
|
+
body?: never;
|
|
63072
|
+
path: {
|
|
63073
|
+
/**
|
|
63074
|
+
* Export identifier returned by its create or list operation; use the id, not a display name.
|
|
63075
|
+
*/
|
|
63076
|
+
export_id: string;
|
|
63077
|
+
};
|
|
63078
|
+
query?: never;
|
|
63079
|
+
url: '/cut/v1/exports/{export_id}:cancel';
|
|
63080
|
+
};
|
|
63081
|
+
export type CutCancelExportErrors = {
|
|
63082
|
+
/**
|
|
63083
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
63084
|
+
*/
|
|
63085
|
+
400: CutCutError;
|
|
63086
|
+
/**
|
|
63087
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
63088
|
+
*/
|
|
63089
|
+
401: CutCutError;
|
|
63090
|
+
/**
|
|
63091
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
63092
|
+
*/
|
|
63093
|
+
403: CutCutError;
|
|
63094
|
+
/**
|
|
63095
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
63096
|
+
*/
|
|
63097
|
+
404: CutCutError;
|
|
63098
|
+
/**
|
|
63099
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
63100
|
+
*/
|
|
63101
|
+
500: CutCutError;
|
|
63102
|
+
};
|
|
63103
|
+
export type CutCancelExportError = CutCancelExportErrors[keyof CutCancelExportErrors];
|
|
63104
|
+
export type CutCancelExportResponses = {
|
|
63105
|
+
/**
|
|
63106
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
63107
|
+
*/
|
|
63108
|
+
200: CutExport;
|
|
63109
|
+
};
|
|
63110
|
+
export type CutCancelExportResponse = CutCancelExportResponses[keyof CutCancelExportResponses];
|
|
63111
|
+
export type CutListVersionsData = {
|
|
63112
|
+
body?: never;
|
|
63113
|
+
path: {
|
|
63114
|
+
/**
|
|
63115
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
63116
|
+
*/
|
|
63117
|
+
project_id: string;
|
|
63118
|
+
};
|
|
63119
|
+
query?: {
|
|
63120
|
+
/**
|
|
63121
|
+
* Maximum resources in one page, from 1 to 100; defaults to 50.
|
|
63122
|
+
*/
|
|
63123
|
+
page_size?: number;
|
|
63124
|
+
/**
|
|
63125
|
+
* Opaque next_page_token from the preceding page; omit on the first request.
|
|
63126
|
+
*/
|
|
63127
|
+
page_token?: string;
|
|
63128
|
+
/**
|
|
63129
|
+
* Optional resource filter; projects supports state = "active" or state = "deleted".
|
|
63130
|
+
*/
|
|
63131
|
+
filter?: string;
|
|
63132
|
+
/**
|
|
63133
|
+
* Optional ordering expression; projects supports updateTime desc.
|
|
63134
|
+
*/
|
|
63135
|
+
order_by?: string;
|
|
63136
|
+
};
|
|
63137
|
+
url: '/cut/v1/projects/{project_id}/versions';
|
|
63138
|
+
};
|
|
63139
|
+
export type CutListVersionsErrors = {
|
|
63140
|
+
/**
|
|
63141
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
63142
|
+
*/
|
|
63143
|
+
400: CutCutError;
|
|
63144
|
+
/**
|
|
63145
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
63146
|
+
*/
|
|
63147
|
+
401: CutCutError;
|
|
63148
|
+
/**
|
|
63149
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
63150
|
+
*/
|
|
63151
|
+
403: CutCutError;
|
|
63152
|
+
/**
|
|
63153
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
63154
|
+
*/
|
|
63155
|
+
404: CutCutError;
|
|
63156
|
+
/**
|
|
63157
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
63158
|
+
*/
|
|
63159
|
+
500: CutCutError;
|
|
63160
|
+
};
|
|
63161
|
+
export type CutListVersionsError = CutListVersionsErrors[keyof CutListVersionsErrors];
|
|
63162
|
+
export type CutListVersionsResponses = {
|
|
63163
|
+
/**
|
|
63164
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
63165
|
+
*/
|
|
63166
|
+
200: CutVersionPage;
|
|
63167
|
+
};
|
|
63168
|
+
export type CutListVersionsResponse = CutListVersionsResponses[keyof CutListVersionsResponses];
|
|
63169
|
+
export type CutCreateVersionData = {
|
|
63170
|
+
/**
|
|
63171
|
+
* Save the current project revision with an optional label.
|
|
63172
|
+
*/
|
|
63173
|
+
body: CutVersionInput;
|
|
63174
|
+
path: {
|
|
63175
|
+
/**
|
|
63176
|
+
* Project identifier returned by its create or list operation; use the id, not a display name.
|
|
63177
|
+
*/
|
|
63178
|
+
project_id: string;
|
|
63179
|
+
};
|
|
63180
|
+
query?: never;
|
|
63181
|
+
url: '/cut/v1/projects/{project_id}/versions';
|
|
63182
|
+
};
|
|
63183
|
+
export type CutCreateVersionErrors = {
|
|
63184
|
+
/**
|
|
63185
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
63186
|
+
*/
|
|
63187
|
+
400: CutCutError;
|
|
63188
|
+
/**
|
|
63189
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
63190
|
+
*/
|
|
63191
|
+
401: CutCutError;
|
|
63192
|
+
/**
|
|
63193
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
63194
|
+
*/
|
|
63195
|
+
403: CutCutError;
|
|
63196
|
+
/**
|
|
63197
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
63198
|
+
*/
|
|
63199
|
+
404: CutCutError;
|
|
63200
|
+
/**
|
|
63201
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
63202
|
+
*/
|
|
63203
|
+
500: CutCutError;
|
|
63204
|
+
};
|
|
63205
|
+
export type CutCreateVersionError = CutCreateVersionErrors[keyof CutCreateVersionErrors];
|
|
63206
|
+
export type CutCreateVersionResponses = {
|
|
63207
|
+
/**
|
|
63208
|
+
* New resource; save its id for subsequent calls.
|
|
63209
|
+
*/
|
|
63210
|
+
201: CutVersion;
|
|
63211
|
+
};
|
|
63212
|
+
export type CutCreateVersionResponse = CutCreateVersionResponses[keyof CutCreateVersionResponses];
|
|
63213
|
+
export type CutRestoreVersionData = {
|
|
63214
|
+
body?: never;
|
|
63215
|
+
path: {
|
|
63216
|
+
/**
|
|
63217
|
+
* Version identifier returned by its create or list operation; use the id, not a display name.
|
|
63218
|
+
*/
|
|
63219
|
+
version_id: string;
|
|
63220
|
+
};
|
|
63221
|
+
query?: never;
|
|
63222
|
+
url: '/cut/v1/versions/{version_id}:restore';
|
|
63223
|
+
};
|
|
63224
|
+
export type CutRestoreVersionErrors = {
|
|
63225
|
+
/**
|
|
63226
|
+
* INVALID_PARAMS or BINDING_INVALID means a request field, identifier or library binding is invalid; correct the indicated input before retrying.
|
|
63227
|
+
*/
|
|
63228
|
+
400: CutCutError;
|
|
63229
|
+
/**
|
|
63230
|
+
* The API key is missing, invalid or has no organization; supply a valid organization API key before retrying.
|
|
63231
|
+
*/
|
|
63232
|
+
401: CutCutError;
|
|
63233
|
+
/**
|
|
63234
|
+
* PERMISSION_DENIED means the credential cannot perform this operation; use a key with the required Cut access in the owning organization.
|
|
63235
|
+
*/
|
|
63236
|
+
403: CutCutError;
|
|
63237
|
+
/**
|
|
63238
|
+
* PROJECT_NOT_FOUND, EXPORT_NOT_FOUND, VERSION_NOT_FOUND or LIBRARY_NOT_FOUND means the requested resource is missing, deleted or outside the organization; choose an accessible identifier from its list operation.
|
|
63239
|
+
*/
|
|
63240
|
+
404: CutCutError;
|
|
63241
|
+
/**
|
|
63242
|
+
* REVISION_CONFLICT means the project changed since expected_revision or while preparing the second-based response; retrieve the current state and inspect whether a write committed before retrying, then merge concurrent edits.
|
|
63243
|
+
*/
|
|
63244
|
+
409: CutCutError;
|
|
63245
|
+
/**
|
|
63246
|
+
* PROJECT_TOO_LARGE or RESPONSE_TOO_LARGE means an edit or response exceeds its size limit; reduce the edit batch or narrow the requested timeline range.
|
|
63247
|
+
*/
|
|
63248
|
+
413: CutCutError;
|
|
63249
|
+
/**
|
|
63250
|
+
* INTERNAL means the request could not complete; inspect current project state before retrying a write to avoid duplicating a committed edit.
|
|
63251
|
+
*/
|
|
63252
|
+
500: CutCutError;
|
|
63253
|
+
};
|
|
63254
|
+
export type CutRestoreVersionError = CutRestoreVersionErrors[keyof CutRestoreVersionErrors];
|
|
63255
|
+
export type CutRestoreVersionResponses = {
|
|
63256
|
+
/**
|
|
63257
|
+
* Requested resource or operation result; use its revision when preparing a guarded edit.
|
|
63258
|
+
*/
|
|
63259
|
+
200: CutTransaction;
|
|
63260
|
+
};
|
|
63261
|
+
export type CutRestoreVersionResponse = CutRestoreVersionResponses[keyof CutRestoreVersionResponses];
|
|
60143
63262
|
export type DatabaseListDatabasesData = {
|
|
60144
63263
|
body?: never;
|
|
60145
63264
|
path?: never;
|