@deepraxis/sdk 0.1.1-dev.ec2a9a1 → 0.1.1-dev.edf8922

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.
@@ -938,6 +938,30 @@ export declare const operations: readonly [{
938
938
  readonly required: true;
939
939
  readonly description: "Absolute path of the file whose content to download, as returned in the path field of computers.files.list.";
940
940
  }];
941
+ }, {
942
+ readonly resource: "agent.computers.files.convert";
943
+ readonly method: "create";
944
+ readonly summary: "Convert a Computer Document to PDF";
945
+ readonly 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.\n\nPraxis 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.";
946
+ readonly http: "POST";
947
+ readonly path: "/agent/v1/computers/{computer_id}/files/convert";
948
+ readonly streaming: "no";
949
+ readonly pagination: false;
950
+ readonly pathParams: readonly [{
951
+ readonly name: "computer_id";
952
+ readonly sdkName: "computer_id";
953
+ readonly description: "Computer id (cmp_...), as returned by computers.create or computers.list.";
954
+ }];
955
+ readonly query: readonly [];
956
+ readonly body: {
957
+ readonly required: true;
958
+ readonly fields: readonly [{
959
+ readonly name: "name";
960
+ readonly type: "string";
961
+ readonly required: true;
962
+ readonly description: "Name of the entry or object.";
963
+ }];
964
+ };
941
965
  }, {
942
966
  readonly resource: "agent.computers.leases";
943
967
  readonly method: "delete";
@@ -4845,7 +4869,7 @@ export declare const operations: readonly [{
4845
4869
  readonly type: "string";
4846
4870
  readonly enum: readonly ["skip", "allow"];
4847
4871
  readonly required: false;
4848
- readonly description: "skip (default) skips when a previous run is still active; allow permits overlapping runs.";
4872
+ readonly 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.";
4849
4873
  }, {
4850
4874
  readonly name: "catchup_window_seconds";
4851
4875
  readonly type: "integer";
@@ -4986,7 +5010,7 @@ export declare const operations: readonly [{
4986
5010
  readonly type: "string";
4987
5011
  readonly enum: readonly ["skip", "allow"];
4988
5012
  readonly required: false;
4989
- readonly description: "skip (default) skips when a previous run is still active; allow permits overlapping runs.";
5013
+ readonly 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.";
4990
5014
  }, {
4991
5015
  readonly name: "catchup_window_seconds";
4992
5016
  readonly type: "integer";
@@ -8102,7 +8126,7 @@ export declare const operations: readonly [{
8102
8126
  readonly name: "loudness";
8103
8127
  readonly type: "object";
8104
8128
  readonly required: false;
8105
- readonly description: "Optional loudness normalization target; normalization adds analysis and rendering work.";
8129
+ readonly 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.";
8106
8130
  }];
8107
8131
  };
8108
8132
  }, {
@@ -8169,6 +8193,46 @@ export declare const operations: readonly [{
8169
8193
  readonly description: "Optional human-readable display name for the new media asset.";
8170
8194
  }];
8171
8195
  };
8196
+ }, {
8197
+ readonly resource: "cut.projects.renders";
8198
+ readonly method: "create";
8199
+ readonly summary: "Create draft range render";
8200
+ readonly description: "Render one interval of the timeline so you can hear or look at how that passage comes out, without publishing anything to a media library. Choose kind audio for the mixed soundtrack as an .m4a file, or kind video for a draft-quality .mp4 with picture and sound. from and to are seconds on the project clock and must satisfy 0 <= from < to, to <= the timeline duration, and to - from <= 120; a longer passage is requested in several 分段请求 ranges and joined by the caller. The result is a temporary file (purpose user_data) that expires 24 hours after it is stored and is never imported into a library, so it is not a deliverable and carries no cut-export tag. HTTP 202 only accepts the job; poll praxis.cut.renders.retrieve using the returned id until status is done or failed, then read url while it lasts. A draft also bills like a draft export, by rendered seconds. Each project runs at most 2 draft renders at a time, a budget separate from its exports; a third answers HTTP 429 CUT_BUSY and the same call succeeds once one finishes.";
8201
+ readonly http: "POST";
8202
+ readonly path: "/cut/v1/projects/{project_id}/renders";
8203
+ readonly streaming: "no";
8204
+ readonly pagination: false;
8205
+ readonly pathParams: readonly [{
8206
+ readonly name: "project_id";
8207
+ readonly sdkName: "project_id";
8208
+ readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
8209
+ }];
8210
+ readonly query: readonly [];
8211
+ readonly body: {
8212
+ readonly required: true;
8213
+ readonly fields: readonly [{
8214
+ readonly name: "kind";
8215
+ readonly type: "string";
8216
+ readonly enum: readonly ["audio", "video"];
8217
+ readonly required: true;
8218
+ readonly description: "audio renders the mixed soundtrack alone as an .m4a file for listening; video renders a draft-quality .mp4 with picture and sound for looking at. An audio draft is the cheaper of the two and is what a loudness or mix measurement asks for.";
8219
+ }, {
8220
+ readonly name: "from";
8221
+ readonly type: "number";
8222
+ readonly required: true;
8223
+ readonly description: "Start of the interval in seconds on the project clock, inclusive. Must be less than to.";
8224
+ }, {
8225
+ readonly name: "to";
8226
+ readonly type: "number";
8227
+ readonly required: true;
8228
+ readonly description: "End of the interval in seconds on the project clock, exclusive. At most 120 seconds after from, and never beyond the timeline duration; a longer passage is requested as several ranges.";
8229
+ }, {
8230
+ readonly name: "revision";
8231
+ readonly type: "integer";
8232
+ readonly required: false;
8233
+ readonly description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write.";
8234
+ }];
8235
+ };
8172
8236
  }, {
8173
8237
  readonly resource: "cut.projects";
8174
8238
  readonly method: "retrieveState";
@@ -8283,7 +8347,7 @@ export declare const operations: readonly [{
8283
8347
  readonly resource: "cut.projects";
8284
8348
  readonly method: "execute";
8285
8349
  readonly summary: "Execute editing script";
8286
- 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[];\nListEffects(): EffectInfo[];\nListTextStyles(): TextStylePreset[];\nListTextTemplates(): TextTemplate[];\nListAnimations(): { id: string; version: number; phase: \"in\" | \"out\" | \"loop\"; target: \"any\" | \"text\"; name: string; description: string; defaultDuration: number; params: { name: string; type: string; values?: string[]; default?: string | number; min?: number; max?: number; description: string }[] }[];\nListFonts(): { family: string; weights: number[]; scripts: (\"latin\"|\"cjk\")[]; source: \"bundled\"|\"catalog\" }[];\nInsert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;\nUpdate(id: ClipId, patch: ItemPatchView): void;\nSetSpeed(id: ClipId, rate: number | { curve: { at: number; rate: number; ease?: Ease }[]; audio?: \"mute\" | \"resample\" }, 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; role?: \"voice\" | \"music\" | \"sfx\" }, 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> & { preset?: string }; maxChars?: number }): ClipId[];\nInsertTemplate(track: TrackId, o: { template: string; start: number; slots?: Record<string, string> }): ClipId[];\nAlignCaptions(trackId: TrackId, script: string): { replaced: number; added: number; deleted: number };\nImportCaptions(trackId: TrackId, text: string, o?: { format?: \"srt\" | \"vtt\"; offset?: number }): ClipId[];\nExportCaptions(trackId: TrackId, o: { format: \"srt\" | \"vtt\" }): string;\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, effects, blend 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| ListEffects | Discover the shared visual-effect catalog with parameter types, ranges, defaults, cost and bounds. Effects are supported only on visual clips. |\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| ListAnimations | Discover animation presets. Each entry has id, version, phase (`in`, `out`, `loop`), target (`any`, `text`), name, description, defaultDuration (seconds), and params (name, type, values/default/min/max/description as applicable). A slot use is `{preset, duration?, ...params}`; duration is seconds. |\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. A `{curve: [{at, rate, ease?}, ...], audio?: \"mute\" | \"resample\"}` rate is forward-only and holds output duration fixed; pitch preservation is unavailable. Scalar rates: 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, audio role (`voice`, `music`, `sfx`) 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| ImportCaptions, ExportCaptions | Import SRT or WebVTT text onto a caption track and export it back. format is inferred from a WEBVTT header when omitted. offset shifts imported cues in seconds. Import rejects more than 100000 bytes, more than 5000 cues, malformed or overlapping file cues with INVALID_CAPTION_FILE; overlap with existing timeline clips uses the normal OVERLAP rejection. Export sorts by timeline start and writes millisecond timecodes. |\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 catalog defaults. Unknown kinds and invalid parameters return INVALID_TRANSITION_PARAM with available parameters. Effects: dissolve; dip color black/white default black; push and wipe direction left/right/up/down default left; wipe softness 0–1 default 0; iris centerX/centerY 0–1 default 0.5; blinds integer count 2–64 default 8 and orientation vertical/horizontal default vertical; blur radius 0–100 pixels at 1080-pixel frame height default 24; zoom direction in/out default in, amount 0.1–3 default 1, blur 0–1 default 0.5; clock direction clockwise/counterclockwise default clockwise, startAngle 0–360 degrees default 0 (twelve o'clock), softness 0–1 default 0; flash color white/black default white, intensity 0–1 default 1. Zoom blur uses up to eight radial samples per shot and is slower on server rendering. 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, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| image | media, length | transform, fit, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| text | text, length | style, transform, blend, reveal, animate, animation, effects, mask, transitionIn, transitionOut |\n| color | color, length | transform, fill, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| shape | shape, length, width, height, fill | radius, stroke, transform, blend, animate, animation, effects, mask, transitionIn, transitionOut |\n| audio | media | length, sourceIn, playback, volumeDb, gain, fadeIn, fadeOut, duck |\n| caption | text, length | — |\n\nVisual Insert/Update also accepts `blend`: `normal` (default), `screen`, `multiply`, `overlay`, or `add`; set it to null in Update to clear it. During a Join overlap, both inputs render with normal blending. 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.\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, fill, stroke, strokes, shadows, glow, background, align, maxWidth, position, margin}`. fill accepts a color or linear/radial gradient across the entire text bounding box. strokes draw outside to inside; at most 4, width 0–40. shadows accepts at most 4 `{color,x,y,blur}` entries; blur is 0–100. glow is `{color,radius,strength}` with radius 0–100 and strength 0–1. All dimensions use pixels at 1080 frame height and scale with the text. Glow and large shadow blur increase render time. Invalid colors or ranges return actionable INVALID_STYLE errors. `ListFonts()` discovers family, available weights, scripts and bundled/catalog source. Text and captions share the style fields; caption style additionally supports highlightColor and maxLines: 2. |\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| animation | `{in?: AnimationUse, out?: AnimationUse, loop?: AnimationUse}` on visual clips. Each use is `{preset: string, duration?: number, ...params}`; duration and parameter units follow `ListAnimations()`. Presets replace existing animate and reveal when applied. Update accepts `animation: null` to clear the preset and its generated effects. |\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#### Visual effects\n\n`effects` is an ordered stack of at most 8 catalog entries. Call `ListEffects()` to discover the catalog; unknown kinds return `UNKNOWN_EFFECT`, invalid names/values/keyframes return `INVALID_EFFECT_PARAM`, and stacks over 8 return `TOO_MANY_EFFECTS`. Entries include blur, color adjustment, vignette, film grain, chromatic aberration, pixelate, glitch, shake, flash, light leak and built-in `lut` looks; user `.cube` LUTs are not supported. `speed` is cycles per second. Effects run on CPU during export and increase render time. Parameters are discovered with ListEffects(). Catalog entries expose their own parameters through ListEffects(), including `blur` (`radius` 0–100, default 24) and `color_adjust`: `brightness`, `contrast`, `temperature`, and `tint` each range -1–1 (default 0), while `saturation` ranges 0–2 (default 1). Disabled entries are skipped. `color_adjust` uses an SDR-only Rec.709 adjustment matrix with no color management.\n\nNumeric and integer effect parameters accept `keyframes: {parameter: [{at, value, ease?}, ...]}`; times are seconds relative to the clip, snap to frames like `animate`, must be strictly increasing and within clip duration, and values follow that parameter's catalog range. Omitted parameters use catalog defaults. Trim and Split preserve effect keyframes with the same clip-local behavior as `animate`. There are no custom shaders.\n\n`blend` applies to the completed visual layer after its content, effects and `transform.blur`; `add` maps to Skia Plus. The default `normal` path adds no blend layer. During Join overlaps, blending is forced to normal because each input is composed on transparency.\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, duck, animate, reveal, animation, fill, stroke, shape, width, height, radius, transitionIn, transitionOut, effects, blend, mask, gain. Values and units match Insert; set effects or blend to null to clear them. Set animation to null to clear the preset; set animate or reveal to null to remove that effect. Applying a preset replaces existing animate/reveal. Do not set animation together with animate or reveal in one Insert/Update call. Omit a field to preserve it.\n\n#### Animation presets\n\nDiscover the catalog with `ListAnimations()`. Its entries contain id, version, phase (`in`, `out`, `loop`), target (`any` or `text`), name, description, defaultDuration in seconds, and params. Slots may combine one in, one out and one loop preset. A loop runs only in the interval between in and out; if the same property is animated by multiple slots, loop occupies only that middle interval. Text-target presets are entrances. Their duration controls the rhythm per character/word/line, not the total reveal time. Out and loop presets apply to the whole clip, not per text unit.\n\nPresets replace the clip's existing animate and reveal when applied. The source preset is retained, so changing clip length or transform automatically regenerates its keyframes/reveal. If a clip becomes shorter, in/out durations shrink proportionally; when it grows, the requested durations are restored. Split keeps in on the left, out on the right, and loop on both. Writing animate or reveal directly detaches the preset; setting animation to null clears both source and generated effects. Insert/Update reject a call that supplies animation together with animate or reveal.\n\nErrors: UNKNOWN_ANIMATION (unknown preset), INVALID_ANIMATION_PARAM (invalid slot/parameter or frame/keyframe limit), ANIMATION_TOO_LONG (in+out exceed clip length), ANIMATION_TARGET_MISMATCH (text-only preset on a non-text or preset on non-visual clip), ANIMATION_PHASE_MISMATCH (preset in the wrong slot). Each animated property is limited to 600 keyframes; loop duration must be at least 4 frames. `ANIMATION_TOO_LONG` is avoided during later length changes by proportional fitting.\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";
8350
+ 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<!-- cut-reference:start -->\n### Script function, field and error reference\n\nEvery script function, clip field and error code has its own section, read one at a time:\n\n```\ncodemode.describe(\"praxis.cut.script.<Name>\") // one function: signature, arguments, return, errors, example\ncodemode.describe(\"praxis.cut.fields.<name>\") // one field: type, unit, range, default, where writable\ncodemode.describe(\"praxis.cut.errors.<CODE>\") // one code: meaning, causes, fix\ncodemode.describe(\"praxis.cut.script\") // names, one page at a time\n```\n\nPublished at https://docs.deepraxis.com/docs/developers/cut/script-reference with one anchor per entry. Names below omit the `praxis.cut.<kind>.` prefix.\n\n#### Script functions (script)\n\n- `GetTimeline` — Duration, tracks, joins; clips are under `items`.\n- `GetItem` — One clip's compact view, by id.\n- `FindItems` — Visit every clip with its track; collect results.\n- `GetMedia` — Media metadata; `durationUs` is microseconds.\n- `GetTranscript` — Transcript words in source microseconds.\n- `GetAnalysis` — Silence, filler or scene segments.\n- `ListTransitions` — Join transition kinds and parameters.\n- `ListEffects` — Visual-effect catalog and parameters.\n- `ListAnimations` — Animation presets by phase and target.\n- `ListFonts` — Font families, weights and scripts.\n- `ListTextStyles` — Text style presets for `style.preset`.\n- `ListTextTemplates` — Multi-layer templates and their slots.\n- `Insert` — Add a clip; a track never overlaps itself.\n- `Append` — Add a clip at the end of a track.\n- `Update` — Change named fields; the rest stay.\n- `SetSpeed` — Change rate, keeping source or duration.\n- `Delete` — Remove a clip. There is no `Remove`.\n- `Join` — Overlap clips; followers shift, track shortens.\n- `UpdateJoin` — Change a join's length or effect.\n- `DeleteJoin` — Remove a join; restore the butt cut.\n- `Split` — Cut a clip in two at a time.\n- `Trim` — Move one clip edge by seconds.\n- `Move` — Set a clip's start or track.\n- `RippleDeleteRange` — Cut a time range and close the gap.\n- `AddTrack` — Add a video, audio or caption track.\n- `UpdateTrack` — Change a track's name, lock, gain or role.\n- `DeleteTrack` — Remove a track and its clips.\n- `SetSettings` — Change canvas, frame rate or background.\n- `AddCaptionsFromTranscript` — Captions from a clip's kept words.\n- `InsertTemplate` — Insert a template and fill its slots.\n- `AlignCaptions` — Rebuild captions from text punctuation.\n- `ImportCaptions` — Import SRT or WebVTT onto captions.\n- `ExportCaptions` — Export captions as SRT or WebVTT.\n- `SetMarker` — Label a timeline position.\n- `Print` — Append values to the result's `prints`.\n- `Preview` — Up to 8 frames as inline PNG data URLs.\n\n#### Fields (fields)\n\n- `type` — Clip kind; decides which fields apply.\n- `start` — Clip start in seconds; snaps to frames.\n- `length` — Duration; optional for video and audio.\n- `media` — Source `{ libraryId, assetId }`.\n- `sourceIn` — First source second kept; default 0.\n- `sourceOut` — Exclusive source end; read-only.\n- `text` — Text of a text or caption clip.\n- `color` — Solid colour of a color clip.\n- `shape` — Shape clip kind: `rect` or `ellipse`.\n- `width` — Shape width, a fraction of canvas width.\n- `height` — Shape height, a fraction of canvas height.\n- `radius` — Rect corner rounding, in 1080-height px.\n- `fill` — Shape or text paint: colour or gradient.\n- `stroke` — Shape outline: colour and width.\n- `transform` — Position, scale, rotation, opacity, crop, blur.\n- `fit` — contain, cover, fill or none.\n- `blend` — Layer blend mode; null clears.\n- `style` — Text styling: font, fill, strokes, glow, position.\n- `style.position` — top, middle or bottom; omit it, never null.\n- `playback` — Rate, direction, audio policy, or freeze.\n- `volumeDb` — Audio level in dB; 0 is source level.\n- `gain` — Keyframed audio level in dB.\n- `fadeIn` — Fade-in seconds at the clip's start.\n- `fadeOut` — Fade-out seconds at the clip's end.\n- `duck` — Lower this clip while another track plays.\n- `animate` — Transform keyframes; `at` is clip-relative seconds.\n- `reveal` — Per-character, word or line reveal timing.\n- `animation` — Preset slots `{ in, out, loop }`; null clears.\n- `effects` — Effect stack, at most 8; null clears.\n- `transitionIn` — Entrance effect: kind plus seconds.\n- `transitionOut` — Exit effect: kind plus seconds.\n- `mask` — Shape, path or track matte.\n- `words` — Caption words with clip-local times.\n\n#### Error codes (errors)\n\n- `JOIN_CONFLICT` — A join is invalid or blocks this edit.\n- `INVALID_TRANSITION` — Bad transition kind, parameter or length.\n- `INVALID_STYLE` — A style value is out of range.\n- `INVALID_MASK` — A mask definition is malformed.\n- `MASK_IN_USE` — The edit would break a live mask.\n- `TOO_MANY_MASKS` — At most 16 masks per project.\n- `RATE_OUT_OF_RANGE` — A rate is outside 0.25-4.\n- `UNSUPPORTED_PLAYBACK` — Reverse without an explicit mute.\n- `INVALID_PLAYBACK` — A playback object is partial or malformed.\n- `UNKNOWN_FONT` — The family is not in `ListFonts()`.\n- `UNKNOWN_FIELD` — The field name is not accepted here.\n- `UNKNOWN_TEXT_STYLE` — `style.preset` is not in the catalog.\n- `TEXT_STYLE_TARGET_MISMATCH` — Preset on the wrong clip type.\n- `CAPTION_ALIGN_LOW_CONFIDENCE` — Alignment confidence too low; nothing changed.\n- `OVERLAP` — Two clips on one track would share time.\n- `OUT_OF_SOURCE` — The clip would read past its source.\n- `LOCKED_TRACK` — The edit targets a locked track.\n- `UNBOUND_LIBRARY` — The library is not bound to the project.\n- `TRACK_KIND_MISMATCH` — The clip type does not fit the track.\n- `NOT_FOUND` — The named id is not in this project.\n- `TOO_SHORT` — The result would be under one frame.\n- `INVALID_DUCK` — Bad `duck` level or a missing track.\n- `UNKNOWN_ANIMATION` — The preset is not in `ListAnimations()`.\n- `INVALID_ANIMATION_PARAM` — Bad slot, parameter or keyframe limit.\n- `ANIMATION_TOO_LONG` — In plus out exceed the clip length.\n- `ANIMATION_TARGET_MISMATCH` — The preset does not match the clip type.\n- `ANIMATION_PHASE_MISMATCH` — The preset is in the wrong slot.\n- `UNKNOWN_EFFECT` — The effect is not in `ListEffects()`.\n- `INVALID_EFFECT_PARAM` — Bad effect parameter or keyframe.\n- `TOO_MANY_EFFECTS` — More than 8 effects on one clip.\n- `PROJECT_NOT_FOUND` — No visible project has this id.\n- `EXPORT_NOT_FOUND` — No such export in this project.\n- `VERSION_NOT_FOUND` — No saved version has this revision.\n- `LIBRARY_NOT_FOUND` — The library is missing or invisible.\n- `BINDING_INVALID` — The binding request is malformed.\n- `BINDING_IN_USE` — Clips still use this library's assets.\n- `NOTHING_TO_UNDO` — No earlier revision to return to.\n- `NOTHING_TO_REDO` — No undone revision is waiting.\n- `UNDO_CONFLICT` — The revision to undo is no longer head.\n- `REVISION_CONFLICT` — The project moved; your revision is stale.\n- `CUT_BUSY` — The project is busy; retry.\n- `INVALID_CAPTION_FILE` — The subtitle file is malformed or too big.\n- `SCRIPT_ERROR` — The script threw or did not parse.\n- `SCRIPT_LIMIT` — An execute budget was exceeded.\n- `OPS_REJECTED` — An op failed; the whole edit rolled back.\n- `EDIT_EXPIRED` — The saved edit id is over ten minutes old.\n- `MEDIA_OFFLINE` — The asset cannot be fetched right now.\n- `MEDIA_UNAVAILABLE` — The asset is not usable for rendering.\n- `MEDIA_IMPORT_FAILED` — Importing media failed.\n- `FRAME_OUT_OF_RANGE` — The preview time is outside the project.\n- `PROJECT_TOO_LARGE` — The project exceeds the size limit.\n- `RESPONSE_TOO_LARGE` — The response would exceed its budget.\n- `EXPORT_FAILED` — The render failed; read `error.cause`.\n- `INVALID_PARAMS` — The request is malformed.\n- `PERMISSION_DENIED` — This credential may not do that here.\n- `NOT_IMPLEMENTED` — Not available on this platform yet.\n- `INTERNAL` — Unexpected failure; retry with the request id.\n<!-- cut-reference:end -->\n";
8287
8351
  readonly http: "POST";
8288
8352
  readonly path: "/cut/v1/projects/{project_id}:execute";
8289
8353
  readonly streaming: "no";
@@ -8334,6 +8398,21 @@ export declare const operations: readonly [{
8334
8398
  readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
8335
8399
  }];
8336
8400
  readonly query: readonly [];
8401
+ }, {
8402
+ readonly resource: "cut.renders";
8403
+ readonly method: "retrieve";
8404
+ readonly summary: "Retrieve draft range render";
8405
+ readonly description: "Poll a draft render id returned by projects.renders.create to see whether the interval is ready, then read url while it lasts. queued and rendering are in progress; done provides file_id and a short-lived url for the rendered .m4a or .mp4; failed provides error. Only done yields a url, and the file behind it disappears 24 hours after it was stored, so retrieve again when the link has expired.";
8406
+ readonly http: "GET";
8407
+ readonly path: "/cut/v1/renders/{render_id}";
8408
+ readonly streaming: "no";
8409
+ readonly pagination: false;
8410
+ readonly pathParams: readonly [{
8411
+ readonly name: "render_id";
8412
+ readonly sdkName: "render_id";
8413
+ readonly description: "Draft render id (cutr_…) returned by projects.renders.create.";
8414
+ }];
8415
+ readonly query: readonly [];
8337
8416
  }, {
8338
8417
  readonly resource: "cut.versions";
8339
8418
  readonly method: "restore";
@@ -9134,654 +9213,921 @@ export declare const operations: readonly [{
9134
9213
  }];
9135
9214
  };
9136
9215
  }, {
9137
- readonly resource: "file.files";
9216
+ readonly resource: "devops.projects.testCases";
9138
9217
  readonly method: "list";
9139
- readonly summary: "List files";
9140
- readonly description: "List live files owned by your tenant, optionally filtered by purpose or session scope_id. Results default to descending creation order with a limit of 10000. Page using after or before with a file ID from the list; these cursors are mutually exclusive. Deleted and expired files are excluded.";
9218
+ readonly summary: "List test cases";
9219
+ readonly description: "List a project's cases with their health, state and recent statistics, so you can decide which ones a plan must run and which are quarantined. This is the read a test dashboard is built on; filter it to narrow by state or health instead of paging through everything. A case's id is a fingerprint of its own title and path, so it survives a rename — read aliases when reconciling history recorded under an older title.";
9141
9220
  readonly http: "GET";
9142
- readonly path: "/file/v1/files";
9221
+ readonly path: "/devops/v1/projects/{project}/test-cases";
9143
9222
  readonly streaming: "no";
9144
9223
  readonly pagination: false;
9145
- readonly pathParams: readonly [];
9224
+ readonly pathParams: readonly [{
9225
+ readonly name: "project";
9226
+ readonly sdkName: "project";
9227
+ readonly description: "Identifies the project whose data you are reading, from the project list or create answer.";
9228
+ }];
9146
9229
  readonly query: readonly [{
9147
- readonly name: "purpose";
9148
- readonly type: "string";
9230
+ readonly name: "pageSize";
9231
+ readonly type: "integer";
9149
9232
  readonly required: false;
9150
- readonly description: "Only return files with the given purpose.";
9233
+ readonly description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone.";
9151
9234
  }, {
9152
- readonly name: "limit";
9153
- readonly type: "integer";
9235
+ readonly name: "pageToken";
9236
+ readonly type: "string";
9154
9237
  readonly required: false;
9155
- readonly description: "A limit on the number of objects to be returned. Limit can range between 1 and 10,000, and the default is 10,000.\n";
9238
+ readonly description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page.";
9156
9239
  }, {
9157
- readonly name: "order";
9240
+ readonly name: "filter";
9158
9241
  readonly type: "string";
9159
- readonly enum: readonly ["asc", "desc"];
9160
9242
  readonly required: false;
9161
- readonly description: "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n";
9243
+ readonly description: "AIP-160 equality filter over one declared field at a time, for example state=quarantined or health=broken. Fields a case list does not declare are refused with INVALID_ARGUMENT rather than ignored, so a typo never silently widens the result.";
9162
9244
  }, {
9163
- readonly name: "after";
9245
+ readonly name: "orderBy";
9164
9246
  readonly type: "string";
9165
9247
  readonly required: false;
9166
- readonly description: "File ID cursor for the next page; mutually exclusive with before. Use an ID from the current listing.";
9248
+ readonly description: "Comma-separated fields to order by, each optionally suffixed with desc, for example createTime desc. Only the fields the resource declares are accepted; anything else is refused so an ordering typo cannot silently return a different order. Omitted uses the resource's own order.";
9249
+ }];
9250
+ }, {
9251
+ readonly resource: "devops.projects";
9252
+ readonly method: "retrieveTestCatalog";
9253
+ readonly summary: "Read a commit's test catalog";
9254
+ readonly description: "Read the catalog version discovered at one commit — how many suites and cases it holds, which frameworks they come from, and how the commit changed them. Call this first: it tells you which suites, cases and sizes exist before you list them or select them into a plan, and the reported diff explains why a case count moved. A commit whose discovery has not finished answers CATALOG_NOT_READY, which means \"not yet\", not \"no tests\"; wait and read again. Omit commit to read the newest catalog published for the project.";
9255
+ readonly http: "GET";
9256
+ readonly path: "/devops/v1/projects/{project}/test-catalog";
9257
+ readonly streaming: "no";
9258
+ readonly pagination: false;
9259
+ readonly pathParams: readonly [{
9260
+ readonly name: "project";
9261
+ readonly sdkName: "project";
9262
+ readonly description: "Identifies the project whose data you are reading, from the project list or create answer.";
9263
+ }];
9264
+ readonly query: readonly [{
9265
+ readonly name: "commit";
9266
+ readonly type: "string";
9267
+ readonly required: false;
9268
+ readonly description: "Full 40-character commit sha whose catalog you want, from a project branch or commit read. Omit it to read the newest catalog published for the project.";
9269
+ }];
9270
+ }, {
9271
+ readonly resource: "devops.projects.testPlans";
9272
+ readonly method: "list";
9273
+ readonly summary: "List test plans";
9274
+ readonly description: "List the project's plans — what each one selects, which stage and gate it belongs to, and when it runs next. Read this before creating a plan, so a new plan extends what exists instead of duplicating a selector an existing plan already covers.";
9275
+ readonly http: "GET";
9276
+ readonly path: "/devops/v1/projects/{project}/test-plans";
9277
+ readonly streaming: "no";
9278
+ readonly pagination: false;
9279
+ readonly pathParams: readonly [{
9280
+ readonly name: "project";
9281
+ readonly sdkName: "project";
9282
+ readonly description: "Identifies the project whose data you are reading, from the project list or create answer.";
9283
+ }];
9284
+ readonly query: readonly [{
9285
+ readonly name: "pageSize";
9286
+ readonly type: "integer";
9287
+ readonly required: false;
9288
+ readonly description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone.";
9167
9289
  }, {
9168
- readonly name: "scope_id";
9290
+ readonly name: "pageToken";
9169
9291
  readonly type: "string";
9170
9292
  readonly required: false;
9171
- readonly description: "Session whose output files to list. Accepts sesn_ or ags_ followed by 1 to 251 letters, digits, underscores or hyphens. An existing session with no outputs returns an empty list; a nonexistent or inaccessible session returns 404.";
9293
+ readonly description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page.";
9172
9294
  }, {
9173
- readonly name: "before";
9295
+ readonly name: "orderBy";
9174
9296
  readonly type: "string";
9175
9297
  readonly required: false;
9176
- readonly description: "File ID cursor for the preceding page; mutually exclusive with after. Use an ID from the current listing.";
9298
+ readonly description: "Comma-separated fields to order by, each optionally suffixed with desc, for example createTime desc. Only the fields the resource declares are accepted; anything else is refused so an ordering typo cannot silently return a different order. Omitted uses the resource's own order.";
9177
9299
  }];
9178
9300
  }, {
9179
- readonly resource: "file.files";
9301
+ readonly resource: "devops.projects.testPlans";
9180
9302
  readonly method: "create";
9181
- readonly summary: "Upload file";
9182
- 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.";
9303
+ readonly summary: "Create a test plan";
9304
+ readonly description: "Create a plan that decides which cases a stage must run. The plan's key is unique inside the project and is what a later run names; the selector chooses cases by size, purpose, tag, package or explicit ids, and the trigger says when the plan fires by itself. A merge or promotion gate must name the environment it guards, and a plan with a gate but no environment is refused with PLAN_GATE_ENVIRONMENT_MISMATCH rather than created and silently ignored. A plan has no revision history: update it with a patch.";
9183
9305
  readonly http: "POST";
9184
- readonly path: "/file/v1/files";
9306
+ readonly path: "/devops/v1/projects/{project}/test-plans";
9185
9307
  readonly streaming: "no";
9186
9308
  readonly pagination: false;
9187
- readonly multipart: true;
9188
- readonly pathParams: readonly [];
9309
+ readonly pathParams: readonly [{
9310
+ readonly name: "project";
9311
+ readonly sdkName: "project";
9312
+ readonly description: "Identifies the project whose data you are reading, from the project list or create answer.";
9313
+ }];
9189
9314
  readonly query: readonly [];
9190
9315
  readonly body: {
9191
9316
  readonly required: true;
9192
9317
  readonly fields: readonly [{
9193
- readonly name: "file";
9318
+ readonly name: "key";
9194
9319
  readonly type: "string";
9195
9320
  readonly required: true;
9196
- readonly description: "File bytes in one multipart file part, not a filename or file ID. The file must be nonempty and at most 100000000 bytes; its content determines the MIME type.";
9321
+ readonly description: "Short name for the plan, unique inside the project; a key already in use is refused rather than silently reused.";
9197
9322
  }, {
9198
- readonly name: "purpose";
9323
+ readonly name: "title";
9199
9324
  readonly type: "string";
9200
- readonly enum: readonly ["user_data", "assistants", "vision"];
9201
9325
  readonly required: true;
9202
- 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.";
9326
+ readonly description: "Display title of the plan, shown wherever the plan is listed.";
9203
9327
  }, {
9204
- readonly name: "expires_after";
9328
+ readonly name: "stage";
9329
+ readonly type: "string";
9330
+ readonly enum: readonly ["dev", "presubmit", "postsubmit", "nightly", "production"];
9331
+ readonly required: true;
9332
+ readonly description: "Which stage of delivery this plan belongs to, which decides when it is expected to run.";
9333
+ }, {
9334
+ readonly name: "trigger";
9335
+ readonly type: "object";
9336
+ readonly required: true;
9337
+ readonly description: "What starts a run of this plan. Exactly one kind applies; the fields a kind needs are the ones it carries.";
9338
+ }, {
9339
+ readonly name: "selector";
9205
9340
  readonly type: "object";
9341
+ readonly required: true;
9342
+ readonly description: "Which cases a plan or run selects. Every member is optional and they combine as an intersection, so a selector with no member selects every case in the catalog.";
9343
+ }, {
9344
+ readonly name: "environment";
9345
+ readonly type: "string";
9206
9346
  readonly required: false;
9207
- readonly description: "Optional expiry relative to created_at. Files without an expiry persist until deleted.";
9347
+ readonly description: "The environment this plan runs against; required by a merge or promotion gate, and refused with PLAN_GATE_ENVIRONMENT_MISMATCH when it disagrees with the gate.";
9348
+ }, {
9349
+ readonly name: "gate";
9350
+ readonly type: "string";
9351
+ readonly enum: readonly ["merge", "promotion", "observation", "none"];
9352
+ readonly required: true;
9353
+ readonly description: "Whether this plan's result blocks a stage; a merge or promotion gate must name its environment.";
9354
+ }, {
9355
+ readonly name: "repeat";
9356
+ readonly type: "integer";
9357
+ readonly required: false;
9358
+ readonly description: "How many times each selected case runs in one run; omit for once. More than one is how a flake is told apart from a real failure.";
9359
+ }, {
9360
+ readonly name: "timeoutMinutes";
9361
+ readonly type: "integer";
9362
+ readonly required: false;
9363
+ readonly description: "How many minutes a run of this plan may take before it is timed out; omit for the service's default.";
9208
9364
  }];
9209
9365
  };
9210
9366
  }, {
9211
- readonly resource: "file.files";
9212
- readonly method: "delete";
9213
- readonly summary: "Delete file";
9214
- readonly description: "Delete a tenant-owned file. New metadata/content reads return not found. Already-authorized downloads may finish.";
9215
- readonly http: "DELETE";
9216
- readonly path: "/file/v1/files/{file_id}";
9217
- readonly streaming: "no";
9218
- readonly pagination: false;
9219
- readonly pathParams: readonly [{
9220
- readonly name: "file_id";
9221
- readonly sdkName: "file_id";
9222
- readonly description: "ID of a tenant-owned live file, as returned by upload or list; starts with file-.";
9223
- }];
9224
- readonly query: readonly [];
9225
- }, {
9226
- readonly resource: "file.files";
9227
- readonly method: "retrieve";
9228
- readonly summary: "Retrieve file";
9229
- readonly description: "Retrieve metadata for a live file owned by your tenant. Use its file- ID from upload or list. Missing, deleted, expired and other-tenant files return 404; use the content endpoint to download the bytes.";
9230
- readonly http: "GET";
9231
- readonly path: "/file/v1/files/{file_id}";
9232
- readonly streaming: "no";
9233
- readonly pagination: false;
9234
- readonly pathParams: readonly [{
9235
- readonly name: "file_id";
9236
- readonly sdkName: "file_id";
9237
- readonly description: "ID of a tenant-owned live file, as returned by upload or list; starts with file-.";
9238
- }];
9239
- readonly query: readonly [];
9240
- }, {
9241
- readonly resource: "file.files";
9242
- readonly method: "retrieveContent";
9243
- readonly summary: "Retrieve file content";
9244
- readonly description: "Download the original bytes of a live file owned by your tenant. Supply its file- ID from upload or list. A single byte Range can return a partial response; a range outside the file returns 416. Missing, deleted, expired and other-tenant files return 404.";
9245
- readonly http: "GET";
9246
- readonly path: "/file/v1/files/{file_id}/content";
9247
- readonly streaming: "no";
9248
- readonly pagination: false;
9249
- readonly pathParams: readonly [{
9250
- readonly name: "file_id";
9251
- readonly sdkName: "file_id";
9252
- readonly description: "ID of a tenant-owned live file, as returned by upload or list; starts with file-.";
9253
- }];
9254
- readonly query: readonly [];
9255
- }, {
9256
- readonly resource: "file.files.contentLinks";
9257
- readonly method: "revoke";
9258
- readonly summary: "Revoke a file content link";
9259
- 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/>\"}.";
9367
+ readonly resource: "devops.projects.testReports";
9368
+ readonly method: "create";
9369
+ readonly summary: "Upload an external test report";
9370
+ readonly description: "Record the results of a run executed outside Praxis by uploading a CTRF or JUnit report. Nothing has to exist first: a first upload from CI creates the run it reports on (executor external) and catalogues the cases the report names, so there is no setup call before the first result. When the report already belongs to a run, pass ref and the upload joins it; the run's counts and verdict are recomputed from the report. Uploading the same reportId again is idempotent and counts once, so a retry after a timeout is safe — and a reported case is catalogued once, however many reports carry it. The report's bytes are kept as a file (the file field of the answer) rather than in the results database, so the original document stays retrievable.";
9260
9371
  readonly http: "POST";
9261
- readonly path: "/file/v1/files/{file_id}/content_links:revoke";
9372
+ readonly path: "/devops/v1/projects/{project}/test-reports";
9262
9373
  readonly streaming: "no";
9263
9374
  readonly pagination: false;
9264
9375
  readonly pathParams: readonly [{
9265
- readonly name: "file_id";
9266
- readonly sdkName: "file_id";
9267
- readonly description: "Tenant-owned file identifier returned by file creation or listing; the token must name this same file.";
9376
+ readonly name: "project";
9377
+ readonly sdkName: "project";
9378
+ readonly description: "Identifies the project whose data you are reading, from the project list or create answer.";
9268
9379
  }];
9269
9380
  readonly query: readonly [];
9270
9381
  readonly body: {
9271
9382
  readonly required: true;
9272
9383
  readonly fields: readonly [{
9273
- readonly name: "token";
9384
+ readonly name: "reportId";
9274
9385
  readonly type: "string";
9275
9386
  readonly required: true;
9276
- readonly description: "Signed token taken from the /c/ path component of a previously issued file content URL, without the host or /c/ prefix.";
9387
+ readonly description: "Your own identifier for this report. Uploading the same id again is idempotent and counts once, so a retry after a timeout is safe.";
9388
+ }, {
9389
+ readonly name: "format";
9390
+ readonly type: "string";
9391
+ readonly enum: readonly ["ctrf", "junit"];
9392
+ readonly required: true;
9393
+ readonly description: "Which report format the document is in; it decides how the document is parsed.";
9394
+ }, {
9395
+ readonly name: "ref";
9396
+ readonly type: "object";
9397
+ readonly required: true;
9398
+ readonly description: "The exact revision a run tested. A commit is always named, because a run without one has nothing to report against.";
9399
+ }, {
9400
+ readonly name: "report";
9401
+ readonly type: "string";
9402
+ readonly required: true;
9403
+ readonly description: "The report document itself, as text — JSON for ctrf, XML for junit. Send the file's contents unchanged; a malformed document is refused with REPORT_INVALID and records nothing.";
9277
9404
  }];
9278
9405
  };
9279
9406
  }, {
9280
- readonly resource: "file.files.contentUrl";
9281
- readonly method: "create";
9282
- readonly summary: "Create a download URL";
9283
- 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}.";
9284
- readonly http: "POST";
9285
- readonly path: "/file/v1/files/{file_id}/content_url";
9407
+ readonly resource: "devops.projects.testRuns";
9408
+ readonly method: "list";
9409
+ readonly summary: "List test runs";
9410
+ readonly description: "List the project's runs newest first, with each run's state, result and counts. Use it to find the run id whose executions you want to read, or to see whether a commit's tests have finished. A run whose result is pending has not reached a verdict yet — read it again rather than treating it as passed. Filter by state or result to watch only the runs still in flight.";
9411
+ readonly http: "GET";
9412
+ readonly path: "/devops/v1/projects/{project}/test-runs";
9286
9413
  readonly streaming: "no";
9287
9414
  readonly pagination: false;
9288
9415
  readonly pathParams: readonly [{
9289
- readonly name: "file_id";
9290
- readonly sdkName: "file_id";
9291
- readonly description: "Tenant-owned live file identifier from file creation or listing; the file must be active to issue a download URL.";
9416
+ readonly name: "project";
9417
+ readonly sdkName: "project";
9418
+ readonly description: "Identifies the project whose data you are reading, from the project list or create answer.";
9292
9419
  }];
9293
- readonly query: readonly [];
9294
- readonly body: {
9420
+ readonly query: readonly [{
9421
+ readonly name: "pageSize";
9422
+ readonly type: "integer";
9295
9423
  readonly required: false;
9296
- readonly fields: readonly [{
9297
- readonly name: "ttl_seconds";
9298
- readonly type: "integer";
9299
- readonly required: false;
9300
- readonly description: "Download link lifetime in seconds, from 1 through 604800; omitted means 900. This does not change the file's own expiry.";
9301
- }];
9302
- };
9424
+ readonly description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone.";
9425
+ }, {
9426
+ readonly name: "pageToken";
9427
+ readonly type: "string";
9428
+ readonly required: false;
9429
+ readonly description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page.";
9430
+ }, {
9431
+ readonly name: "filter";
9432
+ readonly type: "string";
9433
+ readonly required: false;
9434
+ readonly description: "AIP-160 equality filter over one declared field, for example state=running or result=failed. An undeclared field is refused with INVALID_ARGUMENT; it is never ignored, so a mistyped filter cannot quietly return everything.";
9435
+ }, {
9436
+ readonly name: "orderBy";
9437
+ readonly type: "string";
9438
+ readonly required: false;
9439
+ readonly description: "Comma-separated fields to order by, each optionally suffixed with desc, for example createTime desc. Only the fields the resource declares are accepted; anything else is refused so an ordering typo cannot silently return a different order. Omitted uses the resource's own order.";
9440
+ }];
9303
9441
  }, {
9304
- readonly resource: "file.uploads";
9442
+ readonly resource: "devops.projects.testRuns";
9305
9443
  readonly method: "create";
9306
- readonly summary: "Create an upload";
9307
- 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.";
9444
+ readonly summary: "Create a test run";
9445
+ readonly description: "Start a run of the project's tests at one commit. Name a plan to use its selector, or pass a selector directly for this run alone; the ref says which commit to test and is required, because a run without a commit has nothing to report against. waitUntil decides how far the call waits before answering — queued returns as soon as the run exists, finished waits for a verdict and may take minutes. A retry of an earlier run is a new run: pass its commit and selector, and read the earlier run to compare.";
9308
9446
  readonly http: "POST";
9309
- readonly path: "/file/v1/uploads";
9447
+ readonly path: "/devops/v1/projects/{project}/test-runs";
9310
9448
  readonly streaming: "no";
9311
9449
  readonly pagination: false;
9312
- readonly pathParams: readonly [];
9450
+ readonly pathParams: readonly [{
9451
+ readonly name: "project";
9452
+ readonly sdkName: "project";
9453
+ readonly description: "Identifies the project whose data you are reading, from the project list or create answer.";
9454
+ }];
9313
9455
  readonly query: readonly [];
9314
9456
  readonly body: {
9315
9457
  readonly required: true;
9316
9458
  readonly fields: readonly [{
9317
- readonly name: "bytes";
9318
- readonly type: "integer";
9459
+ readonly name: "ref";
9460
+ readonly type: "object";
9319
9461
  readonly required: true;
9320
- readonly description: "Exact complete file length in bytes, from 1 through 2147483648 (2 GiB); the sum of completed parts must match.";
9462
+ readonly description: "The exact revision a run tested. A commit is always named, because a run without one has nothing to report against.";
9321
9463
  }, {
9322
- readonly name: "filename";
9464
+ readonly name: "plan";
9323
9465
  readonly type: "string";
9324
- readonly required: true;
9325
- readonly description: "Filename for the resulting file, at most 255 UTF-8 bytes.";
9466
+ readonly required: false;
9467
+ readonly description: "Plan whose selector this run uses; omit it when passing selector instead. Naming a plan records the run against that plan, which is what a gate reads.";
9326
9468
  }, {
9327
- readonly name: "mime_type";
9469
+ readonly name: "selector";
9470
+ readonly type: "object";
9471
+ readonly required: false;
9472
+ readonly description: "An ad-hoc selector for this run alone, used instead of a plan's; it is not saved as a plan, so a run you want to repeat should name a plan.";
9473
+ }, {
9474
+ readonly name: "environment";
9328
9475
  readonly type: "string";
9329
- readonly required: true;
9330
- readonly description: "Declared MIME type; validated against the assembled content.";
9476
+ readonly required: false;
9477
+ readonly description: "Environment to run against; it decides whether production-only cases become selectable. Omit it for a run that needs no environment.";
9331
9478
  }, {
9332
- readonly name: "purpose";
9479
+ readonly name: "repeat";
9480
+ readonly type: "integer";
9481
+ readonly required: false;
9482
+ readonly description: "How many times each selected case runs, which is how a flake is told apart from a real failure; omit for once.";
9483
+ }, {
9484
+ readonly name: "waitUntil";
9333
9485
  readonly type: "string";
9334
- readonly enum: readonly ["user_data", "assistants", "vision"];
9335
- readonly required: true;
9336
- readonly description: "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images.";
9486
+ readonly enum: readonly ["queued", "started", "finished"];
9487
+ readonly required: false;
9488
+ readonly description: "How far the call waits before answering — queued returns at once, started waits for execution to begin, finished waits for a verdict and may take minutes.";
9337
9489
  }, {
9338
- readonly name: "expires_after";
9339
- readonly type: "object";
9490
+ readonly name: "executor";
9491
+ readonly type: "string";
9492
+ readonly enum: readonly ["cloud", "external"];
9340
9493
  readonly required: false;
9341
- readonly description: "Optional expiry policy for the resulting file; omission retains the file until deletion.";
9494
+ readonly description: "Who carries the run out. cloud, the default, runs the selected cases in Praxis at the commit; external creates a run that waits for your own CI to upload a report with test-reports.";
9342
9495
  }, {
9343
- readonly name: "part_size";
9344
- readonly type: "integer";
9496
+ readonly name: "requestId";
9497
+ readonly type: "string";
9345
9498
  readonly required: false;
9346
- readonly description: "Optional fixed part size in bytes, 5242880–64000000. Requires part_number on every part; retries of identical bytes at the same number return the same part. Omit to use arbitrary-sized parts.";
9499
+ readonly description: "A key you choose to make creating this run idempotent: repeating the call with the same requestId returns the run it created instead of starting another, so a retry after a timeout is safe.";
9347
9500
  }];
9348
9501
  };
9349
9502
  }, {
9350
- readonly resource: "file.uploads";
9351
- readonly method: "createSigned";
9352
- readonly summary: "Create a one-time upload URL";
9353
- readonly description: "Upload a local file of up to 2 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), PUT each chunk to its numbered parts[].url in any order, then POST 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 3600 for multipart, at most 604800; all multipart URLs 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\"}.";
9354
- readonly http: "POST";
9355
- readonly path: "/file/v1/uploads/signed";
9503
+ readonly resource: "devops.projects.testSuites";
9504
+ readonly method: "list";
9505
+ readonly summary: "List test suites";
9506
+ readonly description: "List the suites the project's newest catalog discovered — one suite per test file and framework pair, with its size, purposes and question count. Use it to find the suite id a case belongs to, or to see which files make up an area before selecting cases from them. Suites come from the catalog, so a file added in code appears only after its commit's catalog is published. Archived suites are returned too; they carry archived true and no case is ever silently dropped from the list.";
9507
+ readonly http: "GET";
9508
+ readonly path: "/devops/v1/projects/{project}/test-suites";
9356
9509
  readonly streaming: "no";
9357
9510
  readonly pagination: false;
9358
- readonly pathParams: readonly [];
9511
+ readonly pathParams: readonly [{
9512
+ readonly name: "project";
9513
+ readonly sdkName: "project";
9514
+ readonly description: "Identifies the project whose data you are reading, from the project list or create answer.";
9515
+ }];
9516
+ readonly query: readonly [{
9517
+ readonly name: "pageSize";
9518
+ readonly type: "integer";
9519
+ readonly required: false;
9520
+ readonly description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone.";
9521
+ }, {
9522
+ readonly name: "pageToken";
9523
+ readonly type: "string";
9524
+ readonly required: false;
9525
+ readonly description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page.";
9526
+ }, {
9527
+ readonly name: "orderBy";
9528
+ readonly type: "string";
9529
+ readonly required: false;
9530
+ readonly description: "Comma-separated fields to order by, each optionally suffixed with desc, for example createTime desc. Only the fields the resource declares are accepted; anything else is refused so an ordering typo cannot silently return a different order. Omitted uses the resource's own order.";
9531
+ }];
9532
+ }, {
9533
+ readonly resource: "devops.testCases";
9534
+ readonly method: "retrieve";
9535
+ readonly summary: "Retrieve a test case";
9536
+ readonly description: "Read one case in full — its steps, tags, declared owners, current state with the policy and ticket behind it, and its rolling 7 or 30 day statistics. Use it before quarantining or fixing a case, to see what the state already is and why. A case that was renamed is reachable by both its current fingerprint id and the ids listed in aliases.";
9537
+ readonly http: "GET";
9538
+ readonly path: "/devops/v1/test-cases/{id}";
9539
+ readonly streaming: "no";
9540
+ readonly pagination: false;
9541
+ readonly pathParams: readonly [{
9542
+ readonly name: "id";
9543
+ readonly sdkName: "id";
9544
+ readonly description: "The case identifier returned by a case list, or an older id listed in that case's aliases.";
9545
+ }];
9546
+ readonly query: readonly [];
9547
+ }, {
9548
+ readonly resource: "devops.testPlans";
9549
+ readonly method: "delete";
9550
+ readonly summary: "Delete a test plan";
9551
+ readonly description: "Delete a plan so it schedules nothing further. The plan stops firing immediately; runs it already produced keep their own record and are not deleted with it. To stop a plan temporarily and keep it for later, pause it instead — deleting cannot be undone and the plan's key becomes free for another plan to take.";
9552
+ readonly http: "DELETE";
9553
+ readonly path: "/devops/v1/test-plans/{id}";
9554
+ readonly streaming: "no";
9555
+ readonly pagination: false;
9556
+ readonly pathParams: readonly [{
9557
+ readonly name: "id";
9558
+ readonly sdkName: "id";
9559
+ readonly description: "The plan identifier returned by a plan list or create answer.";
9560
+ }];
9561
+ readonly query: readonly [];
9562
+ }, {
9563
+ readonly resource: "devops.testPlans";
9564
+ readonly method: "retrieve";
9565
+ readonly summary: "Retrieve a test plan";
9566
+ readonly description: "Read one plan by the id a plan list returned, to see its selector, gate, repeat count, timeout and pause state before updating or deleting it. A paused plan carries the reason, the actor and the time it resumes, so a pause you did not set is explained here rather than guessed at.";
9567
+ readonly http: "GET";
9568
+ readonly path: "/devops/v1/test-plans/{id}";
9569
+ readonly streaming: "no";
9570
+ readonly pagination: false;
9571
+ readonly pathParams: readonly [{
9572
+ readonly name: "id";
9573
+ readonly sdkName: "id";
9574
+ readonly description: "The plan identifier returned by a plan list or create answer.";
9575
+ }];
9576
+ readonly query: readonly [];
9577
+ }, {
9578
+ readonly resource: "devops.testPlans";
9579
+ readonly method: "update";
9580
+ readonly summary: "Update a test plan";
9581
+ readonly description: "Change a plan's title, trigger, selector, gate, repeat count, timeout or enabled flag. Only the fields present in the body are changed, so a body naming one field leaves the rest exactly as they were. Changing a selector does not create a version — the plan is not a published artefact, and runs already started keep the selection they were created with. Read the plan first to know what you are leaving unchanged.";
9582
+ readonly http: "PATCH";
9583
+ readonly path: "/devops/v1/test-plans/{id}";
9584
+ readonly streaming: "no";
9585
+ readonly pagination: false;
9586
+ readonly pathParams: readonly [{
9587
+ readonly name: "id";
9588
+ readonly sdkName: "id";
9589
+ readonly description: "The plan identifier returned by a plan list or create answer.";
9590
+ }];
9359
9591
  readonly query: readonly [];
9360
9592
  readonly body: {
9361
9593
  readonly required: true;
9362
9594
  readonly fields: readonly [{
9363
- readonly name: "filename";
9364
- readonly type: "string";
9365
- readonly required: true;
9366
- readonly description: "Stored basename, 1–255 UTF-8 bytes without control characters or path separators.";
9367
- }, {
9368
- readonly name: "bytes";
9369
- readonly type: "integer";
9370
- readonly required: true;
9371
- readonly description: "Exact local file size in bytes, from 1 through 2147483648 (2 GiB). Up to 104857600 bytes returns one PUT URL; larger files return numbered part URLs and a completion URL. Every PUT requires its exact signed Content-Length.";
9372
- }, {
9373
- readonly name: "content_type";
9374
- readonly type: "string";
9595
+ readonly name: "plan";
9596
+ readonly type: "object";
9375
9597
  readonly required: true;
9376
- readonly description: "Declared MIME type, such as image/png. In single-PUT mode, send exactly this Content-Type or omit it. Stored file metadata is detected from the bytes in both modes.";
9598
+ readonly description: "The fields to change. Anything absent keeps its current value, so read the plan first if you need to know what you are leaving alone.";
9377
9599
  }, {
9378
- readonly name: "purpose";
9600
+ readonly name: "updateMask";
9379
9601
  readonly type: "string";
9380
- readonly enum: readonly ["user_data", "assistants", "vision"];
9381
- readonly required: false;
9382
- 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.";
9383
- }, {
9384
- readonly name: "expires_in";
9385
- readonly type: "integer";
9386
- readonly required: false;
9387
- readonly description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or 3600 for multipart. All part URLs and the completion URL share one expiry. This does not set the resulting file's lifetime.";
9388
- }, {
9389
- readonly name: "part_size";
9390
- readonly type: "integer";
9391
9602
  readonly required: false;
9392
- readonly description: "Fixed multipart chunk size in bytes, from 5242880 through 64000000; defaults to 64000000. Used only above 104857600 total bytes. The final part contains the remaining bytes; single-PUT mode keeps its existing response.";
9603
+ readonly description: "Comma-separated names of the plan fields this patch intends to change, for example title,enabled. Omit it to apply every field present in plan; naming fields makes the intent explicit and keeps a concurrent edit from being overwritten by accident.";
9393
9604
  }];
9394
9605
  };
9395
9606
  }, {
9396
- readonly resource: "file.uploads";
9397
- readonly method: "cancel";
9398
- readonly summary: "Cancel an upload";
9399
- readonly description: "Cancel an unfinished upload using upload_id from create and release its reserved storage. Further parts and completion are rejected. Cancelling an already cancelled upload returns the same terminal result; a completed upload cannot be cancelled. Delete its resulting file instead.";
9400
- readonly http: "POST";
9401
- readonly path: "/file/v1/uploads/{upload_id}/cancel";
9402
- readonly streaming: "no";
9403
- readonly pagination: false;
9404
- readonly pathParams: readonly [{
9405
- readonly name: "upload_id";
9406
- readonly sdkName: "upload_id";
9407
- readonly description: "Upload identifier returned by create; belongs to your organization.";
9408
- }];
9409
- readonly query: readonly [];
9410
- }, {
9411
- readonly resource: "file.uploads";
9412
- readonly method: "complete";
9413
- readonly summary: "Complete an upload";
9414
- readonly 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.";
9607
+ readonly resource: "devops.testPlans";
9608
+ readonly method: "pause";
9609
+ readonly summary: "Pause a test plan";
9610
+ readonly description: "Stop a plan from starting new runs while keeping it and its history. A reason is required and is recorded on the plan, so the next reader learns why it stopped. Give until to resume automatically at a time; omit it to stay paused until someone resumes it. Runs already in flight are not cancelled — cancel those individually.";
9415
9611
  readonly http: "POST";
9416
- readonly path: "/file/v1/uploads/{upload_id}/complete";
9612
+ readonly path: "/devops/v1/test-plans/{id}:pause";
9417
9613
  readonly streaming: "no";
9418
9614
  readonly pagination: false;
9419
9615
  readonly pathParams: readonly [{
9420
- readonly name: "upload_id";
9421
- readonly sdkName: "upload_id";
9422
- readonly description: "Upload identifier returned by create; belongs to your organization.";
9616
+ readonly name: "id";
9617
+ readonly sdkName: "id";
9618
+ readonly description: "The plan identifier returned by a plan list or create answer.";
9423
9619
  }];
9424
9620
  readonly query: readonly [];
9425
9621
  readonly body: {
9426
9622
  readonly required: true;
9427
9623
  readonly fields: readonly [{
9428
- readonly name: "part_ids";
9429
- readonly type: "array";
9430
- readonly itemType: "string";
9624
+ readonly name: "reason";
9625
+ readonly type: "string";
9431
9626
  readonly required: true;
9432
- readonly description: "All part IDs in concatenation order, without duplicates. Fixed-size uploads require increasing part_number order.";
9627
+ readonly description: "Why the plan is being paused; it is stored on the plan and read by whoever finds it stopped.";
9433
9628
  }, {
9434
- readonly name: "md5";
9629
+ readonly name: "until";
9435
9630
  readonly type: "string";
9436
9631
  readonly required: false;
9437
- readonly description: "Optional whole-file MD5 as 32 hexadecimal characters; verified after assembly.";
9632
+ readonly description: "RFC 3339 UTC time the plan resumes by itself; omit it to stay paused until someone resumes it.";
9438
9633
  }];
9439
9634
  };
9440
9635
  }, {
9441
- readonly resource: "file.uploads.parts";
9442
- readonly method: "create";
9443
- readonly summary: "Add an upload part";
9444
- readonly 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.";
9636
+ readonly resource: "devops.testPlans";
9637
+ readonly method: "resume";
9638
+ readonly summary: "Resume a test plan";
9639
+ readonly description: "Clear a plan's pause so it schedules runs again. Resuming an active plan changes nothing and is safe to repeat. The plan keeps its selector, gate and key; only the pause is removed.";
9445
9640
  readonly http: "POST";
9446
- readonly path: "/file/v1/uploads/{upload_id}/parts";
9641
+ readonly path: "/devops/v1/test-plans/{id}:resume";
9447
9642
  readonly streaming: "no";
9448
9643
  readonly pagination: false;
9449
- readonly multipart: true;
9450
9644
  readonly pathParams: readonly [{
9451
- readonly name: "upload_id";
9452
- readonly sdkName: "upload_id";
9453
- readonly description: "Upload identifier returned by create; belongs to your organization.";
9645
+ readonly name: "id";
9646
+ readonly sdkName: "id";
9647
+ readonly description: "The plan identifier returned by a plan list or create answer.";
9648
+ }];
9649
+ readonly query: readonly [];
9650
+ }, {
9651
+ readonly resource: "devops.testRuns";
9652
+ readonly method: "retrieve";
9653
+ readonly summary: "Retrieve a test run";
9654
+ readonly description: "Read one run's current state, result and counts, and ask for its failed executions inline with expand. Poll this after creating a run whose result was pending. A result is monotonic once it reaches a verdict — a failed run never becomes passed by a later report, so read the run rather than the last report to know where it ended.";
9655
+ readonly http: "GET";
9656
+ readonly path: "/devops/v1/test-runs/{id}";
9657
+ readonly streaming: "no";
9658
+ readonly pagination: false;
9659
+ readonly pathParams: readonly [{
9660
+ readonly name: "id";
9661
+ readonly sdkName: "id";
9662
+ readonly description: "The run identifier returned by a run list or create answer.";
9454
9663
  }];
9455
9664
  readonly query: readonly [{
9456
- readonly name: "part_number";
9457
- readonly type: "integer";
9665
+ readonly name: "expand";
9666
+ readonly type: "array";
9667
+ readonly itemType: "string";
9668
+ readonly enum: readonly ["failedExecutions"];
9458
9669
  readonly required: false;
9459
- readonly description: "Required when create set part_size; 1 through ceil(bytes / part_size). Ignored for general uploads.";
9670
+ readonly description: "Repeatable field to expand inline. failedExecutions returns the non-passed executions with the run, which saves a second call when you only need to see what broke; omit it for the bare run.";
9671
+ }];
9672
+ }, {
9673
+ readonly resource: "devops.testRuns";
9674
+ readonly method: "cancel";
9675
+ readonly summary: "Cancel a test run";
9676
+ readonly description: "Stop a run that is still going. A reason is required and is recorded on the run, because a cancelled run is read later as evidence about why a commit was not verified. Cancelling a run that already reached a verdict is refused with RUN_ALREADY_FINISHED: its result is final and cancelling it would erase the verdict. Executions already recorded stay readable.";
9677
+ readonly http: "POST";
9678
+ readonly path: "/devops/v1/test-runs/{id}:cancel";
9679
+ readonly streaming: "no";
9680
+ readonly pagination: false;
9681
+ readonly pathParams: readonly [{
9682
+ readonly name: "id";
9683
+ readonly sdkName: "id";
9684
+ readonly description: "The run identifier returned by a run list or create answer.";
9460
9685
  }];
9686
+ readonly query: readonly [];
9461
9687
  readonly body: {
9462
9688
  readonly required: true;
9463
9689
  readonly fields: readonly [{
9464
- readonly name: "data";
9690
+ readonly name: "reason";
9465
9691
  readonly type: "string";
9466
9692
  readonly required: true;
9467
- readonly description: "Raw bytes of this part, nonempty and at most 64000000 bytes.";
9693
+ readonly description: "Why the run is being cancelled; it is stored on the run and is what a later reader finds instead of a result.";
9468
9694
  }];
9469
9695
  };
9470
9696
  }, {
9471
- readonly resource: "knowledge.vectorStores";
9697
+ readonly resource: "devops.testRuns.executions";
9472
9698
  readonly method: "list";
9473
- readonly summary: "List knowledge bases";
9474
- readonly description: "Lists knowledge bases visible to the caller, newest first by default. Use last_id as after to read the next page; for example, ?limit=20.";
9699
+ readonly summary: "List a run's executions";
9700
+ readonly description: "List the executions recorded against one run — one entry per case the run selected, with its status, duration, attempts and evidence. Use it to find the case that failed, or to compare a repeat run against the previous one case by case. Reads happen while the run is still going, so a case may still be pending; filter by status to watch only the failures.";
9475
9701
  readonly http: "GET";
9476
- readonly path: "/knowledge/v1/vector_stores";
9702
+ readonly path: "/devops/v1/test-runs/{run}/executions";
9477
9703
  readonly streaming: "no";
9478
9704
  readonly pagination: false;
9479
- readonly pathParams: readonly [];
9705
+ readonly pathParams: readonly [{
9706
+ readonly name: "run";
9707
+ readonly sdkName: "run";
9708
+ readonly description: "The run whose executions you are reading, from a run list or create answer.";
9709
+ }];
9480
9710
  readonly query: readonly [{
9481
- readonly name: "status";
9711
+ readonly name: "pageSize";
9712
+ readonly type: "integer";
9713
+ readonly required: false;
9714
+ readonly description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone.";
9715
+ }, {
9716
+ readonly name: "pageToken";
9482
9717
  readonly type: "string";
9483
- readonly enum: readonly ["active", "deleting"];
9484
9718
  readonly required: false;
9485
- readonly description: "active selects active stores; deleting selects soft-deleted stores awaiting purge. Omission excludes soft-deleted stores.";
9719
+ readonly description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page.";
9486
9720
  }, {
9487
- readonly name: "after";
9721
+ readonly name: "filter";
9488
9722
  readonly type: "string";
9489
9723
  readonly required: false;
9490
- readonly description: "Cursor ID from the previous page.";
9724
+ readonly description: "AIP-160 equality filter over one declared field, for example result=failed to read only a run's failures. Fields an execution list does not declare are refused with INVALID_ARGUMENT rather than ignored.";
9491
9725
  }, {
9492
- readonly name: "before";
9726
+ readonly name: "orderBy";
9493
9727
  readonly type: "string";
9494
9728
  readonly required: false;
9495
- readonly description: "Return items before this ID.";
9729
+ readonly description: "Comma-separated fields to order by, each optionally suffixed with desc, for example createTime desc. Only the fields the resource declares are accepted; anything else is refused so an ordering typo cannot silently return a different order. Omitted uses the resource's own order.";
9730
+ }];
9731
+ }, {
9732
+ readonly resource: "devops.testRuns.executions";
9733
+ readonly method: "retrieve";
9734
+ readonly summary: "Retrieve one case's execution in a run";
9735
+ readonly description: "Read one case's execution inside one run, including every attempt with its own duration and message. Use it after a run reports a failure to see whether the case failed once and passed on retry — that is what flaky true means — and to reach the evidence files a triage needs. Both ids come from the run and case reads; an execution that does not exist for that pair is NOT_FOUND rather than an empty answer.";
9736
+ readonly http: "GET";
9737
+ readonly path: "/devops/v1/test-runs/{run}/executions/{case}";
9738
+ readonly streaming: "no";
9739
+ readonly pagination: false;
9740
+ readonly pathParams: readonly [{
9741
+ readonly name: "run";
9742
+ readonly sdkName: "run";
9743
+ readonly description: "The run whose executions you are reading, from a run list or create answer.";
9744
+ }, {
9745
+ readonly name: "case";
9746
+ readonly sdkName: "case";
9747
+ readonly description: "The case to read inside that run, from the run's execution list or the project's case list.";
9748
+ }];
9749
+ readonly query: readonly [];
9750
+ }, {
9751
+ readonly resource: "devops.testSuites";
9752
+ readonly method: "retrieve";
9753
+ readonly summary: "Retrieve a test suite";
9754
+ readonly description: "Read one suite by the id a suite list returned, to learn its file, framework, size, purposes and how many cases it holds. Use it when a case's suite id needs a name for display, or to confirm which commit's catalog a suite came from. The id is opaque; it comes from the list, never from the file path.";
9755
+ readonly http: "GET";
9756
+ readonly path: "/devops/v1/test-suites/{id}";
9757
+ readonly streaming: "no";
9758
+ readonly pagination: false;
9759
+ readonly pathParams: readonly [{
9760
+ readonly name: "id";
9761
+ readonly sdkName: "id";
9762
+ readonly description: "The suite identifier returned by a suite list, not the file path it was discovered from.";
9763
+ }];
9764
+ readonly query: readonly [];
9765
+ }, {
9766
+ readonly resource: "file.files";
9767
+ readonly method: "list";
9768
+ readonly summary: "List files";
9769
+ readonly description: "List live files owned by your tenant, optionally filtered by purpose or session scope_id. Results default to descending creation order with a limit of 10000. Page using after or before with a file ID from the list; these cursors are mutually exclusive. Deleted and expired files are excluded.";
9770
+ readonly http: "GET";
9771
+ readonly path: "/file/v1/files";
9772
+ readonly streaming: "no";
9773
+ readonly pagination: false;
9774
+ readonly pathParams: readonly [];
9775
+ readonly query: readonly [{
9776
+ readonly name: "purpose";
9777
+ readonly type: "string";
9778
+ readonly required: false;
9779
+ readonly description: "Only return files with the given purpose.";
9496
9780
  }, {
9497
9781
  readonly name: "limit";
9498
9782
  readonly type: "integer";
9499
9783
  readonly required: false;
9500
- readonly description: "Page size.";
9784
+ readonly description: "A limit on the number of objects to be returned. Limit can range between 1 and 10,000, and the default is 10,000.\n";
9501
9785
  }, {
9502
9786
  readonly name: "order";
9503
9787
  readonly type: "string";
9504
9788
  readonly enum: readonly ["asc", "desc"];
9505
9789
  readonly required: false;
9506
- readonly description: "Order by creation time; defaults to desc for stores/files and asc by index for segments.";
9790
+ readonly description: "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n";
9791
+ }, {
9792
+ readonly name: "after";
9793
+ readonly type: "string";
9794
+ readonly required: false;
9795
+ readonly description: "File ID cursor for the next page; mutually exclusive with before. Use an ID from the current listing.";
9796
+ }, {
9797
+ readonly name: "scope_id";
9798
+ readonly type: "string";
9799
+ readonly required: false;
9800
+ readonly description: "Session whose output files to list. Accepts sesn_ or ags_ followed by 1 to 251 letters, digits, underscores or hyphens. An existing session with no outputs returns an empty list; a nonexistent or inaccessible session returns 404.";
9801
+ }, {
9802
+ readonly name: "before";
9803
+ readonly type: "string";
9804
+ readonly required: false;
9805
+ readonly description: "File ID cursor for the preceding page; mutually exclusive with after. Use an ID from the current listing.";
9507
9806
  }];
9508
9807
  }, {
9509
- readonly resource: "knowledge.vectorStores";
9808
+ readonly resource: "file.files";
9510
9809
  readonly method: "create";
9511
- readonly summary: "Create knowledge base";
9512
- 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\"}.";
9810
+ readonly summary: "Upload file";
9811
+ 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.";
9513
9812
  readonly http: "POST";
9514
- readonly path: "/knowledge/v1/vector_stores";
9813
+ readonly path: "/file/v1/files";
9515
9814
  readonly streaming: "no";
9516
9815
  readonly pagination: false;
9816
+ readonly multipart: true;
9517
9817
  readonly pathParams: readonly [];
9518
9818
  readonly query: readonly [];
9519
9819
  readonly body: {
9520
9820
  readonly required: true;
9521
9821
  readonly fields: readonly [{
9522
- readonly name: "name";
9822
+ readonly name: "file";
9523
9823
  readonly type: "string";
9524
- readonly required: false;
9525
- readonly description: "Omitted name becomes an empty string; null is rejected.";
9526
- }, {
9527
- readonly name: "metadata";
9528
- readonly type: "object";
9529
- readonly required: false;
9530
- readonly description: "User-defined string metadata for the store; omission or null creates an empty map.";
9531
- }, {
9532
- readonly name: "expires_after";
9533
- readonly type: "object";
9534
- readonly required: false;
9535
- readonly description: "Expiry policy from last activity; omission or null disables automatic expiry.";
9536
- }, {
9537
- readonly name: "file_ids";
9538
- readonly type: "array";
9539
- readonly itemType: "string";
9540
- readonly required: false;
9541
- readonly description: "Existing File IDs to attach; the store allows up to 10,000 files.";
9542
- }, {
9543
- readonly name: "chunking_strategy";
9544
- readonly type: "object";
9545
- readonly required: false;
9546
- 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.";
9824
+ readonly required: true;
9825
+ readonly description: "File bytes in one multipart file part, not a filename or file ID. The file must be nonempty and at most 100000000 bytes; its content determines the MIME type.";
9547
9826
  }, {
9548
- readonly name: "description";
9827
+ readonly name: "purpose";
9549
9828
  readonly type: "string";
9550
- readonly required: false;
9551
- readonly description: "Accepted but not saved or returned; its type is not validated.";
9829
+ readonly enum: readonly ["user_data", "assistants", "vision"];
9830
+ readonly required: true;
9831
+ 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.";
9552
9832
  }, {
9553
- readonly name: "models";
9833
+ readonly name: "expires_after";
9554
9834
  readonly type: "object";
9555
9835
  readonly required: false;
9556
- readonly description: "Model roles to set. The model must exist in the model catalog and serve the role (embedding → openai.embeddings, rerank → cohere.rerank, query_rewrite → openai.chat.completions, ocr → mistral.ocr or pdf_input capability, vision → vision capability). The embedding model must output 1024-dimension vectors. Omitted roles stay unchanged; null restores all defaults. Unknown roles or empty IDs return 400 INVALID_PARAMS. The OpenAI-compatible API rejects this field with 400.";
9836
+ readonly description: "Optional expiry relative to created_at. Files without an expiry persist until deleted.";
9557
9837
  }];
9558
9838
  };
9559
9839
  }, {
9560
- readonly resource: "knowledge.vectorStores";
9840
+ readonly resource: "file.files";
9561
9841
  readonly method: "delete";
9562
- readonly summary: "Delete knowledge base";
9563
- readonly description: "Remove a knowledge base from active use while keeping a recovery window. Unlike OpenAI vector stores, native DELETE returns the store with status=deleting and ISO purge_at, retains it for 7 days and is idempotent on repeat. Retrieve remains 200; object operations return 409. Use restore before purge_at to recover it, or purge to remove it irreversibly.";
9842
+ readonly summary: "Delete file";
9843
+ readonly description: "Delete a tenant-owned file. New metadata/content reads return not found. Already-authorized downloads may finish.";
9564
9844
  readonly http: "DELETE";
9565
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}";
9845
+ readonly path: "/file/v1/files/{file_id}";
9566
9846
  readonly streaming: "no";
9567
9847
  readonly pagination: false;
9568
9848
  readonly pathParams: readonly [{
9569
- readonly name: "vector_store_id";
9570
- readonly sdkName: "vector_store_id";
9571
- readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
9849
+ readonly name: "file_id";
9850
+ readonly sdkName: "file_id";
9851
+ readonly description: "ID of a tenant-owned live file, as returned by upload or list; starts with file-.";
9572
9852
  }];
9573
9853
  readonly query: readonly [];
9574
9854
  }, {
9575
- readonly resource: "knowledge.vectorStores";
9855
+ readonly resource: "file.files";
9576
9856
  readonly method: "retrieve";
9577
- readonly summary: "Retrieve knowledge base";
9578
- readonly description: "Retrieves a knowledge base using an id returned by create or list. Add ?expand=files to include the first page of attached files. Soft-deleted stores remain readable with status=deleting until purged.";
9857
+ readonly summary: "Retrieve file";
9858
+ readonly description: "Retrieve metadata for a live file owned by your tenant. Use its file- ID from upload or list. Missing, deleted, expired and other-tenant files return 404; use the content endpoint to download the bytes.";
9579
9859
  readonly http: "GET";
9580
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}";
9860
+ readonly path: "/file/v1/files/{file_id}";
9581
9861
  readonly streaming: "no";
9582
9862
  readonly pagination: false;
9583
9863
  readonly pathParams: readonly [{
9584
- readonly name: "vector_store_id";
9585
- readonly sdkName: "vector_store_id";
9586
- readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
9864
+ readonly name: "file_id";
9865
+ readonly sdkName: "file_id";
9866
+ readonly description: "ID of a tenant-owned live file, as returned by upload or list; starts with file-.";
9587
9867
  }];
9588
- readonly query: readonly [{
9589
- readonly name: "expand";
9590
- readonly type: "array";
9591
- readonly itemType: "string";
9592
- readonly enum: readonly ["files"];
9593
- readonly required: false;
9594
- readonly description: "Praxis extension on both URLs: files includes the first file page. Unknown values are ignored.";
9595
- }, {
9596
- readonly name: "expand[]";
9597
- readonly type: "array";
9598
- readonly itemType: "string";
9599
- readonly enum: readonly ["files"];
9600
- readonly required: false;
9601
- readonly description: "Praxis extension on both URLs: files includes the first file page. Unknown values are ignored.";
9868
+ readonly query: readonly [];
9869
+ }, {
9870
+ readonly resource: "file.files";
9871
+ readonly method: "retrieveContent";
9872
+ readonly summary: "Retrieve file content";
9873
+ readonly description: "Download the original bytes of a live file owned by your tenant. Supply its file- ID from upload or list. A single byte Range can return a partial response; a range outside the file returns 416. Missing, deleted, expired and other-tenant files return 404.";
9874
+ readonly http: "GET";
9875
+ readonly path: "/file/v1/files/{file_id}/content";
9876
+ readonly streaming: "no";
9877
+ readonly pagination: false;
9878
+ readonly pathParams: readonly [{
9879
+ readonly name: "file_id";
9880
+ readonly sdkName: "file_id";
9881
+ readonly description: "ID of a tenant-owned live file, as returned by upload or list; starts with file-.";
9602
9882
  }];
9883
+ readonly query: readonly [];
9603
9884
  }, {
9604
- readonly resource: "knowledge.vectorStores";
9605
- readonly method: "update";
9606
- readonly summary: "Update knowledge base";
9607
- readonly description: "Updates an active knowledge base using its returned id. Omitted fields stay unchanged; metadata replaces the whole map. Example body: {\"name\":\"Refund policies\"}.";
9885
+ readonly resource: "file.files.contentLinks";
9886
+ readonly method: "revoke";
9887
+ readonly summary: "Revoke a file content link";
9888
+ 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/>\"}.";
9608
9889
  readonly http: "POST";
9609
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}";
9890
+ readonly path: "/file/v1/files/{file_id}/content_links:revoke";
9610
9891
  readonly streaming: "no";
9611
9892
  readonly pagination: false;
9612
9893
  readonly pathParams: readonly [{
9613
- readonly name: "vector_store_id";
9614
- readonly sdkName: "vector_store_id";
9615
- readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
9894
+ readonly name: "file_id";
9895
+ readonly sdkName: "file_id";
9896
+ readonly description: "Tenant-owned file identifier returned by file creation or listing; the token must name this same file.";
9616
9897
  }];
9617
9898
  readonly query: readonly [];
9618
9899
  readonly body: {
9619
9900
  readonly required: true;
9620
9901
  readonly fields: readonly [{
9621
- readonly name: "name";
9902
+ readonly name: "token";
9622
9903
  readonly type: "string";
9623
- readonly required: false;
9624
- readonly description: "null clears the name to an empty string. Omitted fields stay unchanged.";
9625
- }, {
9626
- readonly name: "metadata";
9627
- readonly type: "object";
9628
- readonly required: false;
9629
- readonly description: "Replaces all metadata; null clears it to an empty object.";
9630
- }, {
9631
- readonly name: "expires_after";
9632
- readonly type: "object";
9633
- readonly required: false;
9634
- readonly description: "null removes automatic expiry.";
9635
- }, {
9636
- readonly name: "models";
9637
- readonly type: "object";
9638
- readonly required: false;
9639
- readonly description: "Model roles to set. The model must exist in the model catalog and serve the role (embedding → openai.embeddings, rerank → cohere.rerank, query_rewrite → openai.chat.completions, ocr → mistral.ocr or pdf_input capability, vision → vision capability). The embedding model must output 1024-dimension vectors. Omitted roles stay unchanged; null restores all defaults. Unknown roles or empty IDs return 400 INVALID_PARAMS. The OpenAI-compatible API rejects this field with 400.";
9904
+ readonly required: true;
9905
+ readonly description: "Signed token taken from the /c/ path component of a previously issued file content URL, without the host or /c/ prefix.";
9640
9906
  }];
9641
9907
  };
9642
9908
  }, {
9643
- readonly resource: "knowledge.vectorStores.events";
9644
- readonly method: "list";
9645
- readonly summary: "List events";
9646
- readonly description: "Reads events for this knowledge base in increasing sequence order, including while soft-deleted. Pass next_seq as after_seq to continue; null next_seq marks the current end. Example: ?after_seq=0&limit=20.";
9647
- readonly http: "GET";
9648
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/events";
9909
+ readonly resource: "file.files.contentUrl";
9910
+ readonly method: "create";
9911
+ readonly summary: "Create a download URL";
9912
+ 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}.";
9913
+ readonly http: "POST";
9914
+ readonly path: "/file/v1/files/{file_id}/content_url";
9649
9915
  readonly streaming: "no";
9650
9916
  readonly pagination: false;
9651
9917
  readonly pathParams: readonly [{
9652
- readonly name: "vector_store_id";
9653
- readonly sdkName: "vector_store_id";
9654
- readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
9918
+ readonly name: "file_id";
9919
+ readonly sdkName: "file_id";
9920
+ readonly description: "Tenant-owned live file identifier from file creation or listing; the file must be active to issue a download URL.";
9655
9921
  }];
9656
- readonly query: readonly [{
9657
- readonly name: "after_seq";
9658
- readonly type: "integer";
9659
- readonly required: false;
9660
- readonly description: "Return events with larger seq. Use next_seq to continue; invalid text is currently ignored.";
9661
- }, {
9662
- readonly name: "limit";
9663
- readonly type: "integer";
9922
+ readonly query: readonly [];
9923
+ readonly body: {
9664
9924
  readonly required: false;
9665
- readonly description: "Page size.";
9666
- }];
9925
+ readonly fields: readonly [{
9926
+ readonly name: "ttl_seconds";
9927
+ readonly type: "integer";
9928
+ readonly required: false;
9929
+ readonly description: "Download link lifetime in seconds, from 1 through 604800; omitted means 900. This does not change the file's own expiry.";
9930
+ }];
9931
+ };
9667
9932
  }, {
9668
- readonly resource: "knowledge.vectorStores.fileBatches";
9933
+ readonly resource: "file.uploads";
9669
9934
  readonly method: "create";
9670
- readonly summary: "Create file batch";
9671
- readonly description: "Attaches existing Files as a batch for asynchronous ingestion. Supply exactly one of file_ids or files; files allows per-file settings. Existing attachments are reused. Read the returned batch id to monitor status.";
9935
+ readonly summary: "Create an upload";
9936
+ 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 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.";
9672
9937
  readonly http: "POST";
9673
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/file_batches";
9938
+ readonly path: "/file/v1/uploads";
9674
9939
  readonly streaming: "no";
9675
9940
  readonly pagination: false;
9676
- readonly pathParams: readonly [{
9677
- readonly name: "vector_store_id";
9678
- readonly sdkName: "vector_store_id";
9679
- readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
9680
- }];
9941
+ readonly pathParams: readonly [];
9681
9942
  readonly query: readonly [];
9682
9943
  readonly body: {
9683
9944
  readonly required: true;
9684
- readonly fields: readonly [];
9945
+ readonly fields: readonly [{
9946
+ readonly name: "bytes";
9947
+ readonly type: "integer";
9948
+ readonly required: true;
9949
+ readonly description: "Exact complete file length in bytes, from 1 through 21474836480 (20 GiB); the sum of completed parts must match.";
9950
+ }, {
9951
+ readonly name: "filename";
9952
+ readonly type: "string";
9953
+ readonly required: true;
9954
+ readonly description: "Filename for the resulting file, at most 255 UTF-8 bytes.";
9955
+ }, {
9956
+ readonly name: "mime_type";
9957
+ readonly type: "string";
9958
+ readonly required: true;
9959
+ readonly description: "Declared MIME type; validated against the assembled content.";
9960
+ }, {
9961
+ readonly name: "purpose";
9962
+ readonly type: "string";
9963
+ readonly enum: readonly ["user_data", "assistants", "vision"];
9964
+ readonly required: true;
9965
+ readonly description: "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images.";
9966
+ }, {
9967
+ readonly name: "expires_after";
9968
+ readonly type: "object";
9969
+ readonly required: false;
9970
+ readonly description: "Optional expiry policy for the resulting file; omission retains the file until deletion.";
9971
+ }, {
9972
+ readonly name: "part_size";
9973
+ readonly type: "integer";
9974
+ readonly required: false;
9975
+ readonly description: "Optional fixed part size in bytes, 5242880–64000000. Requires part_number on every part; retries of identical bytes at the same number return the same part. Omit to use arbitrary-sized parts.";
9976
+ }];
9685
9977
  };
9686
9978
  }, {
9687
- readonly resource: "knowledge.vectorStores.fileBatches";
9688
- readonly method: "retrieve";
9689
- readonly summary: "Retrieve file batch";
9690
- readonly description: "Retrieves a batch created in this knowledge base, including current status and file counts. Use the batch id returned by batch creation to monitor ingestion.";
9691
- readonly http: "GET";
9692
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}";
9693
- readonly streaming: "no";
9694
- readonly pagination: false;
9695
- readonly pathParams: readonly [{
9696
- readonly name: "vector_store_id";
9697
- readonly sdkName: "vector_store_id";
9698
- readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
9699
- }, {
9700
- readonly name: "batch_id";
9701
- readonly sdkName: "batch_id";
9702
- readonly description: "File-batch ID returned by batch creation in this knowledge base.";
9703
- }];
9704
- readonly query: readonly [];
9705
- }, {
9706
- readonly resource: "knowledge.vectorStores.fileBatches";
9707
- readonly method: "cancel";
9708
- readonly summary: "Cancel file batch";
9709
- readonly description: "Cancels only in-progress batches and pending files. Completed, failed and cancelled batches return unchanged (200, idempotent).";
9979
+ readonly resource: "file.uploads";
9980
+ readonly method: "createSigned";
9981
+ readonly summary: "Create a one-time upload URL";
9982
+ readonly 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\"}.";
9710
9983
  readonly http: "POST";
9711
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel";
9984
+ readonly path: "/file/v1/uploads/signed";
9712
9985
  readonly streaming: "no";
9713
9986
  readonly pagination: false;
9714
- readonly pathParams: readonly [{
9715
- readonly name: "vector_store_id";
9716
- readonly sdkName: "vector_store_id";
9717
- readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
9718
- }, {
9719
- readonly name: "batch_id";
9720
- readonly sdkName: "batch_id";
9721
- readonly description: "File-batch ID returned by batch creation in this knowledge base.";
9722
- }];
9987
+ readonly pathParams: readonly [];
9723
9988
  readonly query: readonly [];
9724
- }, {
9725
- readonly resource: "knowledge.vectorStores.fileBatches.files";
9726
- readonly method: "list";
9727
- readonly summary: "List batch files";
9728
- readonly description: "Lists files still attached from the identified batch, newest attachment first by default. Use the batch creation id and ?filter=failed to inspect failures; last_id is the next after cursor.";
9989
+ readonly body: {
9990
+ readonly required: true;
9991
+ readonly fields: readonly [{
9992
+ readonly name: "filename";
9993
+ readonly type: "string";
9994
+ readonly required: true;
9995
+ readonly description: "Stored basename, 1–255 UTF-8 bytes without control characters or path separators.";
9996
+ }, {
9997
+ readonly name: "bytes";
9998
+ readonly type: "integer";
9999
+ readonly required: true;
10000
+ readonly 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.";
10001
+ }, {
10002
+ readonly name: "content_type";
10003
+ readonly type: "string";
10004
+ readonly required: true;
10005
+ readonly description: "Declared MIME type, such as image/png. In single-PUT mode, send exactly this Content-Type or omit it. Stored file metadata is detected from the bytes in both modes.";
10006
+ }, {
10007
+ readonly name: "purpose";
10008
+ readonly type: "string";
10009
+ readonly enum: readonly ["user_data", "assistants", "vision"];
10010
+ readonly required: false;
10011
+ 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.";
10012
+ }, {
10013
+ readonly name: "expires_in";
10014
+ readonly type: "integer";
10015
+ readonly required: false;
10016
+ readonly 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.";
10017
+ }, {
10018
+ readonly name: "part_size";
10019
+ readonly type: "integer";
10020
+ readonly required: false;
10021
+ readonly description: "Fixed multipart chunk size in bytes, from 5242880 through 64000000; defaults to 64000000. Used only above 104857600 total bytes. The final part contains the remaining bytes; single-PUT mode keeps its existing response.";
10022
+ }];
10023
+ };
10024
+ }, {
10025
+ readonly resource: "file.uploads";
10026
+ readonly method: "retrieve";
10027
+ readonly summary: "Retrieve an upload";
10028
+ readonly 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.";
9729
10029
  readonly http: "GET";
9730
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files";
10030
+ readonly path: "/file/v1/uploads/{upload_id}";
9731
10031
  readonly streaming: "no";
9732
10032
  readonly pagination: false;
9733
10033
  readonly pathParams: readonly [{
9734
- readonly name: "vector_store_id";
9735
- readonly sdkName: "vector_store_id";
9736
- readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
9737
- }, {
9738
- readonly name: "batch_id";
9739
- readonly sdkName: "batch_id";
9740
- readonly description: "File-batch ID returned by batch creation in this knowledge base.";
10034
+ readonly name: "upload_id";
10035
+ readonly sdkName: "upload_id";
10036
+ readonly description: "Upload identifier returned by create; the upload must belong to your organization.";
10037
+ }];
10038
+ readonly query: readonly [];
10039
+ }, {
10040
+ readonly resource: "file.uploads";
10041
+ readonly method: "cancel";
10042
+ readonly summary: "Cancel an upload";
10043
+ readonly description: "Cancel an unfinished upload using upload_id from create and release its reserved storage. Further parts and completion are rejected. Cancelling an already cancelled upload returns the same terminal result; a completed upload cannot be cancelled. Delete its resulting file instead.";
10044
+ readonly http: "POST";
10045
+ readonly path: "/file/v1/uploads/{upload_id}/cancel";
10046
+ readonly streaming: "no";
10047
+ readonly pagination: false;
10048
+ readonly pathParams: readonly [{
10049
+ readonly name: "upload_id";
10050
+ readonly sdkName: "upload_id";
10051
+ readonly description: "Upload identifier returned by create; belongs to your organization.";
10052
+ }];
10053
+ readonly query: readonly [];
10054
+ }, {
10055
+ readonly resource: "file.uploads";
10056
+ readonly method: "complete";
10057
+ readonly summary: "Complete an upload";
10058
+ readonly 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.";
10059
+ readonly http: "POST";
10060
+ readonly path: "/file/v1/uploads/{upload_id}/complete";
10061
+ readonly streaming: "no";
10062
+ readonly pagination: false;
10063
+ readonly pathParams: readonly [{
10064
+ readonly name: "upload_id";
10065
+ readonly sdkName: "upload_id";
10066
+ readonly description: "Upload identifier returned by create; belongs to your organization.";
10067
+ }];
10068
+ readonly query: readonly [];
10069
+ readonly body: {
10070
+ readonly required: true;
10071
+ readonly fields: readonly [{
10072
+ readonly name: "part_ids";
10073
+ readonly type: "array";
10074
+ readonly itemType: "string";
10075
+ readonly required: true;
10076
+ readonly description: "All part IDs in concatenation order, without duplicates. Fixed-size uploads require increasing part_number order.";
10077
+ }, {
10078
+ readonly name: "md5";
10079
+ readonly type: "string";
10080
+ readonly required: false;
10081
+ readonly description: "Optional whole-file MD5 as 32 hexadecimal characters; verified after assembly.";
10082
+ }];
10083
+ };
10084
+ }, {
10085
+ readonly resource: "file.uploads.parts";
10086
+ readonly method: "create";
10087
+ readonly summary: "Add an upload part";
10088
+ readonly 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.";
10089
+ readonly http: "POST";
10090
+ readonly path: "/file/v1/uploads/{upload_id}/parts";
10091
+ readonly streaming: "no";
10092
+ readonly pagination: false;
10093
+ readonly multipart: true;
10094
+ readonly pathParams: readonly [{
10095
+ readonly name: "upload_id";
10096
+ readonly sdkName: "upload_id";
10097
+ readonly description: "Upload identifier returned by create; belongs to your organization.";
9741
10098
  }];
9742
10099
  readonly query: readonly [{
9743
- readonly name: "after";
9744
- readonly type: "string";
9745
- readonly required: false;
9746
- readonly description: "Cursor ID from the previous page.";
9747
- }, {
9748
- readonly name: "before";
9749
- readonly type: "string";
9750
- readonly required: false;
9751
- readonly description: "Return items before this ID.";
9752
- }, {
9753
- readonly name: "limit";
10100
+ readonly name: "part_number";
9754
10101
  readonly type: "integer";
9755
10102
  readonly required: false;
9756
- readonly description: "Page size.";
9757
- }, {
9758
- readonly name: "order";
9759
- readonly type: "string";
9760
- readonly enum: readonly ["asc", "desc"];
9761
- readonly required: false;
9762
- readonly description: "Order by creation time; defaults to desc for stores/files and asc by index for segments.";
9763
- }, {
9764
- readonly name: "filter";
9765
- readonly type: "string";
9766
- readonly enum: readonly ["in_progress", "completed", "failed", "cancelled"];
9767
- readonly required: false;
9768
- readonly description: "in_progress means ingestion is pending or running; completed means searchable; failed means ingestion failed; cancelled means ingestion was stopped by batch cancellation. Omit to include all statuses.";
10103
+ readonly description: "Required when create set part_size; 1 through ceil(bytes / part_size). Ignored for general uploads.";
9769
10104
  }];
10105
+ readonly body: {
10106
+ readonly required: true;
10107
+ readonly fields: readonly [{
10108
+ readonly name: "data";
10109
+ readonly type: "string";
10110
+ readonly required: true;
10111
+ readonly description: "Raw bytes of this part, nonempty and at most 64000000 bytes.";
10112
+ }];
10113
+ };
9770
10114
  }, {
9771
- readonly resource: "knowledge.vectorStores.files";
10115
+ readonly resource: "knowledge.vectorStores";
9772
10116
  readonly method: "list";
9773
- readonly summary: "List files";
9774
- readonly description: "Lists attached files and their ingestion status, newest attachment first by default. Use last_id as after to continue; ?filter=failed selects files that can be retried.";
10117
+ readonly summary: "List knowledge bases";
10118
+ readonly description: "Lists knowledge bases visible to the caller, newest first by default. Use last_id as after to read the next page; for example, ?limit=20.";
9775
10119
  readonly http: "GET";
9776
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files";
10120
+ readonly path: "/knowledge/v1/vector_stores";
9777
10121
  readonly streaming: "no";
9778
10122
  readonly pagination: false;
9779
- readonly pathParams: readonly [{
9780
- readonly name: "vector_store_id";
9781
- readonly sdkName: "vector_store_id";
9782
- readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
9783
- }];
10123
+ readonly pathParams: readonly [];
9784
10124
  readonly query: readonly [{
10125
+ readonly name: "status";
10126
+ readonly type: "string";
10127
+ readonly enum: readonly ["active", "deleting"];
10128
+ readonly required: false;
10129
+ readonly description: "active selects active stores; deleting selects soft-deleted stores awaiting purge. Omission excludes soft-deleted stores.";
10130
+ }, {
9785
10131
  readonly name: "after";
9786
10132
  readonly type: "string";
9787
10133
  readonly required: false;
@@ -9802,139 +10148,192 @@ export declare const operations: readonly [{
9802
10148
  readonly enum: readonly ["asc", "desc"];
9803
10149
  readonly required: false;
9804
10150
  readonly description: "Order by creation time; defaults to desc for stores/files and asc by index for segments.";
9805
- }, {
9806
- readonly name: "filter";
9807
- readonly type: "string";
9808
- readonly enum: readonly ["in_progress", "completed", "failed", "cancelled"];
9809
- readonly required: false;
9810
- readonly description: "in_progress means ingestion is pending or running; completed means searchable; failed means ingestion failed; cancelled means ingestion was stopped by batch cancellation. Omit to include all statuses.";
9811
10151
  }];
9812
10152
  }, {
9813
- readonly resource: "knowledge.vectorStores.files";
10153
+ readonly resource: "knowledge.vectorStores";
9814
10154
  readonly method: "create";
9815
- readonly summary: "Add file";
9816
- 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.";
10155
+ readonly summary: "Create knowledge base";
10156
+ 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\"}.";
9817
10157
  readonly http: "POST";
9818
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files";
10158
+ readonly path: "/knowledge/v1/vector_stores";
9819
10159
  readonly streaming: "no";
9820
10160
  readonly pagination: false;
9821
- readonly pathParams: readonly [{
9822
- readonly name: "vector_store_id";
9823
- readonly sdkName: "vector_store_id";
9824
- readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
9825
- }];
10161
+ readonly pathParams: readonly [];
9826
10162
  readonly query: readonly [];
9827
10163
  readonly body: {
9828
10164
  readonly required: true;
9829
10165
  readonly fields: readonly [{
9830
- readonly name: "file_id";
10166
+ readonly name: "name";
9831
10167
  readonly type: "string";
9832
- readonly required: true;
9833
- readonly description: "Existing source File ID returned by file upload; the file must be visible to the caller.";
10168
+ readonly required: false;
10169
+ readonly description: "Omitted name becomes an empty string; null is rejected.";
9834
10170
  }, {
9835
- readonly name: "attributes";
10171
+ readonly name: "metadata";
9836
10172
  readonly type: "object";
9837
10173
  readonly required: false;
9838
- readonly description: "Search-filter attributes for a newly attached file; omission or null leaves attributes unset. Reattaching an existing file does not change them.";
10174
+ readonly description: "User-defined string metadata for the store; omission or null creates an empty map.";
10175
+ }, {
10176
+ readonly name: "expires_after";
10177
+ readonly type: "object";
10178
+ readonly required: false;
10179
+ readonly description: "Expiry policy from last activity; omission or null disables automatic expiry.";
10180
+ }, {
10181
+ readonly name: "file_ids";
10182
+ readonly type: "array";
10183
+ readonly itemType: "string";
10184
+ readonly required: false;
10185
+ readonly description: "Existing File IDs to attach; the store allows up to 10,000 files.";
9839
10186
  }, {
9840
10187
  readonly name: "chunking_strategy";
9841
10188
  readonly type: "object";
9842
10189
  readonly required: false;
9843
10190
  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.";
10191
+ }, {
10192
+ readonly name: "description";
10193
+ readonly type: "string";
10194
+ readonly required: false;
10195
+ readonly description: "Accepted but not saved or returned; its type is not validated.";
10196
+ }, {
10197
+ readonly name: "models";
10198
+ readonly type: "object";
10199
+ readonly required: false;
10200
+ readonly description: "Model roles to set. The model must exist in the model catalog and serve the role (embedding → openai.embeddings, rerank → cohere.rerank, query_rewrite → openai.chat.completions, ocr → mistral.ocr or pdf_input capability, vision → vision capability). The embedding model must output 1024-dimension vectors. Omitted roles stay unchanged; null restores all defaults. Unknown roles or empty IDs return 400 INVALID_PARAMS. The OpenAI-compatible API rejects this field with 400.";
9844
10201
  }];
9845
10202
  };
9846
10203
  }, {
9847
- readonly resource: "knowledge.vectorStores.files";
10204
+ readonly resource: "knowledge.vectorStores";
9848
10205
  readonly method: "delete";
9849
- readonly summary: "Remove file";
9850
- readonly description: "Removes the file from search immediately; does not delete the original File.";
10206
+ readonly summary: "Delete knowledge base";
10207
+ readonly description: "Remove a knowledge base from active use while keeping a recovery window. Unlike OpenAI vector stores, native DELETE returns the store with status=deleting and ISO purge_at, retains it for 7 days and is idempotent on repeat. Retrieve remains 200; object operations return 409. Use restore before purge_at to recover it, or purge to remove it irreversibly.";
9851
10208
  readonly http: "DELETE";
9852
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}";
10209
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}";
9853
10210
  readonly streaming: "no";
9854
10211
  readonly pagination: false;
9855
10212
  readonly pathParams: readonly [{
9856
10213
  readonly name: "vector_store_id";
9857
10214
  readonly sdkName: "vector_store_id";
9858
10215
  readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
9859
- }, {
9860
- readonly name: "file_id";
9861
- readonly sdkName: "file_id";
9862
- readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
9863
10216
  }];
9864
10217
  readonly query: readonly [];
9865
10218
  }, {
9866
- readonly resource: "knowledge.vectorStores.files";
10219
+ readonly resource: "knowledge.vectorStores";
9867
10220
  readonly method: "retrieve";
9868
- readonly summary: "Retrieve file";
9869
- readonly description: "Retrieves an attached file using the id returned by attachment or file listing. Poll this operation until status leaves in_progress to observe the ingestion outcome.";
10221
+ readonly summary: "Retrieve knowledge base";
10222
+ readonly description: "Retrieves a knowledge base using an id returned by create or list. Add ?expand=files to include the first page of attached files. Soft-deleted stores remain readable with status=deleting until purged.";
9870
10223
  readonly http: "GET";
9871
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}";
10224
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}";
9872
10225
  readonly streaming: "no";
9873
10226
  readonly pagination: false;
9874
10227
  readonly pathParams: readonly [{
9875
10228
  readonly name: "vector_store_id";
9876
10229
  readonly sdkName: "vector_store_id";
9877
10230
  readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
10231
+ }];
10232
+ readonly query: readonly [{
10233
+ readonly name: "expand";
10234
+ readonly type: "array";
10235
+ readonly itemType: "string";
10236
+ readonly enum: readonly ["files"];
10237
+ readonly required: false;
10238
+ readonly description: "Praxis extension on both URLs: files includes the first file page. Unknown values are ignored.";
9878
10239
  }, {
9879
- readonly name: "file_id";
9880
- readonly sdkName: "file_id";
9881
- readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
10240
+ readonly name: "expand[]";
10241
+ readonly type: "array";
10242
+ readonly itemType: "string";
10243
+ readonly enum: readonly ["files"];
10244
+ readonly required: false;
10245
+ readonly description: "Praxis extension on both URLs: files includes the first file page. Unknown values are ignored.";
9882
10246
  }];
9883
- readonly query: readonly [];
9884
10247
  }, {
9885
- readonly resource: "knowledge.vectorStores.files";
10248
+ readonly resource: "knowledge.vectorStores";
9886
10249
  readonly method: "update";
9887
- readonly summary: "Update file attributes";
9888
- readonly description: "Replaces search-filter attributes of an existing attachment without reingesting its content. Use an attached file id. Example body: {\"attributes\":{\"category\":\"refund\"}}; null clears the attributes.";
9889
- readonly http: "POST";
9890
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}";
10250
+ readonly summary: "Update knowledge base";
10251
+ readonly description: "Updates an active knowledge base using its returned id. Omitted fields stay unchanged; metadata replaces the whole map. Example body: {\"name\":\"Refund policies\"}.";
10252
+ readonly http: "POST";
10253
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}";
9891
10254
  readonly streaming: "no";
9892
10255
  readonly pagination: false;
9893
10256
  readonly pathParams: readonly [{
9894
10257
  readonly name: "vector_store_id";
9895
10258
  readonly sdkName: "vector_store_id";
9896
10259
  readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
9897
- }, {
9898
- readonly name: "file_id";
9899
- readonly sdkName: "file_id";
9900
- readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
9901
10260
  }];
9902
10261
  readonly query: readonly [];
9903
10262
  readonly body: {
9904
10263
  readonly required: true;
9905
10264
  readonly fields: readonly [{
9906
- readonly name: "attributes";
10265
+ readonly name: "name";
10266
+ readonly type: "string";
10267
+ readonly required: false;
10268
+ readonly description: "null clears the name to an empty string. Omitted fields stay unchanged.";
10269
+ }, {
10270
+ readonly name: "metadata";
9907
10271
  readonly type: "object";
9908
10272
  readonly required: false;
9909
- readonly description: "Replaces all search-filter attributes; null clears them.";
10273
+ readonly description: "Replaces all metadata; null clears it to an empty object.";
10274
+ }, {
10275
+ readonly name: "expires_after";
10276
+ readonly type: "object";
10277
+ readonly required: false;
10278
+ readonly description: "null removes automatic expiry.";
10279
+ }, {
10280
+ readonly name: "models";
10281
+ readonly type: "object";
10282
+ readonly required: false;
10283
+ readonly description: "Model roles to set. The model must exist in the model catalog and serve the role (embedding → openai.embeddings, rerank → cohere.rerank, query_rewrite → openai.chat.completions, ocr → mistral.ocr or pdf_input capability, vision → vision capability). The embedding model must output 1024-dimension vectors. Omitted roles stay unchanged; null restores all defaults. Unknown roles or empty IDs return 400 INVALID_PARAMS. The OpenAI-compatible API rejects this field with 400.";
9910
10284
  }];
9911
10285
  };
9912
10286
  }, {
9913
- readonly resource: "knowledge.vectorStores.files";
9914
- readonly method: "retrieveContent";
9915
- readonly summary: "Read extracted content";
9916
- readonly description: "Extracted text chunks may overlap. Image content can be a generated description rather than verbatim OCR.";
10287
+ readonly resource: "knowledge.vectorStores.events";
10288
+ readonly method: "list";
10289
+ readonly summary: "List events";
10290
+ readonly description: "Reads events for this knowledge base in increasing sequence order, including while soft-deleted. Pass next_seq as after_seq to continue; null next_seq marks the current end. Example: ?after_seq=0&limit=20.";
9917
10291
  readonly http: "GET";
9918
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}/content";
10292
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/events";
9919
10293
  readonly streaming: "no";
9920
10294
  readonly pagination: false;
9921
10295
  readonly pathParams: readonly [{
9922
10296
  readonly name: "vector_store_id";
9923
10297
  readonly sdkName: "vector_store_id";
9924
10298
  readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
10299
+ }];
10300
+ readonly query: readonly [{
10301
+ readonly name: "after_seq";
10302
+ readonly type: "integer";
10303
+ readonly required: false;
10304
+ readonly description: "Return events with larger seq. Use next_seq to continue; invalid text is currently ignored.";
9925
10305
  }, {
9926
- readonly name: "file_id";
9927
- readonly sdkName: "file_id";
9928
- readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
10306
+ readonly name: "limit";
10307
+ readonly type: "integer";
10308
+ readonly required: false;
10309
+ readonly description: "Page size.";
9929
10310
  }];
9930
- readonly query: readonly [];
9931
10311
  }, {
9932
- readonly resource: "knowledge.vectorStores.files.retry";
10312
+ readonly resource: "knowledge.vectorStores.fileBatches";
9933
10313
  readonly method: "create";
9934
- readonly summary: "Retry failed file";
9935
- readonly description: "Retries only failed files; other states return 409 FILE_INVALID_STATE. Retry after failure has not yet been observed in the documented run.";
10314
+ readonly summary: "Create file batch";
10315
+ readonly description: "Attaches existing Files as a batch for asynchronous ingestion. Supply exactly one of file_ids or files; files allows per-file settings. Existing attachments are reused. Read the returned batch id to monitor status.";
9936
10316
  readonly http: "POST";
9937
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}/retry";
10317
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/file_batches";
10318
+ readonly streaming: "no";
10319
+ readonly pagination: false;
10320
+ readonly pathParams: readonly [{
10321
+ readonly name: "vector_store_id";
10322
+ readonly sdkName: "vector_store_id";
10323
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
10324
+ }];
10325
+ readonly query: readonly [];
10326
+ readonly body: {
10327
+ readonly required: true;
10328
+ readonly fields: readonly [];
10329
+ };
10330
+ }, {
10331
+ readonly resource: "knowledge.vectorStores.fileBatches";
10332
+ readonly method: "retrieve";
10333
+ readonly summary: "Retrieve file batch";
10334
+ readonly description: "Retrieves a batch created in this knowledge base, including current status and file counts. Use the batch id returned by batch creation to monitor ingestion.";
10335
+ readonly http: "GET";
10336
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}";
9938
10337
  readonly streaming: "no";
9939
10338
  readonly pagination: false;
9940
10339
  readonly pathParams: readonly [{
@@ -9942,18 +10341,37 @@ export declare const operations: readonly [{
9942
10341
  readonly sdkName: "vector_store_id";
9943
10342
  readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
9944
10343
  }, {
9945
- readonly name: "file_id";
9946
- readonly sdkName: "file_id";
9947
- readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
10344
+ readonly name: "batch_id";
10345
+ readonly sdkName: "batch_id";
10346
+ readonly description: "File-batch ID returned by batch creation in this knowledge base.";
9948
10347
  }];
9949
10348
  readonly query: readonly [];
9950
10349
  }, {
9951
- readonly resource: "knowledge.vectorStores.files.segments";
10350
+ readonly resource: "knowledge.vectorStores.fileBatches";
10351
+ readonly method: "cancel";
10352
+ readonly summary: "Cancel file batch";
10353
+ readonly description: "Cancels only in-progress batches and pending files. Completed, failed and cancelled batches return unchanged (200, idempotent).";
10354
+ readonly http: "POST";
10355
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel";
10356
+ readonly streaming: "no";
10357
+ readonly pagination: false;
10358
+ readonly pathParams: readonly [{
10359
+ readonly name: "vector_store_id";
10360
+ readonly sdkName: "vector_store_id";
10361
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
10362
+ }, {
10363
+ readonly name: "batch_id";
10364
+ readonly sdkName: "batch_id";
10365
+ readonly description: "File-batch ID returned by batch creation in this knowledge base.";
10366
+ }];
10367
+ readonly query: readonly [];
10368
+ }, {
10369
+ readonly resource: "knowledge.vectorStores.fileBatches.files";
9952
10370
  readonly method: "list";
9953
- readonly summary: "List file segments";
9954
- readonly description: "Lists the stored chunks of an attached file, ordered by increasing segment index by default. Use the attachment id and last_id as after to continue; returned chunk ids can be retrieved individually.";
10371
+ readonly summary: "List batch files";
10372
+ readonly description: "Lists files still attached from the identified batch, newest attachment first by default. Use the batch creation id and ?filter=failed to inspect failures; last_id is the next after cursor.";
9955
10373
  readonly http: "GET";
9956
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}/segments";
10374
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files";
9957
10375
  readonly streaming: "no";
9958
10376
  readonly pagination: false;
9959
10377
  readonly pathParams: readonly [{
@@ -9961,9 +10379,9 @@ export declare const operations: readonly [{
9961
10379
  readonly sdkName: "vector_store_id";
9962
10380
  readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
9963
10381
  }, {
9964
- readonly name: "file_id";
9965
- readonly sdkName: "file_id";
9966
- readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
10382
+ readonly name: "batch_id";
10383
+ readonly sdkName: "batch_id";
10384
+ readonly description: "File-batch ID returned by batch creation in this knowledge base.";
9967
10385
  }];
9968
10386
  readonly query: readonly [{
9969
10387
  readonly name: "after";
@@ -9986,14 +10404,20 @@ export declare const operations: readonly [{
9986
10404
  readonly enum: readonly ["asc", "desc"];
9987
10405
  readonly required: false;
9988
10406
  readonly description: "Order by creation time; defaults to desc for stores/files and asc by index for segments.";
10407
+ }, {
10408
+ readonly name: "filter";
10409
+ readonly type: "string";
10410
+ readonly enum: readonly ["in_progress", "completed", "failed", "cancelled"];
10411
+ readonly required: false;
10412
+ readonly description: "in_progress means ingestion is pending or running; completed means searchable; failed means ingestion failed; cancelled means ingestion was stopped by batch cancellation. Omit to include all statuses.";
9989
10413
  }];
9990
10414
  }, {
9991
- readonly resource: "knowledge.vectorStores.purge";
9992
- readonly method: "create";
9993
- readonly summary: "Permanently purge knowledge base";
9994
- readonly description: "Immediately and irreversibly clears a deleting store using the retention cleanup path. Active stores return 409; absent stores return 404. Empty body is allowed.";
9995
- readonly http: "POST";
9996
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/purge";
10415
+ readonly resource: "knowledge.vectorStores.files";
10416
+ readonly method: "list";
10417
+ readonly summary: "List files";
10418
+ readonly description: "Lists attached files and their ingestion status, newest attachment first by default. Use last_id as after to continue; ?filter=failed selects files that can be retried.";
10419
+ readonly http: "GET";
10420
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files";
9997
10421
  readonly streaming: "no";
9998
10422
  readonly pagination: false;
9999
10423
  readonly pathParams: readonly [{
@@ -10001,29 +10425,41 @@ export declare const operations: readonly [{
10001
10425
  readonly sdkName: "vector_store_id";
10002
10426
  readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
10003
10427
  }];
10004
- readonly query: readonly [];
10005
- }, {
10006
- readonly resource: "knowledge.vectorStores";
10007
- readonly method: "restore";
10008
- readonly summary: "Restore knowledge base";
10009
- readonly description: "Restores a deleting store within 7 days. Active stores return 409 VECTOR_STORE_INVALID_STATE; absent stores return 404. Empty body is allowed.";
10010
- readonly http: "POST";
10011
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/restore";
10012
- readonly streaming: "no";
10013
- readonly pagination: false;
10014
- readonly pathParams: readonly [{
10015
- readonly name: "vector_store_id";
10016
- readonly sdkName: "vector_store_id";
10017
- readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
10428
+ readonly query: readonly [{
10429
+ readonly name: "after";
10430
+ readonly type: "string";
10431
+ readonly required: false;
10432
+ readonly description: "Cursor ID from the previous page.";
10433
+ }, {
10434
+ readonly name: "before";
10435
+ readonly type: "string";
10436
+ readonly required: false;
10437
+ readonly description: "Return items before this ID.";
10438
+ }, {
10439
+ readonly name: "limit";
10440
+ readonly type: "integer";
10441
+ readonly required: false;
10442
+ readonly description: "Page size.";
10443
+ }, {
10444
+ readonly name: "order";
10445
+ readonly type: "string";
10446
+ readonly enum: readonly ["asc", "desc"];
10447
+ readonly required: false;
10448
+ readonly description: "Order by creation time; defaults to desc for stores/files and asc by index for segments.";
10449
+ }, {
10450
+ readonly name: "filter";
10451
+ readonly type: "string";
10452
+ readonly enum: readonly ["in_progress", "completed", "failed", "cancelled"];
10453
+ readonly required: false;
10454
+ readonly description: "in_progress means ingestion is pending or running; completed means searchable; failed means ingestion failed; cancelled means ingestion was stopped by batch cancellation. Omit to include all statuses.";
10018
10455
  }];
10019
- readonly query: readonly [];
10020
10456
  }, {
10021
- readonly resource: "knowledge.vectorStores.search";
10457
+ readonly resource: "knowledge.vectorStores.files";
10022
10458
  readonly method: "create";
10023
- readonly summary: "Search knowledge base";
10024
- readonly description: "Search ingested text to answer a question or find supporting passages. Native results contain one chunk each, so file_id can repeat; max_num_results counts chunks (1–50, default 10), while the compatible URL groups results by file. Unlike OpenAI vector stores, next_page is always null even when has_more is true. Only completed attachments are searchable. For keyword-only retrieval set ranking_options.hybrid_search to {\"embedding_weight\":0,\"text_weight\":1}; omit rewrite_query or set it to false to avoid query rewriting. Unlike OpenAI, ranker auto does not rerank; only default-2024-11-15 requests reranking. Set praxis.explain=true to inspect scores and use returned content[].chunk_id to retrieve a segment.";
10459
+ readonly summary: "Add file";
10460
+ 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.";
10025
10461
  readonly http: "POST";
10026
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/search";
10462
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files";
10027
10463
  readonly streaming: "no";
10028
10464
  readonly pagination: false;
10029
10465
  readonly pathParams: readonly [{
@@ -10035,49 +10471,29 @@ export declare const operations: readonly [{
10035
10471
  readonly body: {
10036
10472
  readonly required: true;
10037
10473
  readonly fields: readonly [{
10038
- readonly name: "query";
10039
- readonly type: "object";
10040
- readonly required: true;
10041
- readonly description: "Nonblank text. Multiple queries are joined with newlines for one search.";
10042
- }, {
10043
- readonly name: "filters";
10044
- readonly type: "object";
10045
- readonly required: false;
10046
- readonly description: "Type-strict file attribute filters. At most 20 nested levels below the root.";
10047
- }, {
10048
- readonly name: "max_num_results";
10049
- readonly type: "integer";
10050
- readonly required: false;
10051
- readonly description: "Maximum chunks, not distinct files.";
10052
- }, {
10053
- readonly name: "rewrite_query";
10054
- readonly type: "boolean";
10055
- readonly required: false;
10056
- readonly description: "When true, the store's query_rewrite model first rewrites each query into a concise search query; retrieval uses the rewrite and search_query returns it. Each rewrite is one small model call billed by model usage. If a rewrite fails, times out (5 s) or is empty, that query falls back to the original text and the search still succeeds. Omitted or false makes no model call.";
10057
- }, {
10058
- readonly name: "next_page";
10474
+ readonly name: "file_id";
10059
10475
  readonly type: "string";
10060
- readonly required: false;
10061
- readonly description: "Unlike OpenAI vector stores, search has no next page; supplying this cursor has no effect. Narrow the query or filters to inspect other matches.";
10476
+ readonly required: true;
10477
+ readonly description: "Existing source File ID returned by file upload; the file must be visible to the caller.";
10062
10478
  }, {
10063
- readonly name: "ranking_options";
10479
+ readonly name: "attributes";
10064
10480
  readonly type: "object";
10065
10481
  readonly required: false;
10066
- readonly description: "Controls result ranking and the minimum score required for inclusion.";
10482
+ readonly description: "Search-filter attributes for a newly attached file; omission or null leaves attributes unset. Reattaching an existing file does not change them.";
10067
10483
  }, {
10068
- readonly name: "praxis";
10484
+ readonly name: "chunking_strategy";
10069
10485
  readonly type: "object";
10070
10486
  readonly required: false;
10071
- readonly description: "Set explain=true to include score and term explanations.";
10487
+ 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.";
10072
10488
  }];
10073
10489
  };
10074
10490
  }, {
10075
- readonly resource: "knowledge.vectorStores.segments";
10076
- readonly method: "retrieve";
10077
- readonly summary: "Retrieve segment";
10078
- readonly description: "Retrieves one chunk and its term statistics. Take chunk_id from segment listing or native search content; the chunk must belong to this knowledge base.";
10079
- readonly http: "GET";
10080
- readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/segments/{chunk_id}";
10491
+ readonly resource: "knowledge.vectorStores.files";
10492
+ readonly method: "delete";
10493
+ readonly summary: "Remove file";
10494
+ readonly description: "Removes the file from search immediately; does not delete the original File.";
10495
+ readonly http: "DELETE";
10496
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}";
10081
10497
  readonly streaming: "no";
10082
10498
  readonly pagination: false;
10083
10499
  readonly pathParams: readonly [{
@@ -10085,28 +10501,256 @@ export declare const operations: readonly [{
10085
10501
  readonly sdkName: "vector_store_id";
10086
10502
  readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
10087
10503
  }, {
10088
- readonly name: "chunk_id";
10089
- readonly sdkName: "chunk_id";
10090
- readonly description: "Chunk ID returned by segment listing or native search content.";
10504
+ readonly name: "file_id";
10505
+ readonly sdkName: "file_id";
10506
+ readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
10091
10507
  }];
10092
10508
  readonly query: readonly [];
10093
10509
  }, {
10094
- readonly resource: "media.generation.capabilities";
10095
- readonly method: "list";
10096
- readonly summary: "Get generation capabilities";
10097
- readonly 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.";
10510
+ readonly resource: "knowledge.vectorStores.files";
10511
+ readonly method: "retrieve";
10512
+ readonly summary: "Retrieve file";
10513
+ readonly description: "Retrieves an attached file using the id returned by attachment or file listing. Poll this operation until status leaves in_progress to observe the ingestion outcome.";
10098
10514
  readonly http: "GET";
10099
- readonly path: "/media/v1/generation/capabilities";
10515
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}";
10100
10516
  readonly streaming: "no";
10101
10517
  readonly pagination: false;
10102
- readonly pathParams: readonly [];
10103
- readonly query: readonly [];
10104
- }, {
10105
- readonly resource: "media.libraries";
10106
- readonly method: "list";
10107
- readonly summary: "List libraries";
10108
- 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.";
10109
- readonly http: "GET";
10518
+ readonly pathParams: readonly [{
10519
+ readonly name: "vector_store_id";
10520
+ readonly sdkName: "vector_store_id";
10521
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
10522
+ }, {
10523
+ readonly name: "file_id";
10524
+ readonly sdkName: "file_id";
10525
+ readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
10526
+ }];
10527
+ readonly query: readonly [];
10528
+ }, {
10529
+ readonly resource: "knowledge.vectorStores.files";
10530
+ readonly method: "update";
10531
+ readonly summary: "Update file attributes";
10532
+ readonly description: "Replaces search-filter attributes of an existing attachment without reingesting its content. Use an attached file id. Example body: {\"attributes\":{\"category\":\"refund\"}}; null clears the attributes.";
10533
+ readonly http: "POST";
10534
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}";
10535
+ readonly streaming: "no";
10536
+ readonly pagination: false;
10537
+ readonly pathParams: readonly [{
10538
+ readonly name: "vector_store_id";
10539
+ readonly sdkName: "vector_store_id";
10540
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
10541
+ }, {
10542
+ readonly name: "file_id";
10543
+ readonly sdkName: "file_id";
10544
+ readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
10545
+ }];
10546
+ readonly query: readonly [];
10547
+ readonly body: {
10548
+ readonly required: true;
10549
+ readonly fields: readonly [{
10550
+ readonly name: "attributes";
10551
+ readonly type: "object";
10552
+ readonly required: false;
10553
+ readonly description: "Replaces all search-filter attributes; null clears them.";
10554
+ }];
10555
+ };
10556
+ }, {
10557
+ readonly resource: "knowledge.vectorStores.files";
10558
+ readonly method: "retrieveContent";
10559
+ readonly summary: "Read extracted content";
10560
+ readonly description: "Extracted text chunks may overlap. Image content can be a generated description rather than verbatim OCR.";
10561
+ readonly http: "GET";
10562
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}/content";
10563
+ readonly streaming: "no";
10564
+ readonly pagination: false;
10565
+ readonly pathParams: readonly [{
10566
+ readonly name: "vector_store_id";
10567
+ readonly sdkName: "vector_store_id";
10568
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
10569
+ }, {
10570
+ readonly name: "file_id";
10571
+ readonly sdkName: "file_id";
10572
+ readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
10573
+ }];
10574
+ readonly query: readonly [];
10575
+ }, {
10576
+ readonly resource: "knowledge.vectorStores.files.retry";
10577
+ readonly method: "create";
10578
+ readonly summary: "Retry failed file";
10579
+ readonly description: "Retries only failed files; other states return 409 FILE_INVALID_STATE. Retry after failure has not yet been observed in the documented run.";
10580
+ readonly http: "POST";
10581
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}/retry";
10582
+ readonly streaming: "no";
10583
+ readonly pagination: false;
10584
+ readonly pathParams: readonly [{
10585
+ readonly name: "vector_store_id";
10586
+ readonly sdkName: "vector_store_id";
10587
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
10588
+ }, {
10589
+ readonly name: "file_id";
10590
+ readonly sdkName: "file_id";
10591
+ readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
10592
+ }];
10593
+ readonly query: readonly [];
10594
+ }, {
10595
+ readonly resource: "knowledge.vectorStores.files.segments";
10596
+ readonly method: "list";
10597
+ readonly summary: "List file segments";
10598
+ readonly description: "Lists the stored chunks of an attached file, ordered by increasing segment index by default. Use the attachment id and last_id as after to continue; returned chunk ids can be retrieved individually.";
10599
+ readonly http: "GET";
10600
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}/segments";
10601
+ readonly streaming: "no";
10602
+ readonly pagination: false;
10603
+ readonly pathParams: readonly [{
10604
+ readonly name: "vector_store_id";
10605
+ readonly sdkName: "vector_store_id";
10606
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
10607
+ }, {
10608
+ readonly name: "file_id";
10609
+ readonly sdkName: "file_id";
10610
+ readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
10611
+ }];
10612
+ readonly query: readonly [{
10613
+ readonly name: "after";
10614
+ readonly type: "string";
10615
+ readonly required: false;
10616
+ readonly description: "Cursor ID from the previous page.";
10617
+ }, {
10618
+ readonly name: "before";
10619
+ readonly type: "string";
10620
+ readonly required: false;
10621
+ readonly description: "Return items before this ID.";
10622
+ }, {
10623
+ readonly name: "limit";
10624
+ readonly type: "integer";
10625
+ readonly required: false;
10626
+ readonly description: "Page size.";
10627
+ }, {
10628
+ readonly name: "order";
10629
+ readonly type: "string";
10630
+ readonly enum: readonly ["asc", "desc"];
10631
+ readonly required: false;
10632
+ readonly description: "Order by creation time; defaults to desc for stores/files and asc by index for segments.";
10633
+ }];
10634
+ }, {
10635
+ readonly resource: "knowledge.vectorStores.purge";
10636
+ readonly method: "create";
10637
+ readonly summary: "Permanently purge knowledge base";
10638
+ readonly description: "Immediately and irreversibly clears a deleting store using the retention cleanup path. Active stores return 409; absent stores return 404. Empty body is allowed.";
10639
+ readonly http: "POST";
10640
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/purge";
10641
+ readonly streaming: "no";
10642
+ readonly pagination: false;
10643
+ readonly pathParams: readonly [{
10644
+ readonly name: "vector_store_id";
10645
+ readonly sdkName: "vector_store_id";
10646
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
10647
+ }];
10648
+ readonly query: readonly [];
10649
+ }, {
10650
+ readonly resource: "knowledge.vectorStores";
10651
+ readonly method: "restore";
10652
+ readonly summary: "Restore knowledge base";
10653
+ readonly description: "Restores a deleting store within 7 days. Active stores return 409 VECTOR_STORE_INVALID_STATE; absent stores return 404. Empty body is allowed.";
10654
+ readonly http: "POST";
10655
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/restore";
10656
+ readonly streaming: "no";
10657
+ readonly pagination: false;
10658
+ readonly pathParams: readonly [{
10659
+ readonly name: "vector_store_id";
10660
+ readonly sdkName: "vector_store_id";
10661
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
10662
+ }];
10663
+ readonly query: readonly [];
10664
+ }, {
10665
+ readonly resource: "knowledge.vectorStores.search";
10666
+ readonly method: "create";
10667
+ readonly summary: "Search knowledge base";
10668
+ readonly description: "Search ingested text to answer a question or find supporting passages. Native results contain one chunk each, so file_id can repeat; max_num_results counts chunks (1–50, default 10), while the compatible URL groups results by file. Unlike OpenAI vector stores, next_page is always null even when has_more is true. Only completed attachments are searchable. For keyword-only retrieval set ranking_options.hybrid_search to {\"embedding_weight\":0,\"text_weight\":1}; omit rewrite_query or set it to false to avoid query rewriting. Unlike OpenAI, ranker auto does not rerank; only default-2024-11-15 requests reranking. Set praxis.explain=true to inspect scores and use returned content[].chunk_id to retrieve a segment.";
10669
+ readonly http: "POST";
10670
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/search";
10671
+ readonly streaming: "no";
10672
+ readonly pagination: false;
10673
+ readonly pathParams: readonly [{
10674
+ readonly name: "vector_store_id";
10675
+ readonly sdkName: "vector_store_id";
10676
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
10677
+ }];
10678
+ readonly query: readonly [];
10679
+ readonly body: {
10680
+ readonly required: true;
10681
+ readonly fields: readonly [{
10682
+ readonly name: "query";
10683
+ readonly type: "object";
10684
+ readonly required: true;
10685
+ readonly description: "Nonblank text. Multiple queries are joined with newlines for one search.";
10686
+ }, {
10687
+ readonly name: "filters";
10688
+ readonly type: "object";
10689
+ readonly required: false;
10690
+ readonly description: "Type-strict file attribute filters. At most 20 nested levels below the root.";
10691
+ }, {
10692
+ readonly name: "max_num_results";
10693
+ readonly type: "integer";
10694
+ readonly required: false;
10695
+ readonly description: "Maximum chunks, not distinct files.";
10696
+ }, {
10697
+ readonly name: "rewrite_query";
10698
+ readonly type: "boolean";
10699
+ readonly required: false;
10700
+ readonly description: "When true, the store's query_rewrite model first rewrites each query into a concise search query; retrieval uses the rewrite and search_query returns it. Each rewrite is one small model call billed by model usage. If a rewrite fails, times out (5 s) or is empty, that query falls back to the original text and the search still succeeds. Omitted or false makes no model call.";
10701
+ }, {
10702
+ readonly name: "next_page";
10703
+ readonly type: "string";
10704
+ readonly required: false;
10705
+ readonly description: "Unlike OpenAI vector stores, search has no next page; supplying this cursor has no effect. Narrow the query or filters to inspect other matches.";
10706
+ }, {
10707
+ readonly name: "ranking_options";
10708
+ readonly type: "object";
10709
+ readonly required: false;
10710
+ readonly description: "Controls result ranking and the minimum score required for inclusion.";
10711
+ }, {
10712
+ readonly name: "praxis";
10713
+ readonly type: "object";
10714
+ readonly required: false;
10715
+ readonly description: "Set explain=true to include score and term explanations.";
10716
+ }];
10717
+ };
10718
+ }, {
10719
+ readonly resource: "knowledge.vectorStores.segments";
10720
+ readonly method: "retrieve";
10721
+ readonly summary: "Retrieve segment";
10722
+ readonly description: "Retrieves one chunk and its term statistics. Take chunk_id from segment listing or native search content; the chunk must belong to this knowledge base.";
10723
+ readonly http: "GET";
10724
+ readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/segments/{chunk_id}";
10725
+ readonly streaming: "no";
10726
+ readonly pagination: false;
10727
+ readonly pathParams: readonly [{
10728
+ readonly name: "vector_store_id";
10729
+ readonly sdkName: "vector_store_id";
10730
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
10731
+ }, {
10732
+ readonly name: "chunk_id";
10733
+ readonly sdkName: "chunk_id";
10734
+ readonly description: "Chunk ID returned by segment listing or native search content.";
10735
+ }];
10736
+ readonly query: readonly [];
10737
+ }, {
10738
+ readonly resource: "media.generation.capabilities";
10739
+ readonly method: "list";
10740
+ readonly summary: "Get generation capabilities";
10741
+ readonly 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.";
10742
+ readonly http: "GET";
10743
+ readonly path: "/media/v1/generation/capabilities";
10744
+ readonly streaming: "no";
10745
+ readonly pagination: false;
10746
+ readonly pathParams: readonly [];
10747
+ readonly query: readonly [];
10748
+ }, {
10749
+ readonly resource: "media.libraries";
10750
+ readonly method: "list";
10751
+ readonly summary: "List libraries";
10752
+ 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.";
10753
+ readonly http: "GET";
10110
10754
  readonly path: "/media/v1/libraries";
10111
10755
  readonly streaming: "no";
10112
10756
  readonly pagination: true;
@@ -10283,7 +10927,7 @@ export declare const operations: readonly [{
10283
10927
  readonly resource: "media.libraries.assets";
10284
10928
  readonly method: "create";
10285
10929
  readonly summary: "Upload asset";
10286
- 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.";
10930
+ readonly 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.";
10287
10931
  readonly http: "POST";
10288
10932
  readonly path: "/media/v1/libraries/{library_id}/assets";
10289
10933
  readonly streaming: "no";
@@ -10380,7 +11024,7 @@ export declare const operations: readonly [{
10380
11024
  readonly resource: "media.libraries.assets.import";
10381
11025
  readonly method: "create";
10382
11026
  readonly summary: "Import file";
10383
- 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.";
11027
+ 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 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.";
10384
11028
  readonly http: "POST";
10385
11029
  readonly path: "/media/v1/libraries/{library_id}/assets/import";
10386
11030
  readonly streaming: "no";
@@ -10593,7 +11237,7 @@ export declare const operations: readonly [{
10593
11237
  readonly resource: "media.libraries.assets.reprocess";
10594
11238
  readonly method: "create";
10595
11239
  readonly summary: "Reprocess asset";
10596
- 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.";
11240
+ readonly 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.";
10597
11241
  readonly http: "POST";
10598
11242
  readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess";
10599
11243
  readonly streaming: "no";
@@ -10645,9 +11289,9 @@ export declare const operations: readonly [{
10645
11289
  }, {
10646
11290
  readonly name: "kind";
10647
11291
  readonly type: "string";
10648
- readonly enum: readonly ["caption", "tags", "ocr", "transcript", "frame", "overview", "audio", "embedding"];
11292
+ readonly enum: readonly ["caption", "tags", "ocr", "transcript", "frame", "overview", "audio", "loudness", "beats", "content", "embedding"];
10649
11293
  readonly required: false;
10650
- 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.";
11294
+ 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, loudness is measured loudness, beats is the measured tempo and beat grid, content is the derived speech, music and silence split, and embedding reports a failed embedding step.";
10651
11295
  }, {
10652
11296
  readonly name: "cursor";
10653
11297
  readonly type: "string";
@@ -10663,7 +11307,7 @@ export declare const operations: readonly [{
10663
11307
  readonly resource: "media.libraries.assets";
10664
11308
  readonly method: "batch";
10665
11309
  readonly summary: "Batch assets alias";
10666
- 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.";
11310
+ 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 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.";
10667
11311
  readonly http: "POST";
10668
11312
  readonly path: "/media/v1/libraries/{library_id}/assets:batch";
10669
11313
  readonly streaming: "no";
@@ -10692,7 +11336,7 @@ export declare const operations: readonly [{
10692
11336
  readonly resource: "media.libraries.batches";
10693
11337
  readonly method: "create";
10694
11338
  readonly summary: "Create batch";
10695
- 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.";
11339
+ 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 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.";
10696
11340
  readonly http: "POST";
10697
11341
  readonly path: "/media/v1/libraries/{library_id}/batches";
10698
11342
  readonly streaming: "no";
@@ -11243,7 +11887,7 @@ export declare const operations: readonly [{
11243
11887
  readonly name: "kinds";
11244
11888
  readonly type: "string";
11245
11889
  readonly required: false;
11246
- readonly description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind.";
11890
+ readonly description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, loudness, beats, content, embedding. Omit or empty to include every kind.";
11247
11891
  }, {
11248
11892
  readonly name: "cursor";
11249
11893
  readonly type: "string";
@@ -12856,224 +13500,669 @@ export declare const operations: readonly [{
12856
13500
  }];
12857
13501
  readonly query: readonly [];
12858
13502
  }, {
12859
- readonly resource: "model.systemone";
13503
+ readonly resource: "model.systemone";
13504
+ readonly method: "create";
13505
+ readonly summary: "Ask structured decision questions";
13506
+ readonly description: "Ask typed questions about a state and get calibrated probabilities instead of generated text. Same request and response as TypeSafe System One. Use model ids from model.models.list declaring typesafe.systemone. Send one or more noul, choice or score questions; answers use the same question ids. Input tokens are charged at the catalog input price; output tokens are free. usage.cost and X-Praxis-Cost-Usd expose the same customer charge in USD. box questions and assets are unsupported and return 400: images are not supported. Unknown top-level fields pass unchanged to the native upstream.";
13507
+ readonly http: "POST";
13508
+ readonly path: "/model/v1/systemone";
13509
+ readonly streaming: "no";
13510
+ readonly pagination: false;
13511
+ readonly pathParams: readonly [];
13512
+ readonly query: readonly [];
13513
+ readonly body: {
13514
+ readonly required: true;
13515
+ readonly fields: readonly [{
13516
+ readonly name: "model";
13517
+ readonly type: "string";
13518
+ readonly required: true;
13519
+ readonly description: "Published model id from model.models.list with supported_apis containing typesafe.systemone; returned unchanged in the response.";
13520
+ }, {
13521
+ readonly name: "state";
13522
+ readonly type: "object";
13523
+ readonly required: true;
13524
+ readonly description: "Shared content evaluated by every question, supplied as text, a JSON object or an array.";
13525
+ }, {
13526
+ readonly name: "questions";
13527
+ readonly type: "object";
13528
+ readonly required: true;
13529
+ readonly description: "Non-empty map of caller-chosen question ids to typed questions; answers preserve these ids. noul evaluates yes/no, choice selects a named option, score rates ordered levels. box is unsupported.";
13530
+ }, {
13531
+ readonly name: "assets";
13532
+ readonly type: "object";
13533
+ readonly required: false;
13534
+ readonly description: "Unsupported image assets. Supplying this field, including null or an empty collection, returns 400: images are not supported.";
13535
+ }];
13536
+ };
13537
+ }, {
13538
+ readonly resource: "model.videos";
13539
+ readonly method: "list";
13540
+ readonly summary: "List videos";
13541
+ readonly description: "OpenAI video API with OpenRouter request and response extensions.";
13542
+ readonly http: "GET";
13543
+ readonly path: "/model/v1/videos";
13544
+ readonly streaming: "no";
13545
+ readonly pagination: false;
13546
+ readonly pathParams: readonly [];
13547
+ readonly query: readonly [{
13548
+ readonly name: "after";
13549
+ readonly type: "string";
13550
+ readonly required: false;
13551
+ readonly description: "Cursor: the id of the video job after which the page starts, normally the `last_id` of the previous page. It must refer to an existing job of yours, otherwise the call fails.";
13552
+ }, {
13553
+ readonly name: "limit";
13554
+ readonly type: "integer";
13555
+ readonly required: false;
13556
+ readonly description: "Maximum number of jobs per page, from 1 to 100; defaults to 20.";
13557
+ }, {
13558
+ readonly name: "order";
13559
+ readonly type: "string";
13560
+ readonly enum: readonly ["asc", "desc"];
13561
+ readonly required: false;
13562
+ readonly description: "Sort order by creation time: desc (default) lists the newest job first, asc the oldest first.";
13563
+ }];
13564
+ }, {
13565
+ readonly resource: "model.videos";
13566
+ readonly method: "create";
13567
+ readonly summary: "Create video";
13568
+ readonly description: "OpenAI video API with OpenRouter request and response extensions.";
13569
+ readonly http: "POST";
13570
+ readonly path: "/model/v1/videos";
13571
+ readonly streaming: "no";
13572
+ readonly pagination: false;
13573
+ readonly multipart: true;
13574
+ readonly pathParams: readonly [];
13575
+ readonly query: readonly [];
13576
+ readonly body: {
13577
+ readonly required: true;
13578
+ readonly fields: readonly [{
13579
+ readonly name: "model";
13580
+ readonly type: "string";
13581
+ readonly required: false;
13582
+ readonly description: "Video model id, for example `wan2.7-t2v`; list candidates with listModels?type=video. Router support (partial): Select a registered video model explicitly, for example wan2.7-t2v (size=1280x720, seconds=4). Capability preflight errors are reported before creation.";
13583
+ }, {
13584
+ readonly name: "prompt";
13585
+ readonly type: "string";
13586
+ readonly required: true;
13587
+ readonly description: "Text description of the video, at least 1 character. Router support (supported): Controls video content; missing or empty values return 400.";
13588
+ }, {
13589
+ readonly name: "seconds";
13590
+ readonly type: "object";
13591
+ readonly required: false;
13592
+ readonly description: "Takes precedence over duration.";
13593
+ }, {
13594
+ readonly name: "duration";
13595
+ readonly type: "integer";
13596
+ readonly required: false;
13597
+ readonly description: "Length of the video in whole seconds. `seconds` takes precedence when both are given.";
13598
+ }, {
13599
+ readonly name: "size";
13600
+ readonly type: "string";
13601
+ readonly required: false;
13602
+ readonly description: "Output resolution as `WIDTHxHEIGHT`, for example `1280x720`. Router support (partial): Subject to model capability preflight. Earlier wan2.7-t2v samples always produced 1280x720; accepted sizes are not guaranteed pixel-for-pixel.";
13603
+ }, {
13604
+ readonly name: "input_reference";
13605
+ readonly type: "object";
13606
+ readonly required: false;
13607
+ readonly description: "Reference image for image-to-video: a URL or base64 data URL, an object with `image_url`, or an uploaded image file (multipart, at most 20 MiB).";
13608
+ }, {
13609
+ readonly name: "input_references";
13610
+ readonly type: "array";
13611
+ readonly itemType: "object";
13612
+ readonly required: false;
13613
+ readonly description: "Several reference images; each entry is a URL or base64 data URL, or an object with `image_url`.";
13614
+ }, {
13615
+ readonly name: "frame_images";
13616
+ readonly type: "array";
13617
+ readonly itemType: "object";
13618
+ readonly required: false;
13619
+ readonly description: "Images that pin the first and last frame; at most 2 entries.";
13620
+ }, {
13621
+ readonly name: "resolution";
13622
+ readonly type: "string";
13623
+ readonly required: false;
13624
+ readonly description: "Output resolution label such as `720p`, for models that take a label instead of `size`.";
13625
+ }, {
13626
+ readonly name: "aspect_ratio";
13627
+ readonly type: "string";
13628
+ readonly required: false;
13629
+ readonly description: "Aspect ratio of the video such as `16:9`.";
13630
+ }, {
13631
+ readonly name: "generate_audio";
13632
+ readonly type: "boolean";
13633
+ readonly required: false;
13634
+ readonly description: "Whether the video carries a generated audio track. Router support (supported): false produces no audio track on wan2.7-t2v; the default output includes audio.";
13635
+ }, {
13636
+ readonly name: "seed";
13637
+ readonly type: "integer";
13638
+ readonly required: false;
13639
+ readonly description: "Seed for reproducible generation, on models that support it.";
13640
+ }, {
13641
+ readonly name: "callback_url";
13642
+ readonly type: "string";
13643
+ readonly required: false;
13644
+ readonly description: "HTTP or HTTPS callback URL, forwarded to models that support completion callbacks.";
13645
+ }, {
13646
+ readonly name: "quality";
13647
+ readonly type: "string";
13648
+ readonly required: false;
13649
+ readonly description: "Provider-specific quality setting.";
13650
+ }];
13651
+ };
13652
+ }, {
13653
+ readonly resource: "model.videos";
13654
+ readonly method: "delete";
13655
+ readonly summary: "Delete video";
13656
+ readonly description: "OpenAI video API with OpenRouter request and response extensions.";
13657
+ readonly http: "DELETE";
13658
+ readonly path: "/model/v1/videos/{video_id}";
13659
+ readonly streaming: "no";
13660
+ readonly pagination: false;
13661
+ readonly pathParams: readonly [{
13662
+ readonly name: "video_id";
13663
+ readonly sdkName: "video_id";
13664
+ readonly description: "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400.";
13665
+ }];
13666
+ readonly query: readonly [];
13667
+ }, {
13668
+ readonly resource: "model.videos";
13669
+ readonly method: "retrieve";
13670
+ readonly summary: "Retrieve video";
13671
+ readonly description: "OpenAI video API with OpenRouter request and response extensions.";
13672
+ readonly http: "GET";
13673
+ readonly path: "/model/v1/videos/{video_id}";
13674
+ readonly streaming: "no";
13675
+ readonly pagination: false;
13676
+ readonly pathParams: readonly [{
13677
+ readonly name: "video_id";
13678
+ readonly sdkName: "video_id";
13679
+ readonly description: "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400.";
13680
+ }];
13681
+ readonly query: readonly [];
13682
+ }, {
13683
+ readonly resource: "model.videos";
13684
+ readonly method: "retrieveContent";
13685
+ readonly summary: "Download video";
13686
+ readonly description: "OpenAI video API with OpenRouter request and response extensions.";
13687
+ readonly http: "GET";
13688
+ readonly path: "/model/v1/videos/{video_id}/content";
13689
+ readonly streaming: "no";
13690
+ readonly pagination: false;
13691
+ readonly pathParams: readonly [{
13692
+ readonly name: "video_id";
13693
+ readonly sdkName: "video_id";
13694
+ readonly description: "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400.";
13695
+ }];
13696
+ readonly query: readonly [{
13697
+ readonly name: "variant";
13698
+ readonly type: "string";
13699
+ readonly enum: readonly ["video", "thumbnail", "spritesheet"];
13700
+ readonly required: false;
13701
+ readonly description: "Spritesheet is not available in this release (400).";
13702
+ }, {
13703
+ readonly name: "index";
13704
+ readonly type: "integer";
13705
+ readonly required: false;
13706
+ readonly description: "Output index; this release produces index 0. variant takes precedence.";
13707
+ }];
13708
+ }, {
13709
+ readonly resource: "model.videos";
13710
+ readonly method: "remix";
13711
+ readonly summary: "Remix video";
13712
+ readonly description: "Not supported in this release; always returns 400.";
13713
+ readonly http: "POST";
13714
+ readonly path: "/model/v1/videos/{video_id}/remix";
13715
+ readonly streaming: "no";
13716
+ readonly pagination: false;
13717
+ readonly pathParams: readonly [{
13718
+ readonly name: "video_id";
13719
+ readonly sdkName: "video_id";
13720
+ readonly description: "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400.";
13721
+ }];
13722
+ readonly query: readonly [];
13723
+ }, {
13724
+ readonly resource: "ontology.changesets";
13725
+ readonly method: "create";
13726
+ readonly summary: "Apply changeset";
13727
+ readonly 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.";
13728
+ readonly http: "POST";
13729
+ readonly path: "/ontology/v1/changesets";
13730
+ readonly streaming: "no";
13731
+ readonly pagination: false;
13732
+ readonly pathParams: readonly [];
13733
+ readonly query: readonly [];
13734
+ readonly body: {
13735
+ readonly required: true;
13736
+ readonly fields: readonly [{
13737
+ readonly name: "at";
13738
+ readonly type: "string";
13739
+ readonly required: true;
13740
+ readonly description: "World time the batch describes, in ISO 8601 UTC; operations without their own time are dated by it.";
13741
+ }, {
13742
+ readonly name: "scope";
13743
+ readonly type: "string";
13744
+ readonly required: false;
13745
+ readonly description: "Scope the batch came from, normally the session id it was observed in; it is stored with the operations for later reading.";
13746
+ }, {
13747
+ readonly name: "ops";
13748
+ readonly type: "array";
13749
+ readonly itemType: "object";
13750
+ readonly required: true;
13751
+ readonly description: "At most 500 operations, applied in order; each names its kind in op and the fields that kind requires.";
13752
+ }];
13753
+ };
13754
+ }, {
13755
+ readonly resource: "ontology.nodes";
13756
+ readonly method: "list";
13757
+ readonly summary: "List nodes";
13758
+ readonly 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.";
13759
+ readonly http: "GET";
13760
+ readonly path: "/ontology/v1/nodes";
13761
+ readonly streaming: "no";
13762
+ readonly pagination: true;
13763
+ readonly pathParams: readonly [];
13764
+ readonly query: readonly [{
13765
+ readonly name: "type";
13766
+ readonly type: "array";
13767
+ readonly itemType: "string";
13768
+ readonly required: false;
13769
+ readonly description: "Repeat to filter to any of several registered node type names, for example type=file&type=ticket; omit to list every type.";
13770
+ }, {
13771
+ readonly name: "q";
13772
+ readonly type: "string";
13773
+ readonly required: false;
13774
+ readonly description: "Free text matched against node names, aliases and descriptions; omit to list without a text filter.";
13775
+ }, {
13776
+ readonly name: "owner";
13777
+ readonly type: "string";
13778
+ readonly required: false;
13779
+ readonly description: "Filter to nodes owned by this member id, or omit to list nodes of every owner; organization-wide nodes carry no owner.";
13780
+ }, {
13781
+ readonly name: "as_of";
13782
+ readonly type: "string";
13783
+ readonly required: false;
13784
+ readonly description: "ISO 8601 timestamp; return the graph as it was then, so a node recorded later is absent. Omit to read current state.";
13785
+ }, {
13786
+ readonly name: "limit";
13787
+ readonly type: "integer";
13788
+ readonly required: false;
13789
+ readonly description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100.";
13790
+ }, {
13791
+ readonly name: "cursor";
13792
+ readonly type: "string";
13793
+ readonly required: false;
13794
+ readonly description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null.";
13795
+ }];
13796
+ }, {
13797
+ readonly resource: "ontology.nodes";
13798
+ readonly method: "create";
13799
+ readonly summary: "Create node";
13800
+ readonly 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.";
13801
+ readonly http: "POST";
13802
+ readonly path: "/ontology/v1/nodes";
13803
+ readonly streaming: "no";
13804
+ readonly pagination: false;
13805
+ readonly pathParams: readonly [];
13806
+ readonly query: readonly [];
13807
+ readonly body: {
13808
+ readonly required: true;
13809
+ readonly fields: readonly [{
13810
+ readonly name: "type";
13811
+ readonly type: "string";
13812
+ readonly required: true;
13813
+ readonly description: "Registered node type name from types.list; an unregistered name is refused and nothing is written.";
13814
+ }, {
13815
+ readonly name: "ref";
13816
+ readonly type: "string";
13817
+ readonly required: false;
13818
+ readonly 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.";
13819
+ }, {
13820
+ readonly name: "name";
13821
+ readonly type: "string";
13822
+ readonly required: true;
13823
+ readonly description: "Display name of the entity, at most 200 characters.";
13824
+ }, {
13825
+ readonly name: "aliases";
13826
+ readonly type: "array";
13827
+ readonly itemType: "string";
13828
+ readonly required: false;
13829
+ readonly description: "Other names this entity is known by; they are matched by search alongside the name.";
13830
+ }, {
13831
+ readonly name: "description";
13832
+ readonly type: "string";
13833
+ readonly required: false;
13834
+ readonly description: "Profile of the entity, at most 500 characters; omit or null for none.";
13835
+ }, {
13836
+ readonly name: "owner";
13837
+ readonly type: "string";
13838
+ readonly required: false;
13839
+ readonly description: "Member id whose content this is, restricting it to that member; omit or null to make it readable organization-wide.";
13840
+ }];
13841
+ };
13842
+ }, {
13843
+ readonly resource: "ontology.nodes";
13844
+ readonly method: "retrieve";
13845
+ readonly summary: "Retrieve node";
13846
+ readonly 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.";
13847
+ readonly http: "GET";
13848
+ readonly path: "/ontology/v1/nodes/{node_id}";
13849
+ readonly streaming: "no";
13850
+ readonly pagination: false;
13851
+ readonly pathParams: readonly [{
13852
+ readonly name: "node_id";
13853
+ readonly sdkName: "node_id";
13854
+ readonly 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.";
13855
+ }];
13856
+ readonly query: readonly [{
13857
+ readonly name: "expand";
13858
+ readonly type: "string";
13859
+ readonly enum: readonly ["relations"];
13860
+ readonly required: false;
13861
+ readonly description: "Set to relations to include the node's incoming and outgoing relations in the same response; omit for the node alone.";
13862
+ }, {
13863
+ readonly name: "as_of";
13864
+ readonly type: "string";
13865
+ readonly required: false;
13866
+ readonly description: "ISO 8601 timestamp; read the node and its relations as they were then, including relations invalidated since. Omit to read current state.";
13867
+ }];
13868
+ }, {
13869
+ readonly resource: "ontology.nodes";
13870
+ readonly method: "update";
13871
+ readonly summary: "Update node";
13872
+ readonly 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.";
13873
+ readonly http: "PATCH";
13874
+ readonly path: "/ontology/v1/nodes/{node_id}";
13875
+ readonly streaming: "no";
13876
+ readonly pagination: false;
13877
+ readonly pathParams: readonly [{
13878
+ readonly name: "node_id";
13879
+ readonly sdkName: "node_id";
13880
+ readonly 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.";
13881
+ }];
13882
+ readonly query: readonly [];
13883
+ readonly body: {
13884
+ readonly required: true;
13885
+ readonly fields: readonly [{
13886
+ readonly name: "name";
13887
+ readonly type: "string";
13888
+ readonly required: false;
13889
+ readonly description: "New display name, at most 200 characters; omit to keep the current name.";
13890
+ }, {
13891
+ readonly name: "aliases";
13892
+ readonly type: "array";
13893
+ readonly itemType: "string";
13894
+ readonly required: false;
13895
+ readonly description: "Replacement alias list; an empty array clears the aliases and omitting the field keeps them.";
13896
+ }, {
13897
+ readonly name: "description";
13898
+ readonly type: "string";
13899
+ readonly required: false;
13900
+ readonly description: "Replacement profile, at most 500 characters; an explicit null clears it and omitting the field keeps it.";
13901
+ }];
13902
+ };
13903
+ }, {
13904
+ readonly resource: "ontology.nodes.merge";
12860
13905
  readonly method: "create";
12861
- readonly summary: "Ask structured decision questions";
12862
- readonly description: "Ask typed questions about a state and get calibrated probabilities instead of generated text. Same request and response as TypeSafe System One. Use model ids from model.models.list declaring typesafe.systemone. Send one or more noul, choice or score questions; answers use the same question ids. Input tokens are charged at the catalog input price; output tokens are free. usage.cost and X-Praxis-Cost-Usd expose the same customer charge in USD. box questions and assets are unsupported and return 400: images are not supported. Unknown top-level fields pass unchanged to the native upstream.";
13906
+ readonly summary: "Merge node";
13907
+ readonly 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.";
12863
13908
  readonly http: "POST";
12864
- readonly path: "/model/v1/systemone";
13909
+ readonly path: "/ontology/v1/nodes/{node_id}/merge";
12865
13910
  readonly streaming: "no";
12866
13911
  readonly pagination: false;
12867
- readonly pathParams: readonly [];
13912
+ readonly pathParams: readonly [{
13913
+ readonly name: "node_id";
13914
+ readonly sdkName: "node_id";
13915
+ readonly 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.";
13916
+ }];
12868
13917
  readonly query: readonly [];
12869
13918
  readonly body: {
12870
13919
  readonly required: true;
12871
13920
  readonly fields: readonly [{
12872
- readonly name: "model";
13921
+ readonly name: "into";
12873
13922
  readonly type: "string";
12874
13923
  readonly required: true;
12875
- readonly description: "Published model id from model.models.list with supported_apis containing typesafe.systemone; returned unchanged in the response.";
12876
- }, {
12877
- readonly name: "state";
12878
- readonly type: "object";
12879
- readonly required: true;
12880
- readonly description: "Shared content evaluated by every question, supplied as text, a JSON object or an array.";
12881
- }, {
12882
- readonly name: "questions";
12883
- readonly type: "object";
12884
- readonly required: true;
12885
- readonly description: "Non-empty map of caller-chosen question ids to typed questions; answers preserve these ids. noul evaluates yes/no, choice selects a named option, score rates ordered levels. box is unsupported.";
12886
- }, {
12887
- readonly name: "assets";
12888
- readonly type: "object";
12889
- readonly required: false;
12890
- readonly description: "Unsupported image assets. Supplying this field, including null or an empty collection, returns 400: images are not supported.";
13924
+ readonly description: "Node id that should survive, from nodes.list or search; the merged node's relations and aliases move to it.";
12891
13925
  }];
12892
13926
  };
12893
13927
  }, {
12894
- readonly resource: "model.videos";
13928
+ readonly resource: "ontology.relations";
12895
13929
  readonly method: "list";
12896
- readonly summary: "List videos";
12897
- readonly description: "OpenAI video API with OpenRouter request and response extensions.";
13930
+ readonly summary: "List relations";
13931
+ readonly 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.";
12898
13932
  readonly http: "GET";
12899
- readonly path: "/model/v1/videos";
13933
+ readonly path: "/ontology/v1/relations";
12900
13934
  readonly streaming: "no";
12901
- readonly pagination: false;
13935
+ readonly pagination: true;
12902
13936
  readonly pathParams: readonly [];
12903
13937
  readonly query: readonly [{
12904
- readonly name: "after";
13938
+ readonly name: "node";
12905
13939
  readonly type: "string";
12906
13940
  readonly required: false;
12907
- readonly description: "Cursor: the id of the video job after which the page starts, normally the `last_id` of the previous page. It must refer to an existing job of yours, otherwise the call fails.";
13941
+ readonly 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.";
13942
+ }, {
13943
+ readonly name: "type";
13944
+ readonly type: "array";
13945
+ readonly itemType: "string";
13946
+ readonly required: false;
13947
+ readonly description: "Repeat to filter to any of several registered relation type names, for example type=references&type=serves; omit to list every type.";
13948
+ }, {
13949
+ readonly name: "direction";
13950
+ readonly type: "string";
13951
+ readonly enum: readonly ["out", "in", "both"];
13952
+ readonly required: false;
13953
+ readonly 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.";
13954
+ }, {
13955
+ readonly name: "as_of";
13956
+ readonly type: "string";
13957
+ readonly required: false;
13958
+ readonly 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.";
13959
+ }, {
13960
+ readonly name: "include_invalid";
13961
+ readonly type: "boolean";
13962
+ readonly required: false;
13963
+ readonly 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.";
12908
13964
  }, {
12909
13965
  readonly name: "limit";
12910
13966
  readonly type: "integer";
12911
13967
  readonly required: false;
12912
- readonly description: "Maximum number of jobs per page, from 1 to 100; defaults to 20.";
13968
+ readonly description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100.";
12913
13969
  }, {
12914
- readonly name: "order";
13970
+ readonly name: "cursor";
12915
13971
  readonly type: "string";
12916
- readonly enum: readonly ["asc", "desc"];
12917
13972
  readonly required: false;
12918
- readonly description: "Sort order by creation time: desc (default) lists the newest job first, asc the oldest first.";
13973
+ readonly description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null.";
12919
13974
  }];
12920
13975
  }, {
12921
- readonly resource: "model.videos";
13976
+ readonly resource: "ontology.relations";
12922
13977
  readonly method: "create";
12923
- readonly summary: "Create video";
12924
- readonly description: "OpenAI video API with OpenRouter request and response extensions.";
13978
+ readonly summary: "Create relation";
13979
+ readonly 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.";
12925
13980
  readonly http: "POST";
12926
- readonly path: "/model/v1/videos";
13981
+ readonly path: "/ontology/v1/relations";
12927
13982
  readonly streaming: "no";
12928
13983
  readonly pagination: false;
12929
- readonly multipart: true;
12930
13984
  readonly pathParams: readonly [];
12931
13985
  readonly query: readonly [];
12932
13986
  readonly body: {
12933
13987
  readonly required: true;
12934
13988
  readonly fields: readonly [{
12935
- readonly name: "model";
13989
+ readonly name: "type";
12936
13990
  readonly type: "string";
12937
- readonly required: false;
12938
- readonly description: "Video model id, for example `wan2.7-t2v`; list candidates with listModels?type=video. Router support (partial): Select a registered video model explicitly, for example wan2.7-t2v (size=1280x720, seconds=4). Capability preflight errors are reported before creation.";
13991
+ readonly required: true;
13992
+ readonly description: "Registered relation type name from types.list; it must admit both endpoints or the write is refused.";
12939
13993
  }, {
12940
- readonly name: "prompt";
13994
+ readonly name: "source";
12941
13995
  readonly type: "string";
12942
13996
  readonly required: true;
12943
- readonly description: "Text description of the video, at least 1 character. Router support (supported): Controls video content; missing or empty values return 400.";
12944
- }, {
12945
- readonly name: "seconds";
12946
- readonly type: "object";
12947
- readonly required: false;
12948
- readonly description: "Takes precedence over duration.";
12949
- }, {
12950
- readonly name: "duration";
12951
- readonly type: "integer";
12952
- readonly required: false;
12953
- readonly description: "Length of the video in whole seconds. `seconds` takes precedence when both are given.";
13997
+ readonly description: "Node id the fact starts from, from nodes.list or nodes.create.";
12954
13998
  }, {
12955
- readonly name: "size";
13999
+ readonly name: "target";
12956
14000
  readonly type: "string";
12957
- readonly required: false;
12958
- readonly description: "Output resolution as `WIDTHxHEIGHT`, for example `1280x720`. Router support (partial): Subject to model capability preflight. Earlier wan2.7-t2v samples always produced 1280x720; accepted sizes are not guaranteed pixel-for-pixel.";
12959
- }, {
12960
- readonly name: "input_reference";
12961
- readonly type: "object";
12962
- readonly required: false;
12963
- readonly description: "Reference image for image-to-video: a URL or base64 data URL, an object with `image_url`, or an uploaded image file (multipart, at most 20 MiB).";
14001
+ readonly required: true;
14002
+ readonly description: "Node id the fact points at, from nodes.list or nodes.create.";
12964
14003
  }, {
12965
- readonly name: "input_references";
12966
- readonly type: "array";
12967
- readonly itemType: "object";
12968
- readonly required: false;
12969
- readonly description: "Several reference images; each entry is a URL or base64 data URL, or an object with `image_url`.";
14004
+ readonly name: "fact";
14005
+ readonly type: "string";
14006
+ readonly required: true;
14007
+ readonly description: "The relationship in one sentence, at most 280 characters, written to read back on its own.";
12970
14008
  }, {
12971
- readonly name: "frame_images";
12972
- readonly type: "array";
12973
- readonly itemType: "object";
14009
+ readonly name: "valid_at";
14010
+ readonly type: "string";
12974
14011
  readonly required: false;
12975
- readonly description: "Images that pin the first and last frame; at most 2 entries.";
14012
+ readonly description: "World time the fact became true, when the mirrored record dates it; omit to leave it undated.";
12976
14013
  }, {
12977
- readonly name: "resolution";
14014
+ readonly name: "owner";
12978
14015
  readonly type: "string";
12979
14016
  readonly required: false;
12980
- readonly description: "Output resolution label such as `720p`, for models that take a label instead of `size`.";
14017
+ readonly description: "Member id whose content this fact is, restricting it to that member; omit or null for organization-wide.";
14018
+ }];
14019
+ };
14020
+ }, {
14021
+ readonly resource: "ontology.relations";
14022
+ readonly method: "retrieve";
14023
+ readonly summary: "Retrieve relation";
14024
+ readonly 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.";
14025
+ readonly http: "GET";
14026
+ readonly path: "/ontology/v1/relations/{relation_id}";
14027
+ readonly streaming: "no";
14028
+ readonly pagination: false;
14029
+ readonly pathParams: readonly [{
14030
+ readonly name: "relation_id";
14031
+ readonly sdkName: "relation_id";
14032
+ readonly 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.";
14033
+ }];
14034
+ readonly query: readonly [];
14035
+ }, {
14036
+ readonly resource: "ontology.relations.invalidate";
14037
+ readonly method: "create";
14038
+ readonly summary: "Invalidate relation";
14039
+ readonly 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.";
14040
+ readonly http: "POST";
14041
+ readonly path: "/ontology/v1/relations/{relation_id}/invalidate";
14042
+ readonly streaming: "no";
14043
+ readonly pagination: false;
14044
+ readonly pathParams: readonly [{
14045
+ readonly name: "relation_id";
14046
+ readonly sdkName: "relation_id";
14047
+ readonly 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.";
14048
+ }];
14049
+ readonly query: readonly [];
14050
+ readonly body: {
14051
+ readonly required: true;
14052
+ readonly fields: readonly [{
14053
+ readonly name: "invalid_at";
14054
+ readonly type: "string";
14055
+ readonly required: true;
14056
+ readonly description: "World time the fact stopped being true, in ISO 8601 UTC; reads at an earlier as_of still return the relation.";
12981
14057
  }, {
12982
- readonly name: "aspect_ratio";
14058
+ readonly name: "superseded_by";
12983
14059
  readonly type: "string";
12984
14060
  readonly required: false;
12985
- readonly description: "Aspect ratio of the video such as `16:9`.";
14061
+ readonly description: "Relation id that replaces this one, when a successor was recorded; omit or null when nothing replaced it.";
12986
14062
  }, {
12987
- readonly name: "generate_audio";
12988
- readonly type: "boolean";
14063
+ readonly name: "reason";
14064
+ readonly type: "string";
12989
14065
  readonly required: false;
12990
- readonly description: "Whether the video carries a generated audio track. Router support (supported): false produces no audio track on wan2.7-t2v; the default output includes audio.";
14066
+ readonly description: "Why it stopped being true, for people reading the history later; not enforced and safe to omit.";
14067
+ }];
14068
+ };
14069
+ }, {
14070
+ readonly resource: "ontology.search";
14071
+ readonly method: "create";
14072
+ readonly summary: "Search nodes";
14073
+ readonly 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.";
14074
+ readonly http: "POST";
14075
+ readonly path: "/ontology/v1/search";
14076
+ readonly streaming: "no";
14077
+ readonly pagination: false;
14078
+ readonly pathParams: readonly [];
14079
+ readonly query: readonly [];
14080
+ readonly body: {
14081
+ readonly required: true;
14082
+ readonly fields: readonly [{
14083
+ readonly name: "text";
14084
+ readonly type: "string";
14085
+ readonly required: true;
14086
+ readonly description: "Text to find nodes for, matched against names, aliases, descriptions and relation facts; an empty string is refused.";
12991
14087
  }, {
12992
- readonly name: "seed";
12993
- readonly type: "integer";
14088
+ readonly name: "types";
14089
+ readonly type: "array";
14090
+ readonly itemType: "string";
12994
14091
  readonly required: false;
12995
- readonly description: "Seed for reproducible generation, on models that support it.";
14092
+ readonly description: "Registered node type names to search within; omit to search every type.";
12996
14093
  }, {
12997
- readonly name: "callback_url";
12998
- readonly type: "string";
14094
+ readonly name: "window";
14095
+ readonly type: "object";
12999
14096
  readonly required: false;
13000
- readonly description: "HTTP or HTTPS callback URL, forwarded to models that support completion callbacks.";
14097
+ readonly description: "Restrict matches to facts recorded within a period; omit to search all time.";
13001
14098
  }, {
13002
- readonly name: "quality";
13003
- readonly type: "string";
14099
+ readonly name: "limit";
14100
+ readonly type: "integer";
13004
14101
  readonly required: false;
13005
- readonly description: "Provider-specific quality setting.";
14102
+ readonly description: "Maximum candidate nodes to return, from 1 to 50; defaults to 20 when omitted.";
13006
14103
  }];
13007
14104
  };
13008
14105
  }, {
13009
- readonly resource: "model.videos";
13010
- readonly method: "delete";
13011
- readonly summary: "Delete video";
13012
- readonly description: "OpenAI video API with OpenRouter request and response extensions.";
13013
- readonly http: "DELETE";
13014
- readonly path: "/model/v1/videos/{video_id}";
14106
+ readonly resource: "ontology.types";
14107
+ readonly method: "list";
14108
+ readonly summary: "List types";
14109
+ readonly 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.";
14110
+ readonly http: "GET";
14111
+ readonly path: "/ontology/v1/types";
13015
14112
  readonly streaming: "no";
13016
14113
  readonly pagination: false;
13017
- readonly pathParams: readonly [{
13018
- readonly name: "video_id";
13019
- readonly sdkName: "video_id";
13020
- readonly description: "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400.";
13021
- }];
14114
+ readonly pathParams: readonly [];
13022
14115
  readonly query: readonly [];
13023
14116
  }, {
13024
- readonly resource: "model.videos";
13025
- readonly method: "retrieve";
13026
- readonly summary: "Retrieve video";
13027
- readonly description: "OpenAI video API with OpenRouter request and response extensions.";
13028
- readonly http: "GET";
13029
- readonly path: "/model/v1/videos/{video_id}";
14117
+ readonly resource: "ontology.types";
14118
+ readonly method: "create";
14119
+ readonly summary: "Register type";
14120
+ readonly 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.";
14121
+ readonly http: "POST";
14122
+ readonly path: "/ontology/v1/types";
13030
14123
  readonly streaming: "no";
13031
14124
  readonly pagination: false;
13032
- readonly pathParams: readonly [{
13033
- readonly name: "video_id";
13034
- readonly sdkName: "video_id";
13035
- readonly description: "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400.";
13036
- }];
14125
+ readonly pathParams: readonly [];
13037
14126
  readonly query: readonly [];
14127
+ readonly body: {
14128
+ readonly required: true;
14129
+ readonly fields: readonly [{
14130
+ readonly name: "owner";
14131
+ readonly type: "string";
14132
+ readonly required: true;
14133
+ readonly description: "Service that registered these types, for example file or ticket; it is the registrant a later change to a type is checked against.";
14134
+ }, {
14135
+ readonly name: "version";
14136
+ readonly type: "integer";
14137
+ readonly required: true;
14138
+ readonly description: "Monotonic version of this owner's registration; a later registration must extend this one without removing or narrowing anything.";
14139
+ }, {
14140
+ readonly name: "nodes";
14141
+ readonly type: "array";
14142
+ readonly itemType: "object";
14143
+ readonly required: true;
14144
+ readonly description: "Node types this owner registers.";
14145
+ }, {
14146
+ readonly name: "edges";
14147
+ readonly type: "array";
14148
+ readonly itemType: "object";
14149
+ readonly required: true;
14150
+ readonly description: "Relation types this owner registers.";
14151
+ }];
14152
+ };
13038
14153
  }, {
13039
- readonly resource: "model.videos";
13040
- readonly method: "retrieveContent";
13041
- readonly summary: "Download video";
13042
- readonly description: "OpenAI video API with OpenRouter request and response extensions.";
14154
+ readonly resource: "ontology.types";
14155
+ readonly method: "retrieve";
14156
+ readonly summary: "Retrieve type";
14157
+ readonly 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.";
13043
14158
  readonly http: "GET";
13044
- readonly path: "/model/v1/videos/{video_id}/content";
13045
- readonly streaming: "no";
13046
- readonly pagination: false;
13047
- readonly pathParams: readonly [{
13048
- readonly name: "video_id";
13049
- readonly sdkName: "video_id";
13050
- readonly description: "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400.";
13051
- }];
13052
- readonly query: readonly [{
13053
- readonly name: "variant";
13054
- readonly type: "string";
13055
- readonly enum: readonly ["video", "thumbnail", "spritesheet"];
13056
- readonly required: false;
13057
- readonly description: "Spritesheet is not available in this release (400).";
13058
- }, {
13059
- readonly name: "index";
13060
- readonly type: "integer";
13061
- readonly required: false;
13062
- readonly description: "Output index; this release produces index 0. variant takes precedence.";
13063
- }];
13064
- }, {
13065
- readonly resource: "model.videos";
13066
- readonly method: "remix";
13067
- readonly summary: "Remix video";
13068
- readonly description: "Not supported in this release; always returns 400.";
13069
- readonly http: "POST";
13070
- readonly path: "/model/v1/videos/{video_id}/remix";
14159
+ readonly path: "/ontology/v1/types/{name}";
13071
14160
  readonly streaming: "no";
13072
14161
  readonly pagination: false;
13073
14162
  readonly pathParams: readonly [{
13074
- readonly name: "video_id";
13075
- readonly sdkName: "video_id";
13076
- readonly description: "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400.";
14163
+ readonly name: "name";
14164
+ readonly sdkName: "name";
14165
+ readonly description: "A type name from types.list, with its dots preserved — a display label is not accepted.";
13077
14166
  }];
13078
14167
  readonly query: readonly [];
13079
14168
  }, {
@@ -15128,7 +16217,7 @@ export declare const operations: readonly [{
15128
16217
  readonly resource: "ticket.labels";
15129
16218
  readonly method: "create";
15130
16219
  readonly summary: "Create or add labels";
15131
- readonly 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. Organization owner or admin authority is required for this write; API keys without role information act as members.";
16220
+ readonly 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.";
15132
16221
  readonly http: "POST";
15133
16222
  readonly path: "/ticket/v1/labels";
15134
16223
  readonly streaming: "no";
@@ -15163,7 +16252,7 @@ export declare const operations: readonly [{
15163
16252
  readonly resource: "ticket.labels";
15164
16253
  readonly method: "delete";
15165
16254
  readonly summary: "Remove labels";
15166
- readonly 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. Organization owner or admin authority is required for this write; API keys without role information act as members.";
16255
+ readonly 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.";
15167
16256
  readonly http: "DELETE";
15168
16257
  readonly path: "/ticket/v1/labels/{name}";
15169
16258
  readonly streaming: "no";
@@ -15183,7 +16272,7 @@ export declare const operations: readonly [{
15183
16272
  readonly resource: "ticket.labels";
15184
16273
  readonly method: "update";
15185
16274
  readonly summary: "Update labels";
15186
- readonly 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. Organization owner or admin authority is required for this write; API keys without role information act as members.";
16275
+ readonly 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.";
15187
16276
  readonly http: "PATCH";
15188
16277
  readonly path: "/ticket/v1/labels/{name}";
15189
16278
  readonly streaming: "no";
@@ -16317,7 +17406,7 @@ export declare const operations: readonly [{
16317
17406
  readonly resource: "vault.vaults";
16318
17407
  readonly method: "create";
16319
17408
  readonly summary: "Create vault";
16320
- readonly 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. Unlike Anthropic, Agent sessions do not accept nonempty vault_ids; storing a credential or adding its ID to metadata does not enable vault-backed MCP authentication. 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.";
17409
+ readonly 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.";
16321
17410
  readonly http: "POST";
16322
17411
  readonly path: "/vault/v1/vaults";
16323
17412
  readonly streaming: "no";