@seclai/sdk 1.1.4 → 1.2.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/dist/index.d.ts CHANGED
@@ -20,6 +20,28 @@ interface components {
20
20
  */
21
21
  user_input: string;
22
22
  };
23
+ /**
24
+ * AgentDefinitionImportErrorResponse
25
+ * @description 422 body for invalid `agent_definition` payloads.
26
+ *
27
+ * Mirrors :py:meth:`AgentDefinitionImportError.to_response_dict`.
28
+ */
29
+ AgentDefinitionImportErrorResponse: {
30
+ /**
31
+ * Error
32
+ * @default invalid_agent_definition
33
+ */
34
+ error: string;
35
+ /** Errors */
36
+ errors: components["schemas"]["ImportFieldErrorModel"][];
37
+ /** Message */
38
+ message: string;
39
+ /**
40
+ * Source
41
+ * @description Canonical pretty-printed echo of the supplied payload — error line/column refer to this string.
42
+ */
43
+ source: string;
44
+ };
23
45
  /** AgentDefinitionResponse */
24
46
  AgentDefinitionResponse: {
25
47
  /**
@@ -29,7 +51,7 @@ interface components {
29
51
  change_id: string;
30
52
  /**
31
53
  * Definition
32
- * @description The agent definition containing name, description, tags, and step workflow tree. Step types include prompt_call, retrieval, transform, gate, retry, evaluate_step, insight, extract_json, send_email, webhook_call, call_agent, write_metadata, write_content_attachment, load_content_attachment, load_content, display_result, and others.
54
+ * @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, and others.
33
55
  */
34
56
  definition: {
35
57
  [key: string]: unknown;
@@ -179,6 +201,11 @@ interface components {
179
201
  * @description List of attempts made for this agent run.
180
202
  */
181
203
  attempts: components["schemas"]["AgentRunAttemptResponse"][];
204
+ /**
205
+ * Blocked Policies
206
+ * @description Governance policies that produced at least one BLOCK verdict during this run. Deduplicated by policy id.
207
+ */
208
+ blocked_policies?: components["schemas"]["routers__api__agents__GovernancePolicyRefResponse"][];
182
209
  /**
183
210
  * Credits
184
211
  * @description Credits consumed by the agent run, if applicable.
@@ -189,11 +216,31 @@ interface components {
189
216
  * @description Number of errors encountered during the run.
190
217
  */
191
218
  error_count: number;
219
+ /**
220
+ * Flagged Policies
221
+ * @description Governance policies that produced at least one FLAG verdict during this run. Deduplicated by policy id.
222
+ */
223
+ flagged_policies?: components["schemas"]["routers__api__agents__GovernancePolicyRefResponse"][];
224
+ /**
225
+ * Governance Input Status
226
+ * @description Result of the governance input evaluation: safe, blocked, skipped, or timed_out.
227
+ */
228
+ governance_input_status?: string | null;
229
+ /**
230
+ * Governance Input Wait Ms
231
+ * @description Milliseconds spent waiting for governance input evaluation.
232
+ */
233
+ governance_input_wait_ms?: number | null;
192
234
  /**
193
235
  * Input
194
236
  * @description Input provided to the agent for this run.
195
237
  */
196
238
  input: string | null;
239
+ /**
240
+ * Input Scan Status
241
+ * @description Result of the prompt injection scan: safe, unsafe, skipped, timed_out, or error.
242
+ */
243
+ input_scan_status?: string | null;
197
244
  /**
198
245
  * Output
199
246
  * @description Output produced by the agent run.
@@ -209,6 +256,11 @@ interface components {
209
256
  * @description Unique identifier for the agent run.
210
257
  */
211
258
  run_id: string;
259
+ /**
260
+ * Scan Wait Ms
261
+ * @description Milliseconds spent waiting for prompt injection scan.
262
+ */
263
+ scan_wait_ms?: number | null;
212
264
  /** @description Current status of the agent run. */
213
265
  status: components["schemas"]["PendingProcessingCompletedFailedStatus"];
214
266
  /**
@@ -315,6 +367,11 @@ interface components {
315
367
  * @description Unique agent identifier.
316
368
  */
317
369
  id: string;
370
+ /**
371
+ * Import Warnings
372
+ * @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.
373
+ */
374
+ import_warnings?: components["schemas"]["ImportSkipResponse"][] | null;
318
375
  /**
319
376
  * Max Retries
320
377
  * @description Max retries for eval_and_retry mode.
@@ -1045,6 +1102,8 @@ interface components {
1045
1102
  * @description Embedding model override.
1046
1103
  */
1047
1104
  embedding_model?: string | null;
1105
+ /** @description Index mode for custom_index sources: fast_and_cheap (default), balanced, slow_and_thorough, or custom. */
1106
+ index_mode?: components["schemas"]["SourceIndexMode"] | null;
1048
1107
  /**
1049
1108
  * Name
1050
1109
  * @description Source name.
@@ -1072,7 +1131,7 @@ interface components {
1072
1131
  retention?: number | null;
1073
1132
  /**
1074
1133
  * Source Type
1075
- * @description Source type: rss, website, file_uploads, or custom_index.
1134
+ * @description Source type: rss, website, or custom_index. The legacy value 'file_uploads' is accepted as an alias for custom_index.
1076
1135
  */
1077
1136
  source_type: string;
1078
1137
  /**
@@ -1493,7 +1552,7 @@ interface components {
1493
1552
  step_id?: string | null;
1494
1553
  /**
1495
1554
  * Step Type
1496
- * @description The step type to generate config for (e.g. 'transform', 'gate', 'text', 'prompt_call', 'retrieval').
1555
+ * @description The step type to generate config for (e.g. 'regex_replace', 'gate', 'text', 'prompt_call', 'retrieval').
1497
1556
  */
1498
1557
  step_type: string;
1499
1558
  /**
@@ -1604,6 +1663,64 @@ interface components {
1604
1663
  /** Detail */
1605
1664
  detail?: components["schemas"]["ValidationError"][];
1606
1665
  };
1666
+ /**
1667
+ * ImportFieldErrorModel
1668
+ * @description Single agent_definition validation error with source position.
1669
+ */
1670
+ ImportFieldErrorModel: {
1671
+ /**
1672
+ * Column
1673
+ * @description 1-indexed column in `source`.
1674
+ */
1675
+ column: number;
1676
+ /**
1677
+ * Line
1678
+ * @description 1-indexed line in `source`.
1679
+ */
1680
+ line: number;
1681
+ /**
1682
+ * Message
1683
+ * @description Human-readable description of the problem.
1684
+ */
1685
+ message: string;
1686
+ /**
1687
+ * Path
1688
+ * @description Dotted path of the offending field, e.g. `agent.definition.child_steps[0].step_type`.
1689
+ */
1690
+ path: string;
1691
+ };
1692
+ /**
1693
+ * ImportSkipResponse
1694
+ * @description One item that was not applied during an agent import.
1695
+ *
1696
+ * Used as the element type for ``import_warnings`` on every
1697
+ * response model that accepts an ``agent_definition`` payload.
1698
+ * See :py:class:`services.agent_definition_import.AgentImportSkip`
1699
+ * for the full category list.
1700
+ *
1701
+ * Lives here (not on each router) so the authenticated and public
1702
+ * API responses share one definition — keeping the shape that
1703
+ * clients (UI modal, MCP, OpenAPI consumers) depend on aligned.
1704
+ */
1705
+ ImportSkipResponse: {
1706
+ /**
1707
+ * Category
1708
+ * @description The kind of item that was skipped or substituted: 'schedule', 'evaluation_criteria', 'alert_config', 'alert_recipient', 'governance_policy', 'governance_kb_link', 'solution_link'.
1709
+ */
1710
+ category: string;
1711
+ /**
1712
+ * Details
1713
+ * @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.
1714
+ */
1715
+ details?: {
1716
+ [key: string]: unknown;
1717
+ };
1718
+ /**
1719
+ * Message
1720
+ * @description Human-readable explanation of what was skipped and why.
1721
+ */
1722
+ message: string;
1723
+ };
1607
1724
  /**
1608
1725
  * InlineTextReplaceRequest
1609
1726
  * @description Request model for inline text content replacement.
@@ -2032,11 +2149,96 @@ interface components {
2032
2149
  * @enum {string}
2033
2150
  */
2034
2151
  PendingProcessingCompletedFailedStatus: "pending" | "processing" | "completed" | "failed";
2152
+ /**
2153
+ * PlaygroundCreateRequest
2154
+ * @description Create a model playground experiment via the public API.
2155
+ */
2156
+ PlaygroundCreateRequest: {
2157
+ /**
2158
+ * Evaluation Complexity
2159
+ * @description simple, medium, or complex
2160
+ * @default medium
2161
+ * @enum {string}
2162
+ */
2163
+ evaluation_complexity: "simple" | "medium" | "complex";
2164
+ /**
2165
+ * Evaluation Mode
2166
+ * @description manual or prompt
2167
+ * @default manual
2168
+ * @enum {string}
2169
+ */
2170
+ evaluation_mode: "manual" | "prompt";
2171
+ /**
2172
+ * Evaluator Model Id
2173
+ * @description Evaluator model ID when evaluation_mode is prompt.
2174
+ */
2175
+ evaluator_model_id?: string | null;
2176
+ /**
2177
+ * Include Step Output In Evaluation
2178
+ * @description Whether to include selected step output as evaluator context.
2179
+ * @default false
2180
+ */
2181
+ include_step_output_in_evaluation: boolean;
2182
+ /**
2183
+ * Json Template
2184
+ * @description Optional JSON template for advanced mode.
2185
+ */
2186
+ json_template?: string | null;
2187
+ /**
2188
+ * Model Ids
2189
+ * @description Selected model IDs (1-10).
2190
+ */
2191
+ model_ids: string[];
2192
+ /**
2193
+ * Prompt
2194
+ * @description Prompt text for the experiment.
2195
+ */
2196
+ prompt: string;
2197
+ /**
2198
+ * Selected Step Output
2199
+ * @description Optional step output text for evaluator context.
2200
+ */
2201
+ selected_step_output?: string | null;
2202
+ /**
2203
+ * System Prompt
2204
+ * @description Optional system prompt.
2205
+ * @default
2206
+ */
2207
+ system_prompt: string;
2208
+ };
2035
2209
  /**
2036
2210
  * PromptModelAutoUpgradeStrategy
2037
2211
  * @enum {string}
2038
2212
  */
2039
2213
  PromptModelAutoUpgradeStrategy: "none" | "early_adopter" | "middle_of_road" | "cautious_adopter";
2214
+ /**
2215
+ * PromptToolResponse
2216
+ * @description Response model for a prompt tool.
2217
+ */
2218
+ PromptToolResponse: {
2219
+ /** Description */
2220
+ description?: string | null;
2221
+ /** Documentation Url */
2222
+ documentation_url?: string | null;
2223
+ /** Example */
2224
+ example?: string | null;
2225
+ /** Headers */
2226
+ headers?: {
2227
+ [key: string]: string;
2228
+ } | null;
2229
+ /** Id */
2230
+ id: string;
2231
+ /** Name */
2232
+ name: string;
2233
+ /** Notes */
2234
+ notes?: string | null;
2235
+ /** Tool Name */
2236
+ tool_name?: string | null;
2237
+ /** Tool Type */
2238
+ tool_type: string;
2239
+ /** Tool Type Pattern */
2240
+ tool_type_pattern?: string | null;
2241
+ };
2040
2242
  /**
2041
2243
  * ProposedActionResponse
2042
2244
  * @description A single proposed action.
@@ -2065,6 +2267,13 @@ interface components {
2065
2267
  params: {
2066
2268
  [key: string]: unknown;
2067
2269
  };
2270
+ /**
2271
+ * Preview
2272
+ * @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.
2273
+ */
2274
+ preview?: {
2275
+ [key: string]: unknown;
2276
+ } | null;
2068
2277
  };
2069
2278
  /**
2070
2279
  * ProposedPolicyActionResponse
@@ -2224,6 +2433,22 @@ interface components {
2224
2433
  /** Updated At */
2225
2434
  updated_at: string;
2226
2435
  };
2436
+ /**
2437
+ * SourceIndexMode
2438
+ * @description Embedding quality / cost trade-off preset for custom_index sources.
2439
+ *
2440
+ * Each preset controls the default embedding dimensions, chunk size, and
2441
+ * chunk overlap. The embedding model is always the account-level default
2442
+ * (currently ``AWS_BEDROCK_AMAZON_NOVA_2_MULTIMODAL``).
2443
+ *
2444
+ * Presets:
2445
+ * FAST_AND_CHEAP: 256 dimensions, 3 000 char chunks, 500 char overlap.
2446
+ * BALANCED: 384 dimensions, 1 500 char chunks, 300 char overlap.
2447
+ * SLOW_AND_THOROUGH: 1 024 dimensions, 1 000 char chunks, 200 char overlap.
2448
+ * CUSTOM: Caller supplies embedding model, dimensions, and chunk config.
2449
+ * @enum {string}
2450
+ */
2451
+ SourceIndexMode: "fast_and_cheap" | "balanced" | "slow_and_thorough" | "custom";
2227
2452
  /**
2228
2453
  * SourceResponse
2229
2454
  * @description Response model for source data.
@@ -2317,6 +2542,8 @@ interface components {
2317
2542
  * @description Unique identifier for the source connection.
2318
2543
  */
2319
2544
  id: string;
2545
+ /** @description Index mode for custom_index sources: fast_and_cheap, balanced, slow_and_thorough, or custom. */
2546
+ index_mode?: components["schemas"]["SourceIndexMode"] | null;
2320
2547
  /**
2321
2548
  * Name
2322
2549
  * @description Name of the source connection.
@@ -2791,6 +3018,142 @@ interface components {
2791
3018
  /** Error Type */
2792
3019
  type: string;
2793
3020
  };
3021
+ /**
3022
+ * VariantCategoryResponse
3023
+ * @description Response model for a variant category
3024
+ */
3025
+ VariantCategoryResponse: {
3026
+ /** Category */
3027
+ category: string;
3028
+ /** Configurable */
3029
+ configurable: boolean;
3030
+ /** Description */
3031
+ description: string;
3032
+ /** Options */
3033
+ options: components["schemas"]["VariantOptionResponse"][];
3034
+ /** Title */
3035
+ title: string;
3036
+ };
3037
+ /**
3038
+ * VariantOptionResponse
3039
+ * @description Response model for a variant option
3040
+ */
3041
+ VariantOptionResponse: {
3042
+ /** Default */
3043
+ default: boolean;
3044
+ /** Description */
3045
+ description?: string | null;
3046
+ /** Input 1H Cache Write Credits Per 1000 Tokens */
3047
+ input_1h_cache_write_credits_per_1000_tokens?: number | null;
3048
+ /** Input 5M Cache Write Credits Per 1000 Tokens */
3049
+ input_5m_cache_write_credits_per_1000_tokens?: number | null;
3050
+ /** Input Cache Hit Credits Per 1000 Tokens */
3051
+ input_cache_hit_credits_per_1000_tokens?: number | null;
3052
+ /** Input Credits Per 1000 Tokens */
3053
+ input_credits_per_1000_tokens?: number | null;
3054
+ /** Long Context Input Cache Hit Credits Per 1000 Tokens */
3055
+ long_context_input_cache_hit_credits_per_1000_tokens?: number | null;
3056
+ /** Long Context Input Credits Per 1000 Tokens */
3057
+ long_context_input_credits_per_1000_tokens?: number | null;
3058
+ /** Long Context Output Credits Per 1000 Tokens */
3059
+ long_context_output_credits_per_1000_tokens?: number | null;
3060
+ /** Long Context Threshold */
3061
+ long_context_threshold?: number | null;
3062
+ /** Output Credits Per 1000 Tokens */
3063
+ output_credits_per_1000_tokens?: number | null;
3064
+ /** Title */
3065
+ title: string;
3066
+ /** Value */
3067
+ value: string;
3068
+ };
3069
+ /**
3070
+ * AgentImportPreviewRequest
3071
+ * @description Dry-run import request — same payload shape as the export endpoint.
3072
+ */
3073
+ routers__api__agents__AgentImportPreviewRequest: {
3074
+ /**
3075
+ * Agent Definition
3076
+ * @description Payload in the same shape as GET /api/agents/{agent_id}/export.
3077
+ */
3078
+ agent_definition: {
3079
+ [key: string]: unknown;
3080
+ };
3081
+ };
3082
+ /**
3083
+ * AgentImportPreviewResponse
3084
+ * @description Summary of a successfully validated import payload (no DB writes).
3085
+ *
3086
+ * Counts are derived from the validated payload as supplied — they
3087
+ * reflect what was requested, not what would eventually be persisted
3088
+ * (cross-account skips for recipients and KB names happen later, only
3089
+ * on commit).
3090
+ */
3091
+ routers__api__agents__AgentImportPreviewResponse: {
3092
+ /**
3093
+ * Agent Name
3094
+ * @description Imported agent name, if any.
3095
+ */
3096
+ agent_name: string | null;
3097
+ /**
3098
+ * Alert Configs
3099
+ * @description Number of alert configs in the payload.
3100
+ */
3101
+ alert_configs: number;
3102
+ /**
3103
+ * Description
3104
+ * @description Imported agent description, if any.
3105
+ */
3106
+ description: string | null;
3107
+ /**
3108
+ * Evaluation Criteria
3109
+ * @description Number of evaluation criteria in the payload.
3110
+ */
3111
+ evaluation_criteria: number;
3112
+ /**
3113
+ * Governance Policies
3114
+ * @description Number of agent-scoped governance policies in the payload.
3115
+ */
3116
+ governance_policies: number;
3117
+ /**
3118
+ * Ok
3119
+ * @description Always true on a 200 response; failures use HTTP 422.
3120
+ */
3121
+ ok: boolean;
3122
+ /**
3123
+ * Payload Export Version
3124
+ * @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.
3125
+ */
3126
+ payload_export_version?: string | null;
3127
+ /**
3128
+ * Schedules
3129
+ * @description Number of trigger schedules in the payload.
3130
+ */
3131
+ schedules: number;
3132
+ /**
3133
+ * Solutions
3134
+ * @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.
3135
+ * @default 0
3136
+ */
3137
+ solutions: number;
3138
+ /**
3139
+ * Step Count
3140
+ * @description Total number of steps in the workflow tree (recursive).
3141
+ */
3142
+ step_count: number;
3143
+ /**
3144
+ * Supported Export Version
3145
+ * @description Export-format version this server understands. Compare against ``payload_export_version`` to detect cross-version imports.
3146
+ * @default 2
3147
+ */
3148
+ supported_export_version: string;
3149
+ /**
3150
+ * Unresolved Refs
3151
+ * @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.
3152
+ */
3153
+ unresolved_refs?: {
3154
+ [key: string]: unknown;
3155
+ }[];
3156
+ };
2794
3157
  /** AgentListResponse */
2795
3158
  routers__api__agents__AgentListResponse: {
2796
3159
  /**
@@ -2840,6 +3203,13 @@ interface components {
2840
3203
  };
2841
3204
  /** CreateAgentRequest */
2842
3205
  routers__api__agents__CreateAgentRequest: {
3206
+ /**
3207
+ * Agent Definition
3208
+ * @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.
3209
+ */
3210
+ agent_definition?: {
3211
+ [key: string]: unknown;
3212
+ } | null;
2843
3213
  /**
2844
3214
  * Agent Template
2845
3215
  * @description Template to initialize the agent from. Values: blank, retrieval_example, simple_qa, summarizer, json_extractor, content_change_notifier, scheduled_report, webhook_pipeline.
@@ -2850,6 +3220,13 @@ interface components {
2850
3220
  * @description Optional description.
2851
3221
  */
2852
3222
  description?: string | null;
3223
+ /**
3224
+ * Entity Remap
3225
+ * @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.
3226
+ */
3227
+ entity_remap?: {
3228
+ [key: string]: string;
3229
+ } | null;
2853
3230
  /**
2854
3231
  * Name
2855
3232
  * @description Name for the new agent.
@@ -2862,8 +3239,31 @@ interface components {
2862
3239
  */
2863
3240
  trigger_type: string;
2864
3241
  };
3242
+ /**
3243
+ * GovernancePolicyRefResponse
3244
+ * @description Reference to a governance policy by id and name.
3245
+ */
3246
+ routers__api__agents__GovernancePolicyRefResponse: {
3247
+ /**
3248
+ * Policy Id
3249
+ * @description Governance policy identifier.
3250
+ */
3251
+ policy_id: string;
3252
+ /**
3253
+ * Policy Name
3254
+ * @description Display name of the policy at evaluation time. May be null when the policy has been deleted.
3255
+ */
3256
+ policy_name?: string | null;
3257
+ };
2865
3258
  /** UpdateAgentRequest */
2866
3259
  routers__api__agents__UpdateAgentRequest: {
3260
+ /**
3261
+ * Agent Definition
3262
+ * @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.
3263
+ */
3264
+ agent_definition?: {
3265
+ [key: string]: unknown;
3266
+ } | null;
2867
3267
  /**
2868
3268
  * Default Evaluation Tier
2869
3269
  * @description Default evaluation tier: 'fast', 'balanced', or 'thorough'.
@@ -2874,6 +3274,13 @@ interface components {
2874
3274
  * @description New description for the agent.
2875
3275
  */
2876
3276
  description?: string | null;
3277
+ /**
3278
+ * Entity Remap
3279
+ * @description Optional UUID-substitution map applied to the imported workflow before save (same shape as on POST /agents).
3280
+ */
3281
+ entity_remap?: {
3282
+ [key: string]: string;
3283
+ } | null;
2877
3284
  /**
2878
3285
  * Evaluation Mode
2879
3286
  * @description Evaluation mode: 'output_expectation', 'eval_and_retry', or 'sample_and_flag'.
@@ -3689,6 +4096,135 @@ interface components {
3689
4096
  data: components["schemas"]["SourceResponse"][];
3690
4097
  pagination: components["schemas"]["PaginationResponse"];
3691
4098
  };
4099
+ /**
4100
+ * PromptModelResponse
4101
+ * @description Response model for prompt model data
4102
+ */
4103
+ schemas__model_responses__PromptModelResponse: {
4104
+ /** Default */
4105
+ default: boolean;
4106
+ /** Deprecated At */
4107
+ deprecated_at?: string | null;
4108
+ /** Description */
4109
+ description: string;
4110
+ /** Enabled */
4111
+ enabled: boolean;
4112
+ /** Family */
4113
+ family?: string | null;
4114
+ /** Family Generation */
4115
+ family_generation?: number | null;
4116
+ /** Id */
4117
+ id: string;
4118
+ /** Input 1H Cache Write Credits Per 1000 Tokens */
4119
+ input_1h_cache_write_credits_per_1000_tokens?: number | null;
4120
+ /** Input 5M Cache Write Credits Per 1000 Tokens */
4121
+ input_5m_cache_write_credits_per_1000_tokens?: number | null;
4122
+ /** Input Cache Hit Credits Per 1000 Tokens */
4123
+ input_cache_hit_credits_per_1000_tokens?: number | null;
4124
+ /** Input Credits Per 1000 Tokens */
4125
+ input_credits_per_1000_tokens?: number | null;
4126
+ /**
4127
+ * Is New
4128
+ * @default false
4129
+ */
4130
+ is_new: boolean;
4131
+ /**
4132
+ * Last Used
4133
+ * @default false
4134
+ */
4135
+ last_used: boolean;
4136
+ /** Max Context Tokens */
4137
+ max_context_tokens: number;
4138
+ /** Max Conversation Length */
4139
+ max_conversation_length: number;
4140
+ /** Max Output Tokens */
4141
+ max_output_tokens: number;
4142
+ /** Model Id */
4143
+ model_id: string;
4144
+ /** Name */
4145
+ name: string;
4146
+ /** Output Credits Per 1000 Tokens */
4147
+ output_credits_per_1000_tokens?: number | null;
4148
+ /**
4149
+ * Payload Schema
4150
+ * @description Model-specific JSON schema for advanced prompt_call json_template payloads.
4151
+ */
4152
+ payload_schema?: {
4153
+ [key: string]: unknown;
4154
+ } | null;
4155
+ /**
4156
+ * Payload Schema Source Url
4157
+ * @description Source URL used to derive payload_schema guidance for this model.
4158
+ */
4159
+ payload_schema_source_url?: string | null;
4160
+ /** Provider */
4161
+ provider: string;
4162
+ /** Released At */
4163
+ released_at?: string | null;
4164
+ /**
4165
+ * Schema Documentation Url
4166
+ * @description Model documentation URL with request/response payload details.
4167
+ */
4168
+ schema_documentation_url?: string | null;
4169
+ /**
4170
+ * Schema Notes
4171
+ * @description Human-readable notes about request payload compatibility.
4172
+ */
4173
+ schema_notes?: string | null;
4174
+ /** Successor Model Id */
4175
+ successor_model_id?: string | null;
4176
+ /** Sunset At */
4177
+ sunset_at?: string | null;
4178
+ /** Supported Input Media */
4179
+ supported_input_media?: string[] | null;
4180
+ /** Supported Languages */
4181
+ supported_languages?: string[] | null;
4182
+ /**
4183
+ * Supports Openai Arguments
4184
+ * @default false
4185
+ */
4186
+ supports_openai_arguments: boolean;
4187
+ /**
4188
+ * Supports Streaming
4189
+ * @default false
4190
+ */
4191
+ supports_streaming: boolean;
4192
+ /**
4193
+ * Supports Structured Output
4194
+ * @default true
4195
+ */
4196
+ supports_structured_output: boolean;
4197
+ /**
4198
+ * Supports Thinking
4199
+ * @default false
4200
+ */
4201
+ supports_thinking: boolean;
4202
+ /**
4203
+ * Supports Tool Use
4204
+ * @default true
4205
+ */
4206
+ supports_tool_use: boolean;
4207
+ /** Tools Disabled */
4208
+ tools_disabled?: components["schemas"]["PromptToolResponse"][];
4209
+ /** Tools Enabled */
4210
+ tools_enabled?: components["schemas"]["PromptToolResponse"][];
4211
+ /** Training Cutoff At */
4212
+ training_cutoff_at?: string | null;
4213
+ /** Url */
4214
+ url?: string | null;
4215
+ /** Variants */
4216
+ variants?: components["schemas"]["VariantCategoryResponse"][] | null;
4217
+ };
4218
+ /**
4219
+ * ProviderGroupResponse
4220
+ * @description Response model for provider group with models
4221
+ */
4222
+ schemas__model_responses__ProviderGroupResponse: {
4223
+ /** Models */
4224
+ models: components["schemas"]["schemas__model_responses__PromptModelResponse"][];
4225
+ /** Provider */
4226
+ provider: string;
4227
+ };
3692
4228
  /**
3693
4229
  * NonManualEvaluationModeStatResponse
3694
4230
  * @description Per-mode rollup for evaluation activity.
@@ -3774,6 +4310,21 @@ type CreateAgentRequest = components["schemas"]["routers__api__agents__CreateAge
3774
4310
  type UpdateAgentRequest = components["schemas"]["routers__api__agents__UpdateAgentRequest"];
3775
4311
  /** Request body for updating an agent definition (steps, model, etc.). */
3776
4312
  type UpdateAgentDefinitionRequest = components["schemas"]["UpdateAgentDefinitionRequest"];
4313
+ /** Request body for previewing an agent_definition import (dry-run validation). */
4314
+ type AgentImportPreviewRequest = components["schemas"]["routers__api__agents__AgentImportPreviewRequest"];
4315
+ /** Response body summarising a successfully validated agent_definition import payload. */
4316
+ type AgentImportPreviewResponse = components["schemas"]["routers__api__agents__AgentImportPreviewResponse"];
4317
+ /**
4318
+ * 422 response body for invalid `agent_definition` payloads on create/update/preview-import.
4319
+ * Errors carry 1-indexed line/column references into the canonical `source` echo.
4320
+ */
4321
+ type AgentDefinitionImportErrorResponse = components["schemas"]["AgentDefinitionImportErrorResponse"];
4322
+ /** Single validation error within an {@link AgentDefinitionImportErrorResponse} (with source position). */
4323
+ type ImportFieldErrorModel = components["schemas"]["ImportFieldErrorModel"];
4324
+ /** One item dropped or substituted during an agent import (emitted in `import_warnings`). */
4325
+ type ImportSkipResponse = components["schemas"]["ImportSkipResponse"];
4326
+ /** Reference to a governance policy (id and optional display name). */
4327
+ type GovernancePolicyRefResponse = components["schemas"]["routers__api__agents__GovernancePolicyRefResponse"];
3777
4328
  /** Request body for starting an agent run. */
3778
4329
  type AgentRunRequest = components["schemas"]["AgentRunRequest"];
3779
4330
  /** Request body for starting an agent run in streaming mode (SSE). */
@@ -3994,6 +4545,27 @@ type AiAssistantFeedbackRequest = components["schemas"]["routers__api__ai_assist
3994
4545
  type AiAssistantFeedbackResponse = components["schemas"]["AiAssistantFeedbackResponse"];
3995
4546
  /** Prompt model auto-upgrade strategy. */
3996
4547
  type PromptModelAutoUpgradeStrategy = components["schemas"]["PromptModelAutoUpgradeStrategy"];
4548
+ /** Models grouped by provider. */
4549
+ type ProviderGroupResponse = components["schemas"]["schemas__model_responses__ProviderGroupResponse"];
4550
+ /** Full model details including capabilities, pricing, and lifecycle status. */
4551
+ type PromptModelResponse = components["schemas"]["schemas__model_responses__PromptModelResponse"];
4552
+ /** Prompt tool configuration within a model. */
4553
+ type PromptToolResponse = components["schemas"]["PromptToolResponse"];
4554
+ /** Variant category for model pricing tiers. */
4555
+ type VariantCategoryResponse = components["schemas"]["VariantCategoryResponse"];
4556
+ /** Variant option with credit pricing and context limits. */
4557
+ type VariantOptionResponse = components["schemas"]["VariantOptionResponse"];
4558
+ /** Request body for creating a model playground experiment. */
4559
+ type PlaygroundCreateRequest = components["schemas"]["PlaygroundCreateRequest"];
4560
+ /**
4561
+ * Input type for {@link SeclaiClient.createExperiment}.
4562
+ *
4563
+ * Only `model_ids` and `prompt` are required — every other field has a
4564
+ * server-side default and can be omitted.
4565
+ */
4566
+ type CreateExperimentInput = Pick<PlaygroundCreateRequest, "model_ids" | "prompt"> & Partial<Omit<PlaygroundCreateRequest, "model_ids" | "prompt">>;
4567
+ /** Source index mode: fast_and_cheap, balanced, slow_and_thorough, or custom. */
4568
+ type SourceIndexMode = components["schemas"]["SourceIndexMode"];
3997
4569
  /** Processing status: pending, processing, completed, or failed. */
3998
4570
  type PendingProcessingCompletedFailedStatus = components["schemas"]["PendingProcessingCompletedFailedStatus"];
3999
4571
  /** An SSE event emitted during a streaming agent run. */
@@ -4192,6 +4764,25 @@ declare class Seclai {
4192
4764
  * @returns The exported agent snapshot.
4193
4765
  */
4194
4766
  exportAgent(agentId: string, download?: boolean): Promise<AgentExportResponse>;
4767
+ /**
4768
+ * Validate an `agent_definition` payload (same shape as {@link exportAgent})
4769
+ * without creating or modifying any agent.
4770
+ *
4771
+ * Use this before {@link createAgent} or {@link updateAgent} with an
4772
+ * `agent_definition` to surface `unresolved_refs` — workflow references to
4773
+ * knowledge bases, memory banks, source connections, or sub-agents that
4774
+ * don't exist in the target account. Pass the returned ids back in
4775
+ * `entity_remap` on the commit call to substitute them.
4776
+ *
4777
+ * @param body - The preview payload (`{ agent_definition: ... }`).
4778
+ * @returns Summary of the validated payload (step counts, schedules,
4779
+ * alert configs, evaluation criteria, governance policies, and any
4780
+ * `unresolved_refs`).
4781
+ * @throws {SeclaiAPIValidationError} On HTTP 422 — the body is an
4782
+ * {@link AgentDefinitionImportErrorResponse} with 1-indexed
4783
+ * line/column-anchored errors against a canonical `source` echo.
4784
+ */
4785
+ previewImportAgent(body: AgentImportPreviewRequest): Promise<AgentImportPreviewResponse>;
4195
4786
  /**
4196
4787
  * Get an agent's full definition (steps, model config, etc.).
4197
4788
  *
@@ -5075,6 +5666,52 @@ declare class Seclai {
5075
5666
  * @param modelId - Model identifier.
5076
5667
  */
5077
5668
  getModelRecommendations(modelId: string): Promise<unknown>;
5669
+ /**
5670
+ * List all enabled LLM models grouped by provider.
5671
+ *
5672
+ * @param opts - Optional filters.
5673
+ */
5674
+ listModels(opts?: {
5675
+ provider?: string;
5676
+ supportsToolUse?: boolean;
5677
+ supportsThinking?: boolean;
5678
+ }): Promise<ProviderGroupResponse[]>;
5679
+ /**
5680
+ * Get full details for a specific model.
5681
+ *
5682
+ * @param modelId - Model identifier.
5683
+ */
5684
+ getModel(modelId: string): Promise<PromptModelResponse>;
5685
+ /**
5686
+ * List model playground experiments.
5687
+ *
5688
+ * @param opts - Optional filters and pagination.
5689
+ */
5690
+ listExperiments(opts?: {
5691
+ days?: number;
5692
+ startDate?: string;
5693
+ endDate?: string;
5694
+ limit?: number;
5695
+ offset?: number;
5696
+ }): Promise<unknown>;
5697
+ /**
5698
+ * Create a model playground experiment.
5699
+ *
5700
+ * @param body - Experiment configuration.
5701
+ */
5702
+ createExperiment(body: CreateExperimentInput): Promise<unknown>;
5703
+ /**
5704
+ * Get a model playground experiment by ID.
5705
+ *
5706
+ * @param experimentId - Experiment identifier.
5707
+ */
5708
+ getExperiment(experimentId: string): Promise<unknown>;
5709
+ /**
5710
+ * Cancel a running model playground experiment.
5711
+ *
5712
+ * @param experimentId - Experiment identifier.
5713
+ */
5714
+ cancelExperiment(experimentId: string): Promise<unknown>;
5078
5715
  /**
5079
5716
  * Search across all resource types in your account.
5080
5717
  *
@@ -5353,4 +5990,4 @@ declare class SeclaiStreamingError extends SeclaiError {
5353
5990
  constructor(message: string, runId?: string);
5354
5991
  }
5355
5992
 
5356
- 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 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 PromptModelAutoUpgradeStrategy, type ProposedActionResponse, 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 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, deleteSsoCache, isTokenValid, loadSsoProfile, readSsoCache, writeSsoCache };
5993
+ export { type AccessTokenProvider, type AddCommentRequest, type AddConversationTurnRequest, 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 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 GovernancePolicyRefResponse, type GovernanceProposedPolicyActionResponse, type HTTPValidationError, type ImportFieldErrorModel, type ImportSkipResponse, 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 };