@deepraxis/cli 0.2.1-dev.eb022f5 → 0.2.1-dev.f23829c
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/COMMANDS.md +29 -5
- package/dist/praxis.js +1596 -154
- package/package.json +1 -1
package/dist/praxis.js
CHANGED
|
@@ -143,7 +143,7 @@ across all toolsets allowed.`
|
|
|
143
143
|
type: "array",
|
|
144
144
|
itemType: "object",
|
|
145
145
|
required: false,
|
|
146
|
-
description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or
|
|
146
|
+
description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time."
|
|
147
147
|
},
|
|
148
148
|
{
|
|
149
149
|
name: "kind",
|
|
@@ -1218,6 +1218,37 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
|
|
|
1218
1218
|
}
|
|
1219
1219
|
]
|
|
1220
1220
|
},
|
|
1221
|
+
{
|
|
1222
|
+
resource: "agent.computers.files.convert",
|
|
1223
|
+
method: "create",
|
|
1224
|
+
summary: "Convert a Computer Document to PDF",
|
|
1225
|
+
description: `Convert an Office document (docx, doc, ppt, pptx, rtf, odt; up to 16 MiB) to PDF inside a platform-owned ephemeral document sandbox, whatever machine family the computer itself runs on. Returns base64 PDF bytes.
|
|
1226
|
+
|
|
1227
|
+
Praxis extension: the preview conversion endpoint. The browser never parses an untrusted document — LibreOffice runs only inside an ephemeral document-family sandbox and the converter instance is killed after use. The file stays tenant-owned; non-convertible types answer EXTENSION_NOT_CONVERTIBLE and a failed conversion answers CONVERSION_FAILED.`,
|
|
1228
|
+
http: "POST",
|
|
1229
|
+
path: "/agent/v1/computers/{computer_id}/files/convert",
|
|
1230
|
+
streaming: "no",
|
|
1231
|
+
pagination: false,
|
|
1232
|
+
pathParams: [
|
|
1233
|
+
{
|
|
1234
|
+
name: "computer_id",
|
|
1235
|
+
sdkName: "computer_id",
|
|
1236
|
+
description: "Computer id (cmp_...), as returned by computers.create or computers.list."
|
|
1237
|
+
}
|
|
1238
|
+
],
|
|
1239
|
+
query: [],
|
|
1240
|
+
body: {
|
|
1241
|
+
required: true,
|
|
1242
|
+
fields: [
|
|
1243
|
+
{
|
|
1244
|
+
name: "name",
|
|
1245
|
+
type: "string",
|
|
1246
|
+
required: true,
|
|
1247
|
+
description: "Name of the entry or object."
|
|
1248
|
+
}
|
|
1249
|
+
]
|
|
1250
|
+
}
|
|
1251
|
+
},
|
|
1221
1252
|
{
|
|
1222
1253
|
resource: "agent.computers.leases",
|
|
1223
1254
|
method: "delete",
|
|
@@ -6100,7 +6131,7 @@ file at the root of that directory.`
|
|
|
6100
6131
|
"allow"
|
|
6101
6132
|
],
|
|
6102
6133
|
required: false,
|
|
6103
|
-
description: "skip
|
|
6134
|
+
description: "skip skips while a previous run is still active; allow permits overlapping runs. When omitted, schedule triggers use skip and webhook triggers use allow."
|
|
6104
6135
|
},
|
|
6105
6136
|
{
|
|
6106
6137
|
name: "catchup_window_seconds",
|
|
@@ -6274,7 +6305,7 @@ file at the root of that directory.`
|
|
|
6274
6305
|
"allow"
|
|
6275
6306
|
],
|
|
6276
6307
|
required: false,
|
|
6277
|
-
description: "skip
|
|
6308
|
+
description: "skip skips while a previous run is still active; allow permits overlapping runs. When omitted, schedule triggers use skip and webhook triggers use allow."
|
|
6278
6309
|
},
|
|
6279
6310
|
{
|
|
6280
6311
|
name: "catchup_window_seconds",
|
|
@@ -9962,7 +9993,7 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
9962
9993
|
resource: "cut.projects.analysis",
|
|
9963
9994
|
method: "create",
|
|
9964
9995
|
summary: "Analyze project media",
|
|
9965
|
-
description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible.",
|
|
9996
|
+
description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible. Silence measures transcript-based speech pauses, not music or loudness. A completed transcript without words returns ready with empty segments and reason no_speech; no completed transcript returns unsupported with reason no_transcript. A failed transcription remains failed.",
|
|
9966
9997
|
http: "POST",
|
|
9967
9998
|
path: "/cut/v1/projects/{project_id}/analysis",
|
|
9968
9999
|
streaming: "no",
|
|
@@ -10133,6 +10164,18 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10133
10164
|
body: {
|
|
10134
10165
|
required: true,
|
|
10135
10166
|
fields: [
|
|
10167
|
+
{
|
|
10168
|
+
name: "folder",
|
|
10169
|
+
type: "string",
|
|
10170
|
+
required: false,
|
|
10171
|
+
description: "Optional destination path within the bound media library; omitted uses its default folder."
|
|
10172
|
+
},
|
|
10173
|
+
{
|
|
10174
|
+
name: "name",
|
|
10175
|
+
type: "string",
|
|
10176
|
+
required: false,
|
|
10177
|
+
description: "Nonempty display name, frozen with the export. Path separators and control characters become hyphens; limited to 200 characters. Omitted uses project name and timestamp."
|
|
10178
|
+
},
|
|
10136
10179
|
{
|
|
10137
10180
|
name: "output",
|
|
10138
10181
|
type: "object",
|
|
@@ -10150,6 +10193,12 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10150
10193
|
type: "integer",
|
|
10151
10194
|
required: false,
|
|
10152
10195
|
description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write."
|
|
10196
|
+
},
|
|
10197
|
+
{
|
|
10198
|
+
name: "loudness",
|
|
10199
|
+
type: "object",
|
|
10200
|
+
required: false,
|
|
10201
|
+
description: "Loudness normalization target. Omitted, the export is normalized to -14 LUFS integrated and -1 dBTP true peak, the level short-video and streaming platforms play at; null renders without normalization. Normalization adds analysis and rendering work."
|
|
10153
10202
|
}
|
|
10154
10203
|
]
|
|
10155
10204
|
}
|
|
@@ -10158,7 +10207,7 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10158
10207
|
resource: "cut.projects.frames",
|
|
10159
10208
|
method: "list",
|
|
10160
10209
|
summary: "Render preview frames",
|
|
10161
|
-
description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. Decode
|
|
10210
|
+
description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution. The response always includes warnings; FRAME_UNAVAILABLE means a source preview could not be obtained and an offline tile was drawn. Its message identifies a timeout, delivery capacity limit, or unavailable source and contains no source URL. Decode each image's base64 payload to save it. Codemode returns at most four images per call, so request at most four times when reviewing there.",
|
|
10162
10211
|
http: "GET",
|
|
10163
10212
|
path: "/cut/v1/projects/{project_id}/frames",
|
|
10164
10213
|
streaming: "no",
|
|
@@ -10181,7 +10230,7 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10181
10230
|
name: "scale",
|
|
10182
10231
|
type: "number",
|
|
10183
10232
|
required: false,
|
|
10184
|
-
description: "
|
|
10233
|
+
description: "Image size multiplier, default 0.25, greater than zero and at most 0.5. Larger values return INVALID_PARAMS; pixel-area limits may reduce actual dimensions, reported as width and height."
|
|
10185
10234
|
},
|
|
10186
10235
|
{
|
|
10187
10236
|
name: "revision",
|
|
@@ -10375,85 +10424,155 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10375
10424
|
summary: "Execute editing script",
|
|
10376
10425
|
description: `Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: \`const t = AddTrack("video"); Insert(t, {type: "color", color: "#123456", start: 0, length: 3}); Print(t);\`
|
|
10377
10426
|
|
|
10378
|
-
|
|
10427
|
+
<!-- cut-reference:start -->
|
|
10428
|
+
### Script function, field and error reference
|
|
10379
10429
|
|
|
10380
|
-
|
|
10430
|
+
Every script function, clip field and error code has its own section, read one at a time:
|
|
10381
10431
|
|
|
10382
|
-
\`\`\`
|
|
10383
|
-
|
|
10384
|
-
|
|
10385
|
-
|
|
10386
|
-
|
|
10387
|
-
GetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];
|
|
10388
|
-
GetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];
|
|
10389
|
-
Insert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;
|
|
10390
|
-
Update(id: ClipId, patch: ItemPatchView): void;
|
|
10391
|
-
Delete(id: ClipId, o?: { ripple?: boolean }): void;
|
|
10392
|
-
Split(id: ClipId, at: number): ClipId;
|
|
10393
|
-
Trim(id: ClipId, edge: "in" | "out", delta: number, o?: { ripple?: boolean }): void;
|
|
10394
|
-
Move(id: ClipId, start: number, track?: TrackId): void;
|
|
10395
|
-
RippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;
|
|
10396
|
-
AddTrack(kind: "video" | "audio" | "caption", init?: { name?: string }, index?: number): TrackId;
|
|
10397
|
-
UpdateTrack(id: TrackId, patch: TrackPatch): void;
|
|
10398
|
-
DeleteTrack(id: TrackId): void;
|
|
10399
|
-
SetSettings(patch: Partial<ProjectSettingsView>): void;
|
|
10400
|
-
AddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle>; maxChars?: number }): ClipId[];
|
|
10401
|
-
SetMarker(at: number, label: string): string;
|
|
10402
|
-
Print(...values: unknown[]): void;
|
|
10403
|
-
Preview(at: number[]): void;
|
|
10432
|
+
\`\`\`
|
|
10433
|
+
codemode.describe("praxis.cut.script.<Name>") // one function: signature, arguments, return, errors, example
|
|
10434
|
+
codemode.describe("praxis.cut.fields.<name>") // one field: type, unit, range, default, where writable
|
|
10435
|
+
codemode.describe("praxis.cut.errors.<CODE>") // one code: meaning, causes, fix
|
|
10436
|
+
codemode.describe("praxis.cut.script") // names, one page at a time
|
|
10404
10437
|
\`\`\`
|
|
10405
10438
|
|
|
10406
|
-
|
|
10407
|
-
| --- | --- |
|
|
10408
|
-
| GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, sourceIn/sourceOut, text and offline reason. GetTimeline returns duration and tracks (id, kind, name, index, locked, items); from/to and tracks narrow the read. |
|
|
10409
|
-
| FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |
|
|
10410
|
-
| GetMedia | Read metadata for \`{libraryId, assetId}\` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |
|
|
10411
|
-
| GetTranscript, GetAnalysis | Read available transcript words or silence/filler/scenes segments. Transcript filter from/to is seconds; returned word and segment from/to values are source microseconds (divide by 1,000,000 for editing). Words contain text and optional speaker/filler; segments may include label/confidence. Request analysis first if unavailable. |
|
|
10412
|
-
| Insert, Update, Delete | Insert returns the new clip ID; Update changes supplied fields; Delete removes the clip. Optional ripple on Insert/Delete closes or opens space on the track. |
|
|
10413
|
-
| Split, Trim, Move | Split at a timeline position and return the new right-hand clip ID. Trim changes the in or out edge by delta seconds. Move sets the timeline start and optionally a new track. |
|
|
10414
|
-
| RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |
|
|
10415
|
-
| AddTrack, UpdateTrack, DeleteTrack | Add video/audio/caption tracks; index selects layer order (0 is top). TrackPatch supports name, locked, hidden, muted, gainDb and style as appropriate to track kind. |
|
|
10416
|
-
| SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |
|
|
10417
|
-
| AddCaptionsFromTranscript | Create captions from an audio/video clip's kept words. Optional maxChars is 1–1000, default 16; style updates the caption track. Returns caption IDs. |
|
|
10418
|
-
| SetMarker | Add a label at a timeline time and return its ID. |
|
|
10419
|
-
| Print, Preview | Print appends text to prints. Preview requests up to eight times total per execute and puts images in the result's frames. Each url is an inline PNG data URL, not an HTTP image link. Decode the base64 payload to save an image. Codemode returns at most four images per call; request at most four times there. |
|
|
10420
|
-
|
|
10421
|
-
#### Insert fields (ItemInit)
|
|
10422
|
-
|
|
10423
|
-
Every item requires \`type\` and \`start\`. Times used for editing are seconds and snap to the project frame rate: start, length, sourceIn, fadeIn/fadeOut, transition length, keyframe at, reveal delay/stagger/duration. Keyframe and reveal times are relative to the clip start. Video/audio may omit length to use the remaining source duration; other types require length.
|
|
10424
|
-
|
|
10425
|
-
| type | Required fields beyond type/start | Optional fields |
|
|
10426
|
-
| --- | --- | --- |
|
|
10427
|
-
| video | media | length, sourceIn, volumeDb, transform, fit, animate, transitionIn, transitionOut |
|
|
10428
|
-
| image | media, length | transform, fit, animate, transitionIn, transitionOut |
|
|
10429
|
-
| text | text, length | style, transform, reveal, animate, transitionIn, transitionOut |
|
|
10430
|
-
| color | color, length | transform, fill, animate, transitionIn, transitionOut |
|
|
10431
|
-
| shape | shape, length, width, height, fill | radius, stroke, transform, animate, transitionIn, transitionOut |
|
|
10432
|
-
| audio | media | length, sourceIn, volumeDb, fadeIn, fadeOut, transitionIn, transitionOut |
|
|
10433
|
-
| caption | text, length | — |
|
|
10434
|
-
|
|
10435
|
-
Video tracks accept video/image/text/color/shape; audio and caption tracks accept their corresponding type. Media is \`{libraryId: string, assetId: string}\` from a bound library. sourceIn defaults to 0, volumeDb to 0 dB, audio fades to 0 seconds. fit defaults to contain: contain fits the whole image, cover fills and crops, fill stretches, none keeps native dimensions.
|
|
10439
|
+
Published at https://docs.deepraxis.com/docs/developers/cut/script-reference with one anchor per entry. Names below omit the \`praxis.cut.<kind>.\` prefix.
|
|
10436
10440
|
|
|
10437
|
-
|
|
10438
|
-
| --- | --- |
|
|
10439
|
-
| transform | Partial \`{x, y, scale, rotation, opacity, crop, blur}\`. x/y are normalized canvas center coordinates (default 0.5); scale 1 is fitted size; rotation is degrees (default 0); opacity is 0–1 (default 1). crop is \`{top,right,bottom,left}\`. blur is 0–100 pixels at 1080-pixel frame height. |
|
|
10440
|
-
| style | Partial \`{fontFamily, fontSize, fontWeight, color, stroke, background, align, maxWidth}\`. fontFamily: Geist or Noto Sans SC (default); fontSize defaults to 48; fontWeight: 400 (default), 500 or 700; color defaults to #FFFFFF; align: left, center (default), right; maxWidth is a fraction of canvas width (default 0.9). stroke is \`{color,width}\`. Caption style additionally supports position (top/middle/bottom), margin (0–0.4 of canvas height), highlightColor and maxLines: 2. |
|
|
10441
|
-
| animate | An object keyed by x, y, scale, rotation, opacity or blur. Each value is an array of \`{at: number, value: number, ease?: Ease}\` sorted by at with distinct frame-snapped times. Values hold before the first and after the last keyframe, overriding the static transform. |
|
|
10442
|
-
| Ease | linear, in, out, inOut, \`{bezier: [x1,y1,x2,y2]}\` or \`{spring: {stiffness, damping, mass?}}\`. Easing shapes the segment arriving at that keyframe; springs may overshoot. |
|
|
10443
|
-
| reveal | \`{by, delay?: number, stagger: number, duration: number, from: {y?, opacity?, scale?, blur?}, ease?: Ease}\`. by selects char, word or line. Unit k starts at delay + k * stagger and takes duration seconds to reach its resting state; from.y is a fraction of font size. |
|
|
10444
|
-
| fill | A color string (#RRGGBB or #RRGGBBAA), \`{linear: {angle, stops: [{at,color}, ...]}}\` or \`{radial: {stops: [{at,color}, ...]}}\`. Stop positions are 0–1; angle is degrees, 0 left to right. On color clips, fill replaces color when supplied. |
|
|
10445
|
-
| shape, width, height, radius, stroke | shape is rect or ellipse. width/height are fractions of canvas width/height before scaling. radius rounds rect corners in pixels at 1080-pixel frame height. stroke is \`{color: string, width: number}\`. |
|
|
10446
|
-
| transitionIn, transitionOut | \`{kind, length: number}\` at the clip's beginning/end. length is seconds. fade changes opacity; dissolve blends; push_left/push_right move horizontally; wipe_left reveals horizontally. |
|
|
10441
|
+
#### Script functions (script)
|
|
10447
10442
|
|
|
10448
|
-
|
|
10443
|
+
- \`GetTimeline\` — Duration, tracks, joins; clips are under \`items\`.
|
|
10444
|
+
- \`GetItem\` — One clip's compact view, by id.
|
|
10445
|
+
- \`FindItems\` — Visit every clip with its track; collect results.
|
|
10446
|
+
- \`GetMedia\` — Media metadata; \`durationUs\` is microseconds.
|
|
10447
|
+
- \`GetTranscript\` — Transcript words in source microseconds.
|
|
10448
|
+
- \`GetAnalysis\` — Silence, filler or scene segments.
|
|
10449
|
+
- \`ListTransitions\` — Join transition kinds and parameters.
|
|
10450
|
+
- \`ListEffects\` — Visual-effect catalog and parameters.
|
|
10451
|
+
- \`ListAnimations\` — Animation presets by phase and target.
|
|
10452
|
+
- \`ListFonts\` — Font families, weights and scripts.
|
|
10453
|
+
- \`ListTextStyles\` — Text style presets for \`style.preset\`.
|
|
10454
|
+
- \`ListTextTemplates\` — Multi-layer templates and their slots.
|
|
10455
|
+
- \`Insert\` — Add a clip; a track never overlaps itself.
|
|
10456
|
+
- \`Append\` — Add a clip at the end of a track.
|
|
10457
|
+
- \`Update\` — Change named fields; the rest stay.
|
|
10458
|
+
- \`SetSpeed\` — Change rate, keeping source or duration.
|
|
10459
|
+
- \`Delete\` — Remove a clip. There is no \`Remove\`.
|
|
10460
|
+
- \`Join\` — Overlap clips; followers shift, track shortens.
|
|
10461
|
+
- \`UpdateJoin\` — Change a join's length or effect.
|
|
10462
|
+
- \`DeleteJoin\` — Remove a join; restore the butt cut.
|
|
10463
|
+
- \`Split\` — Cut a clip in two at a time.
|
|
10464
|
+
- \`Trim\` — Move one clip edge by seconds.
|
|
10465
|
+
- \`Move\` — Set a clip's start or track.
|
|
10466
|
+
- \`RippleDeleteRange\` — Cut a time range and close the gap.
|
|
10467
|
+
- \`AddTrack\` — Add a video, audio or caption track.
|
|
10468
|
+
- \`UpdateTrack\` — Change a track's name, lock, gain or role.
|
|
10469
|
+
- \`DeleteTrack\` — Remove a track and its clips.
|
|
10470
|
+
- \`SetSettings\` — Change canvas, frame rate or background.
|
|
10471
|
+
- \`AddCaptionsFromTranscript\` — Captions from a clip's kept words.
|
|
10472
|
+
- \`InsertTemplate\` — Insert a template and fill its slots.
|
|
10473
|
+
- \`AlignCaptions\` — Rebuild captions from text punctuation.
|
|
10474
|
+
- \`ImportCaptions\` — Import SRT or WebVTT onto captions.
|
|
10475
|
+
- \`ExportCaptions\` — Export captions as SRT or WebVTT.
|
|
10476
|
+
- \`SetMarker\` — Label a timeline position.
|
|
10477
|
+
- \`Print\` — Append values to the result's \`prints\`.
|
|
10478
|
+
- \`Preview\` — Up to 8 frames as inline PNG data URLs.
|
|
10449
10479
|
|
|
10450
|
-
|
|
10480
|
+
#### Fields (fields)
|
|
10451
10481
|
|
|
10452
|
-
|
|
10482
|
+
- \`type\` — Clip kind; decides which fields apply.
|
|
10483
|
+
- \`start\` — Clip start in seconds; snaps to frames.
|
|
10484
|
+
- \`length\` — Duration; optional for video and audio.
|
|
10485
|
+
- \`media\` — Source \`{ libraryId, assetId }\`.
|
|
10486
|
+
- \`sourceIn\` — First source second kept; default 0.
|
|
10487
|
+
- \`sourceOut\` — Exclusive source end; read-only.
|
|
10488
|
+
- \`text\` — Text of a text or caption clip.
|
|
10489
|
+
- \`color\` — Solid colour of a color clip.
|
|
10490
|
+
- \`shape\` — Shape clip kind: \`rect\` or \`ellipse\`.
|
|
10491
|
+
- \`width\` — Shape width, a fraction of canvas width.
|
|
10492
|
+
- \`height\` — Shape height, a fraction of canvas height.
|
|
10493
|
+
- \`radius\` — Rect corner rounding, in 1080-height px.
|
|
10494
|
+
- \`fill\` — Shape or text paint: colour or gradient.
|
|
10495
|
+
- \`stroke\` — Shape outline: colour and width.
|
|
10496
|
+
- \`transform\` — Position, scale, rotation, opacity, crop, blur.
|
|
10497
|
+
- \`fit\` — contain, cover, fill or none.
|
|
10498
|
+
- \`blend\` — Layer blend mode; null clears.
|
|
10499
|
+
- \`style\` — Text styling: font, fill, strokes, glow, position.
|
|
10500
|
+
- \`style.position\` — top, middle or bottom; omit it, never null.
|
|
10501
|
+
- \`playback\` — Rate, direction, audio policy, or freeze.
|
|
10502
|
+
- \`volumeDb\` — Audio level in dB; 0 is source level.
|
|
10503
|
+
- \`gain\` — Keyframed audio level in dB.
|
|
10504
|
+
- \`fadeIn\` — Fade-in seconds at the clip's start.
|
|
10505
|
+
- \`fadeOut\` — Fade-out seconds at the clip's end.
|
|
10506
|
+
- \`duck\` — Lower this clip while another track plays.
|
|
10507
|
+
- \`animate\` — Transform keyframes; \`at\` is clip-relative seconds.
|
|
10508
|
+
- \`reveal\` — Per-character, word or line reveal timing.
|
|
10509
|
+
- \`animation\` — Preset slots \`{ in, out, loop }\`; null clears.
|
|
10510
|
+
- \`effects\` — Effect stack, at most 8; null clears.
|
|
10511
|
+
- \`transitionIn\` — Entrance effect: kind plus seconds.
|
|
10512
|
+
- \`transitionOut\` — Exit effect: kind plus seconds.
|
|
10513
|
+
- \`mask\` — Shape, path or track matte.
|
|
10514
|
+
- \`words\` — Caption words with clip-local times.
|
|
10453
10515
|
|
|
10454
|
-
|
|
10516
|
+
#### Error codes (errors)
|
|
10455
10517
|
|
|
10456
|
-
|
|
10518
|
+
- \`JOIN_CONFLICT\` — A join is invalid or blocks this edit.
|
|
10519
|
+
- \`INVALID_TRANSITION\` — Bad transition kind, parameter or length.
|
|
10520
|
+
- \`INVALID_STYLE\` — A style value is out of range.
|
|
10521
|
+
- \`INVALID_MASK\` — A mask definition is malformed.
|
|
10522
|
+
- \`MASK_IN_USE\` — The edit would break a live mask.
|
|
10523
|
+
- \`TOO_MANY_MASKS\` — At most 16 masks per project.
|
|
10524
|
+
- \`RATE_OUT_OF_RANGE\` — A rate is outside 0.25-4.
|
|
10525
|
+
- \`UNSUPPORTED_PLAYBACK\` — Reverse without an explicit mute.
|
|
10526
|
+
- \`INVALID_PLAYBACK\` — A playback object is partial or malformed.
|
|
10527
|
+
- \`UNKNOWN_FONT\` — The family is not in \`ListFonts()\`.
|
|
10528
|
+
- \`UNKNOWN_FIELD\` — The field name is not accepted here.
|
|
10529
|
+
- \`UNKNOWN_TEXT_STYLE\` — \`style.preset\` is not in the catalog.
|
|
10530
|
+
- \`TEXT_STYLE_TARGET_MISMATCH\` — Preset on the wrong clip type.
|
|
10531
|
+
- \`CAPTION_ALIGN_LOW_CONFIDENCE\` — Alignment confidence too low; nothing changed.
|
|
10532
|
+
- \`OVERLAP\` — Two clips on one track would share time.
|
|
10533
|
+
- \`OUT_OF_SOURCE\` — The clip would read past its source.
|
|
10534
|
+
- \`LOCKED_TRACK\` — The edit targets a locked track.
|
|
10535
|
+
- \`UNBOUND_LIBRARY\` — The library is not bound to the project.
|
|
10536
|
+
- \`TRACK_KIND_MISMATCH\` — The clip type does not fit the track.
|
|
10537
|
+
- \`NOT_FOUND\` — The named id is not in this project.
|
|
10538
|
+
- \`TOO_SHORT\` — The result would be under one frame.
|
|
10539
|
+
- \`INVALID_DUCK\` — Bad \`duck\` level or a missing track.
|
|
10540
|
+
- \`UNKNOWN_ANIMATION\` — The preset is not in \`ListAnimations()\`.
|
|
10541
|
+
- \`INVALID_ANIMATION_PARAM\` — Bad slot, parameter or keyframe limit.
|
|
10542
|
+
- \`ANIMATION_TOO_LONG\` — In plus out exceed the clip length.
|
|
10543
|
+
- \`ANIMATION_TARGET_MISMATCH\` — The preset does not match the clip type.
|
|
10544
|
+
- \`ANIMATION_PHASE_MISMATCH\` — The preset is in the wrong slot.
|
|
10545
|
+
- \`UNKNOWN_EFFECT\` — The effect is not in \`ListEffects()\`.
|
|
10546
|
+
- \`INVALID_EFFECT_PARAM\` — Bad effect parameter or keyframe.
|
|
10547
|
+
- \`TOO_MANY_EFFECTS\` — More than 8 effects on one clip.
|
|
10548
|
+
- \`PROJECT_NOT_FOUND\` — No visible project has this id.
|
|
10549
|
+
- \`EXPORT_NOT_FOUND\` — No such export in this project.
|
|
10550
|
+
- \`VERSION_NOT_FOUND\` — No saved version has this revision.
|
|
10551
|
+
- \`LIBRARY_NOT_FOUND\` — The library is missing or invisible.
|
|
10552
|
+
- \`BINDING_INVALID\` — The binding request is malformed.
|
|
10553
|
+
- \`BINDING_IN_USE\` — Clips still use this library's assets.
|
|
10554
|
+
- \`NOTHING_TO_UNDO\` — No earlier revision to return to.
|
|
10555
|
+
- \`NOTHING_TO_REDO\` — No undone revision is waiting.
|
|
10556
|
+
- \`UNDO_CONFLICT\` — The revision to undo is no longer head.
|
|
10557
|
+
- \`REVISION_CONFLICT\` — The project moved; your revision is stale.
|
|
10558
|
+
- \`CUT_BUSY\` — The project is busy; retry.
|
|
10559
|
+
- \`INVALID_CAPTION_FILE\` — The subtitle file is malformed or too big.
|
|
10560
|
+
- \`SCRIPT_ERROR\` — The script threw or did not parse.
|
|
10561
|
+
- \`SCRIPT_LIMIT\` — An execute budget was exceeded.
|
|
10562
|
+
- \`OPS_REJECTED\` — An op failed; the whole edit rolled back.
|
|
10563
|
+
- \`EDIT_EXPIRED\` — The saved edit id is over ten minutes old.
|
|
10564
|
+
- \`MEDIA_OFFLINE\` — The asset cannot be fetched right now.
|
|
10565
|
+
- \`MEDIA_UNAVAILABLE\` — The asset is not usable for rendering.
|
|
10566
|
+
- \`MEDIA_IMPORT_FAILED\` — Importing media failed.
|
|
10567
|
+
- \`FRAME_OUT_OF_RANGE\` — The preview time is outside the project.
|
|
10568
|
+
- \`PROJECT_TOO_LARGE\` — The project exceeds the size limit.
|
|
10569
|
+
- \`RESPONSE_TOO_LARGE\` — The response would exceed its budget.
|
|
10570
|
+
- \`EXPORT_FAILED\` — The render failed; read \`error.cause\`.
|
|
10571
|
+
- \`INVALID_PARAMS\` — The request is malformed.
|
|
10572
|
+
- \`PERMISSION_DENIED\` — This credential may not do that here.
|
|
10573
|
+
- \`NOT_IMPLEMENTED\` — Not available on this platform yet.
|
|
10574
|
+
- \`INTERNAL\` — Unexpected failure; retry with the request id.
|
|
10575
|
+
<!-- cut-reference:end -->
|
|
10457
10576
|
`,
|
|
10458
10577
|
http: "POST",
|
|
10459
10578
|
path: "/cut/v1/projects/{project_id}:execute",
|
|
@@ -11546,7 +11665,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11546
11665
|
resource: "file.files",
|
|
11547
11666
|
method: "create",
|
|
11548
11667
|
summary: "Upload file",
|
|
11549
|
-
description: 'Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File(["Return within 23 days."], "policy.txt", { type: "text/plain" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.',
|
|
11668
|
+
description: 'Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File(["Return within 23 days."], "policy.txt", { type: "text/plain" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.',
|
|
11550
11669
|
http: "POST",
|
|
11551
11670
|
path: "/file/v1/files",
|
|
11552
11671
|
streaming: "no",
|
|
@@ -11568,10 +11687,11 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11568
11687
|
type: "string",
|
|
11569
11688
|
enum: [
|
|
11570
11689
|
"user_data",
|
|
11690
|
+
"assistants",
|
|
11571
11691
|
"vision"
|
|
11572
11692
|
],
|
|
11573
11693
|
required: true,
|
|
11574
|
-
description: "Purpose label stored with the file: user_data or vision. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data."
|
|
11694
|
+
description: "Purpose label stored with the file: user_data, assistants or vision. The label is stored and returned unchanged; assistants follows the same rules as user_data. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data."
|
|
11575
11695
|
},
|
|
11576
11696
|
{
|
|
11577
11697
|
name: "expires_after",
|
|
@@ -11640,7 +11760,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11640
11760
|
resource: "file.files.contentLinks",
|
|
11641
11761
|
method: "revoke",
|
|
11642
11762
|
summary: "Revoke a file content link",
|
|
11643
|
-
description: 'Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within
|
|
11763
|
+
description: 'Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within 15 minutes; the file and other links remain available. Only current IAM capability tokens can be revoked; legacy content links expire at the migration deadline. Example body: {"token":"<token from /c/>"}.',
|
|
11644
11764
|
http: "POST",
|
|
11645
11765
|
path: "/file/v1/files/{file_id}/content_links:revoke",
|
|
11646
11766
|
streaming: "no",
|
|
@@ -11669,7 +11789,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11669
11789
|
resource: "file.files.contentUrl",
|
|
11670
11790
|
method: "create",
|
|
11671
11791
|
summary: "Create a download URL",
|
|
11672
|
-
description: `Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to
|
|
11792
|
+
description: `Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to 900 seconds and is at most 604800 seconds. Issuance requires the same credential and file-read access as files.retrieveContent; a processing file returns 409 FILE_NOT_READY, so poll files.retrieve until active before retrying. A missing, expired or other-organization file returns 404. Each issuance creates a new link. OpenAI Files has no signed download URL; this follows S3 presigned GET semantics. Example body: {"ttl_seconds":3600}.`,
|
|
11673
11793
|
http: "POST",
|
|
11674
11794
|
path: "/file/v1/files/{file_id}/content_url",
|
|
11675
11795
|
streaming: "no",
|
|
@@ -11689,7 +11809,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11689
11809
|
name: "ttl_seconds",
|
|
11690
11810
|
type: "integer",
|
|
11691
11811
|
required: false,
|
|
11692
|
-
description: "Download link lifetime in seconds, from 1 through 604800; omitted means
|
|
11812
|
+
description: "Download link lifetime in seconds, from 1 through 604800; omitted means 900. This does not change the file's own expiry."
|
|
11693
11813
|
}
|
|
11694
11814
|
]
|
|
11695
11815
|
}
|
|
@@ -11698,7 +11818,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11698
11818
|
resource: "file.uploads",
|
|
11699
11819
|
method: "create",
|
|
11700
11820
|
summary: "Create an upload",
|
|
11701
|
-
description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most
|
|
11821
|
+
description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 20 GiB (21474836480 bytes) and only user_data, assistants and vision purposes. Send parts of at most 64000000 bytes; an unfinished upload waits for them for 7 days, so a client can create → send parts → query GET /file/v1/uploads/{upload_id} → resend only the missing parts → complete. Optional part_size fixes every part length and makes each numbered part retryable with identical bytes. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.",
|
|
11702
11822
|
http: "POST",
|
|
11703
11823
|
path: "/file/v1/uploads",
|
|
11704
11824
|
streaming: "no",
|
|
@@ -11712,7 +11832,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11712
11832
|
name: "bytes",
|
|
11713
11833
|
type: "integer",
|
|
11714
11834
|
required: true,
|
|
11715
|
-
description: "Exact complete file length in bytes, from 1 through
|
|
11835
|
+
description: "Exact complete file length in bytes, from 1 through 21474836480 (20 GiB); the sum of completed parts must match."
|
|
11716
11836
|
},
|
|
11717
11837
|
{
|
|
11718
11838
|
name: "filename",
|
|
@@ -11731,10 +11851,11 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11731
11851
|
type: "string",
|
|
11732
11852
|
enum: [
|
|
11733
11853
|
"user_data",
|
|
11854
|
+
"assistants",
|
|
11734
11855
|
"vision"
|
|
11735
11856
|
],
|
|
11736
11857
|
required: true,
|
|
11737
|
-
description: "Use user_data for conversation attachments, or vision for PNG, JPEG, GIF and WebP images."
|
|
11858
|
+
description: "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images."
|
|
11738
11859
|
},
|
|
11739
11860
|
{
|
|
11740
11861
|
name: "expires_after",
|
|
@@ -11755,7 +11876,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11755
11876
|
resource: "file.uploads",
|
|
11756
11877
|
method: "createSigned",
|
|
11757
11878
|
summary: "Create a one-time upload URL",
|
|
11758
|
-
description: "Upload a local file of up to
|
|
11879
|
+
description: "Upload a local file of up to 20 GiB from a coding agent without sending bytes through the model. Provide basename, exact byte count and MIME type. Up to 104857600 bytes, PUT the file to url with curl -T photo.png -H 'Content-Type: image/png' '<url>'; success returns 201 with the file object, and reuse returns 410 CAPABILITY_USED. Above that threshold, split the file into part_size chunks (default 64000000 bytes) and PUT each chunk to its numbered parts[].url in any order; an interrupted client GETs status_url to see the received parts and resends only what is missing, then POSTs complete_url without a body. Part PUTs return 200; completion returns 201 with the file object, including its state, or 400 if a part is missing. A processing file can be polled with files.retrieve until active. Identical part bytes may be retried; changed bytes at the same number return 400. Completion reuse returns 410 CAPABILITY_USED. Each PUT requires the exact signed Content-Length; single-PUT Content-Type must match content_type or be omitted. Expired, revoked, invalid, wrong-action or cross-organization URLs return 404. URL lifetime defaults to 900 seconds for single PUT or 604800 (7 days) for multipart, at most 604800; all multipart URLs, including status_url, share an expiry. Multipart creation reserves storage quota. Issuance requires the same unscoped credential as direct file creation. Each issuance creates a new upload and is not idempotent. Example body: {\"filename\":\"photo.png\",\"bytes\":2048,\"content_type\":\"image/png\"}.",
|
|
11759
11880
|
http: "POST",
|
|
11760
11881
|
path: "/file/v1/uploads/signed",
|
|
11761
11882
|
streaming: "no",
|
|
@@ -11775,7 +11896,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11775
11896
|
name: "bytes",
|
|
11776
11897
|
type: "integer",
|
|
11777
11898
|
required: true,
|
|
11778
|
-
description: "Exact local file size in bytes, from 1 through
|
|
11899
|
+
description: "Exact local file size in bytes, from 1 through 21474836480 (20 GiB). Up to 104857600 bytes returns one PUT URL; larger files return numbered part URLs, a completion URL and a status URL. Every PUT requires its exact signed Content-Length."
|
|
11779
11900
|
},
|
|
11780
11901
|
{
|
|
11781
11902
|
name: "content_type",
|
|
@@ -11788,16 +11909,17 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11788
11909
|
type: "string",
|
|
11789
11910
|
enum: [
|
|
11790
11911
|
"user_data",
|
|
11912
|
+
"assistants",
|
|
11791
11913
|
"vision"
|
|
11792
11914
|
],
|
|
11793
11915
|
required: false,
|
|
11794
|
-
description: "user_data
|
|
11916
|
+
description: "user_data and assistants store ordinary files and conversation images with their original purpose label; vision accepts PNG, JPEG, GIF or WebP images only. Omitted means user_data."
|
|
11795
11917
|
},
|
|
11796
11918
|
{
|
|
11797
11919
|
name: "expires_in",
|
|
11798
11920
|
type: "integer",
|
|
11799
11921
|
required: false,
|
|
11800
|
-
description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or
|
|
11922
|
+
description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or 604800 (7 days) for multipart. All part URLs, the status URL and the completion URL share one expiry. This does not set the resulting file's lifetime."
|
|
11801
11923
|
},
|
|
11802
11924
|
{
|
|
11803
11925
|
name: "part_size",
|
|
@@ -11808,6 +11930,24 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11808
11930
|
]
|
|
11809
11931
|
}
|
|
11810
11932
|
},
|
|
11933
|
+
{
|
|
11934
|
+
resource: "file.uploads",
|
|
11935
|
+
method: "retrieve",
|
|
11936
|
+
summary: "Retrieve an upload",
|
|
11937
|
+
description: "Read the state of an unfinished upload — its status, declared bytes, fixed part_size and the parts it already holds (received_parts, each with part_number, bytes and sha256). After a break or a failed part, call it to resend only the missing numbers, then complete. A cancelled or expired upload is refused; a completed one returns its file. A missing or other-organization upload returns 404.",
|
|
11938
|
+
http: "GET",
|
|
11939
|
+
path: "/file/v1/uploads/{upload_id}",
|
|
11940
|
+
streaming: "no",
|
|
11941
|
+
pagination: false,
|
|
11942
|
+
pathParams: [
|
|
11943
|
+
{
|
|
11944
|
+
name: "upload_id",
|
|
11945
|
+
sdkName: "upload_id",
|
|
11946
|
+
description: "Upload identifier returned by create; the upload must belong to your organization."
|
|
11947
|
+
}
|
|
11948
|
+
],
|
|
11949
|
+
query: []
|
|
11950
|
+
},
|
|
11811
11951
|
{
|
|
11812
11952
|
resource: "file.uploads",
|
|
11813
11953
|
method: "cancel",
|
|
@@ -11830,7 +11970,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11830
11970
|
resource: "file.uploads",
|
|
11831
11971
|
method: "complete",
|
|
11832
11972
|
summary: "Complete an upload",
|
|
11833
|
-
description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.",
|
|
11973
|
+
description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. When parts were lost, query GET /file/v1/uploads/{upload_id} and resend them before completing. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.",
|
|
11834
11974
|
http: "POST",
|
|
11835
11975
|
path: "/file/v1/uploads/{upload_id}/complete",
|
|
11836
11976
|
streaming: "no",
|
|
@@ -11866,7 +12006,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11866
12006
|
resource: "file.uploads.parts",
|
|
11867
12007
|
method: "create",
|
|
11868
12008
|
summary: "Add an upload part",
|
|
11869
|
-
description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.",
|
|
12009
|
+
description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID, and query GET /file/v1/uploads/{upload_id} to see which numbers already arrived. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.",
|
|
11870
12010
|
http: "POST",
|
|
11871
12011
|
path: "/file/v1/uploads/{upload_id}/parts",
|
|
11872
12012
|
streaming: "no",
|
|
@@ -11954,7 +12094,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11954
12094
|
resource: "knowledge.vectorStores",
|
|
11955
12095
|
method: "create",
|
|
11956
12096
|
summary: "Create knowledge base",
|
|
11957
|
-
description: 'Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded.
|
|
12097
|
+
description: 'Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; each account holds up to 100 active/nondeleted stores. Minimal body: {"name":"Refund policies"}.',
|
|
11958
12098
|
http: "POST",
|
|
11959
12099
|
path: "/knowledge/v1/vector_stores",
|
|
11960
12100
|
streaming: "no",
|
|
@@ -11993,7 +12133,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11993
12133
|
name: "chunking_strategy",
|
|
11994
12134
|
type: "object",
|
|
11995
12135
|
required: false,
|
|
11996
|
-
description: "auto
|
|
12136
|
+
description: "Native attachment strategy. auto uses static chunks of 800 estimated tokens with 400 overlap; static supplies explicit chunk sizes; hierarchical indexes child chunks and supplies bounded parent context. Existing attachments are reused unchanged; remove and reattach a file to change its strategy."
|
|
11997
12137
|
},
|
|
11998
12138
|
{
|
|
11999
12139
|
name: "description",
|
|
@@ -12340,7 +12480,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12340
12480
|
resource: "knowledge.vectorStores.files",
|
|
12341
12481
|
method: "create",
|
|
12342
12482
|
summary: "Add file",
|
|
12343
|
-
description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching.
|
|
12483
|
+
description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; chunk sizes use estimated tokens rather than a model tokenizer. Text, Markdown, CSV, JSON, HTML, PDF, DOCX, PPTX, XLSX and PNG/JPEG/GIF/WebP images can be extracted; audio and video uploads are not knowledge documents. Images may yield generated descriptions rather than verbatim OCR. auto chunking resolves to static 800/400; explicit sizes are 100–4096 with overlap at most half the size. Each store holds at most 10000 attached files. Reattaching the same file returns its existing record without applying new attributes or chunking; inspect last_error after failure.",
|
|
12344
12484
|
http: "POST",
|
|
12345
12485
|
path: "/knowledge/v1/vector_stores/{vector_store_id}/files",
|
|
12346
12486
|
streaming: "no",
|
|
@@ -12372,7 +12512,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12372
12512
|
name: "chunking_strategy",
|
|
12373
12513
|
type: "object",
|
|
12374
12514
|
required: false,
|
|
12375
|
-
description: "auto
|
|
12515
|
+
description: "Native attachment strategy. auto uses static chunks of 800 estimated tokens with 400 overlap; static supplies explicit chunk sizes; hierarchical indexes child chunks and supplies bounded parent context. Existing attachments are reused unchanged; remove and reattach a file to change its strategy."
|
|
12376
12516
|
}
|
|
12377
12517
|
]
|
|
12378
12518
|
}
|
|
@@ -12679,11 +12819,23 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12679
12819
|
],
|
|
12680
12820
|
query: []
|
|
12681
12821
|
},
|
|
12822
|
+
{
|
|
12823
|
+
resource: "media.generation.capabilities",
|
|
12824
|
+
method: "list",
|
|
12825
|
+
summary: "Get generation capabilities",
|
|
12826
|
+
description: "Read supported text-to-video intent, default model, duration and aspect-ratio limits, per-library concurrency and candidate retention. Generation is charged per second; unsaved candidates expire after 7 days.",
|
|
12827
|
+
http: "GET",
|
|
12828
|
+
path: "/media/v1/generation/capabilities",
|
|
12829
|
+
streaming: "no",
|
|
12830
|
+
pagination: false,
|
|
12831
|
+
pathParams: [],
|
|
12832
|
+
query: []
|
|
12833
|
+
},
|
|
12682
12834
|
{
|
|
12683
12835
|
resource: "media.libraries",
|
|
12684
12836
|
method: "list",
|
|
12685
12837
|
summary: "List libraries",
|
|
12686
|
-
description: "
|
|
12838
|
+
description: "Read a caller-owned library’s current settings, usage and lifecycle status. A deleting library remains readable; missing, foreign or purged libraries return LIBRARY_NOT_FOUND.",
|
|
12687
12839
|
http: "GET",
|
|
12688
12840
|
path: "/media/v1/libraries",
|
|
12689
12841
|
streaming: "no",
|
|
@@ -12765,7 +12917,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12765
12917
|
resource: "media.libraries",
|
|
12766
12918
|
method: "delete",
|
|
12767
12919
|
summary: "Delete library",
|
|
12768
|
-
description: "
|
|
12920
|
+
description: "Restore a deleting library before its purge_at deadline. The library becomes active again and deleted_at and purge_at are cleared; expired or non-deleting libraries cannot be restored.",
|
|
12769
12921
|
http: "DELETE",
|
|
12770
12922
|
path: "/media/v1/libraries/{library_id}",
|
|
12771
12923
|
streaming: "no",
|
|
@@ -12783,7 +12935,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12783
12935
|
resource: "media.libraries",
|
|
12784
12936
|
method: "retrieve",
|
|
12785
12937
|
summary: "Get library",
|
|
12786
|
-
description: "
|
|
12938
|
+
description: "Update an active library’s supplied settings. Labels replace the complete map; understanding settings and model roles merge with current values. Changing the embedding model is rejected while assets exist.",
|
|
12787
12939
|
http: "GET",
|
|
12788
12940
|
path: "/media/v1/libraries/{library_id}",
|
|
12789
12941
|
streaming: "no",
|
|
@@ -12801,7 +12953,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12801
12953
|
resource: "media.libraries",
|
|
12802
12954
|
method: "update",
|
|
12803
12955
|
summary: "Update library",
|
|
12804
|
-
description: "Update an active library
|
|
12956
|
+
description: "Update an active library. Set hotwords for spelling evidence in subsequent transcripts; [] disables inferred vocabulary. Transcript understanding calls the timestamped ASR, optional reference ASR and correction model through the existing metered model path. Reprocess assets to apply new settings to existing transcripts.",
|
|
12805
12957
|
http: "PATCH",
|
|
12806
12958
|
path: "/media/v1/libraries/{library_id}",
|
|
12807
12959
|
streaming: "no",
|
|
@@ -12817,6 +12969,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12817
12969
|
body: {
|
|
12818
12970
|
required: true,
|
|
12819
12971
|
fields: [
|
|
12972
|
+
{
|
|
12973
|
+
name: "hotwords",
|
|
12974
|
+
type: "array",
|
|
12975
|
+
itemType: "string",
|
|
12976
|
+
required: false,
|
|
12977
|
+
description: "Correction vocabulary, at most 200 nonblank terms of at most 32 Unicode characters each. Omitted on an unconfigured library: correction derives up to 200 distinct names from the library name and every folder level, excluding generic names such as 原始素材 and 混剪成品. An explicit empty array disables this vocabulary. Updating affects subsequent understanding and explicit reprocessing, not existing results."
|
|
12978
|
+
},
|
|
12820
12979
|
{
|
|
12821
12980
|
name: "models",
|
|
12822
12981
|
type: "object",
|
|
@@ -12848,7 +13007,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12848
13007
|
resource: "media.libraries.assets",
|
|
12849
13008
|
method: "list",
|
|
12850
13009
|
summary: "List assets",
|
|
12851
|
-
description: "
|
|
13010
|
+
description: "Upload content into an active library and return a Cloudinary-compatible resource. Use file for a multipart file, data URI, public HTTPS URL or same-owner file identifier. Reusing public_id overwrites by default; overwrite=false returns the existing resource. Chunk uploads require both chunk headers.",
|
|
12852
13011
|
http: "GET",
|
|
12853
13012
|
path: "/media/v1/libraries/{library_id}/assets",
|
|
12854
13013
|
streaming: "no",
|
|
@@ -12896,7 +13055,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12896
13055
|
resource: "media.libraries.assets",
|
|
12897
13056
|
method: "create",
|
|
12898
13057
|
summary: "Upload asset",
|
|
12899
|
-
description: "
|
|
13058
|
+
description: " For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.",
|
|
12900
13059
|
http: "POST",
|
|
12901
13060
|
path: "/media/v1/libraries/{library_id}/assets",
|
|
12902
13061
|
streaming: "no",
|
|
@@ -12941,7 +13100,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12941
13100
|
name: "asset_folder",
|
|
12942
13101
|
type: "string",
|
|
12943
13102
|
required: false,
|
|
12944
|
-
description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
|
|
13103
|
+
description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
|
|
12945
13104
|
},
|
|
12946
13105
|
{
|
|
12947
13106
|
name: "use_filename",
|
|
@@ -13020,7 +13179,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13020
13179
|
resource: "media.libraries.assets.import",
|
|
13021
13180
|
method: "create",
|
|
13022
13181
|
summary: "Import file",
|
|
13023
|
-
description: "Copy
|
|
13182
|
+
description: "Copy a File into an independent Media asset. New assets default to organization-private delivery (type=authenticated); explicitly set type=upload for public originals and derivatives. Omitting type on overwrite preserves the current type. Deleting the source File does not delete this copy. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.",
|
|
13024
13183
|
http: "POST",
|
|
13025
13184
|
path: "/media/v1/libraries/{library_id}/assets/import",
|
|
13026
13185
|
streaming: "no",
|
|
@@ -13040,7 +13199,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13040
13199
|
name: "file_id",
|
|
13041
13200
|
type: "string",
|
|
13042
13201
|
required: true,
|
|
13043
|
-
description: "File ID to copy into this library instead of file bytes. This independent copy defaults to
|
|
13202
|
+
description: "File ID to copy into this library instead of file bytes. This independent copy defaults to organization-private delivery (type=authenticated); explicitly set type=upload for public delivery. Deleting the source File does not delete this asset."
|
|
13044
13203
|
},
|
|
13045
13204
|
{
|
|
13046
13205
|
name: "public_id",
|
|
@@ -13064,7 +13223,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13064
13223
|
name: "asset_folder",
|
|
13065
13224
|
type: "string",
|
|
13066
13225
|
required: false,
|
|
13067
|
-
description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
|
|
13226
|
+
description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
|
|
13068
13227
|
},
|
|
13069
13228
|
{
|
|
13070
13229
|
name: "use_filename",
|
|
@@ -13143,7 +13302,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13143
13302
|
resource: "media.libraries.assets",
|
|
13144
13303
|
method: "delete",
|
|
13145
13304
|
summary: "Delete asset",
|
|
13146
|
-
description: "
|
|
13305
|
+
description: "Queue reprocessing of the asset’s current version and return its updated state immediately. Omit kinds to retry failed tasks and legacy source-size unsupported tasks; explicit kinds rerun applicable completed tasks and recoverable source-size unsupported tasks. Other unsupported causes remain unchanged. Replaced understandings become superseded, and processing finishes asynchronously.",
|
|
13147
13306
|
http: "DELETE",
|
|
13148
13307
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
|
|
13149
13308
|
streaming: "no",
|
|
@@ -13166,7 +13325,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13166
13325
|
resource: "media.libraries.assets",
|
|
13167
13326
|
method: "retrieve",
|
|
13168
13327
|
summary: "Get asset",
|
|
13169
|
-
description: "
|
|
13328
|
+
description: "Update an asset’s supplied metadata fields. Tags and context replace their current collections; an empty collection clears them. Moving asset_folder or changing display_name preserves public_id and delivery URLs.",
|
|
13170
13329
|
http: "GET",
|
|
13171
13330
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
|
|
13172
13331
|
streaming: "no",
|
|
@@ -13189,7 +13348,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13189
13348
|
resource: "media.libraries.assets",
|
|
13190
13349
|
method: "update",
|
|
13191
13350
|
summary: "Update asset",
|
|
13192
|
-
description: "
|
|
13351
|
+
description: "Delete an asset from the library so it is no longer readable, searchable or deliverable. This removes the asset rather than placing it in the library’s restoration window; a missing asset returns ASSET_NOT_FOUND.",
|
|
13193
13352
|
http: "PATCH",
|
|
13194
13353
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}",
|
|
13195
13354
|
streaming: "no",
|
|
@@ -13220,7 +13379,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13220
13379
|
name: "asset_folder",
|
|
13221
13380
|
type: "string",
|
|
13222
13381
|
required: false,
|
|
13223
|
-
description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected."
|
|
13382
|
+
description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
|
|
13224
13383
|
},
|
|
13225
13384
|
{
|
|
13226
13385
|
name: "tags",
|
|
@@ -13238,11 +13397,57 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13238
13397
|
]
|
|
13239
13398
|
}
|
|
13240
13399
|
},
|
|
13400
|
+
{
|
|
13401
|
+
resource: "media.libraries.assets.frames",
|
|
13402
|
+
method: "create",
|
|
13403
|
+
summary: "Create frame URLs",
|
|
13404
|
+
description: 'Media creates JPEG frame URLs for inspecting one or more moments in a video without downloading the original. Obtain library_id from libraries and asset_id plus duration from assets. Send 1–20 integer microsecond timestamps strictly below duration, for example {"at_micros":[0,1000000],"width":640}. Only video assets are supported; audio and images return INVALID_PARAMS. Width defaults to 640 and accepts 160, 320 or 640. This read operation does not store a new asset or rerun understanding. Fetch each returned URL to obtain the frame; delivery usage follows media pricing. Authenticated links expire after 300 seconds; upload links remain public and permanent. Reissue expired links. Foreign libraries and assets return 404 without revealing their existence.',
|
|
13405
|
+
http: "POST",
|
|
13406
|
+
path: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames",
|
|
13407
|
+
streaming: "no",
|
|
13408
|
+
pagination: false,
|
|
13409
|
+
pathParams: [
|
|
13410
|
+
{
|
|
13411
|
+
name: "library_id",
|
|
13412
|
+
sdkName: "library_id",
|
|
13413
|
+
description: "Library identifier returned by library creation or listing; must be accessible to the current credential."
|
|
13414
|
+
},
|
|
13415
|
+
{
|
|
13416
|
+
name: "asset_id",
|
|
13417
|
+
sdkName: "asset_id",
|
|
13418
|
+
description: "Video asset identifier returned by asset upload or listing in this library; read its duration before choosing timestamps."
|
|
13419
|
+
}
|
|
13420
|
+
],
|
|
13421
|
+
query: [],
|
|
13422
|
+
body: {
|
|
13423
|
+
required: true,
|
|
13424
|
+
fields: [
|
|
13425
|
+
{
|
|
13426
|
+
name: "at_micros",
|
|
13427
|
+
type: "array",
|
|
13428
|
+
itemType: "integer",
|
|
13429
|
+
required: true,
|
|
13430
|
+
description: "One to twenty timestamps in microseconds from the start of the video. Each must be a nonnegative safe integer strictly below the video duration; order and duplicates are preserved."
|
|
13431
|
+
},
|
|
13432
|
+
{
|
|
13433
|
+
name: "width",
|
|
13434
|
+
type: "integer",
|
|
13435
|
+
enum: [
|
|
13436
|
+
160,
|
|
13437
|
+
320,
|
|
13438
|
+
640
|
|
13439
|
+
],
|
|
13440
|
+
required: false,
|
|
13441
|
+
description: "Maximum JPEG width in pixels: 160 is a small thumbnail, 320 a preview and 640 a larger preview. Defaults to 640; larger widths are unavailable."
|
|
13442
|
+
}
|
|
13443
|
+
]
|
|
13444
|
+
}
|
|
13445
|
+
},
|
|
13241
13446
|
{
|
|
13242
13447
|
resource: "media.libraries.assets.reprocess",
|
|
13243
13448
|
method: "create",
|
|
13244
13449
|
summary: "Reprocess asset",
|
|
13245
|
-
description: "
|
|
13450
|
+
description: " For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.",
|
|
13246
13451
|
http: "POST",
|
|
13247
13452
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess",
|
|
13248
13453
|
streaming: "no",
|
|
@@ -13274,7 +13479,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13274
13479
|
"embedding"
|
|
13275
13480
|
],
|
|
13276
13481
|
required: false,
|
|
13277
|
-
description: "Processing tasks to rerun. Omit to retry failed tasks
|
|
13482
|
+
description: "Processing tasks to rerun. Omit to retry failed tasks and legacy source-size unsupported tasks; explicit kinds rerun applicable ready or failed tasks and recoverable source-size unsupported tasks. Other unsupported causes remain unchanged. Pending and running tasks are unchanged; an empty array does nothing."
|
|
13278
13483
|
}
|
|
13279
13484
|
]
|
|
13280
13485
|
}
|
|
@@ -13283,7 +13488,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13283
13488
|
resource: "media.libraries.assets.understandings",
|
|
13284
13489
|
method: "list",
|
|
13285
13490
|
summary: "List understandings",
|
|
13286
|
-
description: "List an asset
|
|
13491
|
+
description: "List understanding results for an asset, ordered by creation time. Use the cursor to continue; include_superseded also returns replaced records. The optional shots array contains current-version shot boundaries and per-shot captions, scene, location guesses, visible text and confidence flags; it is absent on legacy records. Location guesses and folder mismatch are unverified hints. Correction-enabled transcripts expose text_original, corrected text and a correction audit. Their timed data array remains suitable for subtitles. Reference failure is marked missing; correction failure returns the original verbatim. Model inference uses the existing metered model path.",
|
|
13287
13492
|
http: "GET",
|
|
13288
13493
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}/understandings",
|
|
13289
13494
|
streaming: "no",
|
|
@@ -13315,10 +13520,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13315
13520
|
"tags",
|
|
13316
13521
|
"ocr",
|
|
13317
13522
|
"transcript",
|
|
13318
|
-
"frame"
|
|
13523
|
+
"frame",
|
|
13524
|
+
"overview",
|
|
13525
|
+
"audio",
|
|
13526
|
+
"embedding"
|
|
13319
13527
|
],
|
|
13320
13528
|
required: false,
|
|
13321
|
-
description: "
|
|
13529
|
+
description: "Return one output kind: caption is a visual description, tags are generated labels, ocr is visible text, transcript is speech, frame is a video shot, overview is a video summary, audio is sampled audio understanding, and embedding reports a failed embedding step."
|
|
13322
13530
|
},
|
|
13323
13531
|
{
|
|
13324
13532
|
name: "cursor",
|
|
@@ -13338,7 +13546,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13338
13546
|
resource: "media.libraries.assets",
|
|
13339
13547
|
method: "batch",
|
|
13340
13548
|
summary: "Batch assets alias",
|
|
13341
|
-
description:
|
|
13549
|
+
description: 'Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.',
|
|
13342
13550
|
http: "POST",
|
|
13343
13551
|
path: "/media/v1/libraries/{library_id}/assets:batch",
|
|
13344
13552
|
streaming: "no",
|
|
@@ -13359,6 +13567,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13359
13567
|
type: "object",
|
|
13360
13568
|
required: true,
|
|
13361
13569
|
description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
|
|
13570
|
+
},
|
|
13571
|
+
{
|
|
13572
|
+
name: "reason",
|
|
13573
|
+
type: "string",
|
|
13574
|
+
required: false,
|
|
13575
|
+
description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
|
|
13362
13576
|
}
|
|
13363
13577
|
]
|
|
13364
13578
|
}
|
|
@@ -13367,7 +13581,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13367
13581
|
resource: "media.libraries.batches",
|
|
13368
13582
|
method: "create",
|
|
13369
13583
|
summary: "Create batch",
|
|
13370
|
-
description:
|
|
13584
|
+
description: 'Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.',
|
|
13371
13585
|
http: "POST",
|
|
13372
13586
|
path: "/media/v1/libraries/{library_id}/batches",
|
|
13373
13587
|
streaming: "no",
|
|
@@ -13388,6 +13602,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13388
13602
|
type: "object",
|
|
13389
13603
|
required: true,
|
|
13390
13604
|
description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created."
|
|
13605
|
+
},
|
|
13606
|
+
{
|
|
13607
|
+
name: "reason",
|
|
13608
|
+
type: "string",
|
|
13609
|
+
required: false,
|
|
13610
|
+
description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters."
|
|
13391
13611
|
}
|
|
13392
13612
|
]
|
|
13393
13613
|
}
|
|
@@ -13396,7 +13616,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13396
13616
|
resource: "media.libraries.batches",
|
|
13397
13617
|
method: "retrieve",
|
|
13398
13618
|
summary: "Get batch",
|
|
13399
|
-
description: "
|
|
13619
|
+
description: "Alias of batch creation. Apply one metadata or deletion action to ids or a frozen expression selection asynchronously; poll the returned job id to inspect completion and item failures.",
|
|
13400
13620
|
http: "GET",
|
|
13401
13621
|
path: "/media/v1/libraries/{library_id}/batches/{job_id}",
|
|
13402
13622
|
streaming: "no",
|
|
@@ -13419,7 +13639,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13419
13639
|
resource: "media.libraries.deliveryTokens",
|
|
13420
13640
|
method: "create",
|
|
13421
13641
|
summary: "Create delivery token",
|
|
13422
|
-
description: "Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is
|
|
13642
|
+
description: "Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is 900 seconds; narrow acl and expires_in before sharing. Anyone holding the token can read matching paths until expires_at.",
|
|
13423
13643
|
http: "POST",
|
|
13424
13644
|
path: "/media/v1/libraries/{library_id}/delivery_tokens",
|
|
13425
13645
|
streaming: "no",
|
|
@@ -13445,7 +13665,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13445
13665
|
name: "expires_in",
|
|
13446
13666
|
type: "integer",
|
|
13447
13667
|
required: false,
|
|
13448
|
-
description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to
|
|
13668
|
+
description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 900."
|
|
13449
13669
|
}
|
|
13450
13670
|
]
|
|
13451
13671
|
}
|
|
@@ -13454,7 +13674,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13454
13674
|
resource: "media.libraries.events",
|
|
13455
13675
|
method: "list",
|
|
13456
13676
|
summary: "List events",
|
|
13457
|
-
description: "Read library events in sequence order
|
|
13677
|
+
description: "Read library events in sequence order for observing asset writes and understanding progress. Obtain library_id from creation or listing; continue with after_seq for asc or before_seq for desc, without combining both. Use next_cursor when supplied. Reads do not start or retry understanding.",
|
|
13458
13678
|
http: "GET",
|
|
13459
13679
|
path: "/media/v1/libraries/{library_id}/events",
|
|
13460
13680
|
streaming: "no",
|
|
@@ -13501,7 +13721,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13501
13721
|
resource: "media.libraries.folders",
|
|
13502
13722
|
method: "list",
|
|
13503
13723
|
summary: "List folders",
|
|
13504
|
-
description: "
|
|
13724
|
+
description: "undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.",
|
|
13505
13725
|
http: "GET",
|
|
13506
13726
|
path: "/media/v1/libraries/{library_id}/folders",
|
|
13507
13727
|
streaming: "no",
|
|
@@ -13522,11 +13742,155 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13522
13742
|
}
|
|
13523
13743
|
]
|
|
13524
13744
|
},
|
|
13745
|
+
{
|
|
13746
|
+
resource: "media.libraries.generations",
|
|
13747
|
+
method: "create",
|
|
13748
|
+
summary: "Create video generation",
|
|
13749
|
+
description: "Create a video.generate job. Generation is charged per second. The response is 202 with a queued Job; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until terminal, then save successful outputs. Unsaved candidate Files expire after 7 days.",
|
|
13750
|
+
http: "POST",
|
|
13751
|
+
path: "/media/v1/libraries/{library_id}/generations",
|
|
13752
|
+
streaming: "no",
|
|
13753
|
+
pagination: false,
|
|
13754
|
+
pathParams: [
|
|
13755
|
+
{
|
|
13756
|
+
name: "library_id",
|
|
13757
|
+
sdkName: "library_id",
|
|
13758
|
+
description: "Library ID returned by creation."
|
|
13759
|
+
}
|
|
13760
|
+
],
|
|
13761
|
+
query: [],
|
|
13762
|
+
body: {
|
|
13763
|
+
required: true,
|
|
13764
|
+
fields: [
|
|
13765
|
+
{
|
|
13766
|
+
name: "intent",
|
|
13767
|
+
type: "string",
|
|
13768
|
+
required: true,
|
|
13769
|
+
description: "Generation operation; v1 accepts only video.generate text-to-video requests."
|
|
13770
|
+
},
|
|
13771
|
+
{
|
|
13772
|
+
name: "prompt",
|
|
13773
|
+
type: "string",
|
|
13774
|
+
required: true,
|
|
13775
|
+
description: "Text prompt describing the video to generate."
|
|
13776
|
+
},
|
|
13777
|
+
{
|
|
13778
|
+
name: "count",
|
|
13779
|
+
type: "integer",
|
|
13780
|
+
required: false,
|
|
13781
|
+
description: "Number of videos to generate; defaults to 1 and must be from 1 to 4."
|
|
13782
|
+
},
|
|
13783
|
+
{
|
|
13784
|
+
name: "duration_seconds",
|
|
13785
|
+
type: "integer",
|
|
13786
|
+
required: false,
|
|
13787
|
+
description: "Requested video duration in seconds; Router validates the model-specific supported durations."
|
|
13788
|
+
},
|
|
13789
|
+
{
|
|
13790
|
+
name: "aspect_ratio",
|
|
13791
|
+
type: "string",
|
|
13792
|
+
required: false,
|
|
13793
|
+
description: "Requested output aspect ratio; defaults to 16:9 and Router validates model support."
|
|
13794
|
+
},
|
|
13795
|
+
{
|
|
13796
|
+
name: "model",
|
|
13797
|
+
type: "string",
|
|
13798
|
+
required: false,
|
|
13799
|
+
description: "Router model with video_generation capability; defaults to wan2.7-t2v."
|
|
13800
|
+
},
|
|
13801
|
+
{
|
|
13802
|
+
name: "save",
|
|
13803
|
+
type: "string",
|
|
13804
|
+
enum: [
|
|
13805
|
+
"candidate",
|
|
13806
|
+
"library"
|
|
13807
|
+
],
|
|
13808
|
+
required: false,
|
|
13809
|
+
description: "candidate keeps outputs temporary for explicit save calls; library saves successful outputs automatically."
|
|
13810
|
+
},
|
|
13811
|
+
{
|
|
13812
|
+
name: "asset_folder",
|
|
13813
|
+
type: "string",
|
|
13814
|
+
required: false,
|
|
13815
|
+
description: "Folder for assets saved automatically or by later save calls; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
|
|
13816
|
+
},
|
|
13817
|
+
{
|
|
13818
|
+
name: "tags",
|
|
13819
|
+
type: "array",
|
|
13820
|
+
itemType: "string",
|
|
13821
|
+
required: false,
|
|
13822
|
+
description: "Tags applied when an output becomes a library asset."
|
|
13823
|
+
},
|
|
13824
|
+
{
|
|
13825
|
+
name: "understanding",
|
|
13826
|
+
type: "string",
|
|
13827
|
+
enum: [
|
|
13828
|
+
"auto",
|
|
13829
|
+
"skip"
|
|
13830
|
+
],
|
|
13831
|
+
required: false,
|
|
13832
|
+
description: "Understanding behavior when a candidate is saved as an asset; defaults to auto."
|
|
13833
|
+
},
|
|
13834
|
+
{
|
|
13835
|
+
name: "references",
|
|
13836
|
+
type: "array",
|
|
13837
|
+
itemType: "object",
|
|
13838
|
+
required: false,
|
|
13839
|
+
description: "Not supported in v1; omit this field. Only text-to-video is currently available."
|
|
13840
|
+
}
|
|
13841
|
+
]
|
|
13842
|
+
}
|
|
13843
|
+
},
|
|
13844
|
+
{
|
|
13845
|
+
resource: "media.libraries.jobs",
|
|
13846
|
+
method: "list",
|
|
13847
|
+
summary: "List jobs",
|
|
13848
|
+
description: "List batch and video-generation jobs in a library. Filter by status and continue with next_cursor. Poll a generation Job until terminal, then save successful candidate outputs before they expire after 7 days.",
|
|
13849
|
+
http: "GET",
|
|
13850
|
+
path: "/media/v1/libraries/{library_id}/jobs",
|
|
13851
|
+
streaming: "no",
|
|
13852
|
+
pagination: true,
|
|
13853
|
+
pathParams: [
|
|
13854
|
+
{
|
|
13855
|
+
name: "library_id",
|
|
13856
|
+
sdkName: "library_id",
|
|
13857
|
+
description: "Library ID returned by creation."
|
|
13858
|
+
}
|
|
13859
|
+
],
|
|
13860
|
+
query: [
|
|
13861
|
+
{
|
|
13862
|
+
name: "status",
|
|
13863
|
+
type: "string",
|
|
13864
|
+
enum: [
|
|
13865
|
+
"queued",
|
|
13866
|
+
"running",
|
|
13867
|
+
"completed",
|
|
13868
|
+
"completed_with_errors",
|
|
13869
|
+
"failed",
|
|
13870
|
+
"cancelled"
|
|
13871
|
+
],
|
|
13872
|
+
required: false,
|
|
13873
|
+
description: "Filter jobs by their current status."
|
|
13874
|
+
},
|
|
13875
|
+
{
|
|
13876
|
+
name: "limit",
|
|
13877
|
+
type: "integer",
|
|
13878
|
+
required: false,
|
|
13879
|
+
description: "Maximum entries in this page, from 1 through 100; defaults to 100."
|
|
13880
|
+
},
|
|
13881
|
+
{
|
|
13882
|
+
name: "cursor",
|
|
13883
|
+
type: "string",
|
|
13884
|
+
required: false,
|
|
13885
|
+
description: "Job id from the previous page’s next_cursor; omit for the first page."
|
|
13886
|
+
}
|
|
13887
|
+
]
|
|
13888
|
+
},
|
|
13525
13889
|
{
|
|
13526
13890
|
resource: "media.libraries.jobs",
|
|
13527
13891
|
method: "retrieve",
|
|
13528
|
-
summary: "Get job
|
|
13529
|
-
description: "
|
|
13892
|
+
summary: "Get job",
|
|
13893
|
+
description: "Read the current batch or video-generation Job status and progress. For generation, inspect outputs and failures, then save successful candidates before their preview and save window expires after 7 days.",
|
|
13530
13894
|
http: "GET",
|
|
13531
13895
|
path: "/media/v1/libraries/{library_id}/jobs/{job_id}",
|
|
13532
13896
|
streaming: "no",
|
|
@@ -13540,16 +13904,101 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13540
13904
|
{
|
|
13541
13905
|
name: "job_id",
|
|
13542
13906
|
sdkName: "job_id",
|
|
13543
|
-
description: "
|
|
13907
|
+
description: "Job identifier returned by batch creation, video-generation creation or job listing; resolved within this library."
|
|
13908
|
+
}
|
|
13909
|
+
],
|
|
13910
|
+
query: []
|
|
13911
|
+
},
|
|
13912
|
+
{
|
|
13913
|
+
resource: "media.libraries.jobs",
|
|
13914
|
+
method: "cancel",
|
|
13915
|
+
summary: "Cancel job",
|
|
13916
|
+
description: "Cancel a queued or running generation job. Already completed outputs remain available to save; poll or read the returned Job to confirm its status.",
|
|
13917
|
+
http: "POST",
|
|
13918
|
+
path: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
|
|
13919
|
+
streaming: "no",
|
|
13920
|
+
pagination: false,
|
|
13921
|
+
pathParams: [
|
|
13922
|
+
{
|
|
13923
|
+
name: "library_id",
|
|
13924
|
+
sdkName: "library_id",
|
|
13925
|
+
description: "Library ID returned by creation."
|
|
13926
|
+
},
|
|
13927
|
+
{
|
|
13928
|
+
name: "job_id",
|
|
13929
|
+
sdkName: "job_id",
|
|
13930
|
+
description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
|
|
13544
13931
|
}
|
|
13545
13932
|
],
|
|
13546
13933
|
query: []
|
|
13547
13934
|
},
|
|
13935
|
+
{
|
|
13936
|
+
resource: "media.libraries.jobs.outputs.save",
|
|
13937
|
+
method: "create",
|
|
13938
|
+
summary: "Save generation output",
|
|
13939
|
+
description: "Save a successful candidate as a library asset. Candidate outputs expire after 7 days; save before expiry. Generation is charged per second when the job runs, not when an output is saved.",
|
|
13940
|
+
http: "POST",
|
|
13941
|
+
path: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
|
|
13942
|
+
streaming: "no",
|
|
13943
|
+
pagination: false,
|
|
13944
|
+
pathParams: [
|
|
13945
|
+
{
|
|
13946
|
+
name: "library_id",
|
|
13947
|
+
sdkName: "library_id",
|
|
13948
|
+
description: "Library ID returned by creation."
|
|
13949
|
+
},
|
|
13950
|
+
{
|
|
13951
|
+
name: "job_id",
|
|
13952
|
+
sdkName: "job_id",
|
|
13953
|
+
description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
|
|
13954
|
+
},
|
|
13955
|
+
{
|
|
13956
|
+
name: "index",
|
|
13957
|
+
sdkName: "index",
|
|
13958
|
+
description: "Zero-based position of the candidate in the Job outputs array."
|
|
13959
|
+
}
|
|
13960
|
+
],
|
|
13961
|
+
query: [],
|
|
13962
|
+
body: {
|
|
13963
|
+
required: false,
|
|
13964
|
+
fields: [
|
|
13965
|
+
{
|
|
13966
|
+
name: "public_id",
|
|
13967
|
+
type: "string",
|
|
13968
|
+
required: false,
|
|
13969
|
+
description: "Delivery identifier for the saved asset; defaults to gen_<job_id>_<index> and is idempotent."
|
|
13970
|
+
},
|
|
13971
|
+
{
|
|
13972
|
+
name: "asset_folder",
|
|
13973
|
+
type: "string",
|
|
13974
|
+
required: false,
|
|
13975
|
+
description: "Destination folder for the saved asset; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
|
|
13976
|
+
},
|
|
13977
|
+
{
|
|
13978
|
+
name: "tags",
|
|
13979
|
+
type: "array",
|
|
13980
|
+
itemType: "string",
|
|
13981
|
+
required: false,
|
|
13982
|
+
description: "Tags to apply to the saved asset."
|
|
13983
|
+
},
|
|
13984
|
+
{
|
|
13985
|
+
name: "understanding",
|
|
13986
|
+
type: "string",
|
|
13987
|
+
enum: [
|
|
13988
|
+
"auto",
|
|
13989
|
+
"skip"
|
|
13990
|
+
],
|
|
13991
|
+
required: false,
|
|
13992
|
+
description: "Understanding behavior for the saved asset; defaults to auto."
|
|
13993
|
+
}
|
|
13994
|
+
]
|
|
13995
|
+
}
|
|
13996
|
+
},
|
|
13548
13997
|
{
|
|
13549
13998
|
resource: "media.libraries.purge",
|
|
13550
13999
|
method: "create",
|
|
13551
14000
|
summary: "Purge library",
|
|
13552
|
-
description: "
|
|
14001
|
+
description: "List assets in an active library, newest first, optionally filtering by exact folder and stored resource type. Continue using next_cursor; video includes audio-only assets.",
|
|
13553
14002
|
http: "POST",
|
|
13554
14003
|
path: "/media/v1/libraries/{library_id}/purge",
|
|
13555
14004
|
streaming: "no",
|
|
@@ -13567,7 +14016,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13567
14016
|
resource: "media.libraries",
|
|
13568
14017
|
method: "restore",
|
|
13569
14018
|
summary: "Restore library",
|
|
13570
|
-
description: "
|
|
14019
|
+
description: "Permanently remove a library that is already deleting, without waiting for purge_at. Its assets and related resources are removed and cannot be restored; first soft-delete an active library.",
|
|
13571
14020
|
http: "POST",
|
|
13572
14021
|
path: "/media/v1/libraries/{library_id}/restore",
|
|
13573
14022
|
streaming: "no",
|
|
@@ -13585,7 +14034,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13585
14034
|
resource: "media.libraries.search",
|
|
13586
14035
|
method: "create",
|
|
13587
14036
|
summary: "Semantic search alias",
|
|
13588
|
-
description: "
|
|
14037
|
+
description: "List all immediate child folders under parent, or under the root when parent is omitted. Counts include descendant assets. The result is unpaginated; limit and cursor are rejected.",
|
|
13589
14038
|
http: "POST",
|
|
13590
14039
|
path: "/media/v1/libraries/{library_id}/search",
|
|
13591
14040
|
streaming: "no",
|
|
@@ -13636,7 +14085,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13636
14085
|
resource: "media.libraries.search.expression",
|
|
13637
14086
|
method: "create",
|
|
13638
14087
|
summary: "Expression search",
|
|
13639
|
-
description: "
|
|
14088
|
+
description: "Find visually similar assets using exactly one of asset_id or an inline base64 image. The library must support image search; an asset query needs a current image embedding and excludes that source asset from results.",
|
|
13640
14089
|
http: "POST",
|
|
13641
14090
|
path: "/media/v1/libraries/{library_id}/search/expression",
|
|
13642
14091
|
streaming: "no",
|
|
@@ -13656,7 +14105,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13656
14105
|
name: "expression",
|
|
13657
14106
|
type: "string",
|
|
13658
14107
|
required: false,
|
|
13659
|
-
description: 'Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets. For business metadata use context.sku=KETTLE-RED AND context.revision=2; request with_field: ["context"] to include context.'
|
|
14108
|
+
description: 'Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets. For business metadata use context.sku=KETTLE-RED AND context.revision=2; request with_field: ["context"] to include context. Quality filters: flags:watermark matches any current shot with a watermark; flags.watermark:false requires an assessed video with no positive watermark judgment. The same syntax supports slideshow, hand_frame, text_sticker and low_quality. folder_mismatch:true selects lexical folder/location hints. Geometry filters support width, height, resolution:1920x1080, numeric aspect_ratio (width/height), and orientation:landscape, portrait or square. Missing geometry or unassessed legacy flags do not match positive filters. has_music:true AND audio_genre:jazz AND audio_mood:calm selects current-version audio profiles with music and matching model labels; has_music:false applies only to sampled ranges, not the entire source. failure_code=UPSTREAM_FAILED selects assets with a current failed understanding carrying that code; combine with processing_state=failed or processing_state=partial.'
|
|
13660
14109
|
},
|
|
13661
14110
|
{
|
|
13662
14111
|
name: "sort_by",
|
|
@@ -13708,7 +14157,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13708
14157
|
resource: "media.libraries.search.semantic",
|
|
13709
14158
|
method: "create",
|
|
13710
14159
|
summary: "Semantic search",
|
|
13711
|
-
description: "Search assets with a nonblank text query
|
|
14160
|
+
description: "Alias of semantic search. Search assets with a nonblank text query, optional expression filter and top_k; hybrid combines semantic and keyword matches, while semantic uses vector similarity only.",
|
|
13712
14161
|
http: "POST",
|
|
13713
14162
|
path: "/media/v1/libraries/{library_id}/search/semantic",
|
|
13714
14163
|
streaming: "no",
|
|
@@ -13759,7 +14208,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13759
14208
|
resource: "media.libraries.search.visual",
|
|
13760
14209
|
method: "create",
|
|
13761
14210
|
summary: "Visual search",
|
|
13762
|
-
description: "
|
|
14211
|
+
description: "Search assets with a nonblank text query and optional expression filter. Hybrid mode combines semantic and keyword matches; semantic mode uses vector similarity only. Results are ranked and limited by top_k.",
|
|
13763
14212
|
http: "POST",
|
|
13764
14213
|
path: "/media/v1/libraries/{library_id}/search/visual",
|
|
13765
14214
|
streaming: "no",
|
|
@@ -13802,6 +14251,67 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13802
14251
|
]
|
|
13803
14252
|
}
|
|
13804
14253
|
},
|
|
14254
|
+
{
|
|
14255
|
+
resource: "media.libraries.understandings",
|
|
14256
|
+
method: "list",
|
|
14257
|
+
summary: "List understanding results across a library",
|
|
14258
|
+
description: "Read current understanding entries across one library without fetching every asset separately. Use library_id from creation or listing. folder includes descendants; kinds is a comma-separated list of output kinds. Entries are ordered by asset_id and then understanding id. Continue with next_cursor and the same folder and kinds; limit defaults to 100 and cannot exceed 100. Superseded, deleted and old-version entries are excluded. During historical backfill, this method returns 503 CAPACITY rather than incomplete pages; poll failureSummary until counts_complete is true, then start pagination. Example: GET /media/v1/libraries/lib_example/understandings?folder=travel&kinds=caption,transcript&limit=100.",
|
|
14259
|
+
http: "GET",
|
|
14260
|
+
path: "/media/v1/libraries/{library_id}/understandings",
|
|
14261
|
+
streaming: "no",
|
|
14262
|
+
pagination: true,
|
|
14263
|
+
pathParams: [
|
|
14264
|
+
{
|
|
14265
|
+
name: "library_id",
|
|
14266
|
+
sdkName: "library_id",
|
|
14267
|
+
description: "Library ID returned by creation."
|
|
14268
|
+
}
|
|
14269
|
+
],
|
|
14270
|
+
query: [
|
|
14271
|
+
{
|
|
14272
|
+
name: "folder",
|
|
14273
|
+
type: "string",
|
|
14274
|
+
required: false,
|
|
14275
|
+
description: "Folder path including all descendants; omitted or empty selects the entire library."
|
|
14276
|
+
},
|
|
14277
|
+
{
|
|
14278
|
+
name: "kinds",
|
|
14279
|
+
type: "string",
|
|
14280
|
+
required: false,
|
|
14281
|
+
description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind."
|
|
14282
|
+
},
|
|
14283
|
+
{
|
|
14284
|
+
name: "cursor",
|
|
14285
|
+
type: "string",
|
|
14286
|
+
required: false,
|
|
14287
|
+
description: "Cursor from the previous next_cursor."
|
|
14288
|
+
},
|
|
14289
|
+
{
|
|
14290
|
+
name: "limit",
|
|
14291
|
+
type: "integer",
|
|
14292
|
+
required: false,
|
|
14293
|
+
description: "Maximum entries in this page, from 1 through 100; defaults to 100."
|
|
14294
|
+
}
|
|
14295
|
+
]
|
|
14296
|
+
},
|
|
14297
|
+
{
|
|
14298
|
+
resource: "media.libraries.understandings",
|
|
14299
|
+
method: "retrieveFailureSummary",
|
|
14300
|
+
summary: "Summarize understanding failures",
|
|
14301
|
+
description: "Inspect current understanding failures before retrying. Use library_id from library creation or listing. Groups include code, output kind, actual producer model, retryability and up to five sample asset IDs. At most 1024 detailed groups plus two overflow groups are returned; overflow groups separate retryable and unrecoverable entries and mark overflow=true. Unknown failure codes remain retryable. Historical counts are provisional while counts_complete is false. Example: GET /media/v1/libraries/lib_example/understandings/failure_summary.",
|
|
14302
|
+
http: "GET",
|
|
14303
|
+
path: "/media/v1/libraries/{library_id}/understandings/failure_summary",
|
|
14304
|
+
streaming: "no",
|
|
14305
|
+
pagination: false,
|
|
14306
|
+
pathParams: [
|
|
14307
|
+
{
|
|
14308
|
+
name: "library_id",
|
|
14309
|
+
sdkName: "library_id",
|
|
14310
|
+
description: "Library ID returned by creation."
|
|
14311
|
+
}
|
|
14312
|
+
],
|
|
14313
|
+
query: []
|
|
14314
|
+
},
|
|
13805
14315
|
{
|
|
13806
14316
|
resource: "meta.docs",
|
|
13807
14317
|
method: "search",
|
|
@@ -14089,25 +14599,25 @@ services (model, agent, automation…); call the operation you need and read its
|
|
|
14089
14599
|
name: "model",
|
|
14090
14600
|
type: "string",
|
|
14091
14601
|
required: true,
|
|
14092
|
-
description: "
|
|
14602
|
+
description: "Model catalog identifier declaring openai.audio.transcriptions; use it unchanged, including any creator prefix."
|
|
14093
14603
|
},
|
|
14094
14604
|
{
|
|
14095
14605
|
name: "file",
|
|
14096
14606
|
type: "string",
|
|
14097
14607
|
required: true,
|
|
14098
|
-
description: "Audio
|
|
14608
|
+
description: "Audio bytes uploaded as a multipart file; supported formats and input limits depend on the selected model."
|
|
14099
14609
|
},
|
|
14100
14610
|
{
|
|
14101
14611
|
name: "language",
|
|
14102
14612
|
type: "string",
|
|
14103
14613
|
required: false,
|
|
14104
|
-
description: "
|
|
14614
|
+
description: "Source language code when known; omit to let the model detect the language."
|
|
14105
14615
|
},
|
|
14106
14616
|
{
|
|
14107
14617
|
name: "prompt",
|
|
14108
14618
|
type: "string",
|
|
14109
14619
|
required: false,
|
|
14110
|
-
description: "
|
|
14620
|
+
description: "Optional vocabulary or contextual guidance for recognizing the audio; support depends on the selected model."
|
|
14111
14621
|
},
|
|
14112
14622
|
{
|
|
14113
14623
|
name: "response_format",
|
|
@@ -14115,20 +14625,22 @@ services (model, agent, automation…); call the operation you need and read its
|
|
|
14115
14625
|
enum: [
|
|
14116
14626
|
"json",
|
|
14117
14627
|
"text",
|
|
14118
|
-
"verbose_json"
|
|
14628
|
+
"verbose_json",
|
|
14629
|
+
"diarized_json"
|
|
14119
14630
|
],
|
|
14120
14631
|
required: false,
|
|
14121
|
-
description: "
|
|
14632
|
+
description: "Output format: json returns text in JSON; text returns plain text; verbose_json includes requested timestamps; diarized_json includes speaker-labelled segments when supported. Defaults to json."
|
|
14122
14633
|
},
|
|
14123
14634
|
{
|
|
14124
14635
|
name: "timestamp_granularities[]",
|
|
14125
14636
|
type: "array",
|
|
14126
14637
|
itemType: "string",
|
|
14127
14638
|
enum: [
|
|
14639
|
+
"word",
|
|
14128
14640
|
"segment"
|
|
14129
14641
|
],
|
|
14130
14642
|
required: false,
|
|
14131
|
-
description: "Timestamp levels to
|
|
14643
|
+
description: "Timestamp levels to request as repeated multipart fields: word returns per-word times; segment returns segment times. Omit for the model default. Use verbose_json, or diarized_json on supporting models."
|
|
14132
14644
|
},
|
|
14133
14645
|
{
|
|
14134
14646
|
name: "temperature",
|
|
@@ -16282,6 +16794,539 @@ for more details.`
|
|
|
16282
16794
|
],
|
|
16283
16795
|
query: []
|
|
16284
16796
|
},
|
|
16797
|
+
{
|
|
16798
|
+
resource: "ontology.changesets",
|
|
16799
|
+
method: "create",
|
|
16800
|
+
summary: "Apply changeset",
|
|
16801
|
+
description: "Apply a batch of node, relation and invalidation operations as one transaction, when a mirror has several records to write together and a partial write would leave the graph inconsistent. Every operation succeeds or none is applied. Send an Idempotency-Key header; the same key with the same content replays the first result, and the same key with different content is ONTOLOGY_CONFLICT.",
|
|
16802
|
+
http: "POST",
|
|
16803
|
+
path: "/ontology/v1/changesets",
|
|
16804
|
+
streaming: "no",
|
|
16805
|
+
pagination: false,
|
|
16806
|
+
pathParams: [],
|
|
16807
|
+
query: [],
|
|
16808
|
+
body: {
|
|
16809
|
+
required: true,
|
|
16810
|
+
fields: [
|
|
16811
|
+
{
|
|
16812
|
+
name: "at",
|
|
16813
|
+
type: "string",
|
|
16814
|
+
required: true,
|
|
16815
|
+
description: "World time the batch describes, in ISO 8601 UTC; operations without their own time are dated by it."
|
|
16816
|
+
},
|
|
16817
|
+
{
|
|
16818
|
+
name: "scope",
|
|
16819
|
+
type: "string",
|
|
16820
|
+
required: false,
|
|
16821
|
+
description: "Scope the batch came from, normally the session id it was observed in; it is stored with the operations for later reading."
|
|
16822
|
+
},
|
|
16823
|
+
{
|
|
16824
|
+
name: "ops",
|
|
16825
|
+
type: "array",
|
|
16826
|
+
itemType: "object",
|
|
16827
|
+
required: true,
|
|
16828
|
+
description: "At most 500 operations, applied in order; each names its kind in op and the fields that kind requires."
|
|
16829
|
+
}
|
|
16830
|
+
]
|
|
16831
|
+
}
|
|
16832
|
+
},
|
|
16833
|
+
{
|
|
16834
|
+
resource: "ontology.nodes",
|
|
16835
|
+
method: "list",
|
|
16836
|
+
summary: "List nodes",
|
|
16837
|
+
description: "Discover the entities in this organization's graph and obtain node ids for retrieval, updates and relations. Filter by type, by free text over names, aliases, descriptions and facts, or by owner; limit is 1–100 and defaults to 50. Omit cursor for the first page, then copy next_cursor into the next request until it is null. A node whose content belongs to somebody else comes back as a restricted entry carrying only its id, type and name.",
|
|
16838
|
+
http: "GET",
|
|
16839
|
+
path: "/ontology/v1/nodes",
|
|
16840
|
+
streaming: "no",
|
|
16841
|
+
pagination: true,
|
|
16842
|
+
pathParams: [],
|
|
16843
|
+
query: [
|
|
16844
|
+
{
|
|
16845
|
+
name: "type",
|
|
16846
|
+
type: "array",
|
|
16847
|
+
itemType: "string",
|
|
16848
|
+
required: false,
|
|
16849
|
+
description: "Repeat to filter to any of several registered node type names, for example type=file&type=ticket; omit to list every type."
|
|
16850
|
+
},
|
|
16851
|
+
{
|
|
16852
|
+
name: "q",
|
|
16853
|
+
type: "string",
|
|
16854
|
+
required: false,
|
|
16855
|
+
description: "Free text matched against node names, aliases and descriptions; omit to list without a text filter."
|
|
16856
|
+
},
|
|
16857
|
+
{
|
|
16858
|
+
name: "owner",
|
|
16859
|
+
type: "string",
|
|
16860
|
+
required: false,
|
|
16861
|
+
description: "Filter to nodes owned by this member id, or omit to list nodes of every owner; organization-wide nodes carry no owner."
|
|
16862
|
+
},
|
|
16863
|
+
{
|
|
16864
|
+
name: "as_of",
|
|
16865
|
+
type: "string",
|
|
16866
|
+
required: false,
|
|
16867
|
+
description: "ISO 8601 timestamp; return the graph as it was then, so a node recorded later is absent. Omit to read current state."
|
|
16868
|
+
},
|
|
16869
|
+
{
|
|
16870
|
+
name: "limit",
|
|
16871
|
+
type: "integer",
|
|
16872
|
+
required: false,
|
|
16873
|
+
description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100."
|
|
16874
|
+
},
|
|
16875
|
+
{
|
|
16876
|
+
name: "cursor",
|
|
16877
|
+
type: "string",
|
|
16878
|
+
required: false,
|
|
16879
|
+
description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
|
|
16880
|
+
}
|
|
16881
|
+
]
|
|
16882
|
+
},
|
|
16883
|
+
{
|
|
16884
|
+
resource: "ontology.nodes",
|
|
16885
|
+
method: "create",
|
|
16886
|
+
summary: "Create node",
|
|
16887
|
+
description: "Record one entity in the graph, for a system mirroring a record it owns. type must already be registered and ref, when given, must match that type's ref_prefix. Send an Idempotency-Key header; repeating the same key with the same content returns the first result instead of creating a second node. This writes structure only — to give an agent something to remember, use POST /agent/v1/agents/{agent_id}/consolidations.",
|
|
16888
|
+
http: "POST",
|
|
16889
|
+
path: "/ontology/v1/nodes",
|
|
16890
|
+
streaming: "no",
|
|
16891
|
+
pagination: false,
|
|
16892
|
+
pathParams: [],
|
|
16893
|
+
query: [],
|
|
16894
|
+
body: {
|
|
16895
|
+
required: true,
|
|
16896
|
+
fields: [
|
|
16897
|
+
{
|
|
16898
|
+
name: "type",
|
|
16899
|
+
type: "string",
|
|
16900
|
+
required: true,
|
|
16901
|
+
description: "Registered node type name from types.list; an unregistered name is refused and nothing is written."
|
|
16902
|
+
},
|
|
16903
|
+
{
|
|
16904
|
+
name: "ref",
|
|
16905
|
+
type: "string",
|
|
16906
|
+
required: false,
|
|
16907
|
+
description: "Id of the mirrored record in the owning service, which must start with the type's ref_prefix; omit or null for a concept with no external record."
|
|
16908
|
+
},
|
|
16909
|
+
{
|
|
16910
|
+
name: "name",
|
|
16911
|
+
type: "string",
|
|
16912
|
+
required: true,
|
|
16913
|
+
description: "Display name of the entity, at most 200 characters."
|
|
16914
|
+
},
|
|
16915
|
+
{
|
|
16916
|
+
name: "aliases",
|
|
16917
|
+
type: "array",
|
|
16918
|
+
itemType: "string",
|
|
16919
|
+
required: false,
|
|
16920
|
+
description: "Other names this entity is known by; they are matched by search alongside the name."
|
|
16921
|
+
},
|
|
16922
|
+
{
|
|
16923
|
+
name: "description",
|
|
16924
|
+
type: "string",
|
|
16925
|
+
required: false,
|
|
16926
|
+
description: "Profile of the entity, at most 500 characters; omit or null for none."
|
|
16927
|
+
},
|
|
16928
|
+
{
|
|
16929
|
+
name: "owner",
|
|
16930
|
+
type: "string",
|
|
16931
|
+
required: false,
|
|
16932
|
+
description: "Member id whose content this is, restricting it to that member; omit or null to make it readable organization-wide."
|
|
16933
|
+
}
|
|
16934
|
+
]
|
|
16935
|
+
}
|
|
16936
|
+
},
|
|
16937
|
+
{
|
|
16938
|
+
resource: "ontology.nodes",
|
|
16939
|
+
method: "retrieve",
|
|
16940
|
+
summary: "Retrieve node",
|
|
16941
|
+
description: "Read one node's content and, with expand=relations, every relation on and around it. as_of reads the node as it was at that time. A node id from another organization, or one that never existed, answers ONTOLOGY_NODE_NOT_FOUND; a node you may reach but not read returns restricted true with its name only.",
|
|
16942
|
+
http: "GET",
|
|
16943
|
+
path: "/ontology/v1/nodes/{node_id}",
|
|
16944
|
+
streaming: "no",
|
|
16945
|
+
pagination: false,
|
|
16946
|
+
pathParams: [
|
|
16947
|
+
{
|
|
16948
|
+
name: "node_id",
|
|
16949
|
+
sdkName: "node_id",
|
|
16950
|
+
description: "Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted."
|
|
16951
|
+
}
|
|
16952
|
+
],
|
|
16953
|
+
query: [
|
|
16954
|
+
{
|
|
16955
|
+
name: "expand",
|
|
16956
|
+
type: "string",
|
|
16957
|
+
enum: [
|
|
16958
|
+
"relations"
|
|
16959
|
+
],
|
|
16960
|
+
required: false,
|
|
16961
|
+
description: "Set to relations to include the node's incoming and outgoing relations in the same response; omit for the node alone."
|
|
16962
|
+
},
|
|
16963
|
+
{
|
|
16964
|
+
name: "as_of",
|
|
16965
|
+
type: "string",
|
|
16966
|
+
required: false,
|
|
16967
|
+
description: "ISO 8601 timestamp; read the node and its relations as they were then, including relations invalidated since. Omit to read current state."
|
|
16968
|
+
}
|
|
16969
|
+
]
|
|
16970
|
+
},
|
|
16971
|
+
{
|
|
16972
|
+
resource: "ontology.nodes",
|
|
16973
|
+
method: "update",
|
|
16974
|
+
summary: "Update node",
|
|
16975
|
+
description: "Change a node's name, aliases or description when the mirrored record was renamed, without touching its type or identity. Send only the fields to change; omitted fields keep their current values and an explicitly null description clears it. Repeating the same edit converges on the same node, so this needs no Idempotency-Key.",
|
|
16976
|
+
http: "PATCH",
|
|
16977
|
+
path: "/ontology/v1/nodes/{node_id}",
|
|
16978
|
+
streaming: "no",
|
|
16979
|
+
pagination: false,
|
|
16980
|
+
pathParams: [
|
|
16981
|
+
{
|
|
16982
|
+
name: "node_id",
|
|
16983
|
+
sdkName: "node_id",
|
|
16984
|
+
description: "Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted."
|
|
16985
|
+
}
|
|
16986
|
+
],
|
|
16987
|
+
query: [],
|
|
16988
|
+
body: {
|
|
16989
|
+
required: true,
|
|
16990
|
+
fields: [
|
|
16991
|
+
{
|
|
16992
|
+
name: "name",
|
|
16993
|
+
type: "string",
|
|
16994
|
+
required: false,
|
|
16995
|
+
description: "New display name, at most 200 characters; omit to keep the current name."
|
|
16996
|
+
},
|
|
16997
|
+
{
|
|
16998
|
+
name: "aliases",
|
|
16999
|
+
type: "array",
|
|
17000
|
+
itemType: "string",
|
|
17001
|
+
required: false,
|
|
17002
|
+
description: "Replacement alias list; an empty array clears the aliases and omitting the field keeps them."
|
|
17003
|
+
},
|
|
17004
|
+
{
|
|
17005
|
+
name: "description",
|
|
17006
|
+
type: "string",
|
|
17007
|
+
required: false,
|
|
17008
|
+
description: "Replacement profile, at most 500 characters; an explicit null clears it and omitting the field keeps it."
|
|
17009
|
+
}
|
|
17010
|
+
]
|
|
17011
|
+
}
|
|
17012
|
+
},
|
|
17013
|
+
{
|
|
17014
|
+
resource: "ontology.nodes.merge",
|
|
17015
|
+
method: "create",
|
|
17016
|
+
summary: "Merge node",
|
|
17017
|
+
description: "Fold a duplicate node into the node that should survive, when two records are discovered to be the same entity. The merged node's relations and aliases move to the survivor and later reads of the duplicate resolve to it. Send an Idempotency-Key header; repeating the same key replays the first result. Reversal is a staff operation, not available here.",
|
|
17018
|
+
http: "POST",
|
|
17019
|
+
path: "/ontology/v1/nodes/{node_id}/merge",
|
|
17020
|
+
streaming: "no",
|
|
17021
|
+
pagination: false,
|
|
17022
|
+
pathParams: [
|
|
17023
|
+
{
|
|
17024
|
+
name: "node_id",
|
|
17025
|
+
sdkName: "node_id",
|
|
17026
|
+
description: "Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted."
|
|
17027
|
+
}
|
|
17028
|
+
],
|
|
17029
|
+
query: [],
|
|
17030
|
+
body: {
|
|
17031
|
+
required: true,
|
|
17032
|
+
fields: [
|
|
17033
|
+
{
|
|
17034
|
+
name: "into",
|
|
17035
|
+
type: "string",
|
|
17036
|
+
required: true,
|
|
17037
|
+
description: "Node id that should survive, from nodes.list or search; the merged node's relations and aliases move to it."
|
|
17038
|
+
}
|
|
17039
|
+
]
|
|
17040
|
+
}
|
|
17041
|
+
},
|
|
17042
|
+
{
|
|
17043
|
+
resource: "ontology.relations",
|
|
17044
|
+
method: "list",
|
|
17045
|
+
summary: "List relations",
|
|
17046
|
+
description: "Read the facts in the graph and obtain relation ids for retrieval, invalidation or spreading. Filter by endpoint node, by type and by direction; as_of reads the relations as they were then. Invalidated relations are omitted unless include_invalid is true. limit is 1–100 and defaults to 50; follow next_cursor until it is null.",
|
|
17047
|
+
http: "GET",
|
|
17048
|
+
path: "/ontology/v1/relations",
|
|
17049
|
+
streaming: "no",
|
|
17050
|
+
pagination: true,
|
|
17051
|
+
pathParams: [],
|
|
17052
|
+
query: [
|
|
17053
|
+
{
|
|
17054
|
+
name: "node",
|
|
17055
|
+
type: "string",
|
|
17056
|
+
required: false,
|
|
17057
|
+
description: "A node id from nodes.list or nodes.create; returns the relations this node takes part in, narrowed by direction. Omit to list relations between every node."
|
|
17058
|
+
},
|
|
17059
|
+
{
|
|
17060
|
+
name: "type",
|
|
17061
|
+
type: "array",
|
|
17062
|
+
itemType: "string",
|
|
17063
|
+
required: false,
|
|
17064
|
+
description: "Repeat to filter to any of several registered relation type names, for example type=references&type=serves; omit to list every type."
|
|
17065
|
+
},
|
|
17066
|
+
{
|
|
17067
|
+
name: "direction",
|
|
17068
|
+
type: "string",
|
|
17069
|
+
enum: [
|
|
17070
|
+
"out",
|
|
17071
|
+
"in",
|
|
17072
|
+
"both"
|
|
17073
|
+
],
|
|
17074
|
+
required: false,
|
|
17075
|
+
description: "Which side of node to follow; out returns relations the node is the source of, in returns those it is the target of. Only meaningful together with node."
|
|
17076
|
+
},
|
|
17077
|
+
{
|
|
17078
|
+
name: "as_of",
|
|
17079
|
+
type: "string",
|
|
17080
|
+
required: false,
|
|
17081
|
+
description: "ISO 8601 timestamp; read relations as they were then, so one recorded or invalidated later is judged by that time. Omit to read current state."
|
|
17082
|
+
},
|
|
17083
|
+
{
|
|
17084
|
+
name: "include_invalid",
|
|
17085
|
+
type: "boolean",
|
|
17086
|
+
required: false,
|
|
17087
|
+
description: "Set true to include relations whose invalid_at has passed, which is how a relation that stopped being true stays readable. Omit or false for currently valid relations only."
|
|
17088
|
+
},
|
|
17089
|
+
{
|
|
17090
|
+
name: "limit",
|
|
17091
|
+
type: "integer",
|
|
17092
|
+
required: false,
|
|
17093
|
+
description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100."
|
|
17094
|
+
},
|
|
17095
|
+
{
|
|
17096
|
+
name: "cursor",
|
|
17097
|
+
type: "string",
|
|
17098
|
+
required: false,
|
|
17099
|
+
description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
|
|
17100
|
+
}
|
|
17101
|
+
]
|
|
17102
|
+
},
|
|
17103
|
+
{
|
|
17104
|
+
resource: "ontology.relations",
|
|
17105
|
+
method: "create",
|
|
17106
|
+
summary: "Create relation",
|
|
17107
|
+
description: "Record one fact between two existing nodes, for a system mirroring a relationship it owns. type must be registered and must admit these endpoints; fact states the relationship in one sentence. Send an Idempotency-Key header; repeating the same key returns the first result instead of writing a second relation. This writes structure only — to give an agent something to remember, use POST /agent/v1/agents/{agent_id}/consolidations.",
|
|
17108
|
+
http: "POST",
|
|
17109
|
+
path: "/ontology/v1/relations",
|
|
17110
|
+
streaming: "no",
|
|
17111
|
+
pagination: false,
|
|
17112
|
+
pathParams: [],
|
|
17113
|
+
query: [],
|
|
17114
|
+
body: {
|
|
17115
|
+
required: true,
|
|
17116
|
+
fields: [
|
|
17117
|
+
{
|
|
17118
|
+
name: "type",
|
|
17119
|
+
type: "string",
|
|
17120
|
+
required: true,
|
|
17121
|
+
description: "Registered relation type name from types.list; it must admit both endpoints or the write is refused."
|
|
17122
|
+
},
|
|
17123
|
+
{
|
|
17124
|
+
name: "source",
|
|
17125
|
+
type: "string",
|
|
17126
|
+
required: true,
|
|
17127
|
+
description: "Node id the fact starts from, from nodes.list or nodes.create."
|
|
17128
|
+
},
|
|
17129
|
+
{
|
|
17130
|
+
name: "target",
|
|
17131
|
+
type: "string",
|
|
17132
|
+
required: true,
|
|
17133
|
+
description: "Node id the fact points at, from nodes.list or nodes.create."
|
|
17134
|
+
},
|
|
17135
|
+
{
|
|
17136
|
+
name: "fact",
|
|
17137
|
+
type: "string",
|
|
17138
|
+
required: true,
|
|
17139
|
+
description: "The relationship in one sentence, at most 280 characters, written to read back on its own."
|
|
17140
|
+
},
|
|
17141
|
+
{
|
|
17142
|
+
name: "valid_at",
|
|
17143
|
+
type: "string",
|
|
17144
|
+
required: false,
|
|
17145
|
+
description: "World time the fact became true, when the mirrored record dates it; omit to leave it undated."
|
|
17146
|
+
},
|
|
17147
|
+
{
|
|
17148
|
+
name: "owner",
|
|
17149
|
+
type: "string",
|
|
17150
|
+
required: false,
|
|
17151
|
+
description: "Member id whose content this fact is, restricting it to that member; omit or null for organization-wide."
|
|
17152
|
+
}
|
|
17153
|
+
]
|
|
17154
|
+
}
|
|
17155
|
+
},
|
|
17156
|
+
{
|
|
17157
|
+
resource: "ontology.relations",
|
|
17158
|
+
method: "retrieve",
|
|
17159
|
+
summary: "Retrieve relation",
|
|
17160
|
+
description: "Read one relation's fact and both of its clocks — valid_at and invalid_at for when it was true in the world, created_at and expired_at for when it was recorded and retired. An id from another organization, or one that never existed, answers ONTOLOGY_EDGE_NOT_FOUND.",
|
|
17161
|
+
http: "GET",
|
|
17162
|
+
path: "/ontology/v1/relations/{relation_id}",
|
|
17163
|
+
streaming: "no",
|
|
17164
|
+
pagination: false,
|
|
17165
|
+
pathParams: [
|
|
17166
|
+
{
|
|
17167
|
+
name: "relation_id",
|
|
17168
|
+
sdkName: "relation_id",
|
|
17169
|
+
description: "Relation id returned by relations.list, relations.create or a changeset, in the form oed_ followed by 32 lowercase letters or digits; a node id is not accepted."
|
|
17170
|
+
}
|
|
17171
|
+
],
|
|
17172
|
+
query: []
|
|
17173
|
+
},
|
|
17174
|
+
{
|
|
17175
|
+
resource: "ontology.relations.invalidate",
|
|
17176
|
+
method: "create",
|
|
17177
|
+
summary: "Invalidate relation",
|
|
17178
|
+
description: "Mark a relation as no longer true from a world time, when the mirrored record changed. The relation is kept — invalid_at moves and the relation still reads at an earlier as_of, so history stays answerable. Send an Idempotency-Key header; repeating the same key replays the first result. There is no delete.",
|
|
17179
|
+
http: "POST",
|
|
17180
|
+
path: "/ontology/v1/relations/{relation_id}/invalidate",
|
|
17181
|
+
streaming: "no",
|
|
17182
|
+
pagination: false,
|
|
17183
|
+
pathParams: [
|
|
17184
|
+
{
|
|
17185
|
+
name: "relation_id",
|
|
17186
|
+
sdkName: "relation_id",
|
|
17187
|
+
description: "Relation id returned by relations.list, relations.create or a changeset, in the form oed_ followed by 32 lowercase letters or digits; a node id is not accepted."
|
|
17188
|
+
}
|
|
17189
|
+
],
|
|
17190
|
+
query: [],
|
|
17191
|
+
body: {
|
|
17192
|
+
required: true,
|
|
17193
|
+
fields: [
|
|
17194
|
+
{
|
|
17195
|
+
name: "invalid_at",
|
|
17196
|
+
type: "string",
|
|
17197
|
+
required: true,
|
|
17198
|
+
description: "World time the fact stopped being true, in ISO 8601 UTC; reads at an earlier as_of still return the relation."
|
|
17199
|
+
},
|
|
17200
|
+
{
|
|
17201
|
+
name: "superseded_by",
|
|
17202
|
+
type: "string",
|
|
17203
|
+
required: false,
|
|
17204
|
+
description: "Relation id that replaces this one, when a successor was recorded; omit or null when nothing replaced it."
|
|
17205
|
+
},
|
|
17206
|
+
{
|
|
17207
|
+
name: "reason",
|
|
17208
|
+
type: "string",
|
|
17209
|
+
required: false,
|
|
17210
|
+
description: "Why it stopped being true, for people reading the history later; not enforced and safe to omit."
|
|
17211
|
+
}
|
|
17212
|
+
]
|
|
17213
|
+
}
|
|
17214
|
+
},
|
|
17215
|
+
{
|
|
17216
|
+
resource: "ontology.search",
|
|
17217
|
+
method: "create",
|
|
17218
|
+
summary: "Search nodes",
|
|
17219
|
+
description: "Resolve text to the nodes it most likely names, when a mirror holds a name and needs the node id it corresponds to. Results are ranked candidates, not an answer, each reporting whether the match came from the node's name, an alias, its description or a relation's fact. Narrow with types, and cap the result count with limit (1–50, default 20). This reads structure; it is not an agent recall — agents recall through POST /agent/v1/agents/{agent_id}/consolidations.",
|
|
17220
|
+
http: "POST",
|
|
17221
|
+
path: "/ontology/v1/search",
|
|
17222
|
+
streaming: "no",
|
|
17223
|
+
pagination: false,
|
|
17224
|
+
pathParams: [],
|
|
17225
|
+
query: [],
|
|
17226
|
+
body: {
|
|
17227
|
+
required: true,
|
|
17228
|
+
fields: [
|
|
17229
|
+
{
|
|
17230
|
+
name: "text",
|
|
17231
|
+
type: "string",
|
|
17232
|
+
required: true,
|
|
17233
|
+
description: "Text to find nodes for, matched against names, aliases, descriptions and relation facts; an empty string is refused."
|
|
17234
|
+
},
|
|
17235
|
+
{
|
|
17236
|
+
name: "types",
|
|
17237
|
+
type: "array",
|
|
17238
|
+
itemType: "string",
|
|
17239
|
+
required: false,
|
|
17240
|
+
description: "Registered node type names to search within; omit to search every type."
|
|
17241
|
+
},
|
|
17242
|
+
{
|
|
17243
|
+
name: "window",
|
|
17244
|
+
type: "object",
|
|
17245
|
+
required: false,
|
|
17246
|
+
description: "Restrict matches to facts recorded within a period; omit to search all time."
|
|
17247
|
+
},
|
|
17248
|
+
{
|
|
17249
|
+
name: "limit",
|
|
17250
|
+
type: "integer",
|
|
17251
|
+
required: false,
|
|
17252
|
+
description: "Maximum candidate nodes to return, from 1 to 50; defaults to 20 when omitted."
|
|
17253
|
+
}
|
|
17254
|
+
]
|
|
17255
|
+
}
|
|
17256
|
+
},
|
|
17257
|
+
{
|
|
17258
|
+
resource: "ontology.types",
|
|
17259
|
+
method: "list",
|
|
17260
|
+
summary: "List types",
|
|
17261
|
+
description: "Read the node and relation types registered for this organization before writing, so a create names a type the graph accepts. Each entry is one registrant's registration with its owner, version and definitions. Types cannot be created at runtime; they are registered by the owning service at deploy time, so a type missing here is not available to write.",
|
|
17262
|
+
http: "GET",
|
|
17263
|
+
path: "/ontology/v1/types",
|
|
17264
|
+
streaming: "no",
|
|
17265
|
+
pagination: false,
|
|
17266
|
+
pathParams: [],
|
|
17267
|
+
query: []
|
|
17268
|
+
},
|
|
17269
|
+
{
|
|
17270
|
+
resource: "ontology.types",
|
|
17271
|
+
method: "create",
|
|
17272
|
+
summary: "Register type",
|
|
17273
|
+
description: "Register a node or relation type for this organization. Not open yet — this call currently answers 501 NOT_IMPLEMENTED and writes nothing, because a registration is checked and stored by the deploy gate that ships the registering service, not by a runtime call. Until it opens, read the types already in force with praxis.ontology.types.list and create records only of those types.",
|
|
17274
|
+
http: "POST",
|
|
17275
|
+
path: "/ontology/v1/types",
|
|
17276
|
+
streaming: "no",
|
|
17277
|
+
pagination: false,
|
|
17278
|
+
pathParams: [],
|
|
17279
|
+
query: [],
|
|
17280
|
+
body: {
|
|
17281
|
+
required: true,
|
|
17282
|
+
fields: [
|
|
17283
|
+
{
|
|
17284
|
+
name: "owner",
|
|
17285
|
+
type: "string",
|
|
17286
|
+
required: true,
|
|
17287
|
+
description: "Service that registered these types, for example file or ticket; it is the registrant a later change to a type is checked against."
|
|
17288
|
+
},
|
|
17289
|
+
{
|
|
17290
|
+
name: "version",
|
|
17291
|
+
type: "integer",
|
|
17292
|
+
required: true,
|
|
17293
|
+
description: "Monotonic version of this owner's registration; a later registration must extend this one without removing or narrowing anything."
|
|
17294
|
+
},
|
|
17295
|
+
{
|
|
17296
|
+
name: "nodes",
|
|
17297
|
+
type: "array",
|
|
17298
|
+
itemType: "object",
|
|
17299
|
+
required: true,
|
|
17300
|
+
description: "Node types this owner registers."
|
|
17301
|
+
},
|
|
17302
|
+
{
|
|
17303
|
+
name: "edges",
|
|
17304
|
+
type: "array",
|
|
17305
|
+
itemType: "object",
|
|
17306
|
+
required: true,
|
|
17307
|
+
description: "Relation types this owner registers."
|
|
17308
|
+
}
|
|
17309
|
+
]
|
|
17310
|
+
}
|
|
17311
|
+
},
|
|
17312
|
+
{
|
|
17313
|
+
resource: "ontology.types",
|
|
17314
|
+
method: "retrieve",
|
|
17315
|
+
summary: "Retrieve type",
|
|
17316
|
+
description: "Read one registered type's definition before writing a record of it, to learn whether it is a node or an edge, which endpoints an edge type admits, and which origins it accepts. The name comes from types.list; a name that is not registered answers ONTOLOGY_TYPE_UNKNOWN, and writes of that type are refused.",
|
|
17317
|
+
http: "GET",
|
|
17318
|
+
path: "/ontology/v1/types/{name}",
|
|
17319
|
+
streaming: "no",
|
|
17320
|
+
pagination: false,
|
|
17321
|
+
pathParams: [
|
|
17322
|
+
{
|
|
17323
|
+
name: "name",
|
|
17324
|
+
sdkName: "name",
|
|
17325
|
+
description: "A type name from types.list, with its dots preserved — a display label is not accepted."
|
|
17326
|
+
}
|
|
17327
|
+
],
|
|
17328
|
+
query: []
|
|
17329
|
+
},
|
|
16285
17330
|
{
|
|
16286
17331
|
resource: "organization.charges",
|
|
16287
17332
|
method: "list",
|
|
@@ -19005,7 +20050,7 @@ for more details.`
|
|
|
19005
20050
|
resource: "ticket.labels",
|
|
19006
20051
|
method: "create",
|
|
19007
20052
|
summary: "Create or add labels",
|
|
19008
|
-
description: "Create or add labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result.
|
|
20053
|
+
description: "Create or add labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
19009
20054
|
http: "POST",
|
|
19010
20055
|
path: "/ticket/v1/labels",
|
|
19011
20056
|
streaming: "no",
|
|
@@ -19047,7 +20092,7 @@ for more details.`
|
|
|
19047
20092
|
resource: "ticket.labels",
|
|
19048
20093
|
method: "delete",
|
|
19049
20094
|
summary: "Remove labels",
|
|
19050
|
-
description: "Remove labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result.
|
|
20095
|
+
description: "Remove labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
19051
20096
|
http: "DELETE",
|
|
19052
20097
|
path: "/ticket/v1/labels/{name}",
|
|
19053
20098
|
streaming: "no",
|
|
@@ -19072,7 +20117,7 @@ for more details.`
|
|
|
19072
20117
|
resource: "ticket.labels",
|
|
19073
20118
|
method: "update",
|
|
19074
20119
|
summary: "Update labels",
|
|
19075
|
-
description: "Update labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result.
|
|
20120
|
+
description: "Update labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
19076
20121
|
http: "PATCH",
|
|
19077
20122
|
path: "/ticket/v1/labels/{name}",
|
|
19078
20123
|
streaming: "no",
|
|
@@ -19368,7 +20413,7 @@ for more details.`
|
|
|
19368
20413
|
name: "filter",
|
|
19369
20414
|
type: "string",
|
|
19370
20415
|
required: false,
|
|
19371
|
-
description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort;
|
|
20416
|
+
description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort; write each qualifier as field:value (for example, is:open milestone:5), never field=value. Unknown qualifiers return INVALID_PARAMS. Passed unchanged to the service."
|
|
19372
20417
|
}
|
|
19373
20418
|
]
|
|
19374
20419
|
},
|
|
@@ -20474,7 +21519,7 @@ for more details.`
|
|
|
20474
21519
|
resource: "vault.vaults",
|
|
20475
21520
|
method: "create",
|
|
20476
21521
|
summary: "Create vault",
|
|
20477
|
-
description: "Create an empty, active vault to hold credentials for your account, with a display name and optional metadata. Use its returned id as vault_id when creating secrets or OAuth authorizations.
|
|
21522
|
+
description: "Create an empty, active vault to hold credentials for your account, with a display name and optional metadata. Use its returned id as vault_id when creating secrets or OAuth authorizations. Agent sessions and deployments accept up to 50 vault_ids and match their credentials against the session's MCP servers, so a stored static or oauth credential does serve as vault-backed MCP authentication; only environment_variable credentials are not yet placed, because the egress proxy ADR-058 §6 gives them is not built. Application vault references are also unavailable; praxis_vault_ref version bindings and secret writes with a vault source return 501, so creating a vault does not yet enable either consumer.",
|
|
20478
21523
|
http: "POST",
|
|
20479
21524
|
path: "/vault/v1/vaults",
|
|
20480
21525
|
streaming: "no",
|
|
@@ -22436,6 +23481,23 @@ var computersFilesContent = (options) => (options.client ?? client).get({
|
|
|
22436
23481
|
url: "/agent/v1/computers/{computer_id}/files/content",
|
|
22437
23482
|
...options
|
|
22438
23483
|
});
|
|
23484
|
+
var computersFilesConvert = (options) => (options.client ?? client).post({
|
|
23485
|
+
security: [{
|
|
23486
|
+
key: "BearerAuth",
|
|
23487
|
+
scheme: "bearer",
|
|
23488
|
+
type: "http"
|
|
23489
|
+
}, {
|
|
23490
|
+
key: "ApiKeyAuth",
|
|
23491
|
+
name: "X-API-Key",
|
|
23492
|
+
type: "apiKey"
|
|
23493
|
+
}],
|
|
23494
|
+
url: "/agent/v1/computers/{computer_id}/files/convert",
|
|
23495
|
+
...options,
|
|
23496
|
+
headers: {
|
|
23497
|
+
"Content-Type": "application/json",
|
|
23498
|
+
...options.headers
|
|
23499
|
+
}
|
|
23500
|
+
});
|
|
22439
23501
|
var connectComputer = (options) => (options.client ?? client).post({
|
|
22440
23502
|
security: [{
|
|
22441
23503
|
key: "BearerAuth",
|
|
@@ -22934,6 +23996,15 @@ var fileCancelUpload = (options) => (options.client ?? client).post({
|
|
|
22934
23996
|
url: "/file/v1/uploads/{upload_id}/cancel",
|
|
22935
23997
|
...options
|
|
22936
23998
|
});
|
|
23999
|
+
var fileRetrieveUpload = (options) => (options.client ?? client).get({
|
|
24000
|
+
security: [{
|
|
24001
|
+
key: "BearerAuth",
|
|
24002
|
+
scheme: "bearer",
|
|
24003
|
+
type: "http"
|
|
24004
|
+
}],
|
|
24005
|
+
url: "/file/v1/uploads/{upload_id}",
|
|
24006
|
+
...options
|
|
24007
|
+
});
|
|
22937
24008
|
var fileCreateSignedUpload = (options) => (options.client ?? client).post({
|
|
22938
24009
|
security: [{
|
|
22939
24010
|
key: "BearerAuth",
|
|
@@ -27344,6 +28415,19 @@ var mediaCreateLibrary = (options) => (options.client ?? client).post({
|
|
|
27344
28415
|
...options.headers
|
|
27345
28416
|
}
|
|
27346
28417
|
});
|
|
28418
|
+
var mediaCreateFrameUrls = (options) => (options.client ?? client).post({
|
|
28419
|
+
security: [{
|
|
28420
|
+
key: "media-BearerAuth",
|
|
28421
|
+
scheme: "bearer",
|
|
28422
|
+
type: "http"
|
|
28423
|
+
}],
|
|
28424
|
+
url: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames",
|
|
28425
|
+
...options,
|
|
28426
|
+
headers: {
|
|
28427
|
+
"Content-Type": "application/json",
|
|
28428
|
+
...options.headers
|
|
28429
|
+
}
|
|
28430
|
+
});
|
|
27347
28431
|
var mediaDeleteLibrary = (options) => (options.client ?? client).delete({
|
|
27348
28432
|
security: [{
|
|
27349
28433
|
key: "media-BearerAuth",
|
|
@@ -27608,6 +28692,235 @@ var mediaCreateDeliveryToken = (options) => (options.client ?? client).post({
|
|
|
27608
28692
|
...options.headers
|
|
27609
28693
|
}
|
|
27610
28694
|
});
|
|
28695
|
+
var mediaUnderstandingFailureSummary = (options) => (options.client ?? client).get({
|
|
28696
|
+
security: [{
|
|
28697
|
+
key: "media-BearerAuth",
|
|
28698
|
+
scheme: "bearer",
|
|
28699
|
+
type: "http"
|
|
28700
|
+
}],
|
|
28701
|
+
url: "/media/v1/libraries/{library_id}/understandings/failure_summary",
|
|
28702
|
+
...options
|
|
28703
|
+
});
|
|
28704
|
+
var mediaListUnderstandingsByLibrary = (options) => (options.client ?? client).get({
|
|
28705
|
+
security: [{
|
|
28706
|
+
key: "media-BearerAuth",
|
|
28707
|
+
scheme: "bearer",
|
|
28708
|
+
type: "http"
|
|
28709
|
+
}],
|
|
28710
|
+
url: "/media/v1/libraries/{library_id}/understandings",
|
|
28711
|
+
...options
|
|
28712
|
+
});
|
|
28713
|
+
var mediaCreateGeneration = (options) => (options.client ?? client).post({
|
|
28714
|
+
security: [{
|
|
28715
|
+
key: "media-BearerAuth",
|
|
28716
|
+
scheme: "bearer",
|
|
28717
|
+
type: "http"
|
|
28718
|
+
}],
|
|
28719
|
+
url: "/media/v1/libraries/{library_id}/generations",
|
|
28720
|
+
...options,
|
|
28721
|
+
headers: {
|
|
28722
|
+
"Content-Type": "application/json",
|
|
28723
|
+
...options.headers
|
|
28724
|
+
}
|
|
28725
|
+
});
|
|
28726
|
+
var mediaListJobs = (options) => (options.client ?? client).get({
|
|
28727
|
+
security: [{
|
|
28728
|
+
key: "media-BearerAuth",
|
|
28729
|
+
scheme: "bearer",
|
|
28730
|
+
type: "http"
|
|
28731
|
+
}],
|
|
28732
|
+
url: "/media/v1/libraries/{library_id}/jobs",
|
|
28733
|
+
...options
|
|
28734
|
+
});
|
|
28735
|
+
var mediaCancelJob = (options) => (options.client ?? client).post({
|
|
28736
|
+
security: [{
|
|
28737
|
+
key: "media-BearerAuth",
|
|
28738
|
+
scheme: "bearer",
|
|
28739
|
+
type: "http"
|
|
28740
|
+
}],
|
|
28741
|
+
url: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
|
|
28742
|
+
...options
|
|
28743
|
+
});
|
|
28744
|
+
var mediaSaveGenerationOutput = (options) => (options.client ?? client).post({
|
|
28745
|
+
security: [{
|
|
28746
|
+
key: "media-BearerAuth",
|
|
28747
|
+
scheme: "bearer",
|
|
28748
|
+
type: "http"
|
|
28749
|
+
}],
|
|
28750
|
+
url: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
|
|
28751
|
+
...options,
|
|
28752
|
+
headers: {
|
|
28753
|
+
"Content-Type": "application/json",
|
|
28754
|
+
...options.headers
|
|
28755
|
+
}
|
|
28756
|
+
});
|
|
28757
|
+
var mediaGetGenerationCapabilities = (options) => (options?.client ?? client).get({
|
|
28758
|
+
security: [{
|
|
28759
|
+
key: "media-BearerAuth",
|
|
28760
|
+
scheme: "bearer",
|
|
28761
|
+
type: "http"
|
|
28762
|
+
}],
|
|
28763
|
+
url: "/media/v1/generation/capabilities",
|
|
28764
|
+
...options
|
|
28765
|
+
});
|
|
28766
|
+
var ontologyListTypes = (options) => (options?.client ?? client).get({
|
|
28767
|
+
security: [{
|
|
28768
|
+
key: "ontology-bearerAuth",
|
|
28769
|
+
scheme: "bearer",
|
|
28770
|
+
type: "http"
|
|
28771
|
+
}],
|
|
28772
|
+
url: "/ontology/v1/types",
|
|
28773
|
+
...options
|
|
28774
|
+
});
|
|
28775
|
+
var ontologyRegisterType = (options) => (options.client ?? client).post({
|
|
28776
|
+
security: [{
|
|
28777
|
+
key: "ontology-bearerAuth",
|
|
28778
|
+
scheme: "bearer",
|
|
28779
|
+
type: "http"
|
|
28780
|
+
}],
|
|
28781
|
+
url: "/ontology/v1/types",
|
|
28782
|
+
...options,
|
|
28783
|
+
headers: {
|
|
28784
|
+
"Content-Type": "application/json",
|
|
28785
|
+
...options.headers
|
|
28786
|
+
}
|
|
28787
|
+
});
|
|
28788
|
+
var ontologyRetrieveType = (options) => (options.client ?? client).get({
|
|
28789
|
+
security: [{
|
|
28790
|
+
key: "ontology-bearerAuth",
|
|
28791
|
+
scheme: "bearer",
|
|
28792
|
+
type: "http"
|
|
28793
|
+
}],
|
|
28794
|
+
url: "/ontology/v1/types/{name}",
|
|
28795
|
+
...options
|
|
28796
|
+
});
|
|
28797
|
+
var ontologyListNodes = (options) => (options?.client ?? client).get({
|
|
28798
|
+
security: [{
|
|
28799
|
+
key: "ontology-bearerAuth",
|
|
28800
|
+
scheme: "bearer",
|
|
28801
|
+
type: "http"
|
|
28802
|
+
}],
|
|
28803
|
+
url: "/ontology/v1/nodes",
|
|
28804
|
+
...options
|
|
28805
|
+
});
|
|
28806
|
+
var ontologyCreateNode = (options) => (options.client ?? client).post({
|
|
28807
|
+
security: [{
|
|
28808
|
+
key: "ontology-bearerAuth",
|
|
28809
|
+
scheme: "bearer",
|
|
28810
|
+
type: "http"
|
|
28811
|
+
}],
|
|
28812
|
+
url: "/ontology/v1/nodes",
|
|
28813
|
+
...options,
|
|
28814
|
+
headers: {
|
|
28815
|
+
"Content-Type": "application/json",
|
|
28816
|
+
...options.headers
|
|
28817
|
+
}
|
|
28818
|
+
});
|
|
28819
|
+
var ontologyRetrieveNode = (options) => (options.client ?? client).get({
|
|
28820
|
+
security: [{
|
|
28821
|
+
key: "ontology-bearerAuth",
|
|
28822
|
+
scheme: "bearer",
|
|
28823
|
+
type: "http"
|
|
28824
|
+
}],
|
|
28825
|
+
url: "/ontology/v1/nodes/{node_id}",
|
|
28826
|
+
...options
|
|
28827
|
+
});
|
|
28828
|
+
var ontologyUpdateNode = (options) => (options.client ?? client).patch({
|
|
28829
|
+
security: [{
|
|
28830
|
+
key: "ontology-bearerAuth",
|
|
28831
|
+
scheme: "bearer",
|
|
28832
|
+
type: "http"
|
|
28833
|
+
}],
|
|
28834
|
+
url: "/ontology/v1/nodes/{node_id}",
|
|
28835
|
+
...options,
|
|
28836
|
+
headers: {
|
|
28837
|
+
"Content-Type": "application/json",
|
|
28838
|
+
...options.headers
|
|
28839
|
+
}
|
|
28840
|
+
});
|
|
28841
|
+
var ontologyMergeNode = (options) => (options.client ?? client).post({
|
|
28842
|
+
security: [{
|
|
28843
|
+
key: "ontology-bearerAuth",
|
|
28844
|
+
scheme: "bearer",
|
|
28845
|
+
type: "http"
|
|
28846
|
+
}],
|
|
28847
|
+
url: "/ontology/v1/nodes/{node_id}/merge",
|
|
28848
|
+
...options,
|
|
28849
|
+
headers: {
|
|
28850
|
+
"Content-Type": "application/json",
|
|
28851
|
+
...options.headers
|
|
28852
|
+
}
|
|
28853
|
+
});
|
|
28854
|
+
var ontologyListRelations = (options) => (options?.client ?? client).get({
|
|
28855
|
+
security: [{
|
|
28856
|
+
key: "ontology-bearerAuth",
|
|
28857
|
+
scheme: "bearer",
|
|
28858
|
+
type: "http"
|
|
28859
|
+
}],
|
|
28860
|
+
url: "/ontology/v1/relations",
|
|
28861
|
+
...options
|
|
28862
|
+
});
|
|
28863
|
+
var ontologyCreateRelation = (options) => (options.client ?? client).post({
|
|
28864
|
+
security: [{
|
|
28865
|
+
key: "ontology-bearerAuth",
|
|
28866
|
+
scheme: "bearer",
|
|
28867
|
+
type: "http"
|
|
28868
|
+
}],
|
|
28869
|
+
url: "/ontology/v1/relations",
|
|
28870
|
+
...options,
|
|
28871
|
+
headers: {
|
|
28872
|
+
"Content-Type": "application/json",
|
|
28873
|
+
...options.headers
|
|
28874
|
+
}
|
|
28875
|
+
});
|
|
28876
|
+
var ontologyRetrieveRelation = (options) => (options.client ?? client).get({
|
|
28877
|
+
security: [{
|
|
28878
|
+
key: "ontology-bearerAuth",
|
|
28879
|
+
scheme: "bearer",
|
|
28880
|
+
type: "http"
|
|
28881
|
+
}],
|
|
28882
|
+
url: "/ontology/v1/relations/{relation_id}",
|
|
28883
|
+
...options
|
|
28884
|
+
});
|
|
28885
|
+
var ontologyInvalidateRelation = (options) => (options.client ?? client).post({
|
|
28886
|
+
security: [{
|
|
28887
|
+
key: "ontology-bearerAuth",
|
|
28888
|
+
scheme: "bearer",
|
|
28889
|
+
type: "http"
|
|
28890
|
+
}],
|
|
28891
|
+
url: "/ontology/v1/relations/{relation_id}/invalidate",
|
|
28892
|
+
...options,
|
|
28893
|
+
headers: {
|
|
28894
|
+
"Content-Type": "application/json",
|
|
28895
|
+
...options.headers
|
|
28896
|
+
}
|
|
28897
|
+
});
|
|
28898
|
+
var ontologyApplyChangeset = (options) => (options.client ?? client).post({
|
|
28899
|
+
security: [{
|
|
28900
|
+
key: "ontology-bearerAuth",
|
|
28901
|
+
scheme: "bearer",
|
|
28902
|
+
type: "http"
|
|
28903
|
+
}],
|
|
28904
|
+
url: "/ontology/v1/changesets",
|
|
28905
|
+
...options,
|
|
28906
|
+
headers: {
|
|
28907
|
+
"Content-Type": "application/json",
|
|
28908
|
+
...options.headers
|
|
28909
|
+
}
|
|
28910
|
+
});
|
|
28911
|
+
var ontologySearch = (options) => (options.client ?? client).post({
|
|
28912
|
+
security: [{
|
|
28913
|
+
key: "ontology-bearerAuth",
|
|
28914
|
+
scheme: "bearer",
|
|
28915
|
+
type: "http"
|
|
28916
|
+
}],
|
|
28917
|
+
url: "/ontology/v1/search",
|
|
28918
|
+
...options,
|
|
28919
|
+
headers: {
|
|
28920
|
+
"Content-Type": "application/json",
|
|
28921
|
+
...options.headers
|
|
28922
|
+
}
|
|
28923
|
+
});
|
|
27611
28924
|
var getSandboxV1Sandboxes = (options) => (options?.client ?? client).get({
|
|
27612
28925
|
querySerializer: { parameters: { state: { array: { explode: false } } } },
|
|
27613
28926
|
security: [
|
|
@@ -29485,6 +30798,9 @@ function createAgent(transport) {
|
|
|
29485
30798
|
create: bind(transport, computersCreate),
|
|
29486
30799
|
delete: bind(transport, computersDelete),
|
|
29487
30800
|
files: {
|
|
30801
|
+
convert: {
|
|
30802
|
+
create: bind(transport, computersFilesConvert)
|
|
30803
|
+
},
|
|
29488
30804
|
list: bind(transport, computersFilesList),
|
|
29489
30805
|
retrieveContent: bind(transport, computersFilesContent)
|
|
29490
30806
|
},
|
|
@@ -30006,7 +31322,8 @@ function createFile(transport) {
|
|
|
30006
31322
|
createSigned: bind(transport, fileCreateSignedUpload),
|
|
30007
31323
|
parts: {
|
|
30008
31324
|
create: bind(transport, (options) => fileAddUploadPart({ ...options, bodySerializer: multipartBodySerializer, headers: { "Content-Type": null, ...options.headers } }))
|
|
30009
|
-
}
|
|
31325
|
+
},
|
|
31326
|
+
retrieve: bind(transport, fileRetrieveUpload)
|
|
30010
31327
|
}
|
|
30011
31328
|
};
|
|
30012
31329
|
}
|
|
@@ -30058,11 +31375,19 @@ function createKnowledge(transport) {
|
|
|
30058
31375
|
}
|
|
30059
31376
|
function createMedia(transport) {
|
|
30060
31377
|
return {
|
|
31378
|
+
generation: {
|
|
31379
|
+
capabilities: {
|
|
31380
|
+
list: bind(transport, mediaGetGenerationCapabilities)
|
|
31381
|
+
}
|
|
31382
|
+
},
|
|
30061
31383
|
libraries: {
|
|
30062
31384
|
assets: {
|
|
30063
31385
|
batch: bind(transport, mediaBatchAssets),
|
|
30064
31386
|
create: bind(transport, (options) => mediaUploadAsset({ ...options, bodySerializer: multipartBodySerializer, headers: { "Content-Type": null, ...options.headers } })),
|
|
30065
31387
|
delete: bind(transport, mediaDeleteAsset),
|
|
31388
|
+
frames: {
|
|
31389
|
+
create: bind(transport, mediaCreateFrameUrls)
|
|
31390
|
+
},
|
|
30066
31391
|
import: {
|
|
30067
31392
|
create: bind(transport, mediaImportAsset)
|
|
30068
31393
|
},
|
|
@@ -30091,7 +31416,17 @@ function createMedia(transport) {
|
|
|
30091
31416
|
folders: {
|
|
30092
31417
|
list: bind(transport, mediaListFolders)
|
|
30093
31418
|
},
|
|
31419
|
+
generations: {
|
|
31420
|
+
create: bind(transport, mediaCreateGeneration)
|
|
31421
|
+
},
|
|
30094
31422
|
jobs: {
|
|
31423
|
+
cancel: bind(transport, mediaCancelJob),
|
|
31424
|
+
list: bindPage(transport, mediaListJobs),
|
|
31425
|
+
outputs: {
|
|
31426
|
+
save: {
|
|
31427
|
+
create: bind(transport, mediaSaveGenerationOutput)
|
|
31428
|
+
}
|
|
31429
|
+
},
|
|
30095
31430
|
retrieve: bind(transport, mediaGetJob)
|
|
30096
31431
|
},
|
|
30097
31432
|
list: bindPage(transport, mediaListLibraries),
|
|
@@ -30112,6 +31447,10 @@ function createMedia(transport) {
|
|
|
30112
31447
|
create: bind(transport, mediaVisualSearch)
|
|
30113
31448
|
}
|
|
30114
31449
|
},
|
|
31450
|
+
understandings: {
|
|
31451
|
+
list: bindPage(transport, mediaListUnderstandingsByLibrary),
|
|
31452
|
+
retrieveFailureSummary: bind(transport, mediaUnderstandingFailureSummary)
|
|
31453
|
+
},
|
|
30115
31454
|
update: bind(transport, mediaUpdateLibrary)
|
|
30116
31455
|
}
|
|
30117
31456
|
};
|
|
@@ -30212,6 +31551,38 @@ function createModel(transport) {
|
|
|
30212
31551
|
}
|
|
30213
31552
|
};
|
|
30214
31553
|
}
|
|
31554
|
+
function createOntology(transport) {
|
|
31555
|
+
return {
|
|
31556
|
+
changesets: {
|
|
31557
|
+
create: bind(transport, ontologyApplyChangeset)
|
|
31558
|
+
},
|
|
31559
|
+
nodes: {
|
|
31560
|
+
create: bind(transport, ontologyCreateNode),
|
|
31561
|
+
list: bindPage(transport, ontologyListNodes),
|
|
31562
|
+
merge: {
|
|
31563
|
+
create: bind(transport, ontologyMergeNode)
|
|
31564
|
+
},
|
|
31565
|
+
retrieve: bind(transport, ontologyRetrieveNode),
|
|
31566
|
+
update: bind(transport, ontologyUpdateNode)
|
|
31567
|
+
},
|
|
31568
|
+
relations: {
|
|
31569
|
+
create: bind(transport, ontologyCreateRelation),
|
|
31570
|
+
invalidate: {
|
|
31571
|
+
create: bind(transport, ontologyInvalidateRelation)
|
|
31572
|
+
},
|
|
31573
|
+
list: bindPage(transport, ontologyListRelations),
|
|
31574
|
+
retrieve: bind(transport, ontologyRetrieveRelation)
|
|
31575
|
+
},
|
|
31576
|
+
search: {
|
|
31577
|
+
create: bind(transport, ontologySearch)
|
|
31578
|
+
},
|
|
31579
|
+
types: {
|
|
31580
|
+
create: bind(transport, ontologyRegisterType),
|
|
31581
|
+
list: bind(transport, ontologyListTypes),
|
|
31582
|
+
retrieve: bind(transport, ontologyRetrieveType)
|
|
31583
|
+
}
|
|
31584
|
+
};
|
|
31585
|
+
}
|
|
30215
31586
|
function createOrganization(transport) {
|
|
30216
31587
|
return {
|
|
30217
31588
|
charges: {
|
|
@@ -30478,6 +31849,7 @@ var resourceFactories = {
|
|
|
30478
31849
|
media: createMedia,
|
|
30479
31850
|
meta: createMeta,
|
|
30480
31851
|
model: createModel,
|
|
31852
|
+
ontology: createOntology,
|
|
30481
31853
|
organization: createOrganization,
|
|
30482
31854
|
sandbox: createSandbox,
|
|
30483
31855
|
search: createSearch,
|
|
@@ -31551,6 +32923,26 @@ async function prepareMultipart(op, opts) {
|
|
|
31551
32923
|
opts.body = body;
|
|
31552
32924
|
}
|
|
31553
32925
|
|
|
32926
|
+
// src/core/pagination.ts
|
|
32927
|
+
var PAGE_TOKENS = /^(page_?token|next_?page_?token)$/i;
|
|
32928
|
+
function pageTokenField(op) {
|
|
32929
|
+
return op.query.find((field) => PAGE_TOKENS.test(field.name));
|
|
32930
|
+
}
|
|
32931
|
+
function nextPageToken(result) {
|
|
32932
|
+
const value = result;
|
|
32933
|
+
const token = value?.next_page_token ?? value?.nextPageToken ?? value?.next_cursor;
|
|
32934
|
+
return typeof token === "string" && token ? token : undefined;
|
|
32935
|
+
}
|
|
32936
|
+
function pageOf(result) {
|
|
32937
|
+
const value = result;
|
|
32938
|
+
const arrays = value && typeof value === "object" ? Object.values(value).filter(Array.isArray) : [];
|
|
32939
|
+
const data = Array.isArray(value?.data) ? value.data : Array.isArray(value?.items) ? value.items : arrays.length === 1 ? arrays[0] : undefined;
|
|
32940
|
+
if (!Array.isArray(data))
|
|
32941
|
+
return;
|
|
32942
|
+
const token = nextPageToken(result);
|
|
32943
|
+
return { items: data, ...token ? { token } : {} };
|
|
32944
|
+
}
|
|
32945
|
+
|
|
31554
32946
|
// src/core/bind-args.ts
|
|
31555
32947
|
var globalOptions = [
|
|
31556
32948
|
{ name: "org", type: "string" },
|
|
@@ -31766,7 +33158,7 @@ function bindArgs(parsed, op, data) {
|
|
|
31766
33158
|
(opts.query ??= {})[key] ??= convert(String(globals[name]), { name, type: field.type, enum: field.enum });
|
|
31767
33159
|
}
|
|
31768
33160
|
}
|
|
31769
|
-
if (globals.all && !op.pagination)
|
|
33161
|
+
if (globals.all && !op.pagination && !pageTokenField(op))
|
|
31770
33162
|
throw new UsageError("--all requires a paginated operation");
|
|
31771
33163
|
for (const p of op.pathParams)
|
|
31772
33164
|
if (p !== target && opts.path?.[p.sdkName] === undefined)
|
|
@@ -31792,8 +33184,8 @@ function bindArgs(parsed, op, data) {
|
|
|
31792
33184
|
}
|
|
31793
33185
|
|
|
31794
33186
|
// src/core/help.ts
|
|
31795
|
-
function describeOption(s) {
|
|
31796
|
-
return `--${s.name}${s.type === "boolean" ? " [true|false]" : ` <${s.type}>`}${s.repeated ? " (repeatable)" : ""}${
|
|
33187
|
+
function describeOption(s, required = s.required) {
|
|
33188
|
+
return `--${s.name}${s.type === "boolean" ? " [true|false]" : ` <${s.type}>`}${s.repeated ? " (repeatable)" : ""}${required ? " (required)" : ""}${s.enum ? ` [${s.enum.join(" | ")}]` : ""}${s.description ? ` — ${s.description.replace(/\s+/g, " ")}` : ""}`;
|
|
31797
33189
|
}
|
|
31798
33190
|
function example(command) {
|
|
31799
33191
|
const target = targetParam(command.op);
|
|
@@ -31809,18 +33201,22 @@ function example(command) {
|
|
|
31809
33201
|
args.push("--yes");
|
|
31810
33202
|
return args.join(" ");
|
|
31811
33203
|
}
|
|
33204
|
+
function fieldRequired(op, field, location) {
|
|
33205
|
+
return Boolean(field.required) && (location === "path" || location === "query" || Boolean(op.body?.required));
|
|
33206
|
+
}
|
|
31812
33207
|
function help(commands, prefix, command) {
|
|
31813
33208
|
if (command) {
|
|
31814
33209
|
const target = targetParam(command.op);
|
|
33210
|
+
const parents = operationOptions(command.op).filter((s) => s.location === "path" && s.required).map((s) => ` --${s.name} <${s.field?.name ?? s.sdkName}>`).join("");
|
|
31815
33211
|
return [
|
|
31816
|
-
`praxis ${command.words.join(" ")}${target ? ` <${target.sdkName}>` : ""} [options]`,
|
|
33212
|
+
`praxis ${command.words.join(" ")}${parents}${target ? ` <${target.sdkName}>` : ""} [options]`,
|
|
31817
33213
|
`SDK: ${command.op.resource}.${command.alias ?? command.op.method}`,
|
|
31818
33214
|
`${command.op.http} ${command.op.path}`,
|
|
31819
33215
|
...target ? [`Position: <${target.sdkName}>${target.type ? ` <${target.type}>` : ""} (required target ID)`] : [],
|
|
31820
33216
|
"",
|
|
31821
33217
|
"Options:",
|
|
31822
33218
|
...target?.description ? [` <${target.sdkName}> — ${target.description.replace(/\s+/g, " ")}`] : [],
|
|
31823
|
-
...[...operationOptions(command.op), ...bodyDataOption(command.op), ...globalOptions].map((s) => ` ${describeOption(s)}`),
|
|
33219
|
+
...[...operationOptions(command.op), ...bodyDataOption(command.op), ...globalOptions].map((s) => ` ${describeOption(s, s.required && fieldRequired(command.op, s, s.location ?? "query"))}`),
|
|
31824
33220
|
...command.op.body?.fields.filter((f) => !operationOptions(command.op).some((s) => s.location === "body" && s.field === f) && (f.type === "object" || f.type === "array" && !["string", "number", "integer", "boolean"].includes(f.itemType ?? ""))).map((f) => ` --data: ${f.name} (${f.type}${f.required ? ", required" : ""})`) ?? [],
|
|
31825
33221
|
" -h is an alias of --help",
|
|
31826
33222
|
"PRAXIS_ENV=develop|production (default: develop); no --env option.",
|
|
@@ -33188,9 +34584,11 @@ function renderHuman(result, ctx) {
|
|
|
33188
34584
|
const details = result.details !== undefined ? JSON.stringify(result.details) : undefined;
|
|
33189
34585
|
const detailsLine = details !== undefined ? ` details ${details.length > 2000 ? details.slice(0, 1999) + "…" : details}
|
|
33190
34586
|
` : "";
|
|
34587
|
+
const problemLine = problemLines(result.problem).map((line) => ` ${plain(line)}
|
|
34588
|
+
`).join("");
|
|
33191
34589
|
return { stderr: err.red(`✗ ${plain(result.message)}`) + `
|
|
33192
34590
|
` + err.dim(` code ${plain(result.code)}${result.status !== undefined ? ` · ${result.status}` : ""} · env ${plain(result.env)}${result.request_id ? ` · request ${plain(result.request_id)}` : ""}`) + `
|
|
33193
|
-
` + detailsLine + (result.hint ? ` → ${plain(result.hint)}
|
|
34591
|
+
` + detailsLine + problemLine + (result.hint ? ` → ${plain(result.hint)}
|
|
33194
34592
|
` : "") };
|
|
33195
34593
|
}
|
|
33196
34594
|
case "list":
|
|
@@ -33278,8 +34676,33 @@ ${usage ? `usage: ${JSON.stringify(usage)}
|
|
|
33278
34676
|
}
|
|
33279
34677
|
|
|
33280
34678
|
// src/output/render.ts
|
|
34679
|
+
var PROBLEM_HINTS = ["hint", "errors", "violations", "title", "type"];
|
|
34680
|
+
function serverProblem(raw) {
|
|
34681
|
+
const value = record(raw);
|
|
34682
|
+
const problem = {};
|
|
34683
|
+
for (const member of ["code", "detail", ...PROBLEM_HINTS, "status"]) {
|
|
34684
|
+
const entry = value[member];
|
|
34685
|
+
if (entry !== undefined && entry !== null)
|
|
34686
|
+
problem[member] = entry;
|
|
34687
|
+
}
|
|
34688
|
+
const adds = PROBLEM_HINTS.some((member) => Array.isArray(problem[member]) ? problem[member].length > 0 : problem[member] !== undefined);
|
|
34689
|
+
return adds ? problem : undefined;
|
|
34690
|
+
}
|
|
34691
|
+
function problemLines(problem) {
|
|
34692
|
+
const lines = [];
|
|
34693
|
+
for (const group of [problem?.errors, problem?.violations]) {
|
|
34694
|
+
for (const item of Array.isArray(group) ? group : []) {
|
|
34695
|
+
const entry = record(item);
|
|
34696
|
+
const where = scalar(entry.pointer ?? entry.field);
|
|
34697
|
+
const detail = scalar(entry.detail ?? entry.message ?? entry.reason);
|
|
34698
|
+
if (where || detail)
|
|
34699
|
+
lines.push(`${where ? `${where}: ` : ""}${detail}`);
|
|
34700
|
+
}
|
|
34701
|
+
}
|
|
34702
|
+
return lines;
|
|
34703
|
+
}
|
|
33281
34704
|
function errorJSON(result, ctx) {
|
|
33282
|
-
return JSON.stringify({ error: { code: result.code, ...result.details !== undefined ? { details: result.details } : {}, message: result.message, hint: result.hint ?? null, env: result.env, command: ctx.command ?? null, status: result.status ?? null, request_id: result.request_id ?? null, ...result.credential_source ? { credential_source: result.credential_source } : {} } }) + `
|
|
34705
|
+
return JSON.stringify({ error: { code: result.code, ...result.details !== undefined ? { details: result.details } : {}, message: result.message, hint: result.hint ?? null, env: result.env, command: ctx.command ?? null, status: result.status ?? null, request_id: result.request_id ?? null, ...result.problem !== undefined ? { problem: result.problem } : {}, ...result.credential_source ? { credential_source: result.credential_source } : {} } }) + `
|
|
33283
34706
|
`;
|
|
33284
34707
|
}
|
|
33285
34708
|
function render(result, ctx) {
|
|
@@ -33435,6 +34858,8 @@ function errorInput(error, ctx) {
|
|
|
33435
34858
|
const raw = record(sdk?.raw), nested = record(raw.error);
|
|
33436
34859
|
const candidate = nested.details ?? raw.details;
|
|
33437
34860
|
const details = candidate !== null && typeof candidate === "object" && !Array.isArray(candidate) ? candidate : undefined;
|
|
34861
|
+
const problem = serverProblem(Object.keys(nested).length ? nested : raw);
|
|
34862
|
+
const serverText = (value) => typeof value === "string" && value.trim() ? value : undefined;
|
|
33438
34863
|
let message = error instanceof Error ? error.message : "Unexpected error";
|
|
33439
34864
|
const prefix = message.match(/^([A-Z][A-Z0-9_]+):\s*/)?.[1];
|
|
33440
34865
|
const code = error instanceof UsageError ? error.code : businessCode(raw.code) ?? businessCode(nested.code) ?? businessCode(raw.error_code) ?? prefix ?? businessCode(sdk?.code) ?? (sdk?.status ? `HTTP_${sdk.status}` : sdk ? "API_ERROR" : "RUNTIME_ERROR");
|
|
@@ -33446,11 +34871,14 @@ function errorInput(error, ctx) {
|
|
|
33446
34871
|
if (stripped)
|
|
33447
34872
|
message = `${humanize(code)}${message ? `: ${message}` : ""}`;
|
|
33448
34873
|
const status = sdk?.status, request_id = sdk?.requestId;
|
|
34874
|
+
message = serverText(problem?.detail) ?? serverText(problem?.title) ?? message;
|
|
33449
34875
|
const authFailure = status === 401 || ["NOT_LOGGED_IN", "UNAUTHENTICATED", "TOKEN_REVOKED", "LOGIN_FAILED"].includes(code);
|
|
33450
34876
|
const source = ctx.credentialSource ?? "login";
|
|
33451
34877
|
let hint = genericHint;
|
|
33452
34878
|
if (error instanceof UsageError)
|
|
33453
34879
|
hint = error.hint;
|
|
34880
|
+
else if (serverText(problem?.hint))
|
|
34881
|
+
hint = serverText(problem?.hint);
|
|
33454
34882
|
else if (authFailure)
|
|
33455
34883
|
hint = authHint(source);
|
|
33456
34884
|
else if (status === 404)
|
|
@@ -33461,7 +34889,7 @@ function errorInput(error, ctx) {
|
|
|
33461
34889
|
hint = "Rate limited; retry later.";
|
|
33462
34890
|
else if (status !== undefined && status >= 500)
|
|
33463
34891
|
hint = `Server error; retry later.${request_id ? ` Request id: ${request_id}.` : ""}`;
|
|
33464
|
-
return { kind: "error", code, message, hint, ...details !== undefined ? { details } : {}, env: ctx.env, ...authFailure ? { credential_source: source } : {}, ...status !== undefined ? { status } : {}, ...request_id ? { request_id } : {} };
|
|
34892
|
+
return { kind: "error", code, message, hint, ...details !== undefined ? { details } : {}, ...problem !== undefined ? { problem } : {}, env: ctx.env, ...authFailure ? { credential_source: source } : {}, ...status !== undefined ? { status } : {}, ...request_id ? { request_id } : {} };
|
|
33465
34893
|
}
|
|
33466
34894
|
|
|
33467
34895
|
// src/output/progress.ts
|
|
@@ -33491,7 +34919,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
|
|
|
33491
34919
|
}
|
|
33492
34920
|
|
|
33493
34921
|
// src/main.ts
|
|
33494
|
-
var version = "0.2.1-dev.
|
|
34922
|
+
var version = "0.2.1-dev.f23829c";
|
|
33495
34923
|
var commands = commandTree(operations);
|
|
33496
34924
|
var manual = [...workflows.map((w) => w.words), [API_WORD]];
|
|
33497
34925
|
function route(argv) {
|
|
@@ -33709,7 +35137,7 @@ Examples:
|
|
|
33709
35137
|
let owner = client2;
|
|
33710
35138
|
for (const part of op.resource.split("."))
|
|
33711
35139
|
owner = owner[part];
|
|
33712
|
-
|
|
35140
|
+
let result = await owner[op.method](opts);
|
|
33713
35141
|
const name2 = `${op.resource}.${op.method}`;
|
|
33714
35142
|
const list = (items) => {
|
|
33715
35143
|
const view = clientList(items, op, flags.limit, ctx.mode);
|
|
@@ -33723,7 +35151,21 @@ Examples:
|
|
|
33723
35151
|
const cursor = result instanceof Page ? result.next_cursor : record(result).next_cursor ?? record(result).nextToken;
|
|
33724
35152
|
if (typeof cursor === "string" && cursor)
|
|
33725
35153
|
ctx.nextCommand = nextPageCommand(selected.command, parsed, cursor);
|
|
33726
|
-
|
|
35154
|
+
const pageToken = pageTokenField(op), token = pageToken?.sdkName ?? pageToken?.name;
|
|
35155
|
+
const firstPage = flags.all && !(result instanceof Page) && token ? pageOf(result) : undefined;
|
|
35156
|
+
if (flags.all && !(result instanceof Page) && token && !firstPage)
|
|
35157
|
+
throw new UsageError(`--all cannot find the list in ${op.resource}.${op.method}'s response; page with --${token.replace(/_/g, "-")} instead`);
|
|
35158
|
+
if (firstPage) {
|
|
35159
|
+
const items = [...firstPage.items];
|
|
35160
|
+
const seen = new Set;
|
|
35161
|
+
for (let next = firstPage.token;next && !seen.has(next); next = pageOf(result)?.token) {
|
|
35162
|
+
seen.add(next);
|
|
35163
|
+
result = await owner[op.method]({ ...opts, query: { ...opts.query, [token]: next } });
|
|
35164
|
+
items.push(...pageOf(result)?.items ?? []);
|
|
35165
|
+
}
|
|
35166
|
+
ctx.nextCommand = undefined;
|
|
35167
|
+
emit({ kind: "list", ...list(items), ...ctx.mode === "json" ? { raw: { data: items, next_page_token: null } } : {}, nextCursor: null, op: name2 });
|
|
35168
|
+
} else if (result instanceof Page) {
|
|
33727
35169
|
if (flags.all) {
|
|
33728
35170
|
const items = [];
|
|
33729
35171
|
for await (const item of result)
|
|
@@ -33819,7 +35261,7 @@ Examples:
|
|
|
33819
35261
|
}
|
|
33820
35262
|
}
|
|
33821
35263
|
if (true)
|
|
33822
|
-
process.
|
|
35264
|
+
process.exitCode = await main(process.argv.slice(2));
|
|
33823
35265
|
export {
|
|
33824
35266
|
main
|
|
33825
35267
|
};
|