@deepraxis/sdk 0.1.1-dev.cc34a92 → 0.1.1-dev.d54e526
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/METHODS.md +20 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +163 -40
- package/dist/generated/sdk.gen.js +202 -39
- package/dist/generated/types.gen.d.ts +1912 -279
- package/dist/operations.generated.d.ts +193 -61
- package/dist/operations.generated.js +228 -57
- package/dist/resources.generated.d.ts +26 -0
- package/dist/resources.generated.js +10 -0
- package/package.json +1 -1
|
@@ -7935,7 +7935,7 @@ export declare const operations: readonly [{
|
|
|
7935
7935
|
readonly resource: "cut.projects.analysis";
|
|
7936
7936
|
readonly method: "create";
|
|
7937
7937
|
readonly summary: "Analyze project media";
|
|
7938
|
-
readonly 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.";
|
|
7938
|
+
readonly 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.";
|
|
7939
7939
|
readonly http: "POST";
|
|
7940
7940
|
readonly path: "/cut/v1/projects/{project_id}/analysis";
|
|
7941
7941
|
readonly streaming: "no";
|
|
@@ -8074,6 +8074,16 @@ export declare const operations: readonly [{
|
|
|
8074
8074
|
readonly body: {
|
|
8075
8075
|
readonly required: true;
|
|
8076
8076
|
readonly fields: readonly [{
|
|
8077
|
+
readonly name: "folder";
|
|
8078
|
+
readonly type: "string";
|
|
8079
|
+
readonly required: false;
|
|
8080
|
+
readonly description: "Optional destination path within the bound media library; omitted uses its default folder.";
|
|
8081
|
+
}, {
|
|
8082
|
+
readonly name: "name";
|
|
8083
|
+
readonly type: "string";
|
|
8084
|
+
readonly required: false;
|
|
8085
|
+
readonly 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.";
|
|
8086
|
+
}, {
|
|
8077
8087
|
readonly name: "output";
|
|
8078
8088
|
readonly type: "object";
|
|
8079
8089
|
readonly required: false;
|
|
@@ -8094,7 +8104,7 @@ export declare const operations: readonly [{
|
|
|
8094
8104
|
readonly resource: "cut.projects.frames";
|
|
8095
8105
|
readonly method: "list";
|
|
8096
8106
|
readonly summary: "Render preview frames";
|
|
8097
|
-
readonly 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.
|
|
8107
|
+
readonly 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. FRAME_UNAVAILABLE warnings on execute mean a source preview could not be fetched and an offline tile was drawn; edits still commit, and this warning alone does not establish that the source media is broken. Decode its base64 payload to save the image. Codemode returns at most four images per call, so request at most four times when reviewing there.";
|
|
8098
8108
|
readonly http: "GET";
|
|
8099
8109
|
readonly path: "/cut/v1/projects/{project_id}/frames";
|
|
8100
8110
|
readonly streaming: "no";
|
|
@@ -8113,7 +8123,7 @@ export declare const operations: readonly [{
|
|
|
8113
8123
|
readonly name: "scale";
|
|
8114
8124
|
readonly type: "number";
|
|
8115
8125
|
readonly required: false;
|
|
8116
|
-
readonly description: "
|
|
8126
|
+
readonly 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.";
|
|
8117
8127
|
}, {
|
|
8118
8128
|
readonly name: "revision";
|
|
8119
8129
|
readonly type: "integer";
|
|
@@ -8268,7 +8278,7 @@ export declare const operations: readonly [{
|
|
|
8268
8278
|
readonly resource: "cut.projects";
|
|
8269
8279
|
readonly method: "execute";
|
|
8270
8280
|
readonly summary: "Execute editing script";
|
|
8271
|
-
readonly 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. Use AddTrack, Insert, Update, Delete, Split, Trim, Move, RippleDeleteRange, UpdateTrack, DeleteTrack, SetSettings, AddCaptionsFromTranscript and SetMarker for writes; GetTimeline, GetItem, FindItems, GetMedia, GetTranscript and GetAnalysis read editing context; Print emits text and Preview requests frame previews. All script times are seconds; script object fields use camelCase, for example `media: {libraryId, assetId}`. 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:\n\n```js\nconst t = AddTrack(\"video\");\nInsert(t, {type: \"color\", color: \"#123456\", start: 0, length: 3});\nPrint(t);\n```";
|
|
8281
|
+
readonly 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);`\n\n### Script function reference\n\nFunctions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. JoinId is the string returned by Join or read from GetTimeline().joins. Reads see earlier writes in the same script.\n\n```ts\nGetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;\nGetItem(id: ClipId): ItemView;\nFindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];\nGetMedia(ref: MediaRef): MediaInfo;\nGetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];\nGetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];\nListTransitions(): TransitionInfo[];\nInsert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;\nUpdate(id: ClipId, patch: ItemPatchView): void;\nSetSpeed(id: ClipId, rate: number, o: { keep: \"source\" | \"duration\"; ripple?: boolean }): { length: number; sourceOut: number };\nDelete(id: ClipId, o?: { ripple?: boolean }): void;\nJoin(left: ClipId, right: ClipId, o: { length?: number; effect: TransitionInput }): JoinId;\nUpdateJoin(id: JoinId, patch: { length?: number; effect?: TransitionInput }): void;\nDeleteJoin(id: JoinId): void;\nSplit(id: ClipId, at: number): ClipId;\nTrim(id: ClipId, edge: \"in\" | \"out\", delta: number, o?: { ripple?: boolean }): void;\nMove(id: ClipId, start: number, track?: TrackId): void;\nRippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;\nAddTrack(kind: \"video\" | \"audio\" | \"caption\", init?: { name?: string }, index?: number): TrackId;\nUpdateTrack(id: TrackId, patch: TrackPatch): void;\nDeleteTrack(id: TrackId): void;\nSetSettings(patch: Partial<ProjectSettingsView>): void;\nAddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle>; maxChars?: number }): ClipId[];\nSetMarker(at: number, label: string): string;\nPrint(...values: unknown[]): void;\nPreview(at: number[]): void;\n```\n\n| Functions | Behavior and arguments |\n| --- | --- |\n| GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, playback, sourceIn/sourceOut, text and offline reason. GetTimeline returns duration, tracks (id, kind, name, index, locked, items), and joins (id, track, left, right, length in seconds, normalized effect). from/to and tracks narrow the items and joins; joins are selected by their overlap window. |\n| ListTransitions | Discover the shared validation catalog: each entry contains kind (effect ID), name, description and params. Each parameter has name, type (enum/number/integer), default, description, enum values or numeric min/max. Use the returned kind and parameter names inside effect. |\n| FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |\n| GetMedia | Read metadata for `{libraryId, assetId}` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |\n| 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. |\n| 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. |\n| SetSpeed | Change video/audio rate in 0.25–4; keep is required. source preserves consumed source and changes length, duration preserves output length. Returns actual length and sourceOut in seconds. Optional ripple explicitly shifts same-track followers when keeping source; otherwise overlaps are rejected. |\n| Join, UpdateJoin, DeleteJoin | Join creates an overlap between two butt-adjacent visual clips on the same track and returns its ID. length defaults to 0.5 seconds; effect is required. The right clip and all same-track followers move left by length, shortening that track and potentially the project. UpdateJoin moves those followers by the difference in length; omitted fields are preserved. DeleteJoin moves them right to restore the butt cut. Other tracks stay in place. |\n| 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. |\n| RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |\n| 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. |\n| SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |\n| 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. |\n| SetMarker | Add a label at a timeline time and return its ID. |\n| 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. |\n\n#### Joins between clips\n\nEndpoints may be video, image, text, color or shape; audio and caption are rejected. Require 0 < length < each endpoint's length. Each clip allows at most one incoming and one outgoing join; their summed lengths cannot exceed its length. Three-input overlaps, nonadjacent endpoints and cross-track joins are rejected with OPS_REJECTED. Read the rejection's code and message, shorten or remove conflicting joins, and retry the saved edit.\n\nTransitionInput is an object with kind plus the parameters returned by ListTransitions; omitted parameters use the catalog defaults. Unknown kinds and unknown or invalid parameters are rejected. Effects: dissolve (no parameters); dip (color black/white, default black); push and wipe (direction left/right/up/down, default left); wipe also has softness 0–1, default 0; iris has centerX/centerY 0–1, both default 0.5; blinds has integer count 2–64, default 8, and orientation vertical/horizontal, default vertical; blur has radius 0–100 pixels at 1080-pixel frame height, default 24. Join options and UpdateJoin patches accept only length and effect. Effect updates replace the effect object and apply defaults for omitted parameters.\n\nMinimal example on an existing visual track with adjacent clips left and right: `Print(ListTransitions()); const j = Join(left, right, {length: 0.5, effect: {kind: \"dissolve\"}}); Print(GetTimeline().joins); Preview([GetItem(right).start + 0.25]);` Use `UpdateJoin(j, {length: 0.8})` to adjust it in a later edit or `DeleteJoin(j)` to restore the cut. Preview uses server-rendered frames and includes joins. Per-clip transitionIn/transitionOut remain separate entrance/exit effects.\n\n#### Insert fields (ItemInit)\n\nEvery 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.\n\n| type | Required fields beyond type/start | Optional fields |\n| --- | --- | --- |\n| video | media | length, sourceIn, playback, volumeDb, transform, fit, animate, transitionIn, transitionOut |\n| image | media, length | transform, fit, animate, transitionIn, transitionOut |\n| text | text, length | style, transform, reveal, animate, transitionIn, transitionOut |\n| color | color, length | transform, fill, animate, transitionIn, transitionOut |\n| shape | shape, length, width, height, fill | radius, stroke, transform, animate, transitionIn, transitionOut |\n| audio | media | length, sourceIn, playback, volumeDb, fadeIn, fadeOut |\n| caption | text, length | — |\n\nVideo 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.\n\n| Field | Value |\n| --- | --- |\n| 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. |\n| style | Partial `{fontFamily, fontSize, fontWeight, color, stroke, background, align, maxWidth, position, margin}`. 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}`. Text and captions support position (top/middle/bottom; box centers at 12%/50%/85% of height without margin) and optional margin (0–0.4 of canvas height, box edge distance for top/bottom; middle ignores it). Omitted position preserves the text transform (center by default); explicit position controls vertical placement, so omit it for y animation. Caption style additionally supports highlightColor and maxLines: 2. GetItem and GetTimeline return text style and current caption track style. Caption tracks only accept captions; use AddCaptionsFromTranscript, and place text on video tracks. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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}`. |\n| 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. |\n\n#### Update fields (ItemPatchView)\n\nAll fields are optional; use only fields relevant to the item's type. Supported fields: start, length, sourceIn, playback, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, animate, reveal, fill, stroke, shape, width, height, radius, transitionIn, transitionOut. Values and units match Insert. Set animate, reveal, fill, stroke, transitionIn or transitionOut to null to remove that effect; omitting a field preserves it. For example: `Update(id, {volumeDb: -12})` or `Update(id, {transitionIn: null})`.\n\n#### Speed, reverse and freeze\n\nVideo/audio Insert and Update accept playback as `{kind: \"rate\", rate: number, direction: \"forward\" | \"reverse\", audio: \"preservePitch\" | \"resample\" | \"mute\"}` or `{kind: \"freeze\"}`. Rate is finite and inclusive 0.25–4. Omitted playback defaults to 1× forward with preservePitch; supply the complete rate object when changing playback. preservePitch keeps pitch, resample changes pitch with speed, mute removes audio. Reverse requires explicit audio: \"mute\"; preservePitch/resample are rejected with UNSUPPORTED_PLAYBACK rather than silently muted. Freeze holds sourceIn and is silent. GetItem/GetTimeline echo playback and the source interval in seconds; sourceOut is exclusive even for reverse and equals sourceIn for freeze.\n\nUpdate of playback keeps output length unless length is also supplied. SetSpeed preserves direction/audio, rejects frozen and non-video/audio clips, and requires keep: \"source\" or \"duration\". keep: \"source\" computes round(consumed source / new rate × fps) frames, falling back to floor if rounding would exceed the source end; the returned length/sourceOut are actual frame-rounded seconds. keep: \"duration\" keeps output length and changes source consumption. Length conflicts fail with OVERLAP; move/shorten the conflicting clip, keep duration, or explicitly use ripple: true to shift following clips on the same track. Source overflow fails with OUT_OF_SOURCE; rate limits fail with RATE_OUT_OF_RANGE. Unknown playback fields and SetSpeed options are rejected with UNKNOWN_FIELD; options only accept keep and boolean ripple.\n\nExample for an existing four-second video/audio clip id: `Print(SetSpeed(id, 0.5, {keep: \"source\"})); Print(SetSpeed(id, 2, {keep: \"source\"}));` returns lengths 8 then 2, keeping the same source interval. Reverse: `Update(id, {playback: {kind: \"rate\", rate: 1, direction: \"reverse\", audio: \"mute\"}})`. Freeze: `Update(id, {playback: {kind: \"freeze\"}})`. Ensure enough source remains for the chosen length/rate. Browser reverse playback currently displays a placeholder; server-rendered Preview/frames and exports support reverse normally. Speed-adjusted audio is generated asynchronously after the edit transaction commits; exports wait for that audio before rendering.\n\n#### Script names versus HTTP response names\n\nUse camelCase inside scripts, including nested objects. HTTP request/response JSON outside script source uses snake_case. Map media.library_id → media.libraryId, media.asset_id → media.assetId, source_in → sourceIn, volume_db → volumeDb, fade_in/fade_out → fadeIn/fadeOut, transition_in/transition_out → transitionIn/transitionOut, font_family/font_size/font_weight/max_width → fontFamily/fontSize/fontWeight/maxWidth, gain_db → gainDb, highlight_color/max_lines → highlightColor/maxLines. Fields such as animate, reveal, fill, stroke, at and length retain their spelling. GetTimeline/GetItem already return camelCase compact views; the expanded retrieveTimeline HTTP response is not an Insert object.\n\nUnrecognized script fields fail with OPS_REJECTED and rejection code UNKNOWN_FIELD; snake_case mistakes suggest the corresponding camelCase name. The error message lists each rejection's #opIndex, code and reason. Correct the named fields and retry the saved edit; do not assume an ignored field applied an effect.\n";
|
|
8272
8282
|
readonly http: "POST";
|
|
8273
8283
|
readonly path: "/cut/v1/projects/{project_id}:execute";
|
|
8274
8284
|
readonly streaming: "no";
|
|
@@ -9164,7 +9174,7 @@ export declare const operations: readonly [{
|
|
|
9164
9174
|
readonly resource: "file.files";
|
|
9165
9175
|
readonly method: "create";
|
|
9166
9176
|
readonly summary: "Upload file";
|
|
9167
|
-
readonly 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.";
|
|
9177
|
+
readonly 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.";
|
|
9168
9178
|
readonly http: "POST";
|
|
9169
9179
|
readonly path: "/file/v1/files";
|
|
9170
9180
|
readonly streaming: "no";
|
|
@@ -9182,9 +9192,9 @@ export declare const operations: readonly [{
|
|
|
9182
9192
|
}, {
|
|
9183
9193
|
readonly name: "purpose";
|
|
9184
9194
|
readonly type: "string";
|
|
9185
|
-
readonly enum: readonly ["user_data", "vision"];
|
|
9195
|
+
readonly enum: readonly ["user_data", "assistants", "vision"];
|
|
9186
9196
|
readonly required: true;
|
|
9187
|
-
readonly 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.";
|
|
9197
|
+
readonly 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.";
|
|
9188
9198
|
}, {
|
|
9189
9199
|
readonly name: "expires_after";
|
|
9190
9200
|
readonly type: "object";
|
|
@@ -9241,7 +9251,7 @@ export declare const operations: readonly [{
|
|
|
9241
9251
|
readonly resource: "file.files.contentLinks";
|
|
9242
9252
|
readonly method: "revoke";
|
|
9243
9253
|
readonly summary: "Revoke a file content link";
|
|
9244
|
-
readonly 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
|
|
9254
|
+
readonly 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/>\"}.";
|
|
9245
9255
|
readonly http: "POST";
|
|
9246
9256
|
readonly path: "/file/v1/files/{file_id}/content_links:revoke";
|
|
9247
9257
|
readonly streaming: "no";
|
|
@@ -9265,7 +9275,7 @@ export declare const operations: readonly [{
|
|
|
9265
9275
|
readonly resource: "file.files.contentUrl";
|
|
9266
9276
|
readonly method: "create";
|
|
9267
9277
|
readonly summary: "Create a download URL";
|
|
9268
|
-
readonly 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
|
|
9278
|
+
readonly 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}.";
|
|
9269
9279
|
readonly http: "POST";
|
|
9270
9280
|
readonly path: "/file/v1/files/{file_id}/content_url";
|
|
9271
9281
|
readonly streaming: "no";
|
|
@@ -9282,14 +9292,14 @@ export declare const operations: readonly [{
|
|
|
9282
9292
|
readonly name: "ttl_seconds";
|
|
9283
9293
|
readonly type: "integer";
|
|
9284
9294
|
readonly required: false;
|
|
9285
|
-
readonly description: "Download link lifetime in seconds, from 1 through 604800; omitted means
|
|
9295
|
+
readonly description: "Download link lifetime in seconds, from 1 through 604800; omitted means 900. This does not change the file's own expiry.";
|
|
9286
9296
|
}];
|
|
9287
9297
|
};
|
|
9288
9298
|
}, {
|
|
9289
9299
|
readonly resource: "file.uploads";
|
|
9290
9300
|
readonly method: "create";
|
|
9291
9301
|
readonly summary: "Create an upload";
|
|
9292
|
-
readonly 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 2 GiB (2147483648 bytes) and only user_data and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.";
|
|
9302
|
+
readonly 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 2 GiB (2147483648 bytes) and only user_data, assistants and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.";
|
|
9293
9303
|
readonly http: "POST";
|
|
9294
9304
|
readonly path: "/file/v1/uploads";
|
|
9295
9305
|
readonly streaming: "no";
|
|
@@ -9316,9 +9326,9 @@ export declare const operations: readonly [{
|
|
|
9316
9326
|
}, {
|
|
9317
9327
|
readonly name: "purpose";
|
|
9318
9328
|
readonly type: "string";
|
|
9319
|
-
readonly enum: readonly ["user_data", "vision"];
|
|
9329
|
+
readonly enum: readonly ["user_data", "assistants", "vision"];
|
|
9320
9330
|
readonly required: true;
|
|
9321
|
-
readonly description: "Use user_data for conversation attachments, or vision for PNG, JPEG, GIF and WebP images.";
|
|
9331
|
+
readonly description: "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images.";
|
|
9322
9332
|
}, {
|
|
9323
9333
|
readonly name: "expires_after";
|
|
9324
9334
|
readonly type: "object";
|
|
@@ -9362,9 +9372,9 @@ export declare const operations: readonly [{
|
|
|
9362
9372
|
}, {
|
|
9363
9373
|
readonly name: "purpose";
|
|
9364
9374
|
readonly type: "string";
|
|
9365
|
-
readonly enum: readonly ["user_data", "vision"];
|
|
9375
|
+
readonly enum: readonly ["user_data", "assistants", "vision"];
|
|
9366
9376
|
readonly required: false;
|
|
9367
|
-
readonly description: "user_data
|
|
9377
|
+
readonly 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.";
|
|
9368
9378
|
}, {
|
|
9369
9379
|
readonly name: "expires_in";
|
|
9370
9380
|
readonly type: "integer";
|
|
@@ -9494,7 +9504,7 @@ export declare const operations: readonly [{
|
|
|
9494
9504
|
readonly resource: "knowledge.vectorStores";
|
|
9495
9505
|
readonly method: "create";
|
|
9496
9506
|
readonly summary: "Create knowledge base";
|
|
9497
|
-
readonly 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.
|
|
9507
|
+
readonly 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\"}.";
|
|
9498
9508
|
readonly http: "POST";
|
|
9499
9509
|
readonly path: "/knowledge/v1/vector_stores";
|
|
9500
9510
|
readonly streaming: "no";
|
|
@@ -9528,7 +9538,7 @@ export declare const operations: readonly [{
|
|
|
9528
9538
|
readonly name: "chunking_strategy";
|
|
9529
9539
|
readonly type: "object";
|
|
9530
9540
|
readonly required: false;
|
|
9531
|
-
readonly description: "auto
|
|
9541
|
+
readonly 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.";
|
|
9532
9542
|
}, {
|
|
9533
9543
|
readonly name: "description";
|
|
9534
9544
|
readonly type: "string";
|
|
@@ -9798,7 +9808,7 @@ export declare const operations: readonly [{
|
|
|
9798
9808
|
readonly resource: "knowledge.vectorStores.files";
|
|
9799
9809
|
readonly method: "create";
|
|
9800
9810
|
readonly summary: "Add file";
|
|
9801
|
-
readonly description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching.
|
|
9811
|
+
readonly 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.";
|
|
9802
9812
|
readonly http: "POST";
|
|
9803
9813
|
readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files";
|
|
9804
9814
|
readonly streaming: "no";
|
|
@@ -9825,7 +9835,7 @@ export declare const operations: readonly [{
|
|
|
9825
9835
|
readonly name: "chunking_strategy";
|
|
9826
9836
|
readonly type: "object";
|
|
9827
9837
|
readonly required: false;
|
|
9828
|
-
readonly description: "auto
|
|
9838
|
+
readonly 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.";
|
|
9829
9839
|
}];
|
|
9830
9840
|
};
|
|
9831
9841
|
}, {
|
|
@@ -10079,7 +10089,7 @@ export declare const operations: readonly [{
|
|
|
10079
10089
|
readonly resource: "media.libraries";
|
|
10080
10090
|
readonly method: "list";
|
|
10081
10091
|
readonly summary: "List libraries";
|
|
10082
|
-
readonly description: "
|
|
10092
|
+
readonly 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.";
|
|
10083
10093
|
readonly http: "GET";
|
|
10084
10094
|
readonly path: "/media/v1/libraries";
|
|
10085
10095
|
readonly streaming: "no";
|
|
@@ -10146,7 +10156,7 @@ export declare const operations: readonly [{
|
|
|
10146
10156
|
readonly resource: "media.libraries";
|
|
10147
10157
|
readonly method: "delete";
|
|
10148
10158
|
readonly summary: "Delete library";
|
|
10149
|
-
readonly description: "
|
|
10159
|
+
readonly 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.";
|
|
10150
10160
|
readonly http: "DELETE";
|
|
10151
10161
|
readonly path: "/media/v1/libraries/{library_id}";
|
|
10152
10162
|
readonly streaming: "no";
|
|
@@ -10161,7 +10171,7 @@ export declare const operations: readonly [{
|
|
|
10161
10171
|
readonly resource: "media.libraries";
|
|
10162
10172
|
readonly method: "retrieve";
|
|
10163
10173
|
readonly summary: "Get library";
|
|
10164
|
-
readonly description: "
|
|
10174
|
+
readonly 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.";
|
|
10165
10175
|
readonly http: "GET";
|
|
10166
10176
|
readonly path: "/media/v1/libraries/{library_id}";
|
|
10167
10177
|
readonly streaming: "no";
|
|
@@ -10176,7 +10186,7 @@ export declare const operations: readonly [{
|
|
|
10176
10186
|
readonly resource: "media.libraries";
|
|
10177
10187
|
readonly method: "update";
|
|
10178
10188
|
readonly summary: "Update library";
|
|
10179
|
-
readonly description: "Update an active library
|
|
10189
|
+
readonly 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.";
|
|
10180
10190
|
readonly http: "PATCH";
|
|
10181
10191
|
readonly path: "/media/v1/libraries/{library_id}";
|
|
10182
10192
|
readonly streaming: "no";
|
|
@@ -10190,6 +10200,12 @@ export declare const operations: readonly [{
|
|
|
10190
10200
|
readonly body: {
|
|
10191
10201
|
readonly required: true;
|
|
10192
10202
|
readonly fields: readonly [{
|
|
10203
|
+
readonly name: "hotwords";
|
|
10204
|
+
readonly type: "array";
|
|
10205
|
+
readonly itemType: "string";
|
|
10206
|
+
readonly required: false;
|
|
10207
|
+
readonly 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.";
|
|
10208
|
+
}, {
|
|
10193
10209
|
readonly name: "models";
|
|
10194
10210
|
readonly type: "object";
|
|
10195
10211
|
readonly required: false;
|
|
@@ -10215,7 +10231,7 @@ export declare const operations: readonly [{
|
|
|
10215
10231
|
readonly resource: "media.libraries.assets";
|
|
10216
10232
|
readonly method: "list";
|
|
10217
10233
|
readonly summary: "List assets";
|
|
10218
|
-
readonly description: "
|
|
10234
|
+
readonly 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.";
|
|
10219
10235
|
readonly http: "GET";
|
|
10220
10236
|
readonly path: "/media/v1/libraries/{library_id}/assets";
|
|
10221
10237
|
readonly streaming: "no";
|
|
@@ -10251,7 +10267,7 @@ export declare const operations: readonly [{
|
|
|
10251
10267
|
readonly resource: "media.libraries.assets";
|
|
10252
10268
|
readonly method: "create";
|
|
10253
10269
|
readonly summary: "Upload asset";
|
|
10254
|
-
readonly description: "
|
|
10270
|
+
readonly description: " For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
|
|
10255
10271
|
readonly http: "POST";
|
|
10256
10272
|
readonly path: "/media/v1/libraries/{library_id}/assets";
|
|
10257
10273
|
readonly streaming: "no";
|
|
@@ -10289,7 +10305,7 @@ export declare const operations: readonly [{
|
|
|
10289
10305
|
readonly name: "asset_folder";
|
|
10290
10306
|
readonly type: "string";
|
|
10291
10307
|
readonly required: false;
|
|
10292
|
-
readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected.";
|
|
10308
|
+
readonly 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.";
|
|
10293
10309
|
}, {
|
|
10294
10310
|
readonly name: "use_filename";
|
|
10295
10311
|
readonly type: "boolean";
|
|
@@ -10348,7 +10364,7 @@ export declare const operations: readonly [{
|
|
|
10348
10364
|
readonly resource: "media.libraries.assets.import";
|
|
10349
10365
|
readonly method: "create";
|
|
10350
10366
|
readonly summary: "Import file";
|
|
10351
|
-
readonly description: "Copy
|
|
10367
|
+
readonly 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 and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
|
|
10352
10368
|
readonly http: "POST";
|
|
10353
10369
|
readonly path: "/media/v1/libraries/{library_id}/assets/import";
|
|
10354
10370
|
readonly streaming: "no";
|
|
@@ -10365,7 +10381,7 @@ export declare const operations: readonly [{
|
|
|
10365
10381
|
readonly name: "file_id";
|
|
10366
10382
|
readonly type: "string";
|
|
10367
10383
|
readonly required: true;
|
|
10368
|
-
readonly description: "File ID to copy into this library instead of file bytes. This independent copy defaults to
|
|
10384
|
+
readonly 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.";
|
|
10369
10385
|
}, {
|
|
10370
10386
|
readonly name: "public_id";
|
|
10371
10387
|
readonly type: "string";
|
|
@@ -10385,7 +10401,7 @@ export declare const operations: readonly [{
|
|
|
10385
10401
|
readonly name: "asset_folder";
|
|
10386
10402
|
readonly type: "string";
|
|
10387
10403
|
readonly required: false;
|
|
10388
|
-
readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected.";
|
|
10404
|
+
readonly 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.";
|
|
10389
10405
|
}, {
|
|
10390
10406
|
readonly name: "use_filename";
|
|
10391
10407
|
readonly type: "boolean";
|
|
@@ -10444,7 +10460,7 @@ export declare const operations: readonly [{
|
|
|
10444
10460
|
readonly resource: "media.libraries.assets";
|
|
10445
10461
|
readonly method: "delete";
|
|
10446
10462
|
readonly summary: "Delete asset";
|
|
10447
|
-
readonly description: "
|
|
10463
|
+
readonly 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.";
|
|
10448
10464
|
readonly http: "DELETE";
|
|
10449
10465
|
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}";
|
|
10450
10466
|
readonly streaming: "no";
|
|
@@ -10463,7 +10479,7 @@ export declare const operations: readonly [{
|
|
|
10463
10479
|
readonly resource: "media.libraries.assets";
|
|
10464
10480
|
readonly method: "retrieve";
|
|
10465
10481
|
readonly summary: "Get asset";
|
|
10466
|
-
readonly description: "
|
|
10482
|
+
readonly 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.";
|
|
10467
10483
|
readonly http: "GET";
|
|
10468
10484
|
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}";
|
|
10469
10485
|
readonly streaming: "no";
|
|
@@ -10482,7 +10498,7 @@ export declare const operations: readonly [{
|
|
|
10482
10498
|
readonly resource: "media.libraries.assets";
|
|
10483
10499
|
readonly method: "update";
|
|
10484
10500
|
readonly summary: "Update asset";
|
|
10485
|
-
readonly description: "
|
|
10501
|
+
readonly 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.";
|
|
10486
10502
|
readonly http: "PATCH";
|
|
10487
10503
|
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}";
|
|
10488
10504
|
readonly streaming: "no";
|
|
@@ -10508,7 +10524,7 @@ export declare const operations: readonly [{
|
|
|
10508
10524
|
readonly name: "asset_folder";
|
|
10509
10525
|
readonly type: "string";
|
|
10510
10526
|
readonly required: false;
|
|
10511
|
-
readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected.";
|
|
10527
|
+
readonly 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.";
|
|
10512
10528
|
}, {
|
|
10513
10529
|
readonly name: "tags";
|
|
10514
10530
|
readonly type: "array";
|
|
@@ -10522,11 +10538,46 @@ export declare const operations: readonly [{
|
|
|
10522
10538
|
readonly description: "Replacement custom string-metadata map. Nonempty keys are required and serialized JSON must fit within 1024 UTF-8 bytes; an empty object clears the metadata.";
|
|
10523
10539
|
}];
|
|
10524
10540
|
};
|
|
10541
|
+
}, {
|
|
10542
|
+
readonly resource: "media.libraries.assets.frames";
|
|
10543
|
+
readonly method: "create";
|
|
10544
|
+
readonly summary: "Create frame URLs";
|
|
10545
|
+
readonly 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.";
|
|
10546
|
+
readonly http: "POST";
|
|
10547
|
+
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames";
|
|
10548
|
+
readonly streaming: "no";
|
|
10549
|
+
readonly pagination: false;
|
|
10550
|
+
readonly pathParams: readonly [{
|
|
10551
|
+
readonly name: "library_id";
|
|
10552
|
+
readonly sdkName: "library_id";
|
|
10553
|
+
readonly description: "Library identifier returned by library creation or listing; must be accessible to the current credential.";
|
|
10554
|
+
}, {
|
|
10555
|
+
readonly name: "asset_id";
|
|
10556
|
+
readonly sdkName: "asset_id";
|
|
10557
|
+
readonly description: "Video asset identifier returned by asset upload or listing in this library; read its duration before choosing timestamps.";
|
|
10558
|
+
}];
|
|
10559
|
+
readonly query: readonly [];
|
|
10560
|
+
readonly body: {
|
|
10561
|
+
readonly required: true;
|
|
10562
|
+
readonly fields: readonly [{
|
|
10563
|
+
readonly name: "at_micros";
|
|
10564
|
+
readonly type: "array";
|
|
10565
|
+
readonly itemType: "integer";
|
|
10566
|
+
readonly required: true;
|
|
10567
|
+
readonly 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.";
|
|
10568
|
+
}, {
|
|
10569
|
+
readonly name: "width";
|
|
10570
|
+
readonly type: "integer";
|
|
10571
|
+
readonly enum: readonly [160, 320, 640];
|
|
10572
|
+
readonly required: false;
|
|
10573
|
+
readonly 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.";
|
|
10574
|
+
}];
|
|
10575
|
+
};
|
|
10525
10576
|
}, {
|
|
10526
10577
|
readonly resource: "media.libraries.assets.reprocess";
|
|
10527
10578
|
readonly method: "create";
|
|
10528
10579
|
readonly summary: "Reprocess asset";
|
|
10529
|
-
readonly description: "
|
|
10580
|
+
readonly description: " For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
|
|
10530
10581
|
readonly http: "POST";
|
|
10531
10582
|
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess";
|
|
10532
10583
|
readonly streaming: "no";
|
|
@@ -10549,14 +10600,14 @@ export declare const operations: readonly [{
|
|
|
10549
10600
|
readonly itemType: "string";
|
|
10550
10601
|
readonly enum: readonly ["visual", "frames", "transcript", "embedding"];
|
|
10551
10602
|
readonly required: false;
|
|
10552
|
-
readonly description: "Processing tasks to rerun. Omit to retry failed tasks
|
|
10603
|
+
readonly 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.";
|
|
10553
10604
|
}];
|
|
10554
10605
|
};
|
|
10555
10606
|
}, {
|
|
10556
10607
|
readonly resource: "media.libraries.assets.understandings";
|
|
10557
10608
|
readonly method: "list";
|
|
10558
10609
|
readonly summary: "List understandings";
|
|
10559
|
-
readonly description: "List an asset
|
|
10610
|
+
readonly 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.";
|
|
10560
10611
|
readonly http: "GET";
|
|
10561
10612
|
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/understandings";
|
|
10562
10613
|
readonly streaming: "no";
|
|
@@ -10578,9 +10629,9 @@ export declare const operations: readonly [{
|
|
|
10578
10629
|
}, {
|
|
10579
10630
|
readonly name: "kind";
|
|
10580
10631
|
readonly type: "string";
|
|
10581
|
-
readonly enum: readonly ["caption", "tags", "ocr", "transcript", "frame"];
|
|
10632
|
+
readonly enum: readonly ["caption", "tags", "ocr", "transcript", "frame", "overview", "audio", "embedding"];
|
|
10582
10633
|
readonly required: false;
|
|
10583
|
-
readonly description: "
|
|
10634
|
+
readonly 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.";
|
|
10584
10635
|
}, {
|
|
10585
10636
|
readonly name: "cursor";
|
|
10586
10637
|
readonly type: "string";
|
|
@@ -10596,7 +10647,7 @@ export declare const operations: readonly [{
|
|
|
10596
10647
|
readonly resource: "media.libraries.assets";
|
|
10597
10648
|
readonly method: "batch";
|
|
10598
10649
|
readonly summary: "Batch assets alias";
|
|
10599
|
-
readonly description: "
|
|
10650
|
+
readonly 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 and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
|
|
10600
10651
|
readonly http: "POST";
|
|
10601
10652
|
readonly path: "/media/v1/libraries/{library_id}/assets:batch";
|
|
10602
10653
|
readonly streaming: "no";
|
|
@@ -10614,13 +10665,18 @@ export declare const operations: readonly [{
|
|
|
10614
10665
|
readonly type: "object";
|
|
10615
10666
|
readonly required: true;
|
|
10616
10667
|
readonly description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created.";
|
|
10668
|
+
}, {
|
|
10669
|
+
readonly name: "reason";
|
|
10670
|
+
readonly type: "string";
|
|
10671
|
+
readonly required: false;
|
|
10672
|
+
readonly description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters.";
|
|
10617
10673
|
}];
|
|
10618
10674
|
};
|
|
10619
10675
|
}, {
|
|
10620
10676
|
readonly resource: "media.libraries.batches";
|
|
10621
10677
|
readonly method: "create";
|
|
10622
10678
|
readonly summary: "Create batch";
|
|
10623
|
-
readonly description: "
|
|
10679
|
+
readonly 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 and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
|
|
10624
10680
|
readonly http: "POST";
|
|
10625
10681
|
readonly path: "/media/v1/libraries/{library_id}/batches";
|
|
10626
10682
|
readonly streaming: "no";
|
|
@@ -10638,13 +10694,18 @@ export declare const operations: readonly [{
|
|
|
10638
10694
|
readonly type: "object";
|
|
10639
10695
|
readonly required: true;
|
|
10640
10696
|
readonly description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created.";
|
|
10697
|
+
}, {
|
|
10698
|
+
readonly name: "reason";
|
|
10699
|
+
readonly type: "string";
|
|
10700
|
+
readonly required: false;
|
|
10701
|
+
readonly description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters.";
|
|
10641
10702
|
}];
|
|
10642
10703
|
};
|
|
10643
10704
|
}, {
|
|
10644
10705
|
readonly resource: "media.libraries.batches";
|
|
10645
10706
|
readonly method: "retrieve";
|
|
10646
10707
|
readonly summary: "Get batch";
|
|
10647
|
-
readonly description: "
|
|
10708
|
+
readonly 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.";
|
|
10648
10709
|
readonly http: "GET";
|
|
10649
10710
|
readonly path: "/media/v1/libraries/{library_id}/batches/{job_id}";
|
|
10650
10711
|
readonly streaming: "no";
|
|
@@ -10663,7 +10724,7 @@ export declare const operations: readonly [{
|
|
|
10663
10724
|
readonly resource: "media.libraries.deliveryTokens";
|
|
10664
10725
|
readonly method: "create";
|
|
10665
10726
|
readonly summary: "Create delivery token";
|
|
10666
|
-
readonly 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
|
|
10727
|
+
readonly 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.";
|
|
10667
10728
|
readonly http: "POST";
|
|
10668
10729
|
readonly path: "/media/v1/libraries/{library_id}/delivery_tokens";
|
|
10669
10730
|
readonly streaming: "no";
|
|
@@ -10685,14 +10746,14 @@ export declare const operations: readonly [{
|
|
|
10685
10746
|
readonly name: "expires_in";
|
|
10686
10747
|
readonly type: "integer";
|
|
10687
10748
|
readonly required: false;
|
|
10688
|
-
readonly description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to
|
|
10749
|
+
readonly description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 900.";
|
|
10689
10750
|
}];
|
|
10690
10751
|
};
|
|
10691
10752
|
}, {
|
|
10692
10753
|
readonly resource: "media.libraries.events";
|
|
10693
10754
|
readonly method: "list";
|
|
10694
10755
|
readonly summary: "List events";
|
|
10695
|
-
readonly description: "Read library events in sequence order
|
|
10756
|
+
readonly 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.";
|
|
10696
10757
|
readonly http: "GET";
|
|
10697
10758
|
readonly path: "/media/v1/libraries/{library_id}/events";
|
|
10698
10759
|
readonly streaming: "no";
|
|
@@ -10728,7 +10789,7 @@ export declare const operations: readonly [{
|
|
|
10728
10789
|
readonly resource: "media.libraries.folders";
|
|
10729
10790
|
readonly method: "list";
|
|
10730
10791
|
readonly summary: "List folders";
|
|
10731
|
-
readonly description: "
|
|
10792
|
+
readonly description: "undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.";
|
|
10732
10793
|
readonly http: "GET";
|
|
10733
10794
|
readonly path: "/media/v1/libraries/{library_id}/folders";
|
|
10734
10795
|
readonly streaming: "no";
|
|
@@ -10748,7 +10809,7 @@ export declare const operations: readonly [{
|
|
|
10748
10809
|
readonly resource: "media.libraries.jobs";
|
|
10749
10810
|
readonly method: "retrieve";
|
|
10750
10811
|
readonly summary: "Get job alias";
|
|
10751
|
-
readonly description: "
|
|
10812
|
+
readonly description: "Read library events in sequence order, including while the library is deleting. Page forward with asc and after_seq, or backward with desc and before_seq; never combine the two sequence cursors.";
|
|
10752
10813
|
readonly http: "GET";
|
|
10753
10814
|
readonly path: "/media/v1/libraries/{library_id}/jobs/{job_id}";
|
|
10754
10815
|
readonly streaming: "no";
|
|
@@ -10767,7 +10828,7 @@ export declare const operations: readonly [{
|
|
|
10767
10828
|
readonly resource: "media.libraries.purge";
|
|
10768
10829
|
readonly method: "create";
|
|
10769
10830
|
readonly summary: "Purge library";
|
|
10770
|
-
readonly description: "
|
|
10831
|
+
readonly 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.";
|
|
10771
10832
|
readonly http: "POST";
|
|
10772
10833
|
readonly path: "/media/v1/libraries/{library_id}/purge";
|
|
10773
10834
|
readonly streaming: "no";
|
|
@@ -10782,7 +10843,7 @@ export declare const operations: readonly [{
|
|
|
10782
10843
|
readonly resource: "media.libraries";
|
|
10783
10844
|
readonly method: "restore";
|
|
10784
10845
|
readonly summary: "Restore library";
|
|
10785
|
-
readonly description: "
|
|
10846
|
+
readonly 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.";
|
|
10786
10847
|
readonly http: "POST";
|
|
10787
10848
|
readonly path: "/media/v1/libraries/{library_id}/restore";
|
|
10788
10849
|
readonly streaming: "no";
|
|
@@ -10797,7 +10858,7 @@ export declare const operations: readonly [{
|
|
|
10797
10858
|
readonly resource: "media.libraries.search";
|
|
10798
10859
|
readonly method: "create";
|
|
10799
10860
|
readonly summary: "Semantic search alias";
|
|
10800
|
-
readonly description: "
|
|
10861
|
+
readonly 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.";
|
|
10801
10862
|
readonly http: "POST";
|
|
10802
10863
|
readonly path: "/media/v1/libraries/{library_id}/search";
|
|
10803
10864
|
readonly streaming: "no";
|
|
@@ -10837,7 +10898,7 @@ export declare const operations: readonly [{
|
|
|
10837
10898
|
readonly resource: "media.libraries.search.expression";
|
|
10838
10899
|
readonly method: "create";
|
|
10839
10900
|
readonly summary: "Expression search";
|
|
10840
|
-
readonly description: "
|
|
10901
|
+
readonly 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.";
|
|
10841
10902
|
readonly http: "POST";
|
|
10842
10903
|
readonly path: "/media/v1/libraries/{library_id}/search/expression";
|
|
10843
10904
|
readonly streaming: "no";
|
|
@@ -10854,7 +10915,7 @@ export declare const operations: readonly [{
|
|
|
10854
10915
|
readonly name: "expression";
|
|
10855
10916
|
readonly type: "string";
|
|
10856
10917
|
readonly required: false;
|
|
10857
|
-
readonly 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.";
|
|
10918
|
+
readonly 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.";
|
|
10858
10919
|
}, {
|
|
10859
10920
|
readonly name: "sort_by";
|
|
10860
10921
|
readonly type: "array";
|
|
@@ -10891,7 +10952,7 @@ export declare const operations: readonly [{
|
|
|
10891
10952
|
readonly resource: "media.libraries.search.semantic";
|
|
10892
10953
|
readonly method: "create";
|
|
10893
10954
|
readonly summary: "Semantic search";
|
|
10894
|
-
readonly description: "Search assets with a nonblank text query
|
|
10955
|
+
readonly 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.";
|
|
10895
10956
|
readonly http: "POST";
|
|
10896
10957
|
readonly path: "/media/v1/libraries/{library_id}/search/semantic";
|
|
10897
10958
|
readonly streaming: "no";
|
|
@@ -10931,7 +10992,7 @@ export declare const operations: readonly [{
|
|
|
10931
10992
|
readonly resource: "media.libraries.search.visual";
|
|
10932
10993
|
readonly method: "create";
|
|
10933
10994
|
readonly summary: "Visual search";
|
|
10934
|
-
readonly description: "
|
|
10995
|
+
readonly 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.";
|
|
10935
10996
|
readonly http: "POST";
|
|
10936
10997
|
readonly path: "/media/v1/libraries/{library_id}/search/visual";
|
|
10937
10998
|
readonly streaming: "no";
|
|
@@ -10966,6 +11027,56 @@ export declare const operations: readonly [{
|
|
|
10966
11027
|
readonly description: "Expression filter restricting eligible result assets.";
|
|
10967
11028
|
}];
|
|
10968
11029
|
};
|
|
11030
|
+
}, {
|
|
11031
|
+
readonly resource: "media.libraries.understandings";
|
|
11032
|
+
readonly method: "list";
|
|
11033
|
+
readonly summary: "List understanding results across a library";
|
|
11034
|
+
readonly 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.";
|
|
11035
|
+
readonly http: "GET";
|
|
11036
|
+
readonly path: "/media/v1/libraries/{library_id}/understandings";
|
|
11037
|
+
readonly streaming: "no";
|
|
11038
|
+
readonly pagination: true;
|
|
11039
|
+
readonly pathParams: readonly [{
|
|
11040
|
+
readonly name: "library_id";
|
|
11041
|
+
readonly sdkName: "library_id";
|
|
11042
|
+
readonly description: "Library ID returned by creation.";
|
|
11043
|
+
}];
|
|
11044
|
+
readonly query: readonly [{
|
|
11045
|
+
readonly name: "folder";
|
|
11046
|
+
readonly type: "string";
|
|
11047
|
+
readonly required: false;
|
|
11048
|
+
readonly description: "Folder path including all descendants; omitted or empty selects the entire library.";
|
|
11049
|
+
}, {
|
|
11050
|
+
readonly name: "kinds";
|
|
11051
|
+
readonly type: "string";
|
|
11052
|
+
readonly required: false;
|
|
11053
|
+
readonly description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind.";
|
|
11054
|
+
}, {
|
|
11055
|
+
readonly name: "cursor";
|
|
11056
|
+
readonly type: "string";
|
|
11057
|
+
readonly required: false;
|
|
11058
|
+
readonly description: "Cursor from the previous next_cursor.";
|
|
11059
|
+
}, {
|
|
11060
|
+
readonly name: "limit";
|
|
11061
|
+
readonly type: "integer";
|
|
11062
|
+
readonly required: false;
|
|
11063
|
+
readonly description: "Maximum entries in this page, from 1 through 100; defaults to 100.";
|
|
11064
|
+
}];
|
|
11065
|
+
}, {
|
|
11066
|
+
readonly resource: "media.libraries.understandings";
|
|
11067
|
+
readonly method: "retrieveFailureSummary";
|
|
11068
|
+
readonly summary: "Summarize understanding failures";
|
|
11069
|
+
readonly 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.";
|
|
11070
|
+
readonly http: "GET";
|
|
11071
|
+
readonly path: "/media/v1/libraries/{library_id}/understandings/failure_summary";
|
|
11072
|
+
readonly streaming: "no";
|
|
11073
|
+
readonly pagination: false;
|
|
11074
|
+
readonly pathParams: readonly [{
|
|
11075
|
+
readonly name: "library_id";
|
|
11076
|
+
readonly sdkName: "library_id";
|
|
11077
|
+
readonly description: "Library ID returned by creation.";
|
|
11078
|
+
}];
|
|
11079
|
+
readonly query: readonly [];
|
|
10969
11080
|
}, {
|
|
10970
11081
|
readonly resource: "meta.docs";
|
|
10971
11082
|
readonly method: "search";
|
|
@@ -11179,35 +11290,35 @@ export declare const operations: readonly [{
|
|
|
11179
11290
|
readonly name: "model";
|
|
11180
11291
|
readonly type: "string";
|
|
11181
11292
|
readonly required: true;
|
|
11182
|
-
readonly description: "
|
|
11293
|
+
readonly description: "Model catalog identifier declaring openai.audio.transcriptions; use it unchanged, including any creator prefix.";
|
|
11183
11294
|
}, {
|
|
11184
11295
|
readonly name: "file";
|
|
11185
11296
|
readonly type: "string";
|
|
11186
11297
|
readonly required: true;
|
|
11187
|
-
readonly description: "Audio
|
|
11298
|
+
readonly description: "Audio bytes uploaded as a multipart file; supported formats and input limits depend on the selected model.";
|
|
11188
11299
|
}, {
|
|
11189
11300
|
readonly name: "language";
|
|
11190
11301
|
readonly type: "string";
|
|
11191
11302
|
readonly required: false;
|
|
11192
|
-
readonly description: "
|
|
11303
|
+
readonly description: "Source language code when known; omit to let the model detect the language.";
|
|
11193
11304
|
}, {
|
|
11194
11305
|
readonly name: "prompt";
|
|
11195
11306
|
readonly type: "string";
|
|
11196
11307
|
readonly required: false;
|
|
11197
|
-
readonly description: "
|
|
11308
|
+
readonly description: "Optional vocabulary or contextual guidance for recognizing the audio; support depends on the selected model.";
|
|
11198
11309
|
}, {
|
|
11199
11310
|
readonly name: "response_format";
|
|
11200
11311
|
readonly type: "string";
|
|
11201
|
-
readonly enum: readonly ["json", "text", "verbose_json"];
|
|
11312
|
+
readonly enum: readonly ["json", "text", "verbose_json", "diarized_json"];
|
|
11202
11313
|
readonly required: false;
|
|
11203
|
-
readonly description: "
|
|
11314
|
+
readonly 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.";
|
|
11204
11315
|
}, {
|
|
11205
11316
|
readonly name: "timestamp_granularities[]";
|
|
11206
11317
|
readonly type: "array";
|
|
11207
11318
|
readonly itemType: "string";
|
|
11208
|
-
readonly enum: readonly ["segment"];
|
|
11319
|
+
readonly enum: readonly ["word", "segment"];
|
|
11209
11320
|
readonly required: false;
|
|
11210
|
-
readonly description: "Timestamp levels to
|
|
11321
|
+
readonly 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.";
|
|
11211
11322
|
}, {
|
|
11212
11323
|
readonly name: "temperature";
|
|
11213
11324
|
readonly type: "number";
|
|
@@ -13067,6 +13178,27 @@ export declare const operations: readonly [{
|
|
|
13067
13178
|
readonly description: "Up to five attachments; decoded bytes must not exceed 10 MiB each or 20 MiB in total.";
|
|
13068
13179
|
}];
|
|
13069
13180
|
};
|
|
13181
|
+
}, {
|
|
13182
|
+
readonly resource: "organization.members";
|
|
13183
|
+
readonly method: "list";
|
|
13184
|
+
readonly summary: "List organization members";
|
|
13185
|
+
readonly description: "Concepts follow GitHub org members: find a person's user id, for example to assign an approver to an approval task. Lists only members of the organization behind your API key or runtime token, ordered by joined_at ascending (membership id breaks ties). Ask the user who should approve, then use that member's id. Emails are visible only within this organization. The request cannot select another organization. Pass next_page unchanged as page; null means the end. Read-only; no usage charge. Example: GET /organization/v1/members?limit=20.";
|
|
13186
|
+
readonly http: "GET";
|
|
13187
|
+
readonly path: "/organization/v1/members";
|
|
13188
|
+
readonly streaming: "no";
|
|
13189
|
+
readonly pagination: false;
|
|
13190
|
+
readonly pathParams: readonly [];
|
|
13191
|
+
readonly query: readonly [{
|
|
13192
|
+
readonly name: "limit";
|
|
13193
|
+
readonly type: "integer";
|
|
13194
|
+
readonly required: false;
|
|
13195
|
+
readonly description: "Maximum members per page, from 1 to 100; defaults to 20.";
|
|
13196
|
+
}, {
|
|
13197
|
+
readonly name: "page";
|
|
13198
|
+
readonly type: "string";
|
|
13199
|
+
readonly required: false;
|
|
13200
|
+
readonly description: "Opaque next_page cursor returned by the previous response; omit for the first page.";
|
|
13201
|
+
}];
|
|
13070
13202
|
}, {
|
|
13071
13203
|
readonly resource: "organization.usage";
|
|
13072
13204
|
readonly method: "list";
|