@deepraxis/sdk 0.1.1-dev.e5614a0 → 0.1.1-dev.e5cbcae
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/METHODS.md +98 -1
- package/README.md +2 -2
- package/dist/core/errors.d.ts +6 -0
- package/dist/core/errors.js +8 -0
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +344 -47
- package/dist/generated/sdk.gen.js +599 -46
- package/dist/generated/types.gen.d.ts +5980 -1753
- package/dist/operations.generated.d.ts +897 -88
- package/dist/operations.generated.js +1361 -363
- package/dist/resources.generated.d.ts +96 -8
- package/dist/resources.generated.js +62 -0
- package/package.json +2 -2
|
@@ -107,7 +107,7 @@ export declare const operations: readonly [{
|
|
|
107
107
|
readonly type: "array";
|
|
108
108
|
readonly itemType: "object";
|
|
109
109
|
readonly required: false;
|
|
110
|
-
readonly description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or
|
|
110
|
+
readonly description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.";
|
|
111
111
|
}, {
|
|
112
112
|
readonly name: "kind";
|
|
113
113
|
readonly type: "string";
|
|
@@ -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
|
|
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
|
|
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";
|
|
@@ -7935,7 +7959,7 @@ export declare const operations: readonly [{
|
|
|
7935
7959
|
readonly resource: "cut.projects.analysis";
|
|
7936
7960
|
readonly method: "create";
|
|
7937
7961
|
readonly summary: "Analyze project media";
|
|
7938
|
-
readonly description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible.";
|
|
7962
|
+
readonly description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible. Silence measures transcript-based speech pauses, not music or loudness. A completed transcript without words returns ready with empty segments and reason no_speech; no completed transcript returns unsupported with reason no_transcript. A failed transcription remains failed.";
|
|
7939
7963
|
readonly http: "POST";
|
|
7940
7964
|
readonly path: "/cut/v1/projects/{project_id}/analysis";
|
|
7941
7965
|
readonly streaming: "no";
|
|
@@ -8074,6 +8098,16 @@ export declare const operations: readonly [{
|
|
|
8074
8098
|
readonly body: {
|
|
8075
8099
|
readonly required: true;
|
|
8076
8100
|
readonly fields: readonly [{
|
|
8101
|
+
readonly name: "folder";
|
|
8102
|
+
readonly type: "string";
|
|
8103
|
+
readonly required: false;
|
|
8104
|
+
readonly description: "Optional destination path within the bound media library; omitted uses its default folder.";
|
|
8105
|
+
}, {
|
|
8106
|
+
readonly name: "name";
|
|
8107
|
+
readonly type: "string";
|
|
8108
|
+
readonly required: false;
|
|
8109
|
+
readonly description: "Nonempty display name, frozen with the export. Path separators and control characters become hyphens; limited to 200 characters. Omitted uses project name and timestamp.";
|
|
8110
|
+
}, {
|
|
8077
8111
|
readonly name: "output";
|
|
8078
8112
|
readonly type: "object";
|
|
8079
8113
|
readonly required: false;
|
|
@@ -8088,13 +8122,18 @@ export declare const operations: readonly [{
|
|
|
8088
8122
|
readonly type: "integer";
|
|
8089
8123
|
readonly required: false;
|
|
8090
8124
|
readonly description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write.";
|
|
8125
|
+
}, {
|
|
8126
|
+
readonly name: "loudness";
|
|
8127
|
+
readonly type: "object";
|
|
8128
|
+
readonly required: false;
|
|
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.";
|
|
8091
8130
|
}];
|
|
8092
8131
|
};
|
|
8093
8132
|
}, {
|
|
8094
8133
|
readonly resource: "cut.projects.frames";
|
|
8095
8134
|
readonly method: "list";
|
|
8096
8135
|
readonly summary: "Render preview frames";
|
|
8097
|
-
readonly description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision.
|
|
8136
|
+
readonly description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution. The response always includes warnings; FRAME_UNAVAILABLE means a source preview could not be obtained and an offline tile was drawn. Its message identifies a timeout, delivery capacity limit, or unavailable source and contains no source URL. Decode each image's base64 payload to save it. Codemode returns at most four images per call, so request at most four times when reviewing there.";
|
|
8098
8137
|
readonly http: "GET";
|
|
8099
8138
|
readonly path: "/cut/v1/projects/{project_id}/frames";
|
|
8100
8139
|
readonly streaming: "no";
|
|
@@ -8113,7 +8152,7 @@ export declare const operations: readonly [{
|
|
|
8113
8152
|
readonly name: "scale";
|
|
8114
8153
|
readonly type: "number";
|
|
8115
8154
|
readonly required: false;
|
|
8116
|
-
readonly description: "
|
|
8155
|
+
readonly description: "Image size multiplier, default 0.25, greater than zero and at most 0.5. Larger values return INVALID_PARAMS; pixel-area limits may reduce actual dimensions, reported as width and height.";
|
|
8117
8156
|
}, {
|
|
8118
8157
|
readonly name: "revision";
|
|
8119
8158
|
readonly type: "integer";
|
|
@@ -8268,7 +8307,7 @@ export declare const operations: readonly [{
|
|
|
8268
8307
|
readonly resource: "cut.projects";
|
|
8269
8308
|
readonly method: "execute";
|
|
8270
8309
|
readonly summary: "Execute editing script";
|
|
8271
|
-
readonly description: "Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes.
|
|
8310
|
+
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";
|
|
8272
8311
|
readonly http: "POST";
|
|
8273
8312
|
readonly path: "/cut/v1/projects/{project_id}:execute";
|
|
8274
8313
|
readonly streaming: "no";
|
|
@@ -9164,7 +9203,7 @@ export declare const operations: readonly [{
|
|
|
9164
9203
|
readonly resource: "file.files";
|
|
9165
9204
|
readonly method: "create";
|
|
9166
9205
|
readonly summary: "Upload file";
|
|
9167
|
-
readonly description: "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.";
|
|
9206
|
+
readonly description: "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.";
|
|
9168
9207
|
readonly http: "POST";
|
|
9169
9208
|
readonly path: "/file/v1/files";
|
|
9170
9209
|
readonly streaming: "no";
|
|
@@ -9182,9 +9221,9 @@ export declare const operations: readonly [{
|
|
|
9182
9221
|
}, {
|
|
9183
9222
|
readonly name: "purpose";
|
|
9184
9223
|
readonly type: "string";
|
|
9185
|
-
readonly enum: readonly ["user_data", "vision"];
|
|
9224
|
+
readonly enum: readonly ["user_data", "assistants", "vision"];
|
|
9186
9225
|
readonly required: true;
|
|
9187
|
-
readonly description: "Purpose label stored with the file: user_data or vision. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data.";
|
|
9226
|
+
readonly description: "Purpose label stored with the file: user_data, assistants or vision. The label is stored and returned unchanged; assistants follows the same rules as user_data. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data.";
|
|
9188
9227
|
}, {
|
|
9189
9228
|
readonly name: "expires_after";
|
|
9190
9229
|
readonly type: "object";
|
|
@@ -9241,7 +9280,7 @@ export declare const operations: readonly [{
|
|
|
9241
9280
|
readonly resource: "file.files.contentLinks";
|
|
9242
9281
|
readonly method: "revoke";
|
|
9243
9282
|
readonly summary: "Revoke a file content link";
|
|
9244
|
-
readonly description: "Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within
|
|
9283
|
+
readonly description: "Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within 15 minutes; the file and other links remain available. Only current IAM capability tokens can be revoked; legacy content links expire at the migration deadline. Example body: {\"token\":\"<token from /c/>\"}.";
|
|
9245
9284
|
readonly http: "POST";
|
|
9246
9285
|
readonly path: "/file/v1/files/{file_id}/content_links:revoke";
|
|
9247
9286
|
readonly streaming: "no";
|
|
@@ -9265,7 +9304,7 @@ export declare const operations: readonly [{
|
|
|
9265
9304
|
readonly resource: "file.files.contentUrl";
|
|
9266
9305
|
readonly method: "create";
|
|
9267
9306
|
readonly summary: "Create a download URL";
|
|
9268
|
-
readonly description: "Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to
|
|
9307
|
+
readonly description: "Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to 900 seconds and is at most 604800 seconds. Issuance requires the same credential and file-read access as files.retrieveContent; a processing file returns 409 FILE_NOT_READY, so poll files.retrieve until active before retrying. A missing, expired or other-organization file returns 404. Each issuance creates a new link. OpenAI Files has no signed download URL; this follows S3 presigned GET semantics. Example body: {\"ttl_seconds\":3600}.";
|
|
9269
9308
|
readonly http: "POST";
|
|
9270
9309
|
readonly path: "/file/v1/files/{file_id}/content_url";
|
|
9271
9310
|
readonly streaming: "no";
|
|
@@ -9282,14 +9321,14 @@ export declare const operations: readonly [{
|
|
|
9282
9321
|
readonly name: "ttl_seconds";
|
|
9283
9322
|
readonly type: "integer";
|
|
9284
9323
|
readonly required: false;
|
|
9285
|
-
readonly description: "Download link lifetime in seconds, from 1 through 604800; omitted means
|
|
9324
|
+
readonly description: "Download link lifetime in seconds, from 1 through 604800; omitted means 900. This does not change the file's own expiry.";
|
|
9286
9325
|
}];
|
|
9287
9326
|
};
|
|
9288
9327
|
}, {
|
|
9289
9328
|
readonly resource: "file.uploads";
|
|
9290
9329
|
readonly method: "create";
|
|
9291
9330
|
readonly summary: "Create an upload";
|
|
9292
|
-
readonly description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most
|
|
9331
|
+
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.";
|
|
9293
9332
|
readonly http: "POST";
|
|
9294
9333
|
readonly path: "/file/v1/uploads";
|
|
9295
9334
|
readonly streaming: "no";
|
|
@@ -9302,7 +9341,7 @@ export declare const operations: readonly [{
|
|
|
9302
9341
|
readonly name: "bytes";
|
|
9303
9342
|
readonly type: "integer";
|
|
9304
9343
|
readonly required: true;
|
|
9305
|
-
readonly description: "Exact complete file length in bytes, from 1 through
|
|
9344
|
+
readonly description: "Exact complete file length in bytes, from 1 through 21474836480 (20 GiB); the sum of completed parts must match.";
|
|
9306
9345
|
}, {
|
|
9307
9346
|
readonly name: "filename";
|
|
9308
9347
|
readonly type: "string";
|
|
@@ -9316,9 +9355,9 @@ export declare const operations: readonly [{
|
|
|
9316
9355
|
}, {
|
|
9317
9356
|
readonly name: "purpose";
|
|
9318
9357
|
readonly type: "string";
|
|
9319
|
-
readonly enum: readonly ["user_data", "vision"];
|
|
9358
|
+
readonly enum: readonly ["user_data", "assistants", "vision"];
|
|
9320
9359
|
readonly required: true;
|
|
9321
|
-
readonly description: "Use user_data for conversation attachments, or vision for PNG, JPEG, GIF and WebP images.";
|
|
9360
|
+
readonly description: "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images.";
|
|
9322
9361
|
}, {
|
|
9323
9362
|
readonly name: "expires_after";
|
|
9324
9363
|
readonly type: "object";
|
|
@@ -9335,7 +9374,7 @@ export declare const operations: readonly [{
|
|
|
9335
9374
|
readonly resource: "file.uploads";
|
|
9336
9375
|
readonly method: "createSigned";
|
|
9337
9376
|
readonly summary: "Create a one-time upload URL";
|
|
9338
|
-
readonly description: "Upload a local file of up to
|
|
9377
|
+
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\"}.";
|
|
9339
9378
|
readonly http: "POST";
|
|
9340
9379
|
readonly path: "/file/v1/uploads/signed";
|
|
9341
9380
|
readonly streaming: "no";
|
|
@@ -9353,7 +9392,7 @@ export declare const operations: readonly [{
|
|
|
9353
9392
|
readonly name: "bytes";
|
|
9354
9393
|
readonly type: "integer";
|
|
9355
9394
|
readonly required: true;
|
|
9356
|
-
readonly description: "Exact local file size in bytes, from 1 through
|
|
9395
|
+
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.";
|
|
9357
9396
|
}, {
|
|
9358
9397
|
readonly name: "content_type";
|
|
9359
9398
|
readonly type: "string";
|
|
@@ -9362,14 +9401,14 @@ export declare const operations: readonly [{
|
|
|
9362
9401
|
}, {
|
|
9363
9402
|
readonly name: "purpose";
|
|
9364
9403
|
readonly type: "string";
|
|
9365
|
-
readonly enum: readonly ["user_data", "vision"];
|
|
9404
|
+
readonly enum: readonly ["user_data", "assistants", "vision"];
|
|
9366
9405
|
readonly required: false;
|
|
9367
|
-
readonly description: "user_data
|
|
9406
|
+
readonly description: "user_data and assistants store ordinary files and conversation images with their original purpose label; vision accepts PNG, JPEG, GIF or WebP images only. Omitted means user_data.";
|
|
9368
9407
|
}, {
|
|
9369
9408
|
readonly name: "expires_in";
|
|
9370
9409
|
readonly type: "integer";
|
|
9371
9410
|
readonly required: false;
|
|
9372
|
-
readonly description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or
|
|
9411
|
+
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.";
|
|
9373
9412
|
}, {
|
|
9374
9413
|
readonly name: "part_size";
|
|
9375
9414
|
readonly type: "integer";
|
|
@@ -9377,6 +9416,21 @@ export declare const operations: readonly [{
|
|
|
9377
9416
|
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.";
|
|
9378
9417
|
}];
|
|
9379
9418
|
};
|
|
9419
|
+
}, {
|
|
9420
|
+
readonly resource: "file.uploads";
|
|
9421
|
+
readonly method: "retrieve";
|
|
9422
|
+
readonly summary: "Retrieve an upload";
|
|
9423
|
+
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.";
|
|
9424
|
+
readonly http: "GET";
|
|
9425
|
+
readonly path: "/file/v1/uploads/{upload_id}";
|
|
9426
|
+
readonly streaming: "no";
|
|
9427
|
+
readonly pagination: false;
|
|
9428
|
+
readonly pathParams: readonly [{
|
|
9429
|
+
readonly name: "upload_id";
|
|
9430
|
+
readonly sdkName: "upload_id";
|
|
9431
|
+
readonly description: "Upload identifier returned by create; the upload must belong to your organization.";
|
|
9432
|
+
}];
|
|
9433
|
+
readonly query: readonly [];
|
|
9380
9434
|
}, {
|
|
9381
9435
|
readonly resource: "file.uploads";
|
|
9382
9436
|
readonly method: "cancel";
|
|
@@ -9396,7 +9450,7 @@ export declare const operations: readonly [{
|
|
|
9396
9450
|
readonly resource: "file.uploads";
|
|
9397
9451
|
readonly method: "complete";
|
|
9398
9452
|
readonly summary: "Complete an upload";
|
|
9399
|
-
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.";
|
|
9453
|
+
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.";
|
|
9400
9454
|
readonly http: "POST";
|
|
9401
9455
|
readonly path: "/file/v1/uploads/{upload_id}/complete";
|
|
9402
9456
|
readonly streaming: "no";
|
|
@@ -9426,7 +9480,7 @@ export declare const operations: readonly [{
|
|
|
9426
9480
|
readonly resource: "file.uploads.parts";
|
|
9427
9481
|
readonly method: "create";
|
|
9428
9482
|
readonly summary: "Add an upload part";
|
|
9429
|
-
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.";
|
|
9483
|
+
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.";
|
|
9430
9484
|
readonly http: "POST";
|
|
9431
9485
|
readonly path: "/file/v1/uploads/{upload_id}/parts";
|
|
9432
9486
|
readonly streaming: "no";
|
|
@@ -9494,7 +9548,7 @@ export declare const operations: readonly [{
|
|
|
9494
9548
|
readonly resource: "knowledge.vectorStores";
|
|
9495
9549
|
readonly method: "create";
|
|
9496
9550
|
readonly summary: "Create knowledge base";
|
|
9497
|
-
readonly description: "Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded.
|
|
9551
|
+
readonly description: "Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; each account holds up to 100 active/nondeleted stores. Minimal body: {\"name\":\"Refund policies\"}.";
|
|
9498
9552
|
readonly http: "POST";
|
|
9499
9553
|
readonly path: "/knowledge/v1/vector_stores";
|
|
9500
9554
|
readonly streaming: "no";
|
|
@@ -9528,7 +9582,7 @@ export declare const operations: readonly [{
|
|
|
9528
9582
|
readonly name: "chunking_strategy";
|
|
9529
9583
|
readonly type: "object";
|
|
9530
9584
|
readonly required: false;
|
|
9531
|
-
readonly description: "auto
|
|
9585
|
+
readonly description: "Native attachment strategy. auto uses static chunks of 800 estimated tokens with 400 overlap; static supplies explicit chunk sizes; hierarchical indexes child chunks and supplies bounded parent context. Existing attachments are reused unchanged; remove and reattach a file to change its strategy.";
|
|
9532
9586
|
}, {
|
|
9533
9587
|
readonly name: "description";
|
|
9534
9588
|
readonly type: "string";
|
|
@@ -9798,7 +9852,7 @@ export declare const operations: readonly [{
|
|
|
9798
9852
|
readonly resource: "knowledge.vectorStores.files";
|
|
9799
9853
|
readonly method: "create";
|
|
9800
9854
|
readonly summary: "Add file";
|
|
9801
|
-
readonly description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching.
|
|
9855
|
+
readonly description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; chunk sizes use estimated tokens rather than a model tokenizer. Text, Markdown, CSV, JSON, HTML, PDF, DOCX, PPTX, XLSX and PNG/JPEG/GIF/WebP images can be extracted; audio and video uploads are not knowledge documents. Images may yield generated descriptions rather than verbatim OCR. auto chunking resolves to static 800/400; explicit sizes are 100–4096 with overlap at most half the size. Each store holds at most 10000 attached files. Reattaching the same file returns its existing record without applying new attributes or chunking; inspect last_error after failure.";
|
|
9802
9856
|
readonly http: "POST";
|
|
9803
9857
|
readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files";
|
|
9804
9858
|
readonly streaming: "no";
|
|
@@ -9825,7 +9879,7 @@ export declare const operations: readonly [{
|
|
|
9825
9879
|
readonly name: "chunking_strategy";
|
|
9826
9880
|
readonly type: "object";
|
|
9827
9881
|
readonly required: false;
|
|
9828
|
-
readonly description: "auto
|
|
9882
|
+
readonly description: "Native attachment strategy. auto uses static chunks of 800 estimated tokens with 400 overlap; static supplies explicit chunk sizes; hierarchical indexes child chunks and supplies bounded parent context. Existing attachments are reused unchanged; remove and reattach a file to change its strategy.";
|
|
9829
9883
|
}];
|
|
9830
9884
|
};
|
|
9831
9885
|
}, {
|
|
@@ -10075,11 +10129,22 @@ export declare const operations: readonly [{
|
|
|
10075
10129
|
readonly description: "Chunk ID returned by segment listing or native search content.";
|
|
10076
10130
|
}];
|
|
10077
10131
|
readonly query: readonly [];
|
|
10132
|
+
}, {
|
|
10133
|
+
readonly resource: "media.generation.capabilities";
|
|
10134
|
+
readonly method: "list";
|
|
10135
|
+
readonly summary: "Get generation capabilities";
|
|
10136
|
+
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.";
|
|
10137
|
+
readonly http: "GET";
|
|
10138
|
+
readonly path: "/media/v1/generation/capabilities";
|
|
10139
|
+
readonly streaming: "no";
|
|
10140
|
+
readonly pagination: false;
|
|
10141
|
+
readonly pathParams: readonly [];
|
|
10142
|
+
readonly query: readonly [];
|
|
10078
10143
|
}, {
|
|
10079
10144
|
readonly resource: "media.libraries";
|
|
10080
10145
|
readonly method: "list";
|
|
10081
10146
|
readonly summary: "List libraries";
|
|
10082
|
-
readonly description: "
|
|
10147
|
+
readonly description: "Read a caller-owned library’s current settings, usage and lifecycle status. A deleting library remains readable; missing, foreign or purged libraries return LIBRARY_NOT_FOUND.";
|
|
10083
10148
|
readonly http: "GET";
|
|
10084
10149
|
readonly path: "/media/v1/libraries";
|
|
10085
10150
|
readonly streaming: "no";
|
|
@@ -10146,7 +10211,7 @@ export declare const operations: readonly [{
|
|
|
10146
10211
|
readonly resource: "media.libraries";
|
|
10147
10212
|
readonly method: "delete";
|
|
10148
10213
|
readonly summary: "Delete library";
|
|
10149
|
-
readonly description: "
|
|
10214
|
+
readonly description: "Restore a deleting library before its purge_at deadline. The library becomes active again and deleted_at and purge_at are cleared; expired or non-deleting libraries cannot be restored.";
|
|
10150
10215
|
readonly http: "DELETE";
|
|
10151
10216
|
readonly path: "/media/v1/libraries/{library_id}";
|
|
10152
10217
|
readonly streaming: "no";
|
|
@@ -10161,7 +10226,7 @@ export declare const operations: readonly [{
|
|
|
10161
10226
|
readonly resource: "media.libraries";
|
|
10162
10227
|
readonly method: "retrieve";
|
|
10163
10228
|
readonly summary: "Get library";
|
|
10164
|
-
readonly description: "
|
|
10229
|
+
readonly description: "Update an active library’s supplied settings. Labels replace the complete map; understanding settings and model roles merge with current values. Changing the embedding model is rejected while assets exist.";
|
|
10165
10230
|
readonly http: "GET";
|
|
10166
10231
|
readonly path: "/media/v1/libraries/{library_id}";
|
|
10167
10232
|
readonly streaming: "no";
|
|
@@ -10176,7 +10241,7 @@ export declare const operations: readonly [{
|
|
|
10176
10241
|
readonly resource: "media.libraries";
|
|
10177
10242
|
readonly method: "update";
|
|
10178
10243
|
readonly summary: "Update library";
|
|
10179
|
-
readonly description: "Update an active library
|
|
10244
|
+
readonly description: "Update an active library. Set hotwords for spelling evidence in subsequent transcripts; [] disables inferred vocabulary. Transcript understanding calls the timestamped ASR, optional reference ASR and correction model through the existing metered model path. Reprocess assets to apply new settings to existing transcripts.";
|
|
10180
10245
|
readonly http: "PATCH";
|
|
10181
10246
|
readonly path: "/media/v1/libraries/{library_id}";
|
|
10182
10247
|
readonly streaming: "no";
|
|
@@ -10190,6 +10255,12 @@ export declare const operations: readonly [{
|
|
|
10190
10255
|
readonly body: {
|
|
10191
10256
|
readonly required: true;
|
|
10192
10257
|
readonly fields: readonly [{
|
|
10258
|
+
readonly name: "hotwords";
|
|
10259
|
+
readonly type: "array";
|
|
10260
|
+
readonly itemType: "string";
|
|
10261
|
+
readonly required: false;
|
|
10262
|
+
readonly description: "Correction vocabulary, at most 200 nonblank terms of at most 32 Unicode characters each. Omitted on an unconfigured library: correction derives up to 200 distinct names from the library name and every folder level, excluding generic names such as 原始素材 and 混剪成品. An explicit empty array disables this vocabulary. Updating affects subsequent understanding and explicit reprocessing, not existing results.";
|
|
10263
|
+
}, {
|
|
10193
10264
|
readonly name: "models";
|
|
10194
10265
|
readonly type: "object";
|
|
10195
10266
|
readonly required: false;
|
|
@@ -10215,7 +10286,7 @@ export declare const operations: readonly [{
|
|
|
10215
10286
|
readonly resource: "media.libraries.assets";
|
|
10216
10287
|
readonly method: "list";
|
|
10217
10288
|
readonly summary: "List assets";
|
|
10218
|
-
readonly description: "
|
|
10289
|
+
readonly description: "Upload content into an active library and return a Cloudinary-compatible resource. Use file for a multipart file, data URI, public HTTPS URL or same-owner file identifier. Reusing public_id overwrites by default; overwrite=false returns the existing resource. Chunk uploads require both chunk headers.";
|
|
10219
10290
|
readonly http: "GET";
|
|
10220
10291
|
readonly path: "/media/v1/libraries/{library_id}/assets";
|
|
10221
10292
|
readonly streaming: "no";
|
|
@@ -10251,7 +10322,7 @@ export declare const operations: readonly [{
|
|
|
10251
10322
|
readonly resource: "media.libraries.assets";
|
|
10252
10323
|
readonly method: "create";
|
|
10253
10324
|
readonly summary: "Upload asset";
|
|
10254
|
-
readonly description: "
|
|
10325
|
+
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.";
|
|
10255
10326
|
readonly http: "POST";
|
|
10256
10327
|
readonly path: "/media/v1/libraries/{library_id}/assets";
|
|
10257
10328
|
readonly streaming: "no";
|
|
@@ -10289,7 +10360,7 @@ export declare const operations: readonly [{
|
|
|
10289
10360
|
readonly name: "asset_folder";
|
|
10290
10361
|
readonly type: "string";
|
|
10291
10362
|
readonly required: false;
|
|
10292
|
-
readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected.";
|
|
10363
|
+
readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.";
|
|
10293
10364
|
}, {
|
|
10294
10365
|
readonly name: "use_filename";
|
|
10295
10366
|
readonly type: "boolean";
|
|
@@ -10348,7 +10419,7 @@ export declare const operations: readonly [{
|
|
|
10348
10419
|
readonly resource: "media.libraries.assets.import";
|
|
10349
10420
|
readonly method: "create";
|
|
10350
10421
|
readonly summary: "Import file";
|
|
10351
|
-
readonly description: "Copy
|
|
10422
|
+
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.";
|
|
10352
10423
|
readonly http: "POST";
|
|
10353
10424
|
readonly path: "/media/v1/libraries/{library_id}/assets/import";
|
|
10354
10425
|
readonly streaming: "no";
|
|
@@ -10365,7 +10436,7 @@ export declare const operations: readonly [{
|
|
|
10365
10436
|
readonly name: "file_id";
|
|
10366
10437
|
readonly type: "string";
|
|
10367
10438
|
readonly required: true;
|
|
10368
|
-
readonly description: "File ID to copy into this library instead of file bytes. This independent copy defaults to
|
|
10439
|
+
readonly description: "File ID to copy into this library instead of file bytes. This independent copy defaults to organization-private delivery (type=authenticated); explicitly set type=upload for public delivery. Deleting the source File does not delete this asset.";
|
|
10369
10440
|
}, {
|
|
10370
10441
|
readonly name: "public_id";
|
|
10371
10442
|
readonly type: "string";
|
|
@@ -10385,7 +10456,7 @@ export declare const operations: readonly [{
|
|
|
10385
10456
|
readonly name: "asset_folder";
|
|
10386
10457
|
readonly type: "string";
|
|
10387
10458
|
readonly required: false;
|
|
10388
|
-
readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected.";
|
|
10459
|
+
readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.";
|
|
10389
10460
|
}, {
|
|
10390
10461
|
readonly name: "use_filename";
|
|
10391
10462
|
readonly type: "boolean";
|
|
@@ -10444,7 +10515,7 @@ export declare const operations: readonly [{
|
|
|
10444
10515
|
readonly resource: "media.libraries.assets";
|
|
10445
10516
|
readonly method: "delete";
|
|
10446
10517
|
readonly summary: "Delete asset";
|
|
10447
|
-
readonly description: "
|
|
10518
|
+
readonly description: "Queue reprocessing of the asset’s current version and return its updated state immediately. Omit kinds to retry failed tasks and legacy source-size unsupported tasks; explicit kinds rerun applicable completed tasks and recoverable source-size unsupported tasks. Other unsupported causes remain unchanged. Replaced understandings become superseded, and processing finishes asynchronously.";
|
|
10448
10519
|
readonly http: "DELETE";
|
|
10449
10520
|
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}";
|
|
10450
10521
|
readonly streaming: "no";
|
|
@@ -10463,7 +10534,7 @@ export declare const operations: readonly [{
|
|
|
10463
10534
|
readonly resource: "media.libraries.assets";
|
|
10464
10535
|
readonly method: "retrieve";
|
|
10465
10536
|
readonly summary: "Get asset";
|
|
10466
|
-
readonly description: "
|
|
10537
|
+
readonly description: "Update an asset’s supplied metadata fields. Tags and context replace their current collections; an empty collection clears them. Moving asset_folder or changing display_name preserves public_id and delivery URLs.";
|
|
10467
10538
|
readonly http: "GET";
|
|
10468
10539
|
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}";
|
|
10469
10540
|
readonly streaming: "no";
|
|
@@ -10482,7 +10553,7 @@ export declare const operations: readonly [{
|
|
|
10482
10553
|
readonly resource: "media.libraries.assets";
|
|
10483
10554
|
readonly method: "update";
|
|
10484
10555
|
readonly summary: "Update asset";
|
|
10485
|
-
readonly description: "
|
|
10556
|
+
readonly description: "Delete an asset from the library so it is no longer readable, searchable or deliverable. This removes the asset rather than placing it in the library’s restoration window; a missing asset returns ASSET_NOT_FOUND.";
|
|
10486
10557
|
readonly http: "PATCH";
|
|
10487
10558
|
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}";
|
|
10488
10559
|
readonly streaming: "no";
|
|
@@ -10508,7 +10579,7 @@ export declare const operations: readonly [{
|
|
|
10508
10579
|
readonly name: "asset_folder";
|
|
10509
10580
|
readonly type: "string";
|
|
10510
10581
|
readonly required: false;
|
|
10511
|
-
readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected.";
|
|
10582
|
+
readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.";
|
|
10512
10583
|
}, {
|
|
10513
10584
|
readonly name: "tags";
|
|
10514
10585
|
readonly type: "array";
|
|
@@ -10522,11 +10593,46 @@ export declare const operations: readonly [{
|
|
|
10522
10593
|
readonly description: "Replacement custom string-metadata map. Nonempty keys are required and serialized JSON must fit within 1024 UTF-8 bytes; an empty object clears the metadata.";
|
|
10523
10594
|
}];
|
|
10524
10595
|
};
|
|
10596
|
+
}, {
|
|
10597
|
+
readonly resource: "media.libraries.assets.frames";
|
|
10598
|
+
readonly method: "create";
|
|
10599
|
+
readonly summary: "Create frame URLs";
|
|
10600
|
+
readonly description: "Media creates JPEG frame URLs for inspecting one or more moments in a video without downloading the original. Obtain library_id from libraries and asset_id plus duration from assets. Send 1–20 integer microsecond timestamps strictly below duration, for example {\"at_micros\":[0,1000000],\"width\":640}. Only video assets are supported; audio and images return INVALID_PARAMS. Width defaults to 640 and accepts 160, 320 or 640. This read operation does not store a new asset or rerun understanding. Fetch each returned URL to obtain the frame; delivery usage follows media pricing. Authenticated links expire after 300 seconds; upload links remain public and permanent. Reissue expired links. Foreign libraries and assets return 404 without revealing their existence.";
|
|
10601
|
+
readonly http: "POST";
|
|
10602
|
+
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames";
|
|
10603
|
+
readonly streaming: "no";
|
|
10604
|
+
readonly pagination: false;
|
|
10605
|
+
readonly pathParams: readonly [{
|
|
10606
|
+
readonly name: "library_id";
|
|
10607
|
+
readonly sdkName: "library_id";
|
|
10608
|
+
readonly description: "Library identifier returned by library creation or listing; must be accessible to the current credential.";
|
|
10609
|
+
}, {
|
|
10610
|
+
readonly name: "asset_id";
|
|
10611
|
+
readonly sdkName: "asset_id";
|
|
10612
|
+
readonly description: "Video asset identifier returned by asset upload or listing in this library; read its duration before choosing timestamps.";
|
|
10613
|
+
}];
|
|
10614
|
+
readonly query: readonly [];
|
|
10615
|
+
readonly body: {
|
|
10616
|
+
readonly required: true;
|
|
10617
|
+
readonly fields: readonly [{
|
|
10618
|
+
readonly name: "at_micros";
|
|
10619
|
+
readonly type: "array";
|
|
10620
|
+
readonly itemType: "integer";
|
|
10621
|
+
readonly required: true;
|
|
10622
|
+
readonly description: "One to twenty timestamps in microseconds from the start of the video. Each must be a nonnegative safe integer strictly below the video duration; order and duplicates are preserved.";
|
|
10623
|
+
}, {
|
|
10624
|
+
readonly name: "width";
|
|
10625
|
+
readonly type: "integer";
|
|
10626
|
+
readonly enum: readonly [160, 320, 640];
|
|
10627
|
+
readonly required: false;
|
|
10628
|
+
readonly description: "Maximum JPEG width in pixels: 160 is a small thumbnail, 320 a preview and 640 a larger preview. Defaults to 640; larger widths are unavailable.";
|
|
10629
|
+
}];
|
|
10630
|
+
};
|
|
10525
10631
|
}, {
|
|
10526
10632
|
readonly resource: "media.libraries.assets.reprocess";
|
|
10527
10633
|
readonly method: "create";
|
|
10528
10634
|
readonly summary: "Reprocess asset";
|
|
10529
|
-
readonly description: "
|
|
10635
|
+
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.";
|
|
10530
10636
|
readonly http: "POST";
|
|
10531
10637
|
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess";
|
|
10532
10638
|
readonly streaming: "no";
|
|
@@ -10549,14 +10655,14 @@ export declare const operations: readonly [{
|
|
|
10549
10655
|
readonly itemType: "string";
|
|
10550
10656
|
readonly enum: readonly ["visual", "frames", "transcript", "embedding"];
|
|
10551
10657
|
readonly required: false;
|
|
10552
|
-
readonly description: "Processing tasks to rerun. Omit to retry failed tasks
|
|
10658
|
+
readonly description: "Processing tasks to rerun. Omit to retry failed tasks and legacy source-size unsupported tasks; explicit kinds rerun applicable ready or failed tasks and recoverable source-size unsupported tasks. Other unsupported causes remain unchanged. Pending and running tasks are unchanged; an empty array does nothing.";
|
|
10553
10659
|
}];
|
|
10554
10660
|
};
|
|
10555
10661
|
}, {
|
|
10556
10662
|
readonly resource: "media.libraries.assets.understandings";
|
|
10557
10663
|
readonly method: "list";
|
|
10558
10664
|
readonly summary: "List understandings";
|
|
10559
|
-
readonly description: "List an asset
|
|
10665
|
+
readonly description: "List understanding results for an asset, ordered by creation time. Use the cursor to continue; include_superseded also returns replaced records. The optional shots array contains current-version shot boundaries and per-shot captions, scene, location guesses, visible text and confidence flags; it is absent on legacy records. Location guesses and folder mismatch are unverified hints. Correction-enabled transcripts expose text_original, corrected text and a correction audit. Their timed data array remains suitable for subtitles. Reference failure is marked missing; correction failure returns the original verbatim. Model inference uses the existing metered model path.";
|
|
10560
10666
|
readonly http: "GET";
|
|
10561
10667
|
readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/understandings";
|
|
10562
10668
|
readonly streaming: "no";
|
|
@@ -10578,9 +10684,9 @@ export declare const operations: readonly [{
|
|
|
10578
10684
|
}, {
|
|
10579
10685
|
readonly name: "kind";
|
|
10580
10686
|
readonly type: "string";
|
|
10581
|
-
readonly enum: readonly ["caption", "tags", "ocr", "transcript", "frame"];
|
|
10687
|
+
readonly enum: readonly ["caption", "tags", "ocr", "transcript", "frame", "overview", "audio", "embedding"];
|
|
10582
10688
|
readonly required: false;
|
|
10583
|
-
readonly description: "
|
|
10689
|
+
readonly description: "Return one output kind: caption is a visual description, tags are generated labels, ocr is visible text, transcript is speech, frame is a video shot, overview is a video summary, audio is sampled audio understanding, and embedding reports a failed embedding step.";
|
|
10584
10690
|
}, {
|
|
10585
10691
|
readonly name: "cursor";
|
|
10586
10692
|
readonly type: "string";
|
|
@@ -10596,7 +10702,7 @@ export declare const operations: readonly [{
|
|
|
10596
10702
|
readonly resource: "media.libraries.assets";
|
|
10597
10703
|
readonly method: "batch";
|
|
10598
10704
|
readonly summary: "Batch assets alias";
|
|
10599
|
-
readonly description: "
|
|
10705
|
+
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.";
|
|
10600
10706
|
readonly http: "POST";
|
|
10601
10707
|
readonly path: "/media/v1/libraries/{library_id}/assets:batch";
|
|
10602
10708
|
readonly streaming: "no";
|
|
@@ -10614,13 +10720,18 @@ export declare const operations: readonly [{
|
|
|
10614
10720
|
readonly type: "object";
|
|
10615
10721
|
readonly required: true;
|
|
10616
10722
|
readonly description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created.";
|
|
10723
|
+
}, {
|
|
10724
|
+
readonly name: "reason";
|
|
10725
|
+
readonly type: "string";
|
|
10726
|
+
readonly required: false;
|
|
10727
|
+
readonly description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters.";
|
|
10617
10728
|
}];
|
|
10618
10729
|
};
|
|
10619
10730
|
}, {
|
|
10620
10731
|
readonly resource: "media.libraries.batches";
|
|
10621
10732
|
readonly method: "create";
|
|
10622
10733
|
readonly summary: "Create batch";
|
|
10623
|
-
readonly description: "
|
|
10734
|
+
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.";
|
|
10624
10735
|
readonly http: "POST";
|
|
10625
10736
|
readonly path: "/media/v1/libraries/{library_id}/batches";
|
|
10626
10737
|
readonly streaming: "no";
|
|
@@ -10638,13 +10749,18 @@ export declare const operations: readonly [{
|
|
|
10638
10749
|
readonly type: "object";
|
|
10639
10750
|
readonly required: true;
|
|
10640
10751
|
readonly description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created.";
|
|
10752
|
+
}, {
|
|
10753
|
+
readonly name: "reason";
|
|
10754
|
+
readonly type: "string";
|
|
10755
|
+
readonly required: false;
|
|
10756
|
+
readonly description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters.";
|
|
10641
10757
|
}];
|
|
10642
10758
|
};
|
|
10643
10759
|
}, {
|
|
10644
10760
|
readonly resource: "media.libraries.batches";
|
|
10645
10761
|
readonly method: "retrieve";
|
|
10646
10762
|
readonly summary: "Get batch";
|
|
10647
|
-
readonly description: "
|
|
10763
|
+
readonly description: "Alias of batch creation. Apply one metadata or deletion action to ids or a frozen expression selection asynchronously; poll the returned job id to inspect completion and item failures.";
|
|
10648
10764
|
readonly http: "GET";
|
|
10649
10765
|
readonly path: "/media/v1/libraries/{library_id}/batches/{job_id}";
|
|
10650
10766
|
readonly streaming: "no";
|
|
@@ -10663,7 +10779,7 @@ export declare const operations: readonly [{
|
|
|
10663
10779
|
readonly resource: "media.libraries.deliveryTokens";
|
|
10664
10780
|
readonly method: "create";
|
|
10665
10781
|
readonly summary: "Create delivery token";
|
|
10666
|
-
readonly description: "Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is
|
|
10782
|
+
readonly description: "Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is 900 seconds; narrow acl and expires_in before sharing. Anyone holding the token can read matching paths until expires_at.";
|
|
10667
10783
|
readonly http: "POST";
|
|
10668
10784
|
readonly path: "/media/v1/libraries/{library_id}/delivery_tokens";
|
|
10669
10785
|
readonly streaming: "no";
|
|
@@ -10685,14 +10801,14 @@ export declare const operations: readonly [{
|
|
|
10685
10801
|
readonly name: "expires_in";
|
|
10686
10802
|
readonly type: "integer";
|
|
10687
10803
|
readonly required: false;
|
|
10688
|
-
readonly description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to
|
|
10804
|
+
readonly description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 900.";
|
|
10689
10805
|
}];
|
|
10690
10806
|
};
|
|
10691
10807
|
}, {
|
|
10692
10808
|
readonly resource: "media.libraries.events";
|
|
10693
10809
|
readonly method: "list";
|
|
10694
10810
|
readonly summary: "List events";
|
|
10695
|
-
readonly description: "Read library events in sequence order
|
|
10811
|
+
readonly description: "Read library events in sequence order for observing asset writes and understanding progress. Obtain library_id from creation or listing; continue with after_seq for asc or before_seq for desc, without combining both. Use next_cursor when supplied. Reads do not start or retry understanding.";
|
|
10696
10812
|
readonly http: "GET";
|
|
10697
10813
|
readonly path: "/media/v1/libraries/{library_id}/events";
|
|
10698
10814
|
readonly streaming: "no";
|
|
@@ -10728,7 +10844,7 @@ export declare const operations: readonly [{
|
|
|
10728
10844
|
readonly resource: "media.libraries.folders";
|
|
10729
10845
|
readonly method: "list";
|
|
10730
10846
|
readonly summary: "List folders";
|
|
10731
|
-
readonly description: "
|
|
10847
|
+
readonly description: "undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.";
|
|
10732
10848
|
readonly http: "GET";
|
|
10733
10849
|
readonly path: "/media/v1/libraries/{library_id}/folders";
|
|
10734
10850
|
readonly streaming: "no";
|
|
@@ -10744,11 +10860,120 @@ export declare const operations: readonly [{
|
|
|
10744
10860
|
readonly required: false;
|
|
10745
10861
|
readonly description: "Folder whose immediate children are returned. Omit or use an empty string for the library root; invalid folder paths are rejected.";
|
|
10746
10862
|
}];
|
|
10863
|
+
}, {
|
|
10864
|
+
readonly resource: "media.libraries.generations";
|
|
10865
|
+
readonly method: "create";
|
|
10866
|
+
readonly summary: "Create video generation";
|
|
10867
|
+
readonly description: "Create a video.generate job. Generation is charged per second. The response is 202 with a queued Job; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until terminal, then save successful outputs. Unsaved candidate Files expire after 7 days.";
|
|
10868
|
+
readonly http: "POST";
|
|
10869
|
+
readonly path: "/media/v1/libraries/{library_id}/generations";
|
|
10870
|
+
readonly streaming: "no";
|
|
10871
|
+
readonly pagination: false;
|
|
10872
|
+
readonly pathParams: readonly [{
|
|
10873
|
+
readonly name: "library_id";
|
|
10874
|
+
readonly sdkName: "library_id";
|
|
10875
|
+
readonly description: "Library ID returned by creation.";
|
|
10876
|
+
}];
|
|
10877
|
+
readonly query: readonly [];
|
|
10878
|
+
readonly body: {
|
|
10879
|
+
readonly required: true;
|
|
10880
|
+
readonly fields: readonly [{
|
|
10881
|
+
readonly name: "intent";
|
|
10882
|
+
readonly type: "string";
|
|
10883
|
+
readonly required: true;
|
|
10884
|
+
readonly description: "Generation operation; v1 accepts only video.generate text-to-video requests.";
|
|
10885
|
+
}, {
|
|
10886
|
+
readonly name: "prompt";
|
|
10887
|
+
readonly type: "string";
|
|
10888
|
+
readonly required: true;
|
|
10889
|
+
readonly description: "Text prompt describing the video to generate.";
|
|
10890
|
+
}, {
|
|
10891
|
+
readonly name: "count";
|
|
10892
|
+
readonly type: "integer";
|
|
10893
|
+
readonly required: false;
|
|
10894
|
+
readonly description: "Number of videos to generate; defaults to 1 and must be from 1 to 4.";
|
|
10895
|
+
}, {
|
|
10896
|
+
readonly name: "duration_seconds";
|
|
10897
|
+
readonly type: "integer";
|
|
10898
|
+
readonly required: false;
|
|
10899
|
+
readonly description: "Requested video duration in seconds; Router validates the model-specific supported durations.";
|
|
10900
|
+
}, {
|
|
10901
|
+
readonly name: "aspect_ratio";
|
|
10902
|
+
readonly type: "string";
|
|
10903
|
+
readonly required: false;
|
|
10904
|
+
readonly description: "Requested output aspect ratio; defaults to 16:9 and Router validates model support.";
|
|
10905
|
+
}, {
|
|
10906
|
+
readonly name: "model";
|
|
10907
|
+
readonly type: "string";
|
|
10908
|
+
readonly required: false;
|
|
10909
|
+
readonly description: "Router model with video_generation capability; defaults to wan2.7-t2v.";
|
|
10910
|
+
}, {
|
|
10911
|
+
readonly name: "save";
|
|
10912
|
+
readonly type: "string";
|
|
10913
|
+
readonly enum: readonly ["candidate", "library"];
|
|
10914
|
+
readonly required: false;
|
|
10915
|
+
readonly description: "candidate keeps outputs temporary for explicit save calls; library saves successful outputs automatically.";
|
|
10916
|
+
}, {
|
|
10917
|
+
readonly name: "asset_folder";
|
|
10918
|
+
readonly type: "string";
|
|
10919
|
+
readonly required: false;
|
|
10920
|
+
readonly description: "Folder for assets saved automatically or by later save calls; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.";
|
|
10921
|
+
}, {
|
|
10922
|
+
readonly name: "tags";
|
|
10923
|
+
readonly type: "array";
|
|
10924
|
+
readonly itemType: "string";
|
|
10925
|
+
readonly required: false;
|
|
10926
|
+
readonly description: "Tags applied when an output becomes a library asset.";
|
|
10927
|
+
}, {
|
|
10928
|
+
readonly name: "understanding";
|
|
10929
|
+
readonly type: "string";
|
|
10930
|
+
readonly enum: readonly ["auto", "skip"];
|
|
10931
|
+
readonly required: false;
|
|
10932
|
+
readonly description: "Understanding behavior when a candidate is saved as an asset; defaults to auto.";
|
|
10933
|
+
}, {
|
|
10934
|
+
readonly name: "references";
|
|
10935
|
+
readonly type: "array";
|
|
10936
|
+
readonly itemType: "object";
|
|
10937
|
+
readonly required: false;
|
|
10938
|
+
readonly description: "Not supported in v1; omit this field. Only text-to-video is currently available.";
|
|
10939
|
+
}];
|
|
10940
|
+
};
|
|
10941
|
+
}, {
|
|
10942
|
+
readonly resource: "media.libraries.jobs";
|
|
10943
|
+
readonly method: "list";
|
|
10944
|
+
readonly summary: "List jobs";
|
|
10945
|
+
readonly description: "List batch and video-generation jobs in a library. Filter by status and continue with next_cursor. Poll a generation Job until terminal, then save successful candidate outputs before they expire after 7 days.";
|
|
10946
|
+
readonly http: "GET";
|
|
10947
|
+
readonly path: "/media/v1/libraries/{library_id}/jobs";
|
|
10948
|
+
readonly streaming: "no";
|
|
10949
|
+
readonly pagination: true;
|
|
10950
|
+
readonly pathParams: readonly [{
|
|
10951
|
+
readonly name: "library_id";
|
|
10952
|
+
readonly sdkName: "library_id";
|
|
10953
|
+
readonly description: "Library ID returned by creation.";
|
|
10954
|
+
}];
|
|
10955
|
+
readonly query: readonly [{
|
|
10956
|
+
readonly name: "status";
|
|
10957
|
+
readonly type: "string";
|
|
10958
|
+
readonly enum: readonly ["queued", "running", "completed", "completed_with_errors", "failed", "cancelled"];
|
|
10959
|
+
readonly required: false;
|
|
10960
|
+
readonly description: "Filter jobs by their current status.";
|
|
10961
|
+
}, {
|
|
10962
|
+
readonly name: "limit";
|
|
10963
|
+
readonly type: "integer";
|
|
10964
|
+
readonly required: false;
|
|
10965
|
+
readonly description: "Maximum entries in this page, from 1 through 100; defaults to 100.";
|
|
10966
|
+
}, {
|
|
10967
|
+
readonly name: "cursor";
|
|
10968
|
+
readonly type: "string";
|
|
10969
|
+
readonly required: false;
|
|
10970
|
+
readonly description: "Job id from the previous page’s next_cursor; omit for the first page.";
|
|
10971
|
+
}];
|
|
10747
10972
|
}, {
|
|
10748
10973
|
readonly resource: "media.libraries.jobs";
|
|
10749
10974
|
readonly method: "retrieve";
|
|
10750
|
-
readonly summary: "Get job
|
|
10751
|
-
readonly description: "
|
|
10975
|
+
readonly summary: "Get job";
|
|
10976
|
+
readonly description: "Read the current batch or video-generation Job status and progress. For generation, inspect outputs and failures, then save successful candidates before their preview and save window expires after 7 days.";
|
|
10752
10977
|
readonly http: "GET";
|
|
10753
10978
|
readonly path: "/media/v1/libraries/{library_id}/jobs/{job_id}";
|
|
10754
10979
|
readonly streaming: "no";
|
|
@@ -10760,14 +10985,82 @@ export declare const operations: readonly [{
|
|
|
10760
10985
|
}, {
|
|
10761
10986
|
readonly name: "job_id";
|
|
10762
10987
|
readonly sdkName: "job_id";
|
|
10763
|
-
readonly description: "
|
|
10988
|
+
readonly description: "Job identifier returned by batch creation, video-generation creation or job listing; resolved within this library.";
|
|
10989
|
+
}];
|
|
10990
|
+
readonly query: readonly [];
|
|
10991
|
+
}, {
|
|
10992
|
+
readonly resource: "media.libraries.jobs";
|
|
10993
|
+
readonly method: "cancel";
|
|
10994
|
+
readonly summary: "Cancel job";
|
|
10995
|
+
readonly description: "Cancel a queued or running generation job. Already completed outputs remain available to save; poll or read the returned Job to confirm its status.";
|
|
10996
|
+
readonly http: "POST";
|
|
10997
|
+
readonly path: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel";
|
|
10998
|
+
readonly streaming: "no";
|
|
10999
|
+
readonly pagination: false;
|
|
11000
|
+
readonly pathParams: readonly [{
|
|
11001
|
+
readonly name: "library_id";
|
|
11002
|
+
readonly sdkName: "library_id";
|
|
11003
|
+
readonly description: "Library ID returned by creation.";
|
|
11004
|
+
}, {
|
|
11005
|
+
readonly name: "job_id";
|
|
11006
|
+
readonly sdkName: "job_id";
|
|
11007
|
+
readonly description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library.";
|
|
11008
|
+
}];
|
|
11009
|
+
readonly query: readonly [];
|
|
11010
|
+
}, {
|
|
11011
|
+
readonly resource: "media.libraries.jobs.outputs.save";
|
|
11012
|
+
readonly method: "create";
|
|
11013
|
+
readonly summary: "Save generation output";
|
|
11014
|
+
readonly description: "Save a successful candidate as a library asset. Candidate outputs expire after 7 days; save before expiry. Generation is charged per second when the job runs, not when an output is saved.";
|
|
11015
|
+
readonly http: "POST";
|
|
11016
|
+
readonly path: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save";
|
|
11017
|
+
readonly streaming: "no";
|
|
11018
|
+
readonly pagination: false;
|
|
11019
|
+
readonly pathParams: readonly [{
|
|
11020
|
+
readonly name: "library_id";
|
|
11021
|
+
readonly sdkName: "library_id";
|
|
11022
|
+
readonly description: "Library ID returned by creation.";
|
|
11023
|
+
}, {
|
|
11024
|
+
readonly name: "job_id";
|
|
11025
|
+
readonly sdkName: "job_id";
|
|
11026
|
+
readonly description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library.";
|
|
11027
|
+
}, {
|
|
11028
|
+
readonly name: "index";
|
|
11029
|
+
readonly sdkName: "index";
|
|
11030
|
+
readonly description: "Zero-based position of the candidate in the Job outputs array.";
|
|
10764
11031
|
}];
|
|
10765
11032
|
readonly query: readonly [];
|
|
11033
|
+
readonly body: {
|
|
11034
|
+
readonly required: false;
|
|
11035
|
+
readonly fields: readonly [{
|
|
11036
|
+
readonly name: "public_id";
|
|
11037
|
+
readonly type: "string";
|
|
11038
|
+
readonly required: false;
|
|
11039
|
+
readonly description: "Delivery identifier for the saved asset; defaults to gen_<job_id>_<index> and is idempotent.";
|
|
11040
|
+
}, {
|
|
11041
|
+
readonly name: "asset_folder";
|
|
11042
|
+
readonly type: "string";
|
|
11043
|
+
readonly required: false;
|
|
11044
|
+
readonly description: "Destination folder for the saved asset; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.";
|
|
11045
|
+
}, {
|
|
11046
|
+
readonly name: "tags";
|
|
11047
|
+
readonly type: "array";
|
|
11048
|
+
readonly itemType: "string";
|
|
11049
|
+
readonly required: false;
|
|
11050
|
+
readonly description: "Tags to apply to the saved asset.";
|
|
11051
|
+
}, {
|
|
11052
|
+
readonly name: "understanding";
|
|
11053
|
+
readonly type: "string";
|
|
11054
|
+
readonly enum: readonly ["auto", "skip"];
|
|
11055
|
+
readonly required: false;
|
|
11056
|
+
readonly description: "Understanding behavior for the saved asset; defaults to auto.";
|
|
11057
|
+
}];
|
|
11058
|
+
};
|
|
10766
11059
|
}, {
|
|
10767
11060
|
readonly resource: "media.libraries.purge";
|
|
10768
11061
|
readonly method: "create";
|
|
10769
11062
|
readonly summary: "Purge library";
|
|
10770
|
-
readonly description: "
|
|
11063
|
+
readonly description: "List assets in an active library, newest first, optionally filtering by exact folder and stored resource type. Continue using next_cursor; video includes audio-only assets.";
|
|
10771
11064
|
readonly http: "POST";
|
|
10772
11065
|
readonly path: "/media/v1/libraries/{library_id}/purge";
|
|
10773
11066
|
readonly streaming: "no";
|
|
@@ -10782,7 +11075,7 @@ export declare const operations: readonly [{
|
|
|
10782
11075
|
readonly resource: "media.libraries";
|
|
10783
11076
|
readonly method: "restore";
|
|
10784
11077
|
readonly summary: "Restore library";
|
|
10785
|
-
readonly description: "
|
|
11078
|
+
readonly description: "Permanently remove a library that is already deleting, without waiting for purge_at. Its assets and related resources are removed and cannot be restored; first soft-delete an active library.";
|
|
10786
11079
|
readonly http: "POST";
|
|
10787
11080
|
readonly path: "/media/v1/libraries/{library_id}/restore";
|
|
10788
11081
|
readonly streaming: "no";
|
|
@@ -10797,7 +11090,7 @@ export declare const operations: readonly [{
|
|
|
10797
11090
|
readonly resource: "media.libraries.search";
|
|
10798
11091
|
readonly method: "create";
|
|
10799
11092
|
readonly summary: "Semantic search alias";
|
|
10800
|
-
readonly description: "
|
|
11093
|
+
readonly description: "List all immediate child folders under parent, or under the root when parent is omitted. Counts include descendant assets. The result is unpaginated; limit and cursor are rejected.";
|
|
10801
11094
|
readonly http: "POST";
|
|
10802
11095
|
readonly path: "/media/v1/libraries/{library_id}/search";
|
|
10803
11096
|
readonly streaming: "no";
|
|
@@ -10837,7 +11130,7 @@ export declare const operations: readonly [{
|
|
|
10837
11130
|
readonly resource: "media.libraries.search.expression";
|
|
10838
11131
|
readonly method: "create";
|
|
10839
11132
|
readonly summary: "Expression search";
|
|
10840
|
-
readonly description: "
|
|
11133
|
+
readonly description: "Find visually similar assets using exactly one of asset_id or an inline base64 image. The library must support image search; an asset query needs a current image embedding and excludes that source asset from results.";
|
|
10841
11134
|
readonly http: "POST";
|
|
10842
11135
|
readonly path: "/media/v1/libraries/{library_id}/search/expression";
|
|
10843
11136
|
readonly streaming: "no";
|
|
@@ -10854,7 +11147,7 @@ export declare const operations: readonly [{
|
|
|
10854
11147
|
readonly name: "expression";
|
|
10855
11148
|
readonly type: "string";
|
|
10856
11149
|
readonly required: false;
|
|
10857
|
-
readonly description: "Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets. For business metadata use context.sku=KETTLE-RED AND context.revision=2; request with_field: [\"context\"] to include context.";
|
|
11150
|
+
readonly description: "Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets. For business metadata use context.sku=KETTLE-RED AND context.revision=2; request with_field: [\"context\"] to include context. Quality filters: flags:watermark matches any current shot with a watermark; flags.watermark:false requires an assessed video with no positive watermark judgment. The same syntax supports slideshow, hand_frame, text_sticker and low_quality. folder_mismatch:true selects lexical folder/location hints. Geometry filters support width, height, resolution:1920x1080, numeric aspect_ratio (width/height), and orientation:landscape, portrait or square. Missing geometry or unassessed legacy flags do not match positive filters. has_music:true AND audio_genre:jazz AND audio_mood:calm selects current-version audio profiles with music and matching model labels; has_music:false applies only to sampled ranges, not the entire source. failure_code=UPSTREAM_FAILED selects assets with a current failed understanding carrying that code; combine with processing_state=failed or processing_state=partial.";
|
|
10858
11151
|
}, {
|
|
10859
11152
|
readonly name: "sort_by";
|
|
10860
11153
|
readonly type: "array";
|
|
@@ -10891,7 +11184,7 @@ export declare const operations: readonly [{
|
|
|
10891
11184
|
readonly resource: "media.libraries.search.semantic";
|
|
10892
11185
|
readonly method: "create";
|
|
10893
11186
|
readonly summary: "Semantic search";
|
|
10894
|
-
readonly description: "Search assets with a nonblank text query
|
|
11187
|
+
readonly description: "Alias of semantic search. Search assets with a nonblank text query, optional expression filter and top_k; hybrid combines semantic and keyword matches, while semantic uses vector similarity only.";
|
|
10895
11188
|
readonly http: "POST";
|
|
10896
11189
|
readonly path: "/media/v1/libraries/{library_id}/search/semantic";
|
|
10897
11190
|
readonly streaming: "no";
|
|
@@ -10931,7 +11224,7 @@ export declare const operations: readonly [{
|
|
|
10931
11224
|
readonly resource: "media.libraries.search.visual";
|
|
10932
11225
|
readonly method: "create";
|
|
10933
11226
|
readonly summary: "Visual search";
|
|
10934
|
-
readonly description: "
|
|
11227
|
+
readonly description: "Search assets with a nonblank text query and optional expression filter. Hybrid mode combines semantic and keyword matches; semantic mode uses vector similarity only. Results are ranked and limited by top_k.";
|
|
10935
11228
|
readonly http: "POST";
|
|
10936
11229
|
readonly path: "/media/v1/libraries/{library_id}/search/visual";
|
|
10937
11230
|
readonly streaming: "no";
|
|
@@ -10967,19 +11260,69 @@ export declare const operations: readonly [{
|
|
|
10967
11260
|
}];
|
|
10968
11261
|
};
|
|
10969
11262
|
}, {
|
|
10970
|
-
readonly resource: "
|
|
10971
|
-
readonly method: "
|
|
10972
|
-
readonly summary: "
|
|
10973
|
-
readonly description: "
|
|
11263
|
+
readonly resource: "media.libraries.understandings";
|
|
11264
|
+
readonly method: "list";
|
|
11265
|
+
readonly summary: "List understanding results across a library";
|
|
11266
|
+
readonly description: "Read current understanding entries across one library without fetching every asset separately. Use library_id from creation or listing. folder includes descendants; kinds is a comma-separated list of output kinds. Entries are ordered by asset_id and then understanding id. Continue with next_cursor and the same folder and kinds; limit defaults to 100 and cannot exceed 100. Superseded, deleted and old-version entries are excluded. During historical backfill, this method returns 503 CAPACITY rather than incomplete pages; poll failureSummary until counts_complete is true, then start pagination. Example: GET /media/v1/libraries/lib_example/understandings?folder=travel&kinds=caption,transcript&limit=100.";
|
|
10974
11267
|
readonly http: "GET";
|
|
10975
|
-
readonly path: "/
|
|
11268
|
+
readonly path: "/media/v1/libraries/{library_id}/understandings";
|
|
10976
11269
|
readonly streaming: "no";
|
|
10977
|
-
readonly pagination:
|
|
10978
|
-
readonly pathParams: readonly [
|
|
10979
|
-
|
|
10980
|
-
readonly
|
|
10981
|
-
readonly
|
|
10982
|
-
|
|
11270
|
+
readonly pagination: true;
|
|
11271
|
+
readonly pathParams: readonly [{
|
|
11272
|
+
readonly name: "library_id";
|
|
11273
|
+
readonly sdkName: "library_id";
|
|
11274
|
+
readonly description: "Library ID returned by creation.";
|
|
11275
|
+
}];
|
|
11276
|
+
readonly query: readonly [{
|
|
11277
|
+
readonly name: "folder";
|
|
11278
|
+
readonly type: "string";
|
|
11279
|
+
readonly required: false;
|
|
11280
|
+
readonly description: "Folder path including all descendants; omitted or empty selects the entire library.";
|
|
11281
|
+
}, {
|
|
11282
|
+
readonly name: "kinds";
|
|
11283
|
+
readonly type: "string";
|
|
11284
|
+
readonly required: false;
|
|
11285
|
+
readonly description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind.";
|
|
11286
|
+
}, {
|
|
11287
|
+
readonly name: "cursor";
|
|
11288
|
+
readonly type: "string";
|
|
11289
|
+
readonly required: false;
|
|
11290
|
+
readonly description: "Cursor from the previous next_cursor.";
|
|
11291
|
+
}, {
|
|
11292
|
+
readonly name: "limit";
|
|
11293
|
+
readonly type: "integer";
|
|
11294
|
+
readonly required: false;
|
|
11295
|
+
readonly description: "Maximum entries in this page, from 1 through 100; defaults to 100.";
|
|
11296
|
+
}];
|
|
11297
|
+
}, {
|
|
11298
|
+
readonly resource: "media.libraries.understandings";
|
|
11299
|
+
readonly method: "retrieveFailureSummary";
|
|
11300
|
+
readonly summary: "Summarize understanding failures";
|
|
11301
|
+
readonly description: "Inspect current understanding failures before retrying. Use library_id from library creation or listing. Groups include code, output kind, actual producer model, retryability and up to five sample asset IDs. At most 1024 detailed groups plus two overflow groups are returned; overflow groups separate retryable and unrecoverable entries and mark overflow=true. Unknown failure codes remain retryable. Historical counts are provisional while counts_complete is false. Example: GET /media/v1/libraries/lib_example/understandings/failure_summary.";
|
|
11302
|
+
readonly http: "GET";
|
|
11303
|
+
readonly path: "/media/v1/libraries/{library_id}/understandings/failure_summary";
|
|
11304
|
+
readonly streaming: "no";
|
|
11305
|
+
readonly pagination: false;
|
|
11306
|
+
readonly pathParams: readonly [{
|
|
11307
|
+
readonly name: "library_id";
|
|
11308
|
+
readonly sdkName: "library_id";
|
|
11309
|
+
readonly description: "Library ID returned by creation.";
|
|
11310
|
+
}];
|
|
11311
|
+
readonly query: readonly [];
|
|
11312
|
+
}, {
|
|
11313
|
+
readonly resource: "meta.docs";
|
|
11314
|
+
readonly method: "search";
|
|
11315
|
+
readonly summary: "Search platform documentation";
|
|
11316
|
+
readonly description: "Find guides and references by keyword before reading them with praxis.meta.docs.retrieve. Public; no API key required. Matches documentation titles, headings and page text without case sensitivity; all query words must occur. q is required; limit defaults to 20 and accepts 1–50. lang defaults to zh or use en for English. Returns paths, page titles, canonical URLs and short matching snippets; no matches returns an empty array.";
|
|
11317
|
+
readonly http: "GET";
|
|
11318
|
+
readonly path: "/meta/v1/docs/search";
|
|
11319
|
+
readonly streaming: "no";
|
|
11320
|
+
readonly pagination: false;
|
|
11321
|
+
readonly pathParams: readonly [];
|
|
11322
|
+
readonly query: readonly [{
|
|
11323
|
+
readonly name: "q";
|
|
11324
|
+
readonly type: "string";
|
|
11325
|
+
readonly required: true;
|
|
10983
11326
|
readonly description: "Keywords describing the syntax or guide needed, for example export or workflow.";
|
|
10984
11327
|
}, {
|
|
10985
11328
|
readonly name: "limit";
|
|
@@ -11179,35 +11522,35 @@ export declare const operations: readonly [{
|
|
|
11179
11522
|
readonly name: "model";
|
|
11180
11523
|
readonly type: "string";
|
|
11181
11524
|
readonly required: true;
|
|
11182
|
-
readonly description: "
|
|
11525
|
+
readonly description: "Model catalog identifier declaring openai.audio.transcriptions; use it unchanged, including any creator prefix.";
|
|
11183
11526
|
}, {
|
|
11184
11527
|
readonly name: "file";
|
|
11185
11528
|
readonly type: "string";
|
|
11186
11529
|
readonly required: true;
|
|
11187
|
-
readonly description: "Audio
|
|
11530
|
+
readonly description: "Audio bytes uploaded as a multipart file; supported formats and input limits depend on the selected model.";
|
|
11188
11531
|
}, {
|
|
11189
11532
|
readonly name: "language";
|
|
11190
11533
|
readonly type: "string";
|
|
11191
11534
|
readonly required: false;
|
|
11192
|
-
readonly description: "
|
|
11535
|
+
readonly description: "Source language code when known; omit to let the model detect the language.";
|
|
11193
11536
|
}, {
|
|
11194
11537
|
readonly name: "prompt";
|
|
11195
11538
|
readonly type: "string";
|
|
11196
11539
|
readonly required: false;
|
|
11197
|
-
readonly description: "
|
|
11540
|
+
readonly description: "Optional vocabulary or contextual guidance for recognizing the audio; support depends on the selected model.";
|
|
11198
11541
|
}, {
|
|
11199
11542
|
readonly name: "response_format";
|
|
11200
11543
|
readonly type: "string";
|
|
11201
|
-
readonly enum: readonly ["json", "text", "verbose_json"];
|
|
11544
|
+
readonly enum: readonly ["json", "text", "verbose_json", "diarized_json"];
|
|
11202
11545
|
readonly required: false;
|
|
11203
|
-
readonly description: "
|
|
11546
|
+
readonly description: "Output format: json returns text in JSON; text returns plain text; verbose_json includes requested timestamps; diarized_json includes speaker-labelled segments when supported. Defaults to json.";
|
|
11204
11547
|
}, {
|
|
11205
11548
|
readonly name: "timestamp_granularities[]";
|
|
11206
11549
|
readonly type: "array";
|
|
11207
11550
|
readonly itemType: "string";
|
|
11208
|
-
readonly enum: readonly ["segment"];
|
|
11551
|
+
readonly enum: readonly ["word", "segment"];
|
|
11209
11552
|
readonly required: false;
|
|
11210
|
-
readonly description: "Timestamp levels to
|
|
11553
|
+
readonly description: "Timestamp levels to request as repeated multipart fields: word returns per-word times; segment returns segment times. Omit for the model default. Use verbose_json, or diarized_json on supporting models.";
|
|
11211
11554
|
}, {
|
|
11212
11555
|
readonly name: "temperature";
|
|
11213
11556
|
readonly type: "number";
|
|
@@ -12772,6 +13115,451 @@ export declare const operations: readonly [{
|
|
|
12772
13115
|
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.";
|
|
12773
13116
|
}];
|
|
12774
13117
|
readonly query: readonly [];
|
|
13118
|
+
}, {
|
|
13119
|
+
readonly resource: "ontology.changesets";
|
|
13120
|
+
readonly method: "create";
|
|
13121
|
+
readonly summary: "Apply changeset";
|
|
13122
|
+
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.";
|
|
13123
|
+
readonly http: "POST";
|
|
13124
|
+
readonly path: "/ontology/v1/changesets";
|
|
13125
|
+
readonly streaming: "no";
|
|
13126
|
+
readonly pagination: false;
|
|
13127
|
+
readonly pathParams: readonly [];
|
|
13128
|
+
readonly query: readonly [];
|
|
13129
|
+
readonly body: {
|
|
13130
|
+
readonly required: true;
|
|
13131
|
+
readonly fields: readonly [{
|
|
13132
|
+
readonly name: "at";
|
|
13133
|
+
readonly type: "string";
|
|
13134
|
+
readonly required: true;
|
|
13135
|
+
readonly description: "World time the batch describes, in ISO 8601 UTC; operations without their own time are dated by it.";
|
|
13136
|
+
}, {
|
|
13137
|
+
readonly name: "scope";
|
|
13138
|
+
readonly type: "string";
|
|
13139
|
+
readonly required: false;
|
|
13140
|
+
readonly description: "Scope the batch came from, normally the session id it was observed in; it is stored with the operations for later reading.";
|
|
13141
|
+
}, {
|
|
13142
|
+
readonly name: "ops";
|
|
13143
|
+
readonly type: "array";
|
|
13144
|
+
readonly itemType: "object";
|
|
13145
|
+
readonly required: true;
|
|
13146
|
+
readonly description: "At most 500 operations, applied in order; each names its kind in op and the fields that kind requires.";
|
|
13147
|
+
}];
|
|
13148
|
+
};
|
|
13149
|
+
}, {
|
|
13150
|
+
readonly resource: "ontology.nodes";
|
|
13151
|
+
readonly method: "list";
|
|
13152
|
+
readonly summary: "List nodes";
|
|
13153
|
+
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.";
|
|
13154
|
+
readonly http: "GET";
|
|
13155
|
+
readonly path: "/ontology/v1/nodes";
|
|
13156
|
+
readonly streaming: "no";
|
|
13157
|
+
readonly pagination: true;
|
|
13158
|
+
readonly pathParams: readonly [];
|
|
13159
|
+
readonly query: readonly [{
|
|
13160
|
+
readonly name: "type";
|
|
13161
|
+
readonly type: "array";
|
|
13162
|
+
readonly itemType: "string";
|
|
13163
|
+
readonly required: false;
|
|
13164
|
+
readonly description: "Repeat to filter to any of several registered node type names, for example type=file&type=ticket; omit to list every type.";
|
|
13165
|
+
}, {
|
|
13166
|
+
readonly name: "q";
|
|
13167
|
+
readonly type: "string";
|
|
13168
|
+
readonly required: false;
|
|
13169
|
+
readonly description: "Free text matched against node names, aliases and descriptions; omit to list without a text filter.";
|
|
13170
|
+
}, {
|
|
13171
|
+
readonly name: "owner";
|
|
13172
|
+
readonly type: "string";
|
|
13173
|
+
readonly required: false;
|
|
13174
|
+
readonly description: "Filter to nodes owned by this member id, or omit to list nodes of every owner; organization-wide nodes carry no owner.";
|
|
13175
|
+
}, {
|
|
13176
|
+
readonly name: "as_of";
|
|
13177
|
+
readonly type: "string";
|
|
13178
|
+
readonly required: false;
|
|
13179
|
+
readonly description: "ISO 8601 timestamp; return the graph as it was then, so a node recorded later is absent. Omit to read current state.";
|
|
13180
|
+
}, {
|
|
13181
|
+
readonly name: "limit";
|
|
13182
|
+
readonly type: "integer";
|
|
13183
|
+
readonly required: false;
|
|
13184
|
+
readonly description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100.";
|
|
13185
|
+
}, {
|
|
13186
|
+
readonly name: "cursor";
|
|
13187
|
+
readonly type: "string";
|
|
13188
|
+
readonly required: false;
|
|
13189
|
+
readonly description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null.";
|
|
13190
|
+
}];
|
|
13191
|
+
}, {
|
|
13192
|
+
readonly resource: "ontology.nodes";
|
|
13193
|
+
readonly method: "create";
|
|
13194
|
+
readonly summary: "Create node";
|
|
13195
|
+
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.";
|
|
13196
|
+
readonly http: "POST";
|
|
13197
|
+
readonly path: "/ontology/v1/nodes";
|
|
13198
|
+
readonly streaming: "no";
|
|
13199
|
+
readonly pagination: false;
|
|
13200
|
+
readonly pathParams: readonly [];
|
|
13201
|
+
readonly query: readonly [];
|
|
13202
|
+
readonly body: {
|
|
13203
|
+
readonly required: true;
|
|
13204
|
+
readonly fields: readonly [{
|
|
13205
|
+
readonly name: "type";
|
|
13206
|
+
readonly type: "string";
|
|
13207
|
+
readonly required: true;
|
|
13208
|
+
readonly description: "Registered node type name from types.list; an unregistered name is refused and nothing is written.";
|
|
13209
|
+
}, {
|
|
13210
|
+
readonly name: "ref";
|
|
13211
|
+
readonly type: "string";
|
|
13212
|
+
readonly required: false;
|
|
13213
|
+
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.";
|
|
13214
|
+
}, {
|
|
13215
|
+
readonly name: "name";
|
|
13216
|
+
readonly type: "string";
|
|
13217
|
+
readonly required: true;
|
|
13218
|
+
readonly description: "Display name of the entity, at most 200 characters.";
|
|
13219
|
+
}, {
|
|
13220
|
+
readonly name: "aliases";
|
|
13221
|
+
readonly type: "array";
|
|
13222
|
+
readonly itemType: "string";
|
|
13223
|
+
readonly required: false;
|
|
13224
|
+
readonly description: "Other names this entity is known by; they are matched by search alongside the name.";
|
|
13225
|
+
}, {
|
|
13226
|
+
readonly name: "description";
|
|
13227
|
+
readonly type: "string";
|
|
13228
|
+
readonly required: false;
|
|
13229
|
+
readonly description: "Profile of the entity, at most 500 characters; omit or null for none.";
|
|
13230
|
+
}, {
|
|
13231
|
+
readonly name: "owner";
|
|
13232
|
+
readonly type: "string";
|
|
13233
|
+
readonly required: false;
|
|
13234
|
+
readonly description: "Member id whose content this is, restricting it to that member; omit or null to make it readable organization-wide.";
|
|
13235
|
+
}];
|
|
13236
|
+
};
|
|
13237
|
+
}, {
|
|
13238
|
+
readonly resource: "ontology.nodes";
|
|
13239
|
+
readonly method: "retrieve";
|
|
13240
|
+
readonly summary: "Retrieve node";
|
|
13241
|
+
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.";
|
|
13242
|
+
readonly http: "GET";
|
|
13243
|
+
readonly path: "/ontology/v1/nodes/{node_id}";
|
|
13244
|
+
readonly streaming: "no";
|
|
13245
|
+
readonly pagination: false;
|
|
13246
|
+
readonly pathParams: readonly [{
|
|
13247
|
+
readonly name: "node_id";
|
|
13248
|
+
readonly sdkName: "node_id";
|
|
13249
|
+
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.";
|
|
13250
|
+
}];
|
|
13251
|
+
readonly query: readonly [{
|
|
13252
|
+
readonly name: "expand";
|
|
13253
|
+
readonly type: "string";
|
|
13254
|
+
readonly enum: readonly ["relations"];
|
|
13255
|
+
readonly required: false;
|
|
13256
|
+
readonly description: "Set to relations to include the node's incoming and outgoing relations in the same response; omit for the node alone.";
|
|
13257
|
+
}, {
|
|
13258
|
+
readonly name: "as_of";
|
|
13259
|
+
readonly type: "string";
|
|
13260
|
+
readonly required: false;
|
|
13261
|
+
readonly description: "ISO 8601 timestamp; read the node and its relations as they were then, including relations invalidated since. Omit to read current state.";
|
|
13262
|
+
}];
|
|
13263
|
+
}, {
|
|
13264
|
+
readonly resource: "ontology.nodes";
|
|
13265
|
+
readonly method: "update";
|
|
13266
|
+
readonly summary: "Update node";
|
|
13267
|
+
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.";
|
|
13268
|
+
readonly http: "PATCH";
|
|
13269
|
+
readonly path: "/ontology/v1/nodes/{node_id}";
|
|
13270
|
+
readonly streaming: "no";
|
|
13271
|
+
readonly pagination: false;
|
|
13272
|
+
readonly pathParams: readonly [{
|
|
13273
|
+
readonly name: "node_id";
|
|
13274
|
+
readonly sdkName: "node_id";
|
|
13275
|
+
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.";
|
|
13276
|
+
}];
|
|
13277
|
+
readonly query: readonly [];
|
|
13278
|
+
readonly body: {
|
|
13279
|
+
readonly required: true;
|
|
13280
|
+
readonly fields: readonly [{
|
|
13281
|
+
readonly name: "name";
|
|
13282
|
+
readonly type: "string";
|
|
13283
|
+
readonly required: false;
|
|
13284
|
+
readonly description: "New display name, at most 200 characters; omit to keep the current name.";
|
|
13285
|
+
}, {
|
|
13286
|
+
readonly name: "aliases";
|
|
13287
|
+
readonly type: "array";
|
|
13288
|
+
readonly itemType: "string";
|
|
13289
|
+
readonly required: false;
|
|
13290
|
+
readonly description: "Replacement alias list; an empty array clears the aliases and omitting the field keeps them.";
|
|
13291
|
+
}, {
|
|
13292
|
+
readonly name: "description";
|
|
13293
|
+
readonly type: "string";
|
|
13294
|
+
readonly required: false;
|
|
13295
|
+
readonly description: "Replacement profile, at most 500 characters; an explicit null clears it and omitting the field keeps it.";
|
|
13296
|
+
}];
|
|
13297
|
+
};
|
|
13298
|
+
}, {
|
|
13299
|
+
readonly resource: "ontology.nodes.merge";
|
|
13300
|
+
readonly method: "create";
|
|
13301
|
+
readonly summary: "Merge node";
|
|
13302
|
+
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.";
|
|
13303
|
+
readonly http: "POST";
|
|
13304
|
+
readonly path: "/ontology/v1/nodes/{node_id}/merge";
|
|
13305
|
+
readonly streaming: "no";
|
|
13306
|
+
readonly pagination: false;
|
|
13307
|
+
readonly pathParams: readonly [{
|
|
13308
|
+
readonly name: "node_id";
|
|
13309
|
+
readonly sdkName: "node_id";
|
|
13310
|
+
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.";
|
|
13311
|
+
}];
|
|
13312
|
+
readonly query: readonly [];
|
|
13313
|
+
readonly body: {
|
|
13314
|
+
readonly required: true;
|
|
13315
|
+
readonly fields: readonly [{
|
|
13316
|
+
readonly name: "into";
|
|
13317
|
+
readonly type: "string";
|
|
13318
|
+
readonly required: true;
|
|
13319
|
+
readonly description: "Node id that should survive, from nodes.list or search; the merged node's relations and aliases move to it.";
|
|
13320
|
+
}];
|
|
13321
|
+
};
|
|
13322
|
+
}, {
|
|
13323
|
+
readonly resource: "ontology.relations";
|
|
13324
|
+
readonly method: "list";
|
|
13325
|
+
readonly summary: "List relations";
|
|
13326
|
+
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.";
|
|
13327
|
+
readonly http: "GET";
|
|
13328
|
+
readonly path: "/ontology/v1/relations";
|
|
13329
|
+
readonly streaming: "no";
|
|
13330
|
+
readonly pagination: true;
|
|
13331
|
+
readonly pathParams: readonly [];
|
|
13332
|
+
readonly query: readonly [{
|
|
13333
|
+
readonly name: "node";
|
|
13334
|
+
readonly type: "string";
|
|
13335
|
+
readonly required: false;
|
|
13336
|
+
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.";
|
|
13337
|
+
}, {
|
|
13338
|
+
readonly name: "type";
|
|
13339
|
+
readonly type: "array";
|
|
13340
|
+
readonly itemType: "string";
|
|
13341
|
+
readonly required: false;
|
|
13342
|
+
readonly description: "Repeat to filter to any of several registered relation type names, for example type=references&type=serves; omit to list every type.";
|
|
13343
|
+
}, {
|
|
13344
|
+
readonly name: "direction";
|
|
13345
|
+
readonly type: "string";
|
|
13346
|
+
readonly enum: readonly ["out", "in", "both"];
|
|
13347
|
+
readonly required: false;
|
|
13348
|
+
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.";
|
|
13349
|
+
}, {
|
|
13350
|
+
readonly name: "as_of";
|
|
13351
|
+
readonly type: "string";
|
|
13352
|
+
readonly required: false;
|
|
13353
|
+
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.";
|
|
13354
|
+
}, {
|
|
13355
|
+
readonly name: "include_invalid";
|
|
13356
|
+
readonly type: "boolean";
|
|
13357
|
+
readonly required: false;
|
|
13358
|
+
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.";
|
|
13359
|
+
}, {
|
|
13360
|
+
readonly name: "limit";
|
|
13361
|
+
readonly type: "integer";
|
|
13362
|
+
readonly required: false;
|
|
13363
|
+
readonly description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100.";
|
|
13364
|
+
}, {
|
|
13365
|
+
readonly name: "cursor";
|
|
13366
|
+
readonly type: "string";
|
|
13367
|
+
readonly required: false;
|
|
13368
|
+
readonly description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null.";
|
|
13369
|
+
}];
|
|
13370
|
+
}, {
|
|
13371
|
+
readonly resource: "ontology.relations";
|
|
13372
|
+
readonly method: "create";
|
|
13373
|
+
readonly summary: "Create relation";
|
|
13374
|
+
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.";
|
|
13375
|
+
readonly http: "POST";
|
|
13376
|
+
readonly path: "/ontology/v1/relations";
|
|
13377
|
+
readonly streaming: "no";
|
|
13378
|
+
readonly pagination: false;
|
|
13379
|
+
readonly pathParams: readonly [];
|
|
13380
|
+
readonly query: readonly [];
|
|
13381
|
+
readonly body: {
|
|
13382
|
+
readonly required: true;
|
|
13383
|
+
readonly fields: readonly [{
|
|
13384
|
+
readonly name: "type";
|
|
13385
|
+
readonly type: "string";
|
|
13386
|
+
readonly required: true;
|
|
13387
|
+
readonly description: "Registered relation type name from types.list; it must admit both endpoints or the write is refused.";
|
|
13388
|
+
}, {
|
|
13389
|
+
readonly name: "source";
|
|
13390
|
+
readonly type: "string";
|
|
13391
|
+
readonly required: true;
|
|
13392
|
+
readonly description: "Node id the fact starts from, from nodes.list or nodes.create.";
|
|
13393
|
+
}, {
|
|
13394
|
+
readonly name: "target";
|
|
13395
|
+
readonly type: "string";
|
|
13396
|
+
readonly required: true;
|
|
13397
|
+
readonly description: "Node id the fact points at, from nodes.list or nodes.create.";
|
|
13398
|
+
}, {
|
|
13399
|
+
readonly name: "fact";
|
|
13400
|
+
readonly type: "string";
|
|
13401
|
+
readonly required: true;
|
|
13402
|
+
readonly description: "The relationship in one sentence, at most 280 characters, written to read back on its own.";
|
|
13403
|
+
}, {
|
|
13404
|
+
readonly name: "valid_at";
|
|
13405
|
+
readonly type: "string";
|
|
13406
|
+
readonly required: false;
|
|
13407
|
+
readonly description: "World time the fact became true, when the mirrored record dates it; omit to leave it undated.";
|
|
13408
|
+
}, {
|
|
13409
|
+
readonly name: "owner";
|
|
13410
|
+
readonly type: "string";
|
|
13411
|
+
readonly required: false;
|
|
13412
|
+
readonly description: "Member id whose content this fact is, restricting it to that member; omit or null for organization-wide.";
|
|
13413
|
+
}];
|
|
13414
|
+
};
|
|
13415
|
+
}, {
|
|
13416
|
+
readonly resource: "ontology.relations";
|
|
13417
|
+
readonly method: "retrieve";
|
|
13418
|
+
readonly summary: "Retrieve relation";
|
|
13419
|
+
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.";
|
|
13420
|
+
readonly http: "GET";
|
|
13421
|
+
readonly path: "/ontology/v1/relations/{relation_id}";
|
|
13422
|
+
readonly streaming: "no";
|
|
13423
|
+
readonly pagination: false;
|
|
13424
|
+
readonly pathParams: readonly [{
|
|
13425
|
+
readonly name: "relation_id";
|
|
13426
|
+
readonly sdkName: "relation_id";
|
|
13427
|
+
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.";
|
|
13428
|
+
}];
|
|
13429
|
+
readonly query: readonly [];
|
|
13430
|
+
}, {
|
|
13431
|
+
readonly resource: "ontology.relations.invalidate";
|
|
13432
|
+
readonly method: "create";
|
|
13433
|
+
readonly summary: "Invalidate relation";
|
|
13434
|
+
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.";
|
|
13435
|
+
readonly http: "POST";
|
|
13436
|
+
readonly path: "/ontology/v1/relations/{relation_id}/invalidate";
|
|
13437
|
+
readonly streaming: "no";
|
|
13438
|
+
readonly pagination: false;
|
|
13439
|
+
readonly pathParams: readonly [{
|
|
13440
|
+
readonly name: "relation_id";
|
|
13441
|
+
readonly sdkName: "relation_id";
|
|
13442
|
+
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.";
|
|
13443
|
+
}];
|
|
13444
|
+
readonly query: readonly [];
|
|
13445
|
+
readonly body: {
|
|
13446
|
+
readonly required: true;
|
|
13447
|
+
readonly fields: readonly [{
|
|
13448
|
+
readonly name: "invalid_at";
|
|
13449
|
+
readonly type: "string";
|
|
13450
|
+
readonly required: true;
|
|
13451
|
+
readonly description: "World time the fact stopped being true, in ISO 8601 UTC; reads at an earlier as_of still return the relation.";
|
|
13452
|
+
}, {
|
|
13453
|
+
readonly name: "superseded_by";
|
|
13454
|
+
readonly type: "string";
|
|
13455
|
+
readonly required: false;
|
|
13456
|
+
readonly description: "Relation id that replaces this one, when a successor was recorded; omit or null when nothing replaced it.";
|
|
13457
|
+
}, {
|
|
13458
|
+
readonly name: "reason";
|
|
13459
|
+
readonly type: "string";
|
|
13460
|
+
readonly required: false;
|
|
13461
|
+
readonly description: "Why it stopped being true, for people reading the history later; not enforced and safe to omit.";
|
|
13462
|
+
}];
|
|
13463
|
+
};
|
|
13464
|
+
}, {
|
|
13465
|
+
readonly resource: "ontology.search";
|
|
13466
|
+
readonly method: "create";
|
|
13467
|
+
readonly summary: "Search nodes";
|
|
13468
|
+
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.";
|
|
13469
|
+
readonly http: "POST";
|
|
13470
|
+
readonly path: "/ontology/v1/search";
|
|
13471
|
+
readonly streaming: "no";
|
|
13472
|
+
readonly pagination: false;
|
|
13473
|
+
readonly pathParams: readonly [];
|
|
13474
|
+
readonly query: readonly [];
|
|
13475
|
+
readonly body: {
|
|
13476
|
+
readonly required: true;
|
|
13477
|
+
readonly fields: readonly [{
|
|
13478
|
+
readonly name: "text";
|
|
13479
|
+
readonly type: "string";
|
|
13480
|
+
readonly required: true;
|
|
13481
|
+
readonly description: "Text to find nodes for, matched against names, aliases, descriptions and relation facts; an empty string is refused.";
|
|
13482
|
+
}, {
|
|
13483
|
+
readonly name: "types";
|
|
13484
|
+
readonly type: "array";
|
|
13485
|
+
readonly itemType: "string";
|
|
13486
|
+
readonly required: false;
|
|
13487
|
+
readonly description: "Registered node type names to search within; omit to search every type.";
|
|
13488
|
+
}, {
|
|
13489
|
+
readonly name: "window";
|
|
13490
|
+
readonly type: "object";
|
|
13491
|
+
readonly required: false;
|
|
13492
|
+
readonly description: "Restrict matches to facts recorded within a period; omit to search all time.";
|
|
13493
|
+
}, {
|
|
13494
|
+
readonly name: "limit";
|
|
13495
|
+
readonly type: "integer";
|
|
13496
|
+
readonly required: false;
|
|
13497
|
+
readonly description: "Maximum candidate nodes to return, from 1 to 50; defaults to 20 when omitted.";
|
|
13498
|
+
}];
|
|
13499
|
+
};
|
|
13500
|
+
}, {
|
|
13501
|
+
readonly resource: "ontology.types";
|
|
13502
|
+
readonly method: "list";
|
|
13503
|
+
readonly summary: "List types";
|
|
13504
|
+
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.";
|
|
13505
|
+
readonly http: "GET";
|
|
13506
|
+
readonly path: "/ontology/v1/types";
|
|
13507
|
+
readonly streaming: "no";
|
|
13508
|
+
readonly pagination: false;
|
|
13509
|
+
readonly pathParams: readonly [];
|
|
13510
|
+
readonly query: readonly [];
|
|
13511
|
+
}, {
|
|
13512
|
+
readonly resource: "ontology.types";
|
|
13513
|
+
readonly method: "create";
|
|
13514
|
+
readonly summary: "Register type";
|
|
13515
|
+
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.";
|
|
13516
|
+
readonly http: "POST";
|
|
13517
|
+
readonly path: "/ontology/v1/types";
|
|
13518
|
+
readonly streaming: "no";
|
|
13519
|
+
readonly pagination: false;
|
|
13520
|
+
readonly pathParams: readonly [];
|
|
13521
|
+
readonly query: readonly [];
|
|
13522
|
+
readonly body: {
|
|
13523
|
+
readonly required: true;
|
|
13524
|
+
readonly fields: readonly [{
|
|
13525
|
+
readonly name: "owner";
|
|
13526
|
+
readonly type: "string";
|
|
13527
|
+
readonly required: true;
|
|
13528
|
+
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.";
|
|
13529
|
+
}, {
|
|
13530
|
+
readonly name: "version";
|
|
13531
|
+
readonly type: "integer";
|
|
13532
|
+
readonly required: true;
|
|
13533
|
+
readonly description: "Monotonic version of this owner's registration; a later registration must extend this one without removing or narrowing anything.";
|
|
13534
|
+
}, {
|
|
13535
|
+
readonly name: "nodes";
|
|
13536
|
+
readonly type: "array";
|
|
13537
|
+
readonly itemType: "object";
|
|
13538
|
+
readonly required: true;
|
|
13539
|
+
readonly description: "Node types this owner registers.";
|
|
13540
|
+
}, {
|
|
13541
|
+
readonly name: "edges";
|
|
13542
|
+
readonly type: "array";
|
|
13543
|
+
readonly itemType: "object";
|
|
13544
|
+
readonly required: true;
|
|
13545
|
+
readonly description: "Relation types this owner registers.";
|
|
13546
|
+
}];
|
|
13547
|
+
};
|
|
13548
|
+
}, {
|
|
13549
|
+
readonly resource: "ontology.types";
|
|
13550
|
+
readonly method: "retrieve";
|
|
13551
|
+
readonly summary: "Retrieve type";
|
|
13552
|
+
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.";
|
|
13553
|
+
readonly http: "GET";
|
|
13554
|
+
readonly path: "/ontology/v1/types/{name}";
|
|
13555
|
+
readonly streaming: "no";
|
|
13556
|
+
readonly pagination: false;
|
|
13557
|
+
readonly pathParams: readonly [{
|
|
13558
|
+
readonly name: "name";
|
|
13559
|
+
readonly sdkName: "name";
|
|
13560
|
+
readonly description: "A type name from types.list, with its dots preserved — a display label is not accepted.";
|
|
13561
|
+
}];
|
|
13562
|
+
readonly query: readonly [];
|
|
12775
13563
|
}, {
|
|
12776
13564
|
readonly resource: "organization.charges";
|
|
12777
13565
|
readonly method: "list";
|
|
@@ -13067,6 +13855,27 @@ export declare const operations: readonly [{
|
|
|
13067
13855
|
readonly description: "Up to five attachments; decoded bytes must not exceed 10 MiB each or 20 MiB in total.";
|
|
13068
13856
|
}];
|
|
13069
13857
|
};
|
|
13858
|
+
}, {
|
|
13859
|
+
readonly resource: "organization.members";
|
|
13860
|
+
readonly method: "list";
|
|
13861
|
+
readonly summary: "List organization members";
|
|
13862
|
+
readonly description: "Concepts follow GitHub org members: find a person's user id, for example to assign an approver to an approval task. Lists only members of the organization behind your API key or runtime token, ordered by joined_at ascending (membership id breaks ties). Ask the user who should approve, then use that member's id. Emails are visible only within this organization. The request cannot select another organization. Pass next_page unchanged as page; null means the end. Read-only; no usage charge. Example: GET /organization/v1/members?limit=20.";
|
|
13863
|
+
readonly http: "GET";
|
|
13864
|
+
readonly path: "/organization/v1/members";
|
|
13865
|
+
readonly streaming: "no";
|
|
13866
|
+
readonly pagination: false;
|
|
13867
|
+
readonly pathParams: readonly [];
|
|
13868
|
+
readonly query: readonly [{
|
|
13869
|
+
readonly name: "limit";
|
|
13870
|
+
readonly type: "integer";
|
|
13871
|
+
readonly required: false;
|
|
13872
|
+
readonly description: "Maximum members per page, from 1 to 100; defaults to 20.";
|
|
13873
|
+
}, {
|
|
13874
|
+
readonly name: "page";
|
|
13875
|
+
readonly type: "string";
|
|
13876
|
+
readonly required: false;
|
|
13877
|
+
readonly description: "Opaque next_page cursor returned by the previous response; omit for the first page.";
|
|
13878
|
+
}];
|
|
13070
13879
|
}, {
|
|
13071
13880
|
readonly resource: "organization.usage";
|
|
13072
13881
|
readonly method: "list";
|
|
@@ -14803,7 +15612,7 @@ export declare const operations: readonly [{
|
|
|
14803
15612
|
readonly resource: "ticket.labels";
|
|
14804
15613
|
readonly method: "create";
|
|
14805
15614
|
readonly summary: "Create or add labels";
|
|
14806
|
-
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.
|
|
15615
|
+
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.";
|
|
14807
15616
|
readonly http: "POST";
|
|
14808
15617
|
readonly path: "/ticket/v1/labels";
|
|
14809
15618
|
readonly streaming: "no";
|
|
@@ -14838,7 +15647,7 @@ export declare const operations: readonly [{
|
|
|
14838
15647
|
readonly resource: "ticket.labels";
|
|
14839
15648
|
readonly method: "delete";
|
|
14840
15649
|
readonly summary: "Remove labels";
|
|
14841
|
-
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.
|
|
15650
|
+
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.";
|
|
14842
15651
|
readonly http: "DELETE";
|
|
14843
15652
|
readonly path: "/ticket/v1/labels/{name}";
|
|
14844
15653
|
readonly streaming: "no";
|
|
@@ -14858,7 +15667,7 @@ export declare const operations: readonly [{
|
|
|
14858
15667
|
readonly resource: "ticket.labels";
|
|
14859
15668
|
readonly method: "update";
|
|
14860
15669
|
readonly summary: "Update labels";
|
|
14861
|
-
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.
|
|
15670
|
+
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.";
|
|
14862
15671
|
readonly http: "PATCH";
|
|
14863
15672
|
readonly path: "/ticket/v1/labels/{name}";
|
|
14864
15673
|
readonly streaming: "no";
|
|
@@ -15098,7 +15907,7 @@ export declare const operations: readonly [{
|
|
|
15098
15907
|
readonly name: "filter";
|
|
15099
15908
|
readonly type: "string";
|
|
15100
15909
|
readonly required: false;
|
|
15101
|
-
readonly description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort;
|
|
15910
|
+
readonly description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort; write each qualifier as field:value (for example, is:open milestone:5), never field=value. Unknown qualifiers return INVALID_PARAMS. Passed unchanged to the service.";
|
|
15102
15911
|
}];
|
|
15103
15912
|
}, {
|
|
15104
15913
|
readonly resource: "ticket.tickets";
|
|
@@ -15992,7 +16801,7 @@ export declare const operations: readonly [{
|
|
|
15992
16801
|
readonly resource: "vault.vaults";
|
|
15993
16802
|
readonly method: "create";
|
|
15994
16803
|
readonly summary: "Create vault";
|
|
15995
|
-
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.
|
|
16804
|
+
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.";
|
|
15996
16805
|
readonly http: "POST";
|
|
15997
16806
|
readonly path: "/vault/v1/vaults";
|
|
15998
16807
|
readonly streaming: "no";
|