@seclai/sdk 1.1.5 → 1.3.0
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/README.md +42 -1
- package/dist/index.cjs +64 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +567 -25
- package/dist/index.d.ts +567 -25
- package/dist/index.js +64 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -20,6 +20,47 @@ interface components {
|
|
|
20
20
|
*/
|
|
21
21
|
user_input: string;
|
|
22
22
|
};
|
|
23
|
+
/**
|
|
24
|
+
* AgentAttachmentRefsApiResponse
|
|
25
|
+
* @description Static attachment-reference contract for an agent.
|
|
26
|
+
*
|
|
27
|
+
* Mirrors the MCP ``get_agent_attachment_references`` tool: returns
|
|
28
|
+
* what files (if any) an agent's templates expect on a run so API
|
|
29
|
+
* consumers can stage uploads correctly before calling
|
|
30
|
+
* ``POST /agents/{id}/runs``.
|
|
31
|
+
*/
|
|
32
|
+
AgentAttachmentRefsApiResponse: {
|
|
33
|
+
/** @description Aggregated selector summary across all consumer steps. ``exact_names`` entries must each appear in the upload batch; ``indexes_max+1`` is the minimum file count; every ``patterns`` glob must match at least one upload. */
|
|
34
|
+
agent?: components["schemas"]["AttachmentRefsSourceApiSummary"];
|
|
35
|
+
/**
|
|
36
|
+
* Requires Uploads
|
|
37
|
+
* @description When ``false`` the agent's definition does NOT reference any uploaded attachments — ``POST /agents/{id}/upload-input`` will reject with HTTP 400. When ``true`` the ``agent`` block lists the specific selectors a run-time batch must satisfy.
|
|
38
|
+
*/
|
|
39
|
+
requires_uploads: boolean;
|
|
40
|
+
};
|
|
41
|
+
/**
|
|
42
|
+
* AgentDefinitionImportErrorResponse
|
|
43
|
+
* @description 422 body for invalid `agent_definition` payloads.
|
|
44
|
+
*
|
|
45
|
+
* Mirrors `AgentDefinitionImportError.to_response_dict`.
|
|
46
|
+
*/
|
|
47
|
+
AgentDefinitionImportErrorResponse: {
|
|
48
|
+
/**
|
|
49
|
+
* Error
|
|
50
|
+
* @description Stable machine-readable error code.
|
|
51
|
+
* @constant
|
|
52
|
+
*/
|
|
53
|
+
error: "invalid_agent_definition";
|
|
54
|
+
/** Errors */
|
|
55
|
+
errors: components["schemas"]["ImportFieldErrorModel"][];
|
|
56
|
+
/** Message */
|
|
57
|
+
message: string;
|
|
58
|
+
/**
|
|
59
|
+
* Source
|
|
60
|
+
* @description Canonical pretty-printed echo of the supplied payload — error line/column refer to this string.
|
|
61
|
+
*/
|
|
62
|
+
source: string;
|
|
63
|
+
};
|
|
23
64
|
/** AgentDefinitionResponse */
|
|
24
65
|
AgentDefinitionResponse: {
|
|
25
66
|
/**
|
|
@@ -29,7 +70,7 @@ interface components {
|
|
|
29
70
|
change_id: string;
|
|
30
71
|
/**
|
|
31
72
|
* Definition
|
|
32
|
-
* @description The agent definition containing name, description, tags, and step workflow tree. Step types include prompt_call, retrieval,
|
|
73
|
+
* @description The agent definition containing name, description, tags, and step workflow tree. Step types include prompt_call, retrieval, regex_replace, gate, retry, evaluate_step, extract_data, extract_content, add_chat_turn, load_chat_history, add_memory, search_memory, load_memory, streaming_result, send_email, webhook_call, call_agent, write_metadata, write_content_attachment, load_content_attachment, load_content, display_result, merge, for_each, if_else, switch, and others.
|
|
33
74
|
*/
|
|
34
75
|
definition: {
|
|
35
76
|
[key: string]: unknown;
|
|
@@ -155,9 +196,18 @@ interface components {
|
|
|
155
196
|
input?: string | null;
|
|
156
197
|
/**
|
|
157
198
|
* Input Upload Id
|
|
158
|
-
* @description ID of a previously uploaded file (via POST /{agent_id}/upload-input) to use as the run input for dynamic-input triggers. Mutually exclusive with the 'input' field.
|
|
199
|
+
* @description ID of a previously uploaded file (via POST /{agent_id}/upload-input) to use as the run input for dynamic-input triggers. Mutually exclusive with the 'input' field. Use ``input_upload_ids`` to attach multiple files.
|
|
200
|
+
*
|
|
201
|
+
* **Attachment visibility:** a step only sees the upload when its template references the input — via ``{{input}}`` / ``{{agent.input}}`` / ``{{step.<id>.input|output}}`` (implicit, all attachments) or the ``{{attachments[…]}}`` family (explicit narrowing — e.g. ``{{attachments[0]}}``, ``{{attachments[*.pdf]}}``).
|
|
202
|
+
*
|
|
203
|
+
* **Per-batch validation:** every selector the agent's definition declares must be satisfied or the run is rejected with HTTP 400. Exact-name selectors require that filename to be present; indexed selectors require at least N+1 files; glob patterns require at least one matching filename.
|
|
159
204
|
*/
|
|
160
205
|
input_upload_id?: string | null;
|
|
206
|
+
/**
|
|
207
|
+
* Input Upload Ids
|
|
208
|
+
* @description IDs of multiple previously uploaded files. Each upload's extracted text is concatenated under a heading; each upload's binary is surfaced as a separate ``MediaAttachment`` so multi-modal prompt steps reason over all files at once. Steps narrow visibility via ``{{attachments[…]}}`` selectors (by index, filename, or fnmatch glob). The batch must satisfy every selector the agent declares — exact names, indexed references (length must exceed the highest index), and glob patterns (each pattern needs at least one match). Mismatches return HTTP 400 with the unmet requirements listed. Mutually exclusive with ``input`` and ``input_upload_id`` — pass exactly one of the three. Max 20 uploads per run.
|
|
209
|
+
*/
|
|
210
|
+
input_upload_ids?: string[] | null;
|
|
161
211
|
/**
|
|
162
212
|
* Metadata
|
|
163
213
|
* @description Metadata to make available for string substitution expressions in agent tasks.
|
|
@@ -171,6 +221,11 @@ interface components {
|
|
|
171
221
|
* @default false
|
|
172
222
|
*/
|
|
173
223
|
priority: boolean;
|
|
224
|
+
/**
|
|
225
|
+
* Replay Of Run Id
|
|
226
|
+
* @description Re-run this agent reusing a prior run's uploaded input files. The files are re-resolved server-side from the source run (which must belong to this account and agent) — you do not re-upload them. Combine with ``input`` to change the text while keeping the files. A fresh upload batch (``input_upload_id(s)``) takes precedence and disables replay. Binaries swept by retention fall back to their extracted text.
|
|
227
|
+
*/
|
|
228
|
+
replay_of_run_id?: string | null;
|
|
174
229
|
};
|
|
175
230
|
/** AgentRunResponse */
|
|
176
231
|
AgentRunResponse: {
|
|
@@ -179,6 +234,11 @@ interface components {
|
|
|
179
234
|
* @description List of attempts made for this agent run.
|
|
180
235
|
*/
|
|
181
236
|
attempts: components["schemas"]["AgentRunAttemptResponse"][];
|
|
237
|
+
/**
|
|
238
|
+
* Blocked Policies
|
|
239
|
+
* @description Governance policies that produced at least one BLOCK verdict during this run. Deduplicated by policy id.
|
|
240
|
+
*/
|
|
241
|
+
blocked_policies?: components["schemas"]["routers__api__agents__GovernancePolicyRefResponse"][];
|
|
182
242
|
/**
|
|
183
243
|
* Credits
|
|
184
244
|
* @description Credits consumed by the agent run, if applicable.
|
|
@@ -189,16 +249,46 @@ interface components {
|
|
|
189
249
|
* @description Number of errors encountered during the run.
|
|
190
250
|
*/
|
|
191
251
|
error_count: number;
|
|
252
|
+
/**
|
|
253
|
+
* Flagged Policies
|
|
254
|
+
* @description Governance policies that produced at least one FLAG verdict during this run. Deduplicated by policy id.
|
|
255
|
+
*/
|
|
256
|
+
flagged_policies?: components["schemas"]["routers__api__agents__GovernancePolicyRefResponse"][];
|
|
257
|
+
/**
|
|
258
|
+
* Governance Input Status
|
|
259
|
+
* @description Result of the governance input evaluation: safe, blocked, skipped, or timed_out.
|
|
260
|
+
*/
|
|
261
|
+
governance_input_status?: string | null;
|
|
262
|
+
/**
|
|
263
|
+
* Governance Input Wait Ms
|
|
264
|
+
* @description Milliseconds spent waiting for governance input evaluation.
|
|
265
|
+
*/
|
|
266
|
+
governance_input_wait_ms?: number | null;
|
|
267
|
+
/**
|
|
268
|
+
* Hitl Wait Ms
|
|
269
|
+
* @description Cumulative milliseconds the run was parked waiting for a human decision on a human_in_the_loop step. Subtracted from active duration in run-detail and duration-stats responses.
|
|
270
|
+
*/
|
|
271
|
+
hitl_wait_ms?: number | null;
|
|
192
272
|
/**
|
|
193
273
|
* Input
|
|
194
274
|
* @description Input provided to the agent for this run.
|
|
195
275
|
*/
|
|
196
276
|
input: string | null;
|
|
277
|
+
/**
|
|
278
|
+
* Input Scan Status
|
|
279
|
+
* @description Result of the prompt injection scan: safe, unsafe, skipped, timed_out, or error.
|
|
280
|
+
*/
|
|
281
|
+
input_scan_status?: string | null;
|
|
197
282
|
/**
|
|
198
283
|
* Output
|
|
199
284
|
* @description Output produced by the agent run.
|
|
200
285
|
*/
|
|
201
286
|
output: string | null;
|
|
287
|
+
/**
|
|
288
|
+
* Output Content Type
|
|
289
|
+
* @description MIME type of `output` — mirrors the terminal step's `output_content_type`. Consumers interpret `output` differently depending on this value: `application/vnd.seclai.manifest+json` is a multi-asset manifest with shape `{text, attachments: [{storage_key, mime, name, bytes}]}` — fetch each attachment via `GET /authenticated/storage-blobs/{storage_key}`. `text/plain` / `text/*` are free-form text. `application/json` is a JSON document. Null on runs that produced no terminal output or that pre-date this column.
|
|
290
|
+
*/
|
|
291
|
+
output_content_type?: string | null;
|
|
202
292
|
/**
|
|
203
293
|
* Priority
|
|
204
294
|
* @description Indicates if the run was treated as a priority execution.
|
|
@@ -209,6 +299,11 @@ interface components {
|
|
|
209
299
|
* @description Unique identifier for the agent run.
|
|
210
300
|
*/
|
|
211
301
|
run_id: string;
|
|
302
|
+
/**
|
|
303
|
+
* Scan Wait Ms
|
|
304
|
+
* @description Milliseconds spent waiting for prompt injection scan.
|
|
305
|
+
*/
|
|
306
|
+
scan_wait_ms?: number | null;
|
|
212
307
|
/** @description Current status of the agent run. */
|
|
213
308
|
status: components["schemas"]["PendingProcessingCompletedFailedStatus"];
|
|
214
309
|
/**
|
|
@@ -266,6 +361,11 @@ interface components {
|
|
|
266
361
|
* @description Type of the agent step.
|
|
267
362
|
*/
|
|
268
363
|
step_type: string;
|
|
364
|
+
/**
|
|
365
|
+
* Tool Calls
|
|
366
|
+
* @description LLM tool calls made during this step (prompt_call steps only), ordered by execution. Empty for steps that invoked no tools.
|
|
367
|
+
*/
|
|
368
|
+
tool_calls?: components["schemas"]["AgentRunToolCallResponse"][];
|
|
269
369
|
};
|
|
270
370
|
/** AgentRunStreamRequest */
|
|
271
371
|
AgentRunStreamRequest: {
|
|
@@ -276,9 +376,14 @@ interface components {
|
|
|
276
376
|
input?: string | null;
|
|
277
377
|
/**
|
|
278
378
|
* Input Upload Id
|
|
279
|
-
* @description ID of a previously uploaded file (via POST /{agent_id}/upload-input) to use as the run input for dynamic-input triggers. Mutually exclusive with the 'input' field.
|
|
379
|
+
* @description ID of a previously uploaded file (via POST /{agent_id}/upload-input) to use as the run input for dynamic-input triggers. Mutually exclusive with the 'input' field. Use ``input_upload_ids`` to attach multiple files. Subject to the same per-batch attachment-selector validation as the non-streaming endpoint.
|
|
280
380
|
*/
|
|
281
381
|
input_upload_id?: string | null;
|
|
382
|
+
/**
|
|
383
|
+
* Input Upload Ids
|
|
384
|
+
* @description IDs of multiple previously uploaded files. See the non-streaming endpoint for full semantics, including per-batch selector validation (exact names, indexed references, and glob patterns must all be satisfied or the run is rejected with HTTP 400). Max 20.
|
|
385
|
+
*/
|
|
386
|
+
input_upload_ids?: string[] | null;
|
|
282
387
|
/**
|
|
283
388
|
* Metadata
|
|
284
389
|
* @description Metadata to make available for string substitution expressions in agent tasks.
|
|
@@ -286,6 +391,81 @@ interface components {
|
|
|
286
391
|
metadata?: {
|
|
287
392
|
[key: string]: components["schemas"]["JsonValue"];
|
|
288
393
|
} | null;
|
|
394
|
+
/**
|
|
395
|
+
* Replay Of Run Id
|
|
396
|
+
* @description Re-run reusing a prior run's uploaded input files (re-resolved server-side from the source run, which must belong to this account and agent). A fresh upload batch takes precedence.
|
|
397
|
+
*/
|
|
398
|
+
replay_of_run_id?: string | null;
|
|
399
|
+
};
|
|
400
|
+
/**
|
|
401
|
+
* AgentRunToolCallResponse
|
|
402
|
+
* @description A single LLM tool call made during a prompt_call step.
|
|
403
|
+
*/
|
|
404
|
+
AgentRunToolCallResponse: {
|
|
405
|
+
/**
|
|
406
|
+
* Credits Used
|
|
407
|
+
* @description Credits consumed by this tool call (0 for tools that don't bill).
|
|
408
|
+
* @default 0
|
|
409
|
+
*/
|
|
410
|
+
credits_used: number;
|
|
411
|
+
/**
|
|
412
|
+
* Duration Seconds
|
|
413
|
+
* @description Duration of the tool call in seconds.
|
|
414
|
+
*/
|
|
415
|
+
duration_seconds?: number | null;
|
|
416
|
+
/**
|
|
417
|
+
* Ended At
|
|
418
|
+
* @description Timestamp when the tool call ended.
|
|
419
|
+
*/
|
|
420
|
+
ended_at?: string | null;
|
|
421
|
+
/**
|
|
422
|
+
* Error
|
|
423
|
+
* @description Error message when the tool call failed.
|
|
424
|
+
*/
|
|
425
|
+
error?: string | null;
|
|
426
|
+
/**
|
|
427
|
+
* Function Name
|
|
428
|
+
* @description Name of the tool/function invoked.
|
|
429
|
+
*/
|
|
430
|
+
function_name: string;
|
|
431
|
+
/**
|
|
432
|
+
* Id
|
|
433
|
+
* @description Tool call identifier.
|
|
434
|
+
*/
|
|
435
|
+
id: string;
|
|
436
|
+
/**
|
|
437
|
+
* Input
|
|
438
|
+
* @description JSON arguments the LLM passed to the tool, if persisted.
|
|
439
|
+
*/
|
|
440
|
+
input?: string | null;
|
|
441
|
+
/**
|
|
442
|
+
* Output
|
|
443
|
+
* @description JSON result the tool returned to the LLM, if persisted.
|
|
444
|
+
*/
|
|
445
|
+
output?: string | null;
|
|
446
|
+
/**
|
|
447
|
+
* Round Index
|
|
448
|
+
* @description 0-based tool-loop round this call belonged to.
|
|
449
|
+
* @default 0
|
|
450
|
+
*/
|
|
451
|
+
round_index: number;
|
|
452
|
+
/**
|
|
453
|
+
* Sequence
|
|
454
|
+
* @description 0-based ordinal of this call within its step run.
|
|
455
|
+
* @default 0
|
|
456
|
+
*/
|
|
457
|
+
sequence: number;
|
|
458
|
+
/**
|
|
459
|
+
* Started At
|
|
460
|
+
* @description Timestamp when the tool call started.
|
|
461
|
+
*/
|
|
462
|
+
started_at?: string | null;
|
|
463
|
+
/**
|
|
464
|
+
* Succeeded
|
|
465
|
+
* @description Whether the tool call completed without error.
|
|
466
|
+
* @default true
|
|
467
|
+
*/
|
|
468
|
+
succeeded: boolean;
|
|
289
469
|
};
|
|
290
470
|
/** AgentSummaryResponse */
|
|
291
471
|
AgentSummaryResponse: {
|
|
@@ -315,6 +495,11 @@ interface components {
|
|
|
315
495
|
* @description Unique agent identifier.
|
|
316
496
|
*/
|
|
317
497
|
id: string;
|
|
498
|
+
/**
|
|
499
|
+
* Import Warnings
|
|
500
|
+
* @description One entry per item dropped or substituted during import. Present only on endpoints that accept agent_definition; null on non-import calls; [] when the import had no skips.
|
|
501
|
+
*/
|
|
502
|
+
import_warnings?: components["schemas"]["ImportSkipResponse"][] | null;
|
|
318
503
|
/**
|
|
319
504
|
* Max Retries
|
|
320
505
|
* @description Max retries for eval_and_retry mode.
|
|
@@ -360,7 +545,7 @@ interface components {
|
|
|
360
545
|
* Trigger Type
|
|
361
546
|
* @description Trigger type for the agent.
|
|
362
547
|
*/
|
|
363
|
-
trigger_type
|
|
548
|
+
trigger_type?: string | null;
|
|
364
549
|
/**
|
|
365
550
|
* Updated At
|
|
366
551
|
* @description ISO 8601 last-updated timestamp.
|
|
@@ -476,17 +661,6 @@ interface components {
|
|
|
476
661
|
/** Flagged */
|
|
477
662
|
flagged: boolean;
|
|
478
663
|
};
|
|
479
|
-
/**
|
|
480
|
-
* AiAssistantGenerateRequest
|
|
481
|
-
* @description Request body for AI assistant generate endpoints.
|
|
482
|
-
*/
|
|
483
|
-
AiAssistantGenerateRequest: {
|
|
484
|
-
/**
|
|
485
|
-
* User Input
|
|
486
|
-
* @description User input describing what to do
|
|
487
|
-
*/
|
|
488
|
-
user_input: string;
|
|
489
|
-
};
|
|
490
664
|
/**
|
|
491
665
|
* AiAssistantGenerateResponse
|
|
492
666
|
* @description Response from an AI assistant generate endpoint.
|
|
@@ -610,6 +784,20 @@ interface components {
|
|
|
610
784
|
*/
|
|
611
785
|
success: boolean;
|
|
612
786
|
};
|
|
787
|
+
/**
|
|
788
|
+
* AttachmentRefsSourceApiSummary
|
|
789
|
+
* @description Per-source attachment-reference summary.
|
|
790
|
+
*/
|
|
791
|
+
AttachmentRefsSourceApiSummary: {
|
|
792
|
+
/** Exact Names */
|
|
793
|
+
exact_names?: string[];
|
|
794
|
+
/** Indexes Max */
|
|
795
|
+
indexes_max?: number | null;
|
|
796
|
+
/** Kinds */
|
|
797
|
+
kinds?: string[];
|
|
798
|
+
/** Patterns */
|
|
799
|
+
patterns?: string[];
|
|
800
|
+
};
|
|
613
801
|
/** Body_upload_file_to_content_api_contents__source_connection_content_version__upload_post */
|
|
614
802
|
Body_upload_file_to_content_api_contents__source_connection_content_version__upload_post: {
|
|
615
803
|
/**
|
|
@@ -1495,7 +1683,7 @@ interface components {
|
|
|
1495
1683
|
step_id?: string | null;
|
|
1496
1684
|
/**
|
|
1497
1685
|
* Step Type
|
|
1498
|
-
* @description The step type to generate config for (e.g. '
|
|
1686
|
+
* @description The step type to generate config for (e.g. 'regex_replace', 'gate', 'text', 'prompt_call', 'retrieval').
|
|
1499
1687
|
*/
|
|
1500
1688
|
step_type: string;
|
|
1501
1689
|
/**
|
|
@@ -1606,6 +1794,64 @@ interface components {
|
|
|
1606
1794
|
/** Detail */
|
|
1607
1795
|
detail?: components["schemas"]["ValidationError"][];
|
|
1608
1796
|
};
|
|
1797
|
+
/**
|
|
1798
|
+
* ImportFieldErrorModel
|
|
1799
|
+
* @description Single agent_definition validation error with source position.
|
|
1800
|
+
*/
|
|
1801
|
+
ImportFieldErrorModel: {
|
|
1802
|
+
/**
|
|
1803
|
+
* Column
|
|
1804
|
+
* @description 1-indexed column in `source`.
|
|
1805
|
+
*/
|
|
1806
|
+
column: number;
|
|
1807
|
+
/**
|
|
1808
|
+
* Line
|
|
1809
|
+
* @description 1-indexed line in `source`.
|
|
1810
|
+
*/
|
|
1811
|
+
line: number;
|
|
1812
|
+
/**
|
|
1813
|
+
* Message
|
|
1814
|
+
* @description Human-readable description of the problem.
|
|
1815
|
+
*/
|
|
1816
|
+
message: string;
|
|
1817
|
+
/**
|
|
1818
|
+
* Path
|
|
1819
|
+
* @description Dotted path of the offending field, e.g. `agent.definition.child_steps[0].step_type`.
|
|
1820
|
+
*/
|
|
1821
|
+
path: string;
|
|
1822
|
+
};
|
|
1823
|
+
/**
|
|
1824
|
+
* ImportSkipResponse
|
|
1825
|
+
* @description One item that was not applied during an agent import.
|
|
1826
|
+
*
|
|
1827
|
+
* Used as the element type for ``import_warnings`` on every
|
|
1828
|
+
* response model that accepts an ``agent_definition`` payload.
|
|
1829
|
+
* See ``services.agent_definition_import.AgentImportSkip`` for the
|
|
1830
|
+
* full category list.
|
|
1831
|
+
*
|
|
1832
|
+
* Lives here (not on each router) so the authenticated and public
|
|
1833
|
+
* API responses share one definition — keeping the shape that
|
|
1834
|
+
* clients (UI modal, MCP, OpenAPI consumers) depend on aligned.
|
|
1835
|
+
*/
|
|
1836
|
+
ImportSkipResponse: {
|
|
1837
|
+
/**
|
|
1838
|
+
* Category
|
|
1839
|
+
* @description The kind of item that was skipped or substituted: 'schedule', 'evaluation_criteria', 'alert_config', 'alert_recipient', 'governance_policy', 'governance_kb_link', 'solution_link'.
|
|
1840
|
+
*/
|
|
1841
|
+
category: string;
|
|
1842
|
+
/**
|
|
1843
|
+
* Details
|
|
1844
|
+
* @description Category-specific identifiers for the skipped item (step_id, alert_type, kb_name, etc.). Stable keys per category; absent keys are simply not applicable.
|
|
1845
|
+
*/
|
|
1846
|
+
details?: {
|
|
1847
|
+
[key: string]: unknown;
|
|
1848
|
+
};
|
|
1849
|
+
/**
|
|
1850
|
+
* Message
|
|
1851
|
+
* @description Human-readable explanation of what was skipped and why.
|
|
1852
|
+
*/
|
|
1853
|
+
message: string;
|
|
1854
|
+
};
|
|
1609
1855
|
/**
|
|
1610
1856
|
* InlineTextReplaceRequest
|
|
1611
1857
|
* @description Request model for inline text content replacement.
|
|
@@ -1664,6 +1910,35 @@ interface components {
|
|
|
1664
1910
|
*/
|
|
1665
1911
|
title?: string | null;
|
|
1666
1912
|
};
|
|
1913
|
+
/**
|
|
1914
|
+
* InsufficientCreditsDetail
|
|
1915
|
+
* @description ``detail`` body for a 402 ``insufficient_credits`` response.
|
|
1916
|
+
*/
|
|
1917
|
+
InsufficientCreditsDetail: {
|
|
1918
|
+
/**
|
|
1919
|
+
* Account Id
|
|
1920
|
+
* @description UUID of the account that ran out of credits.
|
|
1921
|
+
*/
|
|
1922
|
+
account_id: string;
|
|
1923
|
+
/**
|
|
1924
|
+
* Error
|
|
1925
|
+
* @description Stable machine-readable error code.
|
|
1926
|
+
* @constant
|
|
1927
|
+
*/
|
|
1928
|
+
error: "insufficient_credits";
|
|
1929
|
+
/**
|
|
1930
|
+
* Message
|
|
1931
|
+
* @description Human-readable explanation.
|
|
1932
|
+
*/
|
|
1933
|
+
message: string;
|
|
1934
|
+
};
|
|
1935
|
+
/**
|
|
1936
|
+
* InsufficientCreditsResponse
|
|
1937
|
+
* @description 402 envelope returned when the account has exhausted its credits.
|
|
1938
|
+
*/
|
|
1939
|
+
InsufficientCreditsResponse: {
|
|
1940
|
+
detail: components["schemas"]["InsufficientCreditsDetail"];
|
|
1941
|
+
};
|
|
1667
1942
|
JsonValue: unknown;
|
|
1668
1943
|
/**
|
|
1669
1944
|
* KnowledgeBaseListResponseModel
|
|
@@ -1989,6 +2264,24 @@ interface components {
|
|
|
1989
2264
|
*/
|
|
1990
2265
|
updated_at: string;
|
|
1991
2266
|
};
|
|
2267
|
+
/**
|
|
2268
|
+
* ModalityRateResponse
|
|
2269
|
+
* @description Per-modality rate for an LLM that prices image/audio/video output
|
|
2270
|
+
* (or input) at a rate distinct from the default text rate.
|
|
2271
|
+
*
|
|
2272
|
+
* Example: Gemini 3.1 Flash Image charges $3/1M output tokens for
|
|
2273
|
+
* text but $60/1M output tokens for generated images. The image rate
|
|
2274
|
+
* surfaces here with ``modality="image"`` and ``output_credits_per_1000_tokens``
|
|
2275
|
+
* set; the default text rate stays on the parent model fields.
|
|
2276
|
+
*/
|
|
2277
|
+
ModalityRateResponse: {
|
|
2278
|
+
/** Input Credits Per 1000 Tokens */
|
|
2279
|
+
input_credits_per_1000_tokens?: number | null;
|
|
2280
|
+
/** Modality */
|
|
2281
|
+
modality: string;
|
|
2282
|
+
/** Output Credits Per 1000 Tokens */
|
|
2283
|
+
output_credits_per_1000_tokens?: number | null;
|
|
2284
|
+
};
|
|
1992
2285
|
/** OrganizationAlertPreferenceListResponse */
|
|
1993
2286
|
OrganizationAlertPreferenceListResponse: {
|
|
1994
2287
|
/** Preferences */
|
|
@@ -2033,7 +2326,7 @@ interface components {
|
|
|
2033
2326
|
* PendingProcessingCompletedFailedStatus
|
|
2034
2327
|
* @enum {string}
|
|
2035
2328
|
*/
|
|
2036
|
-
PendingProcessingCompletedFailedStatus: "pending" | "processing" | "completed" | "failed";
|
|
2329
|
+
PendingProcessingCompletedFailedStatus: "pending" | "processing" | "completed" | "failed" | "waiting_human";
|
|
2037
2330
|
/**
|
|
2038
2331
|
* PlaygroundCreateRequest
|
|
2039
2332
|
* @description Create a model playground experiment via the public API.
|
|
@@ -2152,6 +2445,13 @@ interface components {
|
|
|
2152
2445
|
params: {
|
|
2153
2446
|
[key: string]: unknown;
|
|
2154
2447
|
};
|
|
2448
|
+
/**
|
|
2449
|
+
* Preview
|
|
2450
|
+
* @description Planning-time dry-run preview attached by the solution AI assistant for create_agent / update_agent actions. Contains ``steps`` (the generated step tree), ``step_count``, ``warnings`` (a mix of heuristic structural issues — e.g. brittle JSONPath, pass-through ``regex_replace``, ``prompt_call`` missing a model — and deterministic resource-usage issues: every pre-bound knowledge base / memory bank must be referenced by at least one step, and no step may reference an unknown id), and ``skipped`` / ``skipped_reason`` when preview couldn't run (e.g. the action depends on resources created earlier in the same plan). ``None`` for non-agent actions or when generation failed.
|
|
2451
|
+
*/
|
|
2452
|
+
preview?: {
|
|
2453
|
+
[key: string]: unknown;
|
|
2454
|
+
} | null;
|
|
2155
2455
|
};
|
|
2156
2456
|
/**
|
|
2157
2457
|
* ProposedPolicyActionResponse
|
|
@@ -2944,6 +3244,94 @@ interface components {
|
|
|
2944
3244
|
/** Value */
|
|
2945
3245
|
value: string;
|
|
2946
3246
|
};
|
|
3247
|
+
/**
|
|
3248
|
+
* AgentImportPreviewRequest
|
|
3249
|
+
* @description Dry-run import request — same payload shape as the export endpoint.
|
|
3250
|
+
*/
|
|
3251
|
+
routers__api__agents__AgentImportPreviewRequest: {
|
|
3252
|
+
/**
|
|
3253
|
+
* Agent Definition
|
|
3254
|
+
* @description Payload in the same shape as GET /api/agents/{agent_id}/export.
|
|
3255
|
+
*/
|
|
3256
|
+
agent_definition: {
|
|
3257
|
+
[key: string]: unknown;
|
|
3258
|
+
};
|
|
3259
|
+
};
|
|
3260
|
+
/**
|
|
3261
|
+
* AgentImportPreviewResponse
|
|
3262
|
+
* @description Summary of a successfully validated import payload (no DB writes).
|
|
3263
|
+
*
|
|
3264
|
+
* Counts are derived from the validated payload as supplied — they
|
|
3265
|
+
* reflect what was requested, not what would eventually be persisted
|
|
3266
|
+
* (cross-account skips for recipients and KB names happen later, only
|
|
3267
|
+
* on commit).
|
|
3268
|
+
*/
|
|
3269
|
+
routers__api__agents__AgentImportPreviewResponse: {
|
|
3270
|
+
/**
|
|
3271
|
+
* Agent Name
|
|
3272
|
+
* @description Imported agent name, if any.
|
|
3273
|
+
*/
|
|
3274
|
+
agent_name: string | null;
|
|
3275
|
+
/**
|
|
3276
|
+
* Alert Configs
|
|
3277
|
+
* @description Number of alert configs in the payload.
|
|
3278
|
+
*/
|
|
3279
|
+
alert_configs: number;
|
|
3280
|
+
/**
|
|
3281
|
+
* Description
|
|
3282
|
+
* @description Imported agent description, if any.
|
|
3283
|
+
*/
|
|
3284
|
+
description: string | null;
|
|
3285
|
+
/**
|
|
3286
|
+
* Evaluation Criteria
|
|
3287
|
+
* @description Number of evaluation criteria in the payload.
|
|
3288
|
+
*/
|
|
3289
|
+
evaluation_criteria: number;
|
|
3290
|
+
/**
|
|
3291
|
+
* Governance Policies
|
|
3292
|
+
* @description Number of agent-scoped governance policies in the payload.
|
|
3293
|
+
*/
|
|
3294
|
+
governance_policies: number;
|
|
3295
|
+
/**
|
|
3296
|
+
* Ok
|
|
3297
|
+
* @description Always true on a 200 response; failures use HTTP 422.
|
|
3298
|
+
*/
|
|
3299
|
+
ok: boolean;
|
|
3300
|
+
/**
|
|
3301
|
+
* Payload Export Version
|
|
3302
|
+
* @description Export-format version the payload claims (or ``null`` for legacy payloads). When this differs from ``supported_export_version``, fields may have been silently dropped or defaulted on import.
|
|
3303
|
+
*/
|
|
3304
|
+
payload_export_version?: string | null;
|
|
3305
|
+
/**
|
|
3306
|
+
* Schedules
|
|
3307
|
+
* @description Number of trigger schedules in the payload.
|
|
3308
|
+
*/
|
|
3309
|
+
schedules: number;
|
|
3310
|
+
/**
|
|
3311
|
+
* Solutions
|
|
3312
|
+
* @description Number of solutions the source agent belonged to. On import these are matched by name in the target account; unmatched names are silently skipped.
|
|
3313
|
+
* @default 0
|
|
3314
|
+
*/
|
|
3315
|
+
solutions: number;
|
|
3316
|
+
/**
|
|
3317
|
+
* Step Count
|
|
3318
|
+
* @description Total number of steps in the workflow tree (recursive).
|
|
3319
|
+
*/
|
|
3320
|
+
step_count: number;
|
|
3321
|
+
/**
|
|
3322
|
+
* Supported Export Version
|
|
3323
|
+
* @description Export-format version this server understands. Compare against ``payload_export_version`` to detect cross-version imports.
|
|
3324
|
+
* @default 2
|
|
3325
|
+
*/
|
|
3326
|
+
supported_export_version: string;
|
|
3327
|
+
/**
|
|
3328
|
+
* Unresolved Refs
|
|
3329
|
+
* @description Entity references in the imported workflow that don't exist in the target account. Each entry: {category, ref_id, ref_name?, locations:[step:<id>], alternatives:[{id, name, description?}]}. Pass {source_uuid: target_uuid} as ``entity_remap`` on the create/update call to substitute these references before save.
|
|
3330
|
+
*/
|
|
3331
|
+
unresolved_refs?: {
|
|
3332
|
+
[key: string]: unknown;
|
|
3333
|
+
}[];
|
|
3334
|
+
};
|
|
2947
3335
|
/** AgentListResponse */
|
|
2948
3336
|
routers__api__agents__AgentListResponse: {
|
|
2949
3337
|
/**
|
|
@@ -2993,6 +3381,13 @@ interface components {
|
|
|
2993
3381
|
};
|
|
2994
3382
|
/** CreateAgentRequest */
|
|
2995
3383
|
routers__api__agents__CreateAgentRequest: {
|
|
3384
|
+
/**
|
|
3385
|
+
* Agent Definition
|
|
3386
|
+
* @description Optional payload in the same format produced by GET /agents/{id}/export. When provided, replaces any template-derived workflow and pre-fills metadata/trigger fields the request does not specify explicitly. Validation errors include line/column references against a canonical pretty-printed echo of the supplied payload.
|
|
3387
|
+
*/
|
|
3388
|
+
agent_definition?: {
|
|
3389
|
+
[key: string]: unknown;
|
|
3390
|
+
} | null;
|
|
2996
3391
|
/**
|
|
2997
3392
|
* Agent Template
|
|
2998
3393
|
* @description Template to initialize the agent from. Values: blank, retrieval_example, simple_qa, summarizer, json_extractor, content_change_notifier, scheduled_report, webhook_pipeline.
|
|
@@ -3003,6 +3398,13 @@ interface components {
|
|
|
3003
3398
|
* @description Optional description.
|
|
3004
3399
|
*/
|
|
3005
3400
|
description?: string | null;
|
|
3401
|
+
/**
|
|
3402
|
+
* Entity Remap
|
|
3403
|
+
* @description Optional UUID-substitution map applied to the imported workflow before save. Each key is a source-account UUID (as returned by /agents/preview-import's ``unresolved_refs``); each value is the target-account UUID to substitute. Used to relink knowledge bases, memory banks, source connections, and sub-agents on cross-account imports.
|
|
3404
|
+
*/
|
|
3405
|
+
entity_remap?: {
|
|
3406
|
+
[key: string]: string;
|
|
3407
|
+
} | null;
|
|
3006
3408
|
/**
|
|
3007
3409
|
* Name
|
|
3008
3410
|
* @description Name for the new agent.
|
|
@@ -3015,8 +3417,31 @@ interface components {
|
|
|
3015
3417
|
*/
|
|
3016
3418
|
trigger_type: string;
|
|
3017
3419
|
};
|
|
3420
|
+
/**
|
|
3421
|
+
* GovernancePolicyRefResponse
|
|
3422
|
+
* @description Reference to a governance policy by id and name.
|
|
3423
|
+
*/
|
|
3424
|
+
routers__api__agents__GovernancePolicyRefResponse: {
|
|
3425
|
+
/**
|
|
3426
|
+
* Policy Id
|
|
3427
|
+
* @description Governance policy identifier.
|
|
3428
|
+
*/
|
|
3429
|
+
policy_id: string;
|
|
3430
|
+
/**
|
|
3431
|
+
* Policy Name
|
|
3432
|
+
* @description Display name of the policy at evaluation time. May be null when the policy has been deleted.
|
|
3433
|
+
*/
|
|
3434
|
+
policy_name?: string | null;
|
|
3435
|
+
};
|
|
3018
3436
|
/** UpdateAgentRequest */
|
|
3019
3437
|
routers__api__agents__UpdateAgentRequest: {
|
|
3438
|
+
/**
|
|
3439
|
+
* Agent Definition
|
|
3440
|
+
* @description Optional payload in the same format produced by GET /agents/{id}/export. When provided, agent metadata fields the request does not set explicitly are taken from the payload, and the agent's workflow is replaced from `agent.definition`. The previous version is preserved in history. Validation errors include line/column references against a canonical pretty-printed echo of the supplied payload.
|
|
3441
|
+
*/
|
|
3442
|
+
agent_definition?: {
|
|
3443
|
+
[key: string]: unknown;
|
|
3444
|
+
} | null;
|
|
3020
3445
|
/**
|
|
3021
3446
|
* Default Evaluation Tier
|
|
3022
3447
|
* @description Default evaluation tier: 'fast', 'balanced', or 'thorough'.
|
|
@@ -3027,6 +3452,13 @@ interface components {
|
|
|
3027
3452
|
* @description New description for the agent.
|
|
3028
3453
|
*/
|
|
3029
3454
|
description?: string | null;
|
|
3455
|
+
/**
|
|
3456
|
+
* Entity Remap
|
|
3457
|
+
* @description Optional UUID-substitution map applied to the imported workflow before save (same shape as on POST /agents).
|
|
3458
|
+
*/
|
|
3459
|
+
entity_remap?: {
|
|
3460
|
+
[key: string]: string;
|
|
3461
|
+
} | null;
|
|
3030
3462
|
/**
|
|
3031
3463
|
* Evaluation Mode
|
|
3032
3464
|
* @description Evaluation mode: 'output_expectation', 'eval_and_retry', or 'sample_and_flag'.
|
|
@@ -3373,11 +3805,6 @@ interface components {
|
|
|
3373
3805
|
* @description Request body for the memory bank AI assistant.
|
|
3374
3806
|
*/
|
|
3375
3807
|
routers__api__memory_banks__MemoryBankAiAssistantRequest: {
|
|
3376
|
-
/**
|
|
3377
|
-
* Conversation Id
|
|
3378
|
-
* @description Previous conversation ID to continue.
|
|
3379
|
-
*/
|
|
3380
|
-
conversation_id?: string | null;
|
|
3381
3808
|
/**
|
|
3382
3809
|
* Current Config
|
|
3383
3810
|
* @description Current configuration to refine, if any.
|
|
@@ -3385,6 +3812,11 @@ interface components {
|
|
|
3385
3812
|
current_config?: {
|
|
3386
3813
|
[key: string]: unknown;
|
|
3387
3814
|
} | null;
|
|
3815
|
+
/**
|
|
3816
|
+
* History Since
|
|
3817
|
+
* @description Optional ISO 8601 timestamp. When set, only conversation turns created at or after this timestamp are loaded as context, scoping history to the current session so the assistant remembers earlier turns in a multi-turn refinement.
|
|
3818
|
+
*/
|
|
3819
|
+
history_since?: string | null;
|
|
3388
3820
|
/**
|
|
3389
3821
|
* User Input
|
|
3390
3822
|
* @description Natural-language description of the memory bank.
|
|
@@ -3478,6 +3910,22 @@ interface components {
|
|
|
3478
3910
|
*/
|
|
3479
3911
|
solution_name?: string | null;
|
|
3480
3912
|
};
|
|
3913
|
+
/**
|
|
3914
|
+
* AiAssistantGenerateRequest
|
|
3915
|
+
* @description Request body for AI assistant generate endpoints.
|
|
3916
|
+
*/
|
|
3917
|
+
routers__api__solutions__AiAssistantGenerateRequest: {
|
|
3918
|
+
/**
|
|
3919
|
+
* History Since
|
|
3920
|
+
* @description Optional ISO 8601 timestamp. When set, only conversation turns created at or after this timestamp are loaded as context, scoping history to the current session so the assistant remembers earlier turns in a create flow.
|
|
3921
|
+
*/
|
|
3922
|
+
history_since?: string | null;
|
|
3923
|
+
/**
|
|
3924
|
+
* User Input
|
|
3925
|
+
* @description User input describing what to do
|
|
3926
|
+
*/
|
|
3927
|
+
user_input: string;
|
|
3928
|
+
};
|
|
3481
3929
|
/** SolutionAgentResponse */
|
|
3482
3930
|
routers__api__solutions__SolutionAgentResponse: {
|
|
3483
3931
|
/**
|
|
@@ -3817,6 +4265,11 @@ interface components {
|
|
|
3817
4265
|
* @description ID of the created content version
|
|
3818
4266
|
*/
|
|
3819
4267
|
content_version_id: string | null;
|
|
4268
|
+
/**
|
|
4269
|
+
* Embedder Warning
|
|
4270
|
+
* @description Set when the file is non-text but the source's embedder is text-only — indexing will rely on OCR / transcription and may produce a FAILED row if no text can be extracted.
|
|
4271
|
+
*/
|
|
4272
|
+
embedder_warning?: string | null;
|
|
3820
4273
|
/**
|
|
3821
4274
|
* Filename
|
|
3822
4275
|
* @description Original filename
|
|
@@ -3903,6 +4356,8 @@ interface components {
|
|
|
3903
4356
|
* @description Source URL used to derive payload_schema guidance for this model.
|
|
3904
4357
|
*/
|
|
3905
4358
|
payload_schema_source_url?: string | null;
|
|
4359
|
+
/** Per Modality Rates */
|
|
4360
|
+
per_modality_rates?: components["schemas"]["ModalityRateResponse"][];
|
|
3906
4361
|
/** Provider */
|
|
3907
4362
|
provider: string;
|
|
3908
4363
|
/** Released At */
|
|
@@ -3925,6 +4380,8 @@ interface components {
|
|
|
3925
4380
|
supported_input_media?: string[] | null;
|
|
3926
4381
|
/** Supported Languages */
|
|
3927
4382
|
supported_languages?: string[] | null;
|
|
4383
|
+
/** Supported Output Media */
|
|
4384
|
+
supported_output_media?: string[] | null;
|
|
3928
4385
|
/**
|
|
3929
4386
|
* Supports Openai Arguments
|
|
3930
4387
|
* @default false
|
|
@@ -4056,6 +4513,21 @@ type CreateAgentRequest = components["schemas"]["routers__api__agents__CreateAge
|
|
|
4056
4513
|
type UpdateAgentRequest = components["schemas"]["routers__api__agents__UpdateAgentRequest"];
|
|
4057
4514
|
/** Request body for updating an agent definition (steps, model, etc.). */
|
|
4058
4515
|
type UpdateAgentDefinitionRequest = components["schemas"]["UpdateAgentDefinitionRequest"];
|
|
4516
|
+
/** Request body for previewing an agent_definition import (dry-run validation). */
|
|
4517
|
+
type AgentImportPreviewRequest = components["schemas"]["routers__api__agents__AgentImportPreviewRequest"];
|
|
4518
|
+
/** Response body summarising a successfully validated agent_definition import payload. */
|
|
4519
|
+
type AgentImportPreviewResponse = components["schemas"]["routers__api__agents__AgentImportPreviewResponse"];
|
|
4520
|
+
/**
|
|
4521
|
+
* 422 response body for invalid `agent_definition` payloads on create/update/preview-import.
|
|
4522
|
+
* Errors carry 1-indexed line/column references into the canonical `source` echo.
|
|
4523
|
+
*/
|
|
4524
|
+
type AgentDefinitionImportErrorResponse = components["schemas"]["AgentDefinitionImportErrorResponse"];
|
|
4525
|
+
/** Single validation error within an {@link AgentDefinitionImportErrorResponse} (with source position). */
|
|
4526
|
+
type ImportFieldErrorModel = components["schemas"]["ImportFieldErrorModel"];
|
|
4527
|
+
/** One item dropped or substituted during an agent import (emitted in `import_warnings`). */
|
|
4528
|
+
type ImportSkipResponse = components["schemas"]["ImportSkipResponse"];
|
|
4529
|
+
/** Reference to a governance policy (id and optional display name). */
|
|
4530
|
+
type GovernancePolicyRefResponse = components["schemas"]["routers__api__agents__GovernancePolicyRefResponse"];
|
|
4059
4531
|
/** Request body for starting an agent run. */
|
|
4060
4532
|
type AgentRunRequest = components["schemas"]["AgentRunRequest"];
|
|
4061
4533
|
/** Request body for starting an agent run in streaming mode (SSE). */
|
|
@@ -4068,6 +4540,8 @@ type AgentRunListResponse = components["schemas"]["routers__api__agents__AgentRu
|
|
|
4068
4540
|
type AgentRunStepResponse = components["schemas"]["AgentRunStepResponse"];
|
|
4069
4541
|
/** Details of a single attempt within an agent run step. */
|
|
4070
4542
|
type AgentRunAttemptResponse = components["schemas"]["AgentRunAttemptResponse"];
|
|
4543
|
+
/** A single LLM tool call made during a `prompt_call` step (within {@link AgentRunStepResponse}'s `tool_calls`). */
|
|
4544
|
+
type AgentRunToolCallResponse = components["schemas"]["AgentRunToolCallResponse"];
|
|
4071
4545
|
/** Search request for agent runs (traces). */
|
|
4072
4546
|
type AgentTraceSearchRequest = components["schemas"]["routers__api__agents__AgentTraceSearchRequest"];
|
|
4073
4547
|
/** Search response containing matching agent runs. */
|
|
@@ -4076,6 +4550,13 @@ type AgentTraceSearchResponse = components["schemas"]["AgentTraceSearchResponse"
|
|
|
4076
4550
|
type AgentTraceMatchResponse = components["schemas"]["AgentTraceMatchResponse"];
|
|
4077
4551
|
/** Response from uploading a file input for an agent run. */
|
|
4078
4552
|
type UploadAgentInputApiResponse = components["schemas"]["UploadAgentInputApiResponse"];
|
|
4553
|
+
/**
|
|
4554
|
+
* Static attachment-reference contract for an agent — what files (if any) its
|
|
4555
|
+
* templates expect on a run, so uploads can be staged before calling `runAgent`.
|
|
4556
|
+
*/
|
|
4557
|
+
type AgentAttachmentRefsApiResponse = components["schemas"]["AgentAttachmentRefsApiResponse"];
|
|
4558
|
+
/** Per-source attachment-reference summary (exact names, indexes, glob patterns) within an {@link AgentAttachmentRefsApiResponse}. */
|
|
4559
|
+
type AttachmentRefsSourceApiSummary = components["schemas"]["AttachmentRefsSourceApiSummary"];
|
|
4079
4560
|
/** Request body for generating agent workflow steps via AI. */
|
|
4080
4561
|
type GenerateAgentStepsRequest = components["schemas"]["GenerateAgentStepsRequest"];
|
|
4081
4562
|
/** Response containing AI-generated agent workflow steps. */
|
|
@@ -4229,7 +4710,7 @@ type AddConversationTurnRequest = components["schemas"]["AddConversationTurnRequ
|
|
|
4229
4710
|
/** Request body for marking a conversation turn. */
|
|
4230
4711
|
type MarkConversationTurnRequest = components["schemas"]["MarkConversationTurnRequest"];
|
|
4231
4712
|
/** AI assistant generate request for solutions. */
|
|
4232
|
-
type AiAssistantGenerateRequest = components["schemas"]["
|
|
4713
|
+
type AiAssistantGenerateRequest = components["schemas"]["routers__api__solutions__AiAssistantGenerateRequest"];
|
|
4233
4714
|
/** AI assistant generate response for solutions. */
|
|
4234
4715
|
type AiAssistantGenerateResponse = components["schemas"]["AiAssistantGenerateResponse"];
|
|
4235
4716
|
/** AI assistant accept request for solutions. */
|
|
@@ -4282,6 +4763,8 @@ type ProviderGroupResponse = components["schemas"]["schemas__model_responses__Pr
|
|
|
4282
4763
|
type PromptModelResponse = components["schemas"]["schemas__model_responses__PromptModelResponse"];
|
|
4283
4764
|
/** Prompt tool configuration within a model. */
|
|
4284
4765
|
type PromptToolResponse = components["schemas"]["PromptToolResponse"];
|
|
4766
|
+
/** Per-modality rate for a model that prices image/audio/video distinctly from its default text rate. */
|
|
4767
|
+
type ModalityRateResponse = components["schemas"]["ModalityRateResponse"];
|
|
4285
4768
|
/** Variant category for model pricing tiers. */
|
|
4286
4769
|
type VariantCategoryResponse = components["schemas"]["VariantCategoryResponse"];
|
|
4287
4770
|
/** Variant option with credit pricing and context limits. */
|
|
@@ -4295,6 +4778,10 @@ type PlaygroundCreateRequest = components["schemas"]["PlaygroundCreateRequest"];
|
|
|
4295
4778
|
* server-side default and can be omitted.
|
|
4296
4779
|
*/
|
|
4297
4780
|
type CreateExperimentInput = Pick<PlaygroundCreateRequest, "model_ids" | "prompt"> & Partial<Omit<PlaygroundCreateRequest, "model_ids" | "prompt">>;
|
|
4781
|
+
/** 402 envelope returned when an account has exhausted its credits. */
|
|
4782
|
+
type InsufficientCreditsResponse = components["schemas"]["InsufficientCreditsResponse"];
|
|
4783
|
+
/** `detail` body of an {@link InsufficientCreditsResponse} (error code, message, and account id). */
|
|
4784
|
+
type InsufficientCreditsDetail = components["schemas"]["InsufficientCreditsDetail"];
|
|
4298
4785
|
/** Source index mode: fast_and_cheap, balanced, slow_and_thorough, or custom. */
|
|
4299
4786
|
type SourceIndexMode = components["schemas"]["SourceIndexMode"];
|
|
4300
4787
|
/** Processing status: pending, processing, completed, or failed. */
|
|
@@ -4495,6 +4982,25 @@ declare class Seclai {
|
|
|
4495
4982
|
* @returns The exported agent snapshot.
|
|
4496
4983
|
*/
|
|
4497
4984
|
exportAgent(agentId: string, download?: boolean): Promise<AgentExportResponse>;
|
|
4985
|
+
/**
|
|
4986
|
+
* Validate an `agent_definition` payload (same shape as {@link exportAgent})
|
|
4987
|
+
* without creating or modifying any agent.
|
|
4988
|
+
*
|
|
4989
|
+
* Use this before {@link createAgent} or {@link updateAgent} with an
|
|
4990
|
+
* `agent_definition` to surface `unresolved_refs` — workflow references to
|
|
4991
|
+
* knowledge bases, memory banks, source connections, or sub-agents that
|
|
4992
|
+
* don't exist in the target account. Pass the returned ids back in
|
|
4993
|
+
* `entity_remap` on the commit call to substitute them.
|
|
4994
|
+
*
|
|
4995
|
+
* @param body - The preview payload (`{ agent_definition: ... }`).
|
|
4996
|
+
* @returns Summary of the validated payload (step counts, schedules,
|
|
4997
|
+
* alert configs, evaluation criteria, governance policies, and any
|
|
4998
|
+
* `unresolved_refs`).
|
|
4999
|
+
* @throws {SeclaiAPIValidationError} On HTTP 422 — the body is an
|
|
5000
|
+
* {@link AgentDefinitionImportErrorResponse} with 1-indexed
|
|
5001
|
+
* line/column-anchored errors against a canonical `source` echo.
|
|
5002
|
+
*/
|
|
5003
|
+
previewImportAgent(body: AgentImportPreviewRequest): Promise<AgentImportPreviewResponse>;
|
|
4498
5004
|
/**
|
|
4499
5005
|
* Get an agent's full definition (steps, model config, etc.).
|
|
4500
5006
|
*
|
|
@@ -4650,6 +5156,33 @@ declare class Seclai {
|
|
|
4650
5156
|
* @returns Upload status and metadata.
|
|
4651
5157
|
*/
|
|
4652
5158
|
getAgentInputUploadStatus(agentId: string, uploadId: string): Promise<UploadAgentInputApiResponse>;
|
|
5159
|
+
/**
|
|
5160
|
+
* Get the static attachment-reference contract for an agent — what files (if
|
|
5161
|
+
* any) its definition expects on a run.
|
|
5162
|
+
*
|
|
5163
|
+
* Call this before staging uploads to learn whether the agent accepts files
|
|
5164
|
+
* at all (`requires_uploads`) and which specific filenames, indexes, or glob
|
|
5165
|
+
* patterns its templates reference. A run-time upload batch that doesn't
|
|
5166
|
+
* satisfy every declared selector is rejected with HTTP 400.
|
|
5167
|
+
*
|
|
5168
|
+
* @param agentId - Agent identifier.
|
|
5169
|
+
* @returns The agent's attachment-reference contract.
|
|
5170
|
+
*/
|
|
5171
|
+
getAgentAttachmentReferences(agentId: string): Promise<AgentAttachmentRefsApiResponse>;
|
|
5172
|
+
/**
|
|
5173
|
+
* Download a file attachment emitted by a step in an agent run.
|
|
5174
|
+
*
|
|
5175
|
+
* Returns the raw `Response` so you can stream or save the binary data.
|
|
5176
|
+
*
|
|
5177
|
+
* @param runId - Run identifier.
|
|
5178
|
+
* @param attachmentId - URL-safe-base64-encoded `storage_key` of the attachment
|
|
5179
|
+
* (as surfaced in run output manifests and webhook/email payloads).
|
|
5180
|
+
* @param opts - Optional `downloadName` filename hint for the download disposition.
|
|
5181
|
+
* @returns Raw response with the attachment bytes.
|
|
5182
|
+
*/
|
|
5183
|
+
downloadAgentRunAttachment(runId: string, attachmentId: string, opts?: {
|
|
5184
|
+
downloadName?: string;
|
|
5185
|
+
}): Promise<Response>;
|
|
4653
5186
|
/**
|
|
4654
5187
|
* Generate agent workflow steps from natural language using AI.
|
|
4655
5188
|
*
|
|
@@ -5424,6 +5957,15 @@ declare class Seclai {
|
|
|
5424
5957
|
* @param experimentId - Experiment identifier.
|
|
5425
5958
|
*/
|
|
5426
5959
|
cancelExperiment(experimentId: string): Promise<unknown>;
|
|
5960
|
+
/**
|
|
5961
|
+
* Soft-delete a model playground experiment.
|
|
5962
|
+
*
|
|
5963
|
+
* Removes the experiment from list/detail views while preserving audit
|
|
5964
|
+
* history. Returns HTTP 204 with no body.
|
|
5965
|
+
*
|
|
5966
|
+
* @param experimentId - Experiment identifier.
|
|
5967
|
+
*/
|
|
5968
|
+
deleteExperiment(experimentId: string): Promise<void>;
|
|
5427
5969
|
/**
|
|
5428
5970
|
* Search across all resource types in your account.
|
|
5429
5971
|
*
|
|
@@ -5471,7 +6013,7 @@ declare class Seclai {
|
|
|
5471
6013
|
*
|
|
5472
6014
|
* @param body - Generation request.
|
|
5473
6015
|
*/
|
|
5474
|
-
aiAssistantMemoryBank(body:
|
|
6016
|
+
aiAssistantMemoryBank(body: MemoryBankAiAssistantRequest): Promise<MemoryBankAiAssistantResponse>;
|
|
5475
6017
|
/**
|
|
5476
6018
|
* Get AI assistant memory bank conversation history.
|
|
5477
6019
|
*/
|
|
@@ -5702,4 +6244,4 @@ declare class SeclaiStreamingError extends SeclaiError {
|
|
|
5702
6244
|
constructor(message: string, runId?: string);
|
|
5703
6245
|
}
|
|
5704
6246
|
|
|
5705
|
-
export { type AccessTokenProvider, type AddCommentRequest, type AddConversationTurnRequest, type AgentDefinitionResponse, type AgentEvaluationTier, type AgentExportResponse, type AgentListResponse, type AgentRunAttemptResponse, type AgentRunEvent, type AgentRunListResponse, type AgentRunRequest, type AgentRunResponse, type AgentRunStepResponse, type AgentRunStreamRequest, type AgentSummaryResponse, type AgentTraceMatchResponse, type AgentTraceSearchRequest, type AgentTraceSearchResponse, type AiAssistantAcceptRequest, type AiAssistantAcceptResponse, type AiAssistantFeedbackRequest, type AiAssistantFeedbackResponse, type AiAssistantGenerateRequest, type AiAssistantGenerateResponse, type AiConversationHistoryResponse, type AiConversationTurnResponse, type AuthState, type ChangeStatusRequest, type CompactionEvaluationModel, type CompactionTestResponse, type CompatibleRunListResponse, type CompatibleRunResponse, type ContentDetailResponse, type ContentEmbeddingResponse, type ContentEmbeddingsListResponse, type ContentFileUploadResponse, type CreateAgentRequest, type CreateAlertConfigRequest, type CreateEvaluationCriteriaRequest, type CreateEvaluationResultRequest, type CreateExperimentInput, type CreateExportRequest, type CreateKnowledgeBaseBody, type CreateMemoryBankBody, type CreateSolutionRequest, type CreateSourceBody, type CredentialChainOptions, DEFAULT_SSO_CLIENT_ID, DEFAULT_SSO_DOMAIN, DEFAULT_SSO_REGION, type EstimateExportRequest, type EstimateExportResponse, type EvaluationCriteriaResponse, type EvaluationResultListResponse, type EvaluationResultResponse, type EvaluationResultSummaryResponse, type EvaluationResultWithCriteriaListResponse, type EvaluationResultWithCriteriaResponse, type EvaluationRunSummaryListResponse, type EvaluationRunSummaryResponse, type EvaluationStatus, type ExamplePrompt, type ExecutedActionResponse, type ExportFormat, type ExportListResponse, type ExportResponse, type FetchLike, type FileUploadResponse, type GenerateAgentStepsRequest, type GenerateAgentStepsResponse, type GenerateStepConfigRequest, type GenerateStepConfigResponse, type GovernanceAiAcceptResponse, type GovernanceAiAssistantRequest, type GovernanceAiAssistantResponse, type GovernanceAppliedActionResponse, type GovernanceConversationResponse, type GovernanceProposedPolicyActionResponse, type HTTPValidationError, type InlineTextReplaceRequest, type InlineTextUploadRequest, type JSONValue, type KnowledgeBaseListResponse, type KnowledgeBaseResponse, type LinkResourcesRequest, type ListOptions, type MarkAiSuggestionRequest, type MarkConversationTurnRequest, type MemoryBankAcceptRequest, type MemoryBankAiAssistantRequest, type MemoryBankAiAssistantResponse, type MemoryBankConfigResponse, type MemoryBankConversationTurnResponse, type MemoryBankLastConversationResponse, type MemoryBankListResponse, type MemoryBankResponse, type NonManualEvaluationModeStatResponse, type NonManualEvaluationSummaryResponse, type OrganizationAlertPreferenceListResponse, type OrganizationAlertPreferenceResponse, type PaginationResponse, type PendingProcessingCompletedFailedStatus, type PlaygroundCreateRequest, type PromptModelAutoUpgradeStrategy, type PromptModelResponse, type PromptToolResponse, type ProposedActionResponse, type ProviderGroupResponse, SECLAI_API_URL, Seclai, SeclaiAPIStatusError, SeclaiAPIValidationError, SeclaiConfigurationError, SeclaiError, type SeclaiOptions, SeclaiStreamingError, type SolutionAgentResponse, type SolutionConversationResponse, type SolutionKnowledgeBaseResponse, type SolutionListResponse, type SolutionResponse, type SolutionSourceConnectionResponse, type SolutionSummaryResponse, type SortableListOptions, type SourceConnectionResponse, type SourceEmbeddingMigrationResponse, type SourceIndexMode, type SourceListResponse, type SourceResponse, type SsoCacheEntry, type SsoProfile, type StandaloneTestCompactionRequest, type StartSourceEmbeddingMigrationRequest, type TestCompactionRequest, type TestDraftEvaluationRequest, type TestDraftEvaluationResponse, type UnlinkResourcesRequest, type UpdateAgentDefinitionRequest, type UpdateAgentRequest, type UpdateAlertConfigRequest, type UpdateEvaluationCriteriaRequest, type UpdateKnowledgeBaseBody, type UpdateMemoryBankBody, type UpdateOrganizationAlertPreferenceRequest, type UpdateSolutionRequest, type UpdateSourceBody, type UploadAgentInputApiResponse, type ValidationError, type VariantCategoryResponse, type VariantOptionResponse, deleteSsoCache, isTokenValid, loadSsoProfile, readSsoCache, writeSsoCache };
|
|
6247
|
+
export { type AccessTokenProvider, type AddCommentRequest, type AddConversationTurnRequest, type AgentAttachmentRefsApiResponse, type AgentDefinitionImportErrorResponse, type AgentDefinitionResponse, type AgentEvaluationTier, type AgentExportResponse, type AgentImportPreviewRequest, type AgentImportPreviewResponse, type AgentListResponse, type AgentRunAttemptResponse, type AgentRunEvent, type AgentRunListResponse, type AgentRunRequest, type AgentRunResponse, type AgentRunStepResponse, type AgentRunStreamRequest, type AgentRunToolCallResponse, type AgentSummaryResponse, type AgentTraceMatchResponse, type AgentTraceSearchRequest, type AgentTraceSearchResponse, type AiAssistantAcceptRequest, type AiAssistantAcceptResponse, type AiAssistantFeedbackRequest, type AiAssistantFeedbackResponse, type AiAssistantGenerateRequest, type AiAssistantGenerateResponse, type AiConversationHistoryResponse, type AiConversationTurnResponse, type AttachmentRefsSourceApiSummary, type AuthState, type ChangeStatusRequest, type CompactionEvaluationModel, type CompactionTestResponse, type CompatibleRunListResponse, type CompatibleRunResponse, type ContentDetailResponse, type ContentEmbeddingResponse, type ContentEmbeddingsListResponse, type ContentFileUploadResponse, type CreateAgentRequest, type CreateAlertConfigRequest, type CreateEvaluationCriteriaRequest, type CreateEvaluationResultRequest, type CreateExperimentInput, type CreateExportRequest, type CreateKnowledgeBaseBody, type CreateMemoryBankBody, type CreateSolutionRequest, type CreateSourceBody, type CredentialChainOptions, DEFAULT_SSO_CLIENT_ID, DEFAULT_SSO_DOMAIN, DEFAULT_SSO_REGION, type EstimateExportRequest, type EstimateExportResponse, type EvaluationCriteriaResponse, type EvaluationResultListResponse, type EvaluationResultResponse, type EvaluationResultSummaryResponse, type EvaluationResultWithCriteriaListResponse, type EvaluationResultWithCriteriaResponse, type EvaluationRunSummaryListResponse, type EvaluationRunSummaryResponse, type EvaluationStatus, type ExamplePrompt, type ExecutedActionResponse, type ExportFormat, type ExportListResponse, type ExportResponse, type FetchLike, type FileUploadResponse, type GenerateAgentStepsRequest, type GenerateAgentStepsResponse, type GenerateStepConfigRequest, type GenerateStepConfigResponse, type GovernanceAiAcceptResponse, type GovernanceAiAssistantRequest, type GovernanceAiAssistantResponse, type GovernanceAppliedActionResponse, type GovernanceConversationResponse, type GovernancePolicyRefResponse, type GovernanceProposedPolicyActionResponse, type HTTPValidationError, type ImportFieldErrorModel, type ImportSkipResponse, type InlineTextReplaceRequest, type InlineTextUploadRequest, type InsufficientCreditsDetail, type InsufficientCreditsResponse, type JSONValue, type KnowledgeBaseListResponse, type KnowledgeBaseResponse, type LinkResourcesRequest, type ListOptions, type MarkAiSuggestionRequest, type MarkConversationTurnRequest, type MemoryBankAcceptRequest, type MemoryBankAiAssistantRequest, type MemoryBankAiAssistantResponse, type MemoryBankConfigResponse, type MemoryBankConversationTurnResponse, type MemoryBankLastConversationResponse, type MemoryBankListResponse, type MemoryBankResponse, type ModalityRateResponse, type NonManualEvaluationModeStatResponse, type NonManualEvaluationSummaryResponse, type OrganizationAlertPreferenceListResponse, type OrganizationAlertPreferenceResponse, type PaginationResponse, type PendingProcessingCompletedFailedStatus, type PlaygroundCreateRequest, type PromptModelAutoUpgradeStrategy, type PromptModelResponse, type PromptToolResponse, type ProposedActionResponse, type ProviderGroupResponse, SECLAI_API_URL, Seclai, SeclaiAPIStatusError, SeclaiAPIValidationError, SeclaiConfigurationError, SeclaiError, type SeclaiOptions, SeclaiStreamingError, type SolutionAgentResponse, type SolutionConversationResponse, type SolutionKnowledgeBaseResponse, type SolutionListResponse, type SolutionResponse, type SolutionSourceConnectionResponse, type SolutionSummaryResponse, type SortableListOptions, type SourceConnectionResponse, type SourceEmbeddingMigrationResponse, type SourceIndexMode, type SourceListResponse, type SourceResponse, type SsoCacheEntry, type SsoProfile, type StandaloneTestCompactionRequest, type StartSourceEmbeddingMigrationRequest, type TestCompactionRequest, type TestDraftEvaluationRequest, type TestDraftEvaluationResponse, type UnlinkResourcesRequest, type UpdateAgentDefinitionRequest, type UpdateAgentRequest, type UpdateAlertConfigRequest, type UpdateEvaluationCriteriaRequest, type UpdateKnowledgeBaseBody, type UpdateMemoryBankBody, type UpdateOrganizationAlertPreferenceRequest, type UpdateSolutionRequest, type UpdateSourceBody, type UploadAgentInputApiResponse, type ValidationError, type VariantCategoryResponse, type VariantOptionResponse, deleteSsoCache, isTokenValid, loadSsoProfile, readSsoCache, writeSsoCache };
|