@ai-matrx/api 0.0.0-stage → 0.1.1
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/CHANGELOG.md +31 -0
- package/LICENSE +21 -0
- package/README.md +22 -2
- package/dist/account.cjs +670 -0
- package/dist/account.d.cts +3246 -0
- package/dist/account.d.ts +3246 -0
- package/dist/account.js +558 -0
- package/dist/agents.cjs +598 -0
- package/dist/agents.d.cts +3417 -0
- package/dist/agents.d.ts +3417 -0
- package/dist/agents.js +497 -0
- package/dist/ai.cjs +109 -0
- package/dist/ai.d.cts +493 -0
- package/dist/ai.d.ts +493 -0
- package/dist/ai.js +91 -0
- package/dist/apps.cjs +394 -0
- package/dist/apps.d.cts +1094 -0
- package/dist/apps.d.ts +1094 -0
- package/dist/apps.js +328 -0
- package/dist/architecture.cjs +1223 -0
- package/dist/architecture.d.cts +4701 -0
- package/dist/architecture.d.ts +4701 -0
- package/dist/architecture.js +1016 -0
- package/dist/audio.cjs +226 -0
- package/dist/audio.d.cts +723 -0
- package/dist/audio.d.ts +723 -0
- package/dist/audio.js +188 -0
- package/dist/chat.cjs +538 -0
- package/dist/chat.d.cts +2251 -0
- package/dist/chat.d.ts +2251 -0
- package/dist/chat.js +447 -0
- package/dist/chunk-2SXAAKGV.cjs +279 -0
- package/dist/chunk-5WJLKYH6.cjs +48 -0
- package/dist/chunk-FNIYADWI.cjs +59 -0
- package/dist/chunk-HER22VVH.cjs +1047 -0
- package/dist/chunk-KIEAFMKB.js +264 -0
- package/dist/chunk-TSHL7Z53.js +1012 -0
- package/dist/chunk-VTZKJMSY.js +43 -0
- package/dist/chunk-YTEOFGFC.js +57 -0
- package/dist/code.cjs +561 -0
- package/dist/code.d.cts +1976 -0
- package/dist/code.d.ts +1976 -0
- package/dist/code.js +467 -0
- package/dist/commerce.cjs +22 -0
- package/dist/commerce.d.cts +45 -0
- package/dist/commerce.d.ts +45 -0
- package/dist/commerce.js +18 -0
- package/dist/communications.cjs +215 -0
- package/dist/communications.d.cts +948 -0
- package/dist/communications.d.ts +948 -0
- package/dist/communications.js +179 -0
- package/dist/computer.cjs +330 -0
- package/dist/computer.d.cts +733 -0
- package/dist/computer.d.ts +733 -0
- package/dist/computer.js +275 -0
- package/dist/content.cjs +425 -0
- package/dist/content.d.cts +1796 -0
- package/dist/content.d.ts +1796 -0
- package/dist/content.js +354 -0
- package/dist/credentials.cjs +22 -0
- package/dist/credentials.d.cts +82 -0
- package/dist/credentials.d.ts +82 -0
- package/dist/credentials.js +1 -0
- package/dist/crm.cjs +271 -0
- package/dist/crm.d.cts +1731 -0
- package/dist/crm.d.ts +1731 -0
- package/dist/crm.js +226 -0
- package/dist/data.cjs +382 -0
- package/dist/data.d.cts +1860 -0
- package/dist/data.d.ts +1860 -0
- package/dist/data.js +318 -0
- package/dist/education.cjs +28 -0
- package/dist/education.d.cts +73 -0
- package/dist/education.d.ts +73 -0
- package/dist/education.js +23 -0
- package/dist/files.cjs +1330 -0
- package/dist/files.d.cts +4956 -0
- package/dist/files.d.ts +4956 -0
- package/dist/files.js +1104 -0
- package/dist/human-resources.cjs +178 -0
- package/dist/human-resources.d.cts +1208 -0
- package/dist/human-resources.d.ts +1208 -0
- package/dist/human-resources.js +148 -0
- package/dist/index-C2E-Cp19.d.ts +385 -0
- package/dist/index-wC2vtb70.d.cts +385 -0
- package/dist/index.cjs +2016 -0
- package/dist/index.d.cts +2069 -0
- package/dist/index.d.ts +2069 -0
- package/dist/index.js +1746 -0
- package/dist/integrations.cjs +5116 -0
- package/dist/integrations.d.cts +19213 -0
- package/dist/integrations.d.ts +19213 -0
- package/dist/integrations.js +4263 -0
- package/dist/intelligence.cjs +1305 -0
- package/dist/intelligence.d.cts +4658 -0
- package/dist/intelligence.d.ts +4658 -0
- package/dist/intelligence.js +1196 -0
- package/dist/knowledge.cjs +1113 -0
- package/dist/knowledge.d.cts +5427 -0
- package/dist/knowledge.d.ts +5427 -0
- package/dist/knowledge.js +921 -0
- package/dist/legal.cjs +225 -0
- package/dist/legal.d.cts +1038 -0
- package/dist/legal.d.ts +1038 -0
- package/dist/legal.js +187 -0
- package/dist/marketing.cjs +1155 -0
- package/dist/marketing.d.cts +7741 -0
- package/dist/marketing.d.ts +7741 -0
- package/dist/marketing.js +951 -0
- package/dist/masterwork.cjs +283 -0
- package/dist/masterwork.d.cts +1938 -0
- package/dist/masterwork.d.ts +1938 -0
- package/dist/masterwork.js +231 -0
- package/dist/media.cjs +610 -0
- package/dist/media.d.cts +2270 -0
- package/dist/media.d.ts +2270 -0
- package/dist/media.js +507 -0
- package/dist/net.cjs +67 -0
- package/dist/net.d.cts +204 -0
- package/dist/net.d.ts +204 -0
- package/dist/net.js +2 -0
- package/dist/platform.cjs +150 -0
- package/dist/platform.d.cts +572 -0
- package/dist/platform.d.ts +572 -0
- package/dist/platform.js +125 -0
- package/dist/publish.cjs +248 -0
- package/dist/publish.d.cts +1431 -0
- package/dist/publish.d.ts +1431 -0
- package/dist/publish.js +206 -0
- package/dist/schemas.cjs +2 -0
- package/dist/schemas.d.cts +1353 -0
- package/dist/schemas.d.ts +1353 -0
- package/dist/schemas.js +1 -0
- package/dist/stream.cjs +44 -0
- package/dist/stream.d.cts +2 -0
- package/dist/stream.d.ts +2 -0
- package/dist/stream.js +3 -0
- package/dist/web.cjs +1045 -0
- package/dist/web.d.cts +4186 -0
- package/dist/web.d.ts +4186 -0
- package/dist/web.js +867 -0
- package/dist/workflows.cjs +825 -0
- package/dist/workflows.d.cts +4699 -0
- package/dist/workflows.d.ts +4699 -0
- package/dist/workflows.js +686 -0
- package/package.json +419 -4
|
@@ -0,0 +1,1353 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* GENERATED by @ai-matrx/api scripts/generate.mjs from aidream/api-contract — never edit by hand.
|
|
3
|
+
* CONTRACT_SHA256 50a790edb39e682b46e0fa9e674faf5ce2a0ba7de2cd01930a497fca4c47844a
|
|
4
|
+
*/
|
|
5
|
+
/** Every schema reached from more than one domain (120). Types only — importing this costs nothing at runtime. */
|
|
6
|
+
/** ActionNeeded */
|
|
7
|
+
type ActionNeeded = {
|
|
8
|
+
/** Stable source-owned dedupe key; never a random notification id */
|
|
9
|
+
fingerprint: string;
|
|
10
|
+
code: string;
|
|
11
|
+
kind: ActionNeededKind;
|
|
12
|
+
feature: string;
|
|
13
|
+
title: string;
|
|
14
|
+
message: string;
|
|
15
|
+
action: ActionNeededAction;
|
|
16
|
+
source: string;
|
|
17
|
+
status?: ActionNeededStatus;
|
|
18
|
+
observed_at?: number;
|
|
19
|
+
details?: {
|
|
20
|
+
[key: string]: unknown;
|
|
21
|
+
} | null;
|
|
22
|
+
};
|
|
23
|
+
/** ActionNeededAction */
|
|
24
|
+
type ActionNeededAction = {
|
|
25
|
+
/** Stable dispatcher action kind */
|
|
26
|
+
kind: string;
|
|
27
|
+
label: string;
|
|
28
|
+
permission_key?: string | null;
|
|
29
|
+
provider?: string | null;
|
|
30
|
+
route?: string | null;
|
|
31
|
+
url?: string | null;
|
|
32
|
+
resource_ids?: string[] | null;
|
|
33
|
+
choices?: ActionNeededChoice[] | null;
|
|
34
|
+
choice_route?: string | null;
|
|
35
|
+
};
|
|
36
|
+
/** One option the person can pick to resolve an item — a picker row. */
|
|
37
|
+
type ActionNeededChoice = {
|
|
38
|
+
id: string;
|
|
39
|
+
label: string;
|
|
40
|
+
description?: string | null;
|
|
41
|
+
};
|
|
42
|
+
/** ActionNeededKind */
|
|
43
|
+
type ActionNeededKind = "os_permission" | "filesystem_access" | "api_key" | "external_approval" | "capability_install" | "organization";
|
|
44
|
+
/** ActionNeededStatus */
|
|
45
|
+
type ActionNeededStatus = "active" | "checking" | "resolved";
|
|
46
|
+
/** AgentAppInputPart */
|
|
47
|
+
type AgentAppInputPart = {
|
|
48
|
+
metadata?: {
|
|
49
|
+
[key: string]: unknown;
|
|
50
|
+
};
|
|
51
|
+
convert_to_text?: boolean;
|
|
52
|
+
optional_context?: boolean;
|
|
53
|
+
keep_fresh?: boolean;
|
|
54
|
+
editable?: boolean | null;
|
|
55
|
+
template?: ("full" | "compact" | "minimal") | null;
|
|
56
|
+
type: "input_agent_app";
|
|
57
|
+
agent_app_ids: string[];
|
|
58
|
+
};
|
|
59
|
+
/** AgentInputPart */
|
|
60
|
+
type AgentInputPart = {
|
|
61
|
+
metadata?: {
|
|
62
|
+
[key: string]: unknown;
|
|
63
|
+
};
|
|
64
|
+
convert_to_text?: boolean;
|
|
65
|
+
optional_context?: boolean;
|
|
66
|
+
keep_fresh?: boolean;
|
|
67
|
+
editable?: boolean | null;
|
|
68
|
+
template?: ("full" | "compact" | "minimal") | null;
|
|
69
|
+
type: "input_agent";
|
|
70
|
+
agent_ids: string[];
|
|
71
|
+
};
|
|
72
|
+
/** AgentStartRequest */
|
|
73
|
+
type AgentStartRequest = {
|
|
74
|
+
/** Organization explicitly selected for this new AI conversation. Required except for fingerprint guests, whose organization is resolved by the AI funnel. */
|
|
75
|
+
organization_id?: string | null;
|
|
76
|
+
/** Optional associated project selected by the caller. */
|
|
77
|
+
project_id?: string | null;
|
|
78
|
+
/** Optional associated task selected by the caller. */
|
|
79
|
+
task_id?: string | null;
|
|
80
|
+
/** Stable application slug that initiated the request. */
|
|
81
|
+
source_app?: string | null;
|
|
82
|
+
/** Stable feature slug within the source application. */
|
|
83
|
+
source_feature?: string | null;
|
|
84
|
+
/** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
|
|
85
|
+
initiation?: ("user" | "auto") | null;
|
|
86
|
+
/** Active context-scope ids selected by the caller and membership-validated server-side. */
|
|
87
|
+
scope_ids?: string[] | null;
|
|
88
|
+
/** Active scope-type ids selected by the caller (type-level selection with no specific scope chosen). */
|
|
89
|
+
active_scope_type_ids?: string[] | null;
|
|
90
|
+
/** Durable resource identity from which authoritative organization and task context is reloaded. */
|
|
91
|
+
context_anchor?: ContextAnchor | null;
|
|
92
|
+
store: boolean;
|
|
93
|
+
/** Specific connected desktop instance allowed to claim delegated local tools. */
|
|
94
|
+
target_instance_id?: string | null;
|
|
95
|
+
conversation_id: string;
|
|
96
|
+
is_new: boolean;
|
|
97
|
+
user_input?: string | ((TextPart | ThinkingPart | ToolCallPart | ToolResultPart | (UserImageMediaPart | UserAudioMediaPart | UserVideoMediaPart | UserDocumentMediaPart | UserYouTubeMediaPart) | CodeExecPart | CodeResultPart | WebSearchPart | WebpageInputPart | NotesInputPart | TaskInputPart | AgentInputPart | ProjectInputPart | AgentAppInputPart | TranscriptInputPart | TranscriptSessionInputPart | WorkbookInputPart | DocumentInputPart | TableInputPart | ListInputPart | DataInputPart | ContextInputPart | RemarksInputPart | DecisionQuestionsPart | DecisionAnswersPart | SpeechScriptPart)[]) | null;
|
|
98
|
+
applet_id?: string | null;
|
|
99
|
+
test_holder?: MandateTestHolder | null;
|
|
100
|
+
variables?: {
|
|
101
|
+
[key: string]: unknown;
|
|
102
|
+
} | null;
|
|
103
|
+
per_turn_variables?: string[] | null;
|
|
104
|
+
variable_resource_context?: {
|
|
105
|
+
[key: string]: ResourceContextPolicy;
|
|
106
|
+
} | null;
|
|
107
|
+
config_overrides?: LLMParams | null;
|
|
108
|
+
stream?: boolean;
|
|
109
|
+
debug?: boolean;
|
|
110
|
+
dry_run?: boolean;
|
|
111
|
+
tools?: (RegisteredToolSpec | InlineToolSpec | AgentToolSpec)[];
|
|
112
|
+
tools_replace?: ((RegisteredToolSpec | InlineToolSpec | AgentToolSpec)[]) | null;
|
|
113
|
+
client?: ClientContext | null;
|
|
114
|
+
user?: UserOverrides | null;
|
|
115
|
+
ide_state?: IdeState | null;
|
|
116
|
+
sandbox?: SandboxBindingRequest | null;
|
|
117
|
+
context?: {
|
|
118
|
+
[key: string]: unknown;
|
|
119
|
+
};
|
|
120
|
+
/** The context keys the client withheld this turn (off by the page, the agent or the person's rule). When sent, the context receipt lists saved-rule rows only for these keys; omitted, it lists every save */
|
|
121
|
+
context_withheld?: string[] | null;
|
|
122
|
+
/** This conversation is the page's own (mode 'own') or the person switched the page off (mode 'off'): the page's values, the screens around it and what identifies the conversation are withheld by the con */
|
|
123
|
+
page_context?: PageContext | null;
|
|
124
|
+
/** The surface whose page published each context value that the primary surface (client.surface) does not declare: a screen mounted inside the page (a transcript open on the Knowledge page). Sent or with */
|
|
125
|
+
context_surfaces?: {
|
|
126
|
+
[key: string]: string;
|
|
127
|
+
} | null;
|
|
128
|
+
writable_variables?: string[];
|
|
129
|
+
allow_context_create?: boolean;
|
|
130
|
+
prior_messages?: ChatMessageInput[];
|
|
131
|
+
is_version?: boolean;
|
|
132
|
+
block_mode?: boolean;
|
|
133
|
+
snapshot?: boolean | null;
|
|
134
|
+
memory?: boolean | null;
|
|
135
|
+
memory_model?: string | null;
|
|
136
|
+
memory_offering_id?: string | null;
|
|
137
|
+
memory_scope?: string;
|
|
138
|
+
cache_bypass?: CacheBypass | null;
|
|
139
|
+
max_iterations?: number;
|
|
140
|
+
max_retries_per_iteration?: number;
|
|
141
|
+
skill_config?: {
|
|
142
|
+
[key: string]: unknown;
|
|
143
|
+
} | null;
|
|
144
|
+
/** Shapes (content_ir kind slugs) picked for this chat. The server resolves each to the skill that teaches it. Omit to use the chat's saved picks; send [] for none. */
|
|
145
|
+
output_kinds?: string[] | null;
|
|
146
|
+
};
|
|
147
|
+
/** AgentToolSpec */
|
|
148
|
+
type AgentToolSpec = {
|
|
149
|
+
kind?: "agent";
|
|
150
|
+
/** UUID of the saved agent to project as a tool. */
|
|
151
|
+
agent_id: string;
|
|
152
|
+
/** When True, agent_id refers to an agx_version row instead of agx_agent. */
|
|
153
|
+
is_version?: boolean;
|
|
154
|
+
/** Optional override of the projected tool's description. When omitted, the agent's own description is used. */
|
|
155
|
+
description_override?: string | null;
|
|
156
|
+
/** The human role this projected agent plays for the caller (an Orchestra edge's role title). Projection shows it with the agent's own name on the tool card; None = the agent's name alone. */
|
|
157
|
+
display_name?: string | null;
|
|
158
|
+
max_calls_per_conversation?: number | null;
|
|
159
|
+
cost_cap_per_call?: number | null;
|
|
160
|
+
/** Per-spec agent-nesting ceiling for the projected tool. None (the default) keeps the platform constant (agent_projection.PROJECTED_AGENT_MAX_RECURSION_DEPTH). A composition that declares its own depth */
|
|
161
|
+
max_recursion_depth?: number | null;
|
|
162
|
+
/** How the child agent's result returns to the caller. 'inline' — the full output in the tool_result (default). 'reference' — the output is stored in the conversation value store and the caller receives */
|
|
163
|
+
result_mode?: "inline" | "reference" | "inline_once";
|
|
164
|
+
/** Agent-as-Router (Pattern 1): a successful call ENDS the caller's loop — the child's answer streams to the client and persists as the conversation's own assistant response; control returns to the calle */
|
|
165
|
+
handoff?: boolean;
|
|
166
|
+
};
|
|
167
|
+
/** Asset */
|
|
168
|
+
type Asset = {
|
|
169
|
+
/** The master cld_files row id */
|
|
170
|
+
file_id: string;
|
|
171
|
+
/** True when the asset master is published to the web (served from the CDN). */
|
|
172
|
+
published_to_web?: boolean;
|
|
173
|
+
/** List filter of the asset master; null follows the type's default. */
|
|
174
|
+
shown_to?: ("only_me" | "my_team" | "everyone" | "everyone_on_ai_matrx") | null;
|
|
175
|
+
visibility?: "personal" | "internal" | "link" | "public";
|
|
176
|
+
share_token?: string | null;
|
|
177
|
+
share_url?: string | null;
|
|
178
|
+
/** Logical folder containing the asset master. */
|
|
179
|
+
folder: string;
|
|
180
|
+
/** Variant preset used when the asset was rendered. */
|
|
181
|
+
preset?: string | null;
|
|
182
|
+
/** Variant key selected as the asset's canonical representation. */
|
|
183
|
+
primary_key?: string;
|
|
184
|
+
/** Always-usable URL for the primary variant. */
|
|
185
|
+
primary_url?: string | null;
|
|
186
|
+
/** Rendered variants keyed by their stable variant identifier. */
|
|
187
|
+
variants?: {
|
|
188
|
+
[key: string]: AssetVariant;
|
|
189
|
+
};
|
|
190
|
+
/** Sanitized JSON metadata copied from the asset master row. */
|
|
191
|
+
metadata?: {
|
|
192
|
+
[key: string]: JsonValue;
|
|
193
|
+
};
|
|
194
|
+
};
|
|
195
|
+
/** AssetVariant */
|
|
196
|
+
type AssetVariant = {
|
|
197
|
+
/** Variant identifier (e.g. 'original', 'cover_url', 'og_url') */
|
|
198
|
+
key: string;
|
|
199
|
+
file_id: string;
|
|
200
|
+
file_path: string;
|
|
201
|
+
width?: number | null;
|
|
202
|
+
height?: number | null;
|
|
203
|
+
mime_type?: string | null;
|
|
204
|
+
size_bytes?: number | null;
|
|
205
|
+
url?: string | null;
|
|
206
|
+
cdn_url?: string | null;
|
|
207
|
+
download_url?: string | null;
|
|
208
|
+
metadata?: {
|
|
209
|
+
[key: string]: JsonValue;
|
|
210
|
+
};
|
|
211
|
+
};
|
|
212
|
+
/** A pointer to the ``platform.block_states`` row a remark was made from (remarks B6). */
|
|
213
|
+
type BlockStateRef = {
|
|
214
|
+
id: string;
|
|
215
|
+
state_version: number;
|
|
216
|
+
};
|
|
217
|
+
/** Opt-in cache invalidation flags attached to an AI request body. */
|
|
218
|
+
type CacheBypass = {
|
|
219
|
+
conversation?: boolean;
|
|
220
|
+
agent?: boolean;
|
|
221
|
+
tools?: boolean;
|
|
222
|
+
models?: boolean;
|
|
223
|
+
};
|
|
224
|
+
/** CalendarCreateResult */
|
|
225
|
+
type CalendarCreateResult = {
|
|
226
|
+
account_email: string | null;
|
|
227
|
+
calendar_id: string;
|
|
228
|
+
calendar_summary: string;
|
|
229
|
+
access_role: "owner" | "writer" | "writerWithoutPrivateAccess";
|
|
230
|
+
event_id: string;
|
|
231
|
+
summary: string;
|
|
232
|
+
description?: string | null;
|
|
233
|
+
starts_at: string;
|
|
234
|
+
ends_at: string;
|
|
235
|
+
attendees: CalendarEventAttendee[];
|
|
236
|
+
send_updates: "all" | "externalOnly" | "none";
|
|
237
|
+
guest_notification_behavior: string;
|
|
238
|
+
undo_notice?: string;
|
|
239
|
+
reconciled_after_uncertain_insert?: boolean;
|
|
240
|
+
provider_event_id: string;
|
|
241
|
+
provider_etag?: string | null;
|
|
242
|
+
local_refresh?: CalendarLocalRefreshResult | null;
|
|
243
|
+
};
|
|
244
|
+
/** CalendarEventAttendee */
|
|
245
|
+
type CalendarEventAttendee = {
|
|
246
|
+
email: string;
|
|
247
|
+
display_name?: string | null;
|
|
248
|
+
};
|
|
249
|
+
/** Privacy-bounded saved-copy outcome, separate from Google's write outcome. */
|
|
250
|
+
type CalendarLocalRefreshResult = {
|
|
251
|
+
status: "updated" | "scrubbed" | "not_saved" | "detached" | "pending";
|
|
252
|
+
reason?: ("refresh_pending" | "series_refresh_required") | null;
|
|
253
|
+
cache_refresh_pending?: boolean;
|
|
254
|
+
};
|
|
255
|
+
/** One LLM message on the request wire. */
|
|
256
|
+
type ChatMessageInput = {
|
|
257
|
+
role: ("system" | "user" | "assistant" | "tool" | "developer") | string;
|
|
258
|
+
content?: string | JsonValue[] | null;
|
|
259
|
+
name?: string | null;
|
|
260
|
+
tool_call_id?: string | null;
|
|
261
|
+
tool_calls?: ChatToolCallInput[] | null;
|
|
262
|
+
[key: string]: unknown;
|
|
263
|
+
};
|
|
264
|
+
/** One tool-call entry inside an assistant message. */
|
|
265
|
+
type ChatToolCallInput = {
|
|
266
|
+
id?: string | null;
|
|
267
|
+
type?: string | null;
|
|
268
|
+
function?: {
|
|
269
|
+
[key: string]: JsonValue;
|
|
270
|
+
} | null;
|
|
271
|
+
name?: string | null;
|
|
272
|
+
input?: JsonValue | null;
|
|
273
|
+
arguments?: JsonValue | null;
|
|
274
|
+
[key: string]: unknown;
|
|
275
|
+
};
|
|
276
|
+
/** Request envelope describing the calling client's surface + capabilities + state. */
|
|
277
|
+
type ClientContext = {
|
|
278
|
+
surface?: string | null;
|
|
279
|
+
capabilities?: string[];
|
|
280
|
+
state?: {
|
|
281
|
+
[key: string]: {
|
|
282
|
+
[key: string]: unknown;
|
|
283
|
+
};
|
|
284
|
+
};
|
|
285
|
+
amendments?: SurfaceAmendments | null;
|
|
286
|
+
mcp?: string[];
|
|
287
|
+
apply_policy?: ("auto" | "ask" | "off") | null;
|
|
288
|
+
};
|
|
289
|
+
/** CodeExecPart */
|
|
290
|
+
type CodeExecPart = {
|
|
291
|
+
metadata?: {
|
|
292
|
+
[key: string]: unknown;
|
|
293
|
+
};
|
|
294
|
+
type: "code_exec";
|
|
295
|
+
language?: string;
|
|
296
|
+
code?: string;
|
|
297
|
+
};
|
|
298
|
+
/** CodeResultPart */
|
|
299
|
+
type CodeResultPart = {
|
|
300
|
+
metadata?: {
|
|
301
|
+
[key: string]: unknown;
|
|
302
|
+
};
|
|
303
|
+
type: "code_result";
|
|
304
|
+
output?: string;
|
|
305
|
+
outcome?: string;
|
|
306
|
+
};
|
|
307
|
+
/** Optional overrides for the 5-tier context compaction pipeline. */
|
|
308
|
+
type CompactionSettings = {
|
|
309
|
+
tier2_minimal_prune?: boolean | null;
|
|
310
|
+
tier3_content_to_retrieval?: boolean | null;
|
|
311
|
+
tier4_threshold_trim?: boolean | null;
|
|
312
|
+
tier5_hard_compression?: boolean | null;
|
|
313
|
+
};
|
|
314
|
+
/** ComputeNextDueResponse */
|
|
315
|
+
type ComputeNextDueResponse = {
|
|
316
|
+
next_due_at?: string | null;
|
|
317
|
+
event_driven: boolean;
|
|
318
|
+
};
|
|
319
|
+
/** Stable identity of the durable entity whose saved context owns a run. */
|
|
320
|
+
type ContextAnchor = {
|
|
321
|
+
/** Canonical entity type whose durable row owns the request context. */
|
|
322
|
+
resource_type: string;
|
|
323
|
+
/** UUID of the durable context-owning entity. */
|
|
324
|
+
resource_id: string;
|
|
325
|
+
};
|
|
326
|
+
/** ContextInputPart */
|
|
327
|
+
type ContextInputPart = {
|
|
328
|
+
metadata?: {
|
|
329
|
+
[key: string]: unknown;
|
|
330
|
+
};
|
|
331
|
+
type: "input_context";
|
|
332
|
+
context_id?: string;
|
|
333
|
+
context_name?: string;
|
|
334
|
+
context_data?: {
|
|
335
|
+
[key: string]: unknown;
|
|
336
|
+
};
|
|
337
|
+
convert_to_text?: boolean;
|
|
338
|
+
optional_context?: boolean;
|
|
339
|
+
keep_fresh?: boolean;
|
|
340
|
+
editable?: boolean | null;
|
|
341
|
+
};
|
|
342
|
+
/** CustomTool */
|
|
343
|
+
type CustomTool = {
|
|
344
|
+
/** Unique tool name. Must match [a-zA-Z0-9_:-]{1,64}; a ':' namespace separator is serialized to '__' at the provider boundary. */
|
|
345
|
+
name: string;
|
|
346
|
+
/** Human-readable description shown to the model. */
|
|
347
|
+
description?: string;
|
|
348
|
+
/** JSON Schema describing the tool's input parameters. */
|
|
349
|
+
input_schema?: CustomToolInputSchema;
|
|
350
|
+
};
|
|
351
|
+
/** CustomToolInputSchema */
|
|
352
|
+
type CustomToolInputSchema = {
|
|
353
|
+
type?: "object";
|
|
354
|
+
properties?: {
|
|
355
|
+
[key: string]: JsonSchemaProperty;
|
|
356
|
+
};
|
|
357
|
+
required?: string[];
|
|
358
|
+
};
|
|
359
|
+
/** DataInputPart */
|
|
360
|
+
type DataInputPart = {
|
|
361
|
+
metadata?: {
|
|
362
|
+
[key: string]: unknown;
|
|
363
|
+
};
|
|
364
|
+
type: "input_data";
|
|
365
|
+
refs: (DbRecordRef | DbQueryRef | DbFieldRef)[];
|
|
366
|
+
convert_to_text?: boolean;
|
|
367
|
+
optional_context?: boolean;
|
|
368
|
+
keep_fresh?: boolean;
|
|
369
|
+
editable?: boolean | null;
|
|
370
|
+
};
|
|
371
|
+
/** DataRefSort */
|
|
372
|
+
type DataRefSort = {
|
|
373
|
+
field: string;
|
|
374
|
+
direction?: "asc" | "desc";
|
|
375
|
+
};
|
|
376
|
+
/** Fetch a single field value from one row of a system table. */
|
|
377
|
+
type DbFieldRef = {
|
|
378
|
+
table: "notes" | "tasks" | "projects" | "organizations";
|
|
379
|
+
label?: string;
|
|
380
|
+
optional_context?: boolean;
|
|
381
|
+
ref_type: "db_field";
|
|
382
|
+
id: string;
|
|
383
|
+
field_name: string;
|
|
384
|
+
};
|
|
385
|
+
/** Fetch multiple rows from a system table with optional filters. */
|
|
386
|
+
type DbQueryRef = {
|
|
387
|
+
table: "notes" | "tasks" | "projects" | "organizations";
|
|
388
|
+
label?: string;
|
|
389
|
+
optional_context?: boolean;
|
|
390
|
+
ref_type: "db_query";
|
|
391
|
+
filter?: {
|
|
392
|
+
[key: string]: unknown;
|
|
393
|
+
};
|
|
394
|
+
fields?: string[] | null;
|
|
395
|
+
sort?: DataRefSort | null;
|
|
396
|
+
limit?: number;
|
|
397
|
+
};
|
|
398
|
+
/** Fetch one full row from a system table by primary key. */
|
|
399
|
+
type DbRecordRef = {
|
|
400
|
+
table: "notes" | "tasks" | "projects" | "organizations";
|
|
401
|
+
label?: string;
|
|
402
|
+
optional_context?: boolean;
|
|
403
|
+
ref_type: "db_record";
|
|
404
|
+
id: string;
|
|
405
|
+
fields?: string[] | null;
|
|
406
|
+
};
|
|
407
|
+
/** One answer, with the holder's own uncertainty attached. */
|
|
408
|
+
type DecisionAnswer = {
|
|
409
|
+
/** The registered kind this payload is an instance of. */
|
|
410
|
+
__kind?: "decision_answer";
|
|
411
|
+
type: "noul" | "choice" | "score";
|
|
412
|
+
answer: boolean | number | string;
|
|
413
|
+
probability?: number | null;
|
|
414
|
+
probabilities?: {
|
|
415
|
+
[key: string]: number;
|
|
416
|
+
} | null;
|
|
417
|
+
confidence: number;
|
|
418
|
+
legend?: {
|
|
419
|
+
[key: string]: string;
|
|
420
|
+
} | null;
|
|
421
|
+
};
|
|
422
|
+
/** DecisionAnswersPart */
|
|
423
|
+
type DecisionAnswersPart = {
|
|
424
|
+
metadata?: {
|
|
425
|
+
[key: string]: unknown;
|
|
426
|
+
};
|
|
427
|
+
type: "decision_answers";
|
|
428
|
+
__kind?: "decision_answers";
|
|
429
|
+
model: string;
|
|
430
|
+
method: "native" | "verbalized" | "verbalized_calibrated";
|
|
431
|
+
answers?: {
|
|
432
|
+
[key: string]: DecisionAnswer;
|
|
433
|
+
};
|
|
434
|
+
unanswerable?: {
|
|
435
|
+
[key: string]: string;
|
|
436
|
+
};
|
|
437
|
+
usage: DecisionUsage_Input;
|
|
438
|
+
cost_usd: number;
|
|
439
|
+
};
|
|
440
|
+
/** One question. Not a kind: it has no meaning outside its batch. */
|
|
441
|
+
type DecisionQuestion = {
|
|
442
|
+
/** The registered kind this payload is an instance of, when it is one. */
|
|
443
|
+
__kind?: string;
|
|
444
|
+
name: string;
|
|
445
|
+
type: "noul" | "choice" | "score";
|
|
446
|
+
instructions: string;
|
|
447
|
+
criteria?: {
|
|
448
|
+
[key: string]: string;
|
|
449
|
+
} | string[] | null;
|
|
450
|
+
suggested_threshold?: number | null;
|
|
451
|
+
};
|
|
452
|
+
/** DecisionQuestionsPart */
|
|
453
|
+
type DecisionQuestionsPart = {
|
|
454
|
+
metadata?: {
|
|
455
|
+
[key: string]: unknown;
|
|
456
|
+
};
|
|
457
|
+
type: "decision_questions";
|
|
458
|
+
__kind?: "decision_questions";
|
|
459
|
+
questions: DecisionQuestion[];
|
|
460
|
+
};
|
|
461
|
+
/** What the decision call consumed. Zero is a real value, never a stand-in. */
|
|
462
|
+
type DecisionUsage_Input = {
|
|
463
|
+
/** The registered kind this payload is an instance of, when it is one. */
|
|
464
|
+
__kind?: string;
|
|
465
|
+
input_tokens: number;
|
|
466
|
+
output_tokens: number;
|
|
467
|
+
};
|
|
468
|
+
/** DictionaryConfig */
|
|
469
|
+
type DictionaryConfig = {
|
|
470
|
+
entries?: DictionaryEntry[];
|
|
471
|
+
custom_entries?: DictionaryEntry[];
|
|
472
|
+
max_inline_chars?: number | null;
|
|
473
|
+
source_count?: number;
|
|
474
|
+
glossary?: GlossaryEntry[];
|
|
475
|
+
context?: string | null;
|
|
476
|
+
};
|
|
477
|
+
/** DictionaryEntry */
|
|
478
|
+
type DictionaryEntry = {
|
|
479
|
+
term: string;
|
|
480
|
+
sounds_like?: string[];
|
|
481
|
+
pronunciation?: string | null;
|
|
482
|
+
ipa?: string | null;
|
|
483
|
+
definition?: string | null;
|
|
484
|
+
category?: string | null;
|
|
485
|
+
source_level?: string | null;
|
|
486
|
+
source_name?: string | null;
|
|
487
|
+
};
|
|
488
|
+
/** DirectiveItemApplied */
|
|
489
|
+
type DirectiveItemApplied = {
|
|
490
|
+
kind?: string;
|
|
491
|
+
directive: string;
|
|
492
|
+
index: number;
|
|
493
|
+
status: "applied" | "already_applied" | "failed" | "pending";
|
|
494
|
+
resource_kind: string;
|
|
495
|
+
resource_ids: string[];
|
|
496
|
+
summary: string;
|
|
497
|
+
message: string;
|
|
498
|
+
before?: {
|
|
499
|
+
[key: string]: unknown;
|
|
500
|
+
} | null;
|
|
501
|
+
thread?: ThreadLink | null;
|
|
502
|
+
};
|
|
503
|
+
/** DirectiveItemFailed */
|
|
504
|
+
type DirectiveItemFailed = {
|
|
505
|
+
kind?: string;
|
|
506
|
+
directive: string;
|
|
507
|
+
index: number;
|
|
508
|
+
error: string;
|
|
509
|
+
fault: string;
|
|
510
|
+
message: string;
|
|
511
|
+
};
|
|
512
|
+
/** DocumentInputPart */
|
|
513
|
+
type DocumentInputPart = {
|
|
514
|
+
metadata?: {
|
|
515
|
+
[key: string]: unknown;
|
|
516
|
+
};
|
|
517
|
+
convert_to_text?: boolean;
|
|
518
|
+
optional_context?: boolean;
|
|
519
|
+
keep_fresh?: boolean;
|
|
520
|
+
editable?: boolean | null;
|
|
521
|
+
template?: ("full" | "compact" | "minimal") | null;
|
|
522
|
+
type: "input_document";
|
|
523
|
+
document_ids: (string | LiveResourceRefInput)[];
|
|
524
|
+
};
|
|
525
|
+
/** Non-secret provenance persisted under ``files.files.metadata``. */
|
|
526
|
+
type ExternalSourceMetadata = {
|
|
527
|
+
provider: "google_drive" | "onedrive" | "dropbox" | "box";
|
|
528
|
+
connection_id: string;
|
|
529
|
+
source_ref: string;
|
|
530
|
+
revision?: string | null;
|
|
531
|
+
modified_at?: string | null;
|
|
532
|
+
};
|
|
533
|
+
/** FullListBookmark */
|
|
534
|
+
type FullListBookmark = {
|
|
535
|
+
type?: "full_list";
|
|
536
|
+
list_id: string;
|
|
537
|
+
list_name?: string | null;
|
|
538
|
+
[key: string]: unknown;
|
|
539
|
+
};
|
|
540
|
+
/** FullTableBookmark */
|
|
541
|
+
type FullTableBookmark = {
|
|
542
|
+
type?: "full_table";
|
|
543
|
+
table_id: string;
|
|
544
|
+
table_name?: string | null;
|
|
545
|
+
[key: string]: unknown;
|
|
546
|
+
};
|
|
547
|
+
/** One translation rule from an attached term list. */
|
|
548
|
+
type GlossaryEntry = {
|
|
549
|
+
term: string;
|
|
550
|
+
translation?: string | null;
|
|
551
|
+
target_language?: string | null;
|
|
552
|
+
do_not_translate?: boolean;
|
|
553
|
+
case_sensitive?: boolean;
|
|
554
|
+
};
|
|
555
|
+
/** IdeDiagnostic */
|
|
556
|
+
type IdeDiagnostic = {
|
|
557
|
+
message: string;
|
|
558
|
+
severity: string;
|
|
559
|
+
range: {
|
|
560
|
+
[key: string]: JsonValue;
|
|
561
|
+
};
|
|
562
|
+
source?: string | null;
|
|
563
|
+
};
|
|
564
|
+
/** IdeFileState */
|
|
565
|
+
type IdeFileState = {
|
|
566
|
+
path: string;
|
|
567
|
+
content: string;
|
|
568
|
+
language: string;
|
|
569
|
+
};
|
|
570
|
+
/** IdeGitState */
|
|
571
|
+
type IdeGitState = {
|
|
572
|
+
branch: string;
|
|
573
|
+
status: string;
|
|
574
|
+
};
|
|
575
|
+
/** Structured IDE snapshot sent with a request. */
|
|
576
|
+
type IdeState = {
|
|
577
|
+
active_file?: IdeFileState | null;
|
|
578
|
+
selected_text?: string | null;
|
|
579
|
+
diagnostics?: IdeDiagnostic[];
|
|
580
|
+
workspace?: IdeWorkspaceState | null;
|
|
581
|
+
git?: IdeGitState | null;
|
|
582
|
+
};
|
|
583
|
+
/** IdeWorkspaceState */
|
|
584
|
+
type IdeWorkspaceState = {
|
|
585
|
+
name: string;
|
|
586
|
+
folders: string[];
|
|
587
|
+
};
|
|
588
|
+
/** Together FLUX LoRA reference — passed through to the provider API. */
|
|
589
|
+
type ImageLora = {
|
|
590
|
+
/** LoRA weights path or URL. */
|
|
591
|
+
path: string;
|
|
592
|
+
/** Blend strength (provider-native scale). */
|
|
593
|
+
scale: number;
|
|
594
|
+
};
|
|
595
|
+
/** InlineToolSpec */
|
|
596
|
+
type InlineToolSpec = {
|
|
597
|
+
kind?: "inline";
|
|
598
|
+
/** Unique tool name. Must match [a-zA-Z0-9_:-]{1,64}; a ':' namespace separator is serialized to '__' at the provider boundary. */
|
|
599
|
+
name: string;
|
|
600
|
+
description?: string;
|
|
601
|
+
input_schema?: CustomToolInputSchema;
|
|
602
|
+
};
|
|
603
|
+
/** Object-root JSON Schema — agent ``output_schema.schema`` and tool roots. */
|
|
604
|
+
type JsonSchemaObjectDocument = {
|
|
605
|
+
type?: "object" | null;
|
|
606
|
+
properties?: {
|
|
607
|
+
[key: string]: JsonSchemaProperty;
|
|
608
|
+
};
|
|
609
|
+
required?: string[] | null;
|
|
610
|
+
additionalProperties?: boolean | JsonValue | null;
|
|
611
|
+
[key: string]: unknown;
|
|
612
|
+
};
|
|
613
|
+
/** One property in a tool parameter schema or structured-output object. */
|
|
614
|
+
type JsonSchemaProperty = {
|
|
615
|
+
type?: ("string" | "number" | "integer" | "boolean" | "array" | "object" | "null") | (("string" | "number" | "integer" | "boolean" | "array" | "object" | "null")[]) | null;
|
|
616
|
+
description?: string | null;
|
|
617
|
+
enum?: JsonValue[] | null;
|
|
618
|
+
default?: JsonValue | null;
|
|
619
|
+
items?: JsonSchemaProperty | null;
|
|
620
|
+
properties?: {
|
|
621
|
+
[key: string]: JsonSchemaProperty;
|
|
622
|
+
} | null;
|
|
623
|
+
required?: string[] | null;
|
|
624
|
+
additionalProperties?: boolean | JsonValue | null;
|
|
625
|
+
[key: string]: unknown;
|
|
626
|
+
};
|
|
627
|
+
type JsonValue = unknown;
|
|
628
|
+
/** LLMParams */
|
|
629
|
+
type LLMParams = {
|
|
630
|
+
model?: string | null;
|
|
631
|
+
offering_id?: string | null;
|
|
632
|
+
max_output_tokens?: number | null;
|
|
633
|
+
temperature?: number | null;
|
|
634
|
+
top_p?: number | null;
|
|
635
|
+
top_k?: number | null;
|
|
636
|
+
tool_choice?: ("none" | "auto" | "required") | null;
|
|
637
|
+
parallel_tool_calls?: boolean | null;
|
|
638
|
+
reasoning_effort?: ("auto" | "none" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max") | null;
|
|
639
|
+
reasoning_summary?: ("concise" | "detailed" | "never" | "auto" | "always") | null;
|
|
640
|
+
visualization?: ("auto" | "off") | null;
|
|
641
|
+
thinking_level?: ("minimal" | "low" | "medium" | "high") | null;
|
|
642
|
+
include_thoughts?: boolean | null;
|
|
643
|
+
thinking_budget?: number | null;
|
|
644
|
+
clear_thinking?: boolean | null;
|
|
645
|
+
disable_reasoning?: boolean | null;
|
|
646
|
+
response_format?: (ResponseFormatText | ResponseFormatJsonObject | ResponseFormatJsonSchema) | null;
|
|
647
|
+
stop_sequences?: string[] | null;
|
|
648
|
+
stream?: boolean | null;
|
|
649
|
+
store?: boolean | null;
|
|
650
|
+
previous_interaction_id?: string | null;
|
|
651
|
+
task?: ("text_to_video" | "image_to_video" | "reference_to_video" | "edit") | null;
|
|
652
|
+
verbosity?: ("low" | "medium" | "high") | null;
|
|
653
|
+
internal_web_search?: boolean | null;
|
|
654
|
+
internal_url_context?: boolean | null;
|
|
655
|
+
internal_x_search?: boolean | null;
|
|
656
|
+
aspect_ratio?: ("1:1" | "2:3" | "3:2" | "3:4" | "4:3" | "4:5" | "5:4" | "9:16" | "16:9" | "21:9") | null;
|
|
657
|
+
width?: number | null;
|
|
658
|
+
height?: number | null;
|
|
659
|
+
count?: number | null;
|
|
660
|
+
render_quality?: ("low" | "medium" | "high" | "auto") | null;
|
|
661
|
+
background?: ("auto" | "opaque" | "transparent") | null;
|
|
662
|
+
output_compression?: number | null;
|
|
663
|
+
moderation?: ("auto" | "low") | null;
|
|
664
|
+
input_fidelity?: ("high" | "low") | null;
|
|
665
|
+
partial_images?: number | null;
|
|
666
|
+
style?: ("vivid" | "natural") | null;
|
|
667
|
+
reference_strength?: number | null;
|
|
668
|
+
tts_voice?: string | TtsVoiceSpeaker[] | TtsDialogueTurn[] | null;
|
|
669
|
+
audio_format?: ("mp3" | "wav" | "ogg" | "opus" | "aac" | "flac" | "pcm" | "mulaw" | "alaw") | null;
|
|
670
|
+
performance_direction?: string | null;
|
|
671
|
+
speech_speed?: number | null;
|
|
672
|
+
turn_pause_ms?: number | null;
|
|
673
|
+
language_code?: string | null;
|
|
674
|
+
duration_seconds?: number | null;
|
|
675
|
+
resolution?: ("480p" | "720p" | "1080p" | "4k" | "1K" | "2K" | "4K") | null;
|
|
676
|
+
fps?: number | null;
|
|
677
|
+
steps?: number | null;
|
|
678
|
+
seed?: number | null;
|
|
679
|
+
guidance_scale?: number | null;
|
|
680
|
+
encode_quality?: number | null;
|
|
681
|
+
negative_prompt?: string | null;
|
|
682
|
+
output_format?: ("jpeg" | "png" | "webp" | "base64" | "url" | "text" | "json_object" | "json_schema") | null;
|
|
683
|
+
frame_images?: MediaRef[] | null;
|
|
684
|
+
reference_images?: MediaRef[] | null;
|
|
685
|
+
image_loras?: ImageLora[] | null;
|
|
686
|
+
disable_safety_checker?: boolean | null;
|
|
687
|
+
generate_audio?: boolean | null;
|
|
688
|
+
enhance_prompt?: boolean | null;
|
|
689
|
+
camera_control?: {
|
|
690
|
+
[key: string]: unknown;
|
|
691
|
+
} | null;
|
|
692
|
+
image_input?: MediaRef | null;
|
|
693
|
+
image_inputs?: MediaRef[] | null;
|
|
694
|
+
mask?: MediaRef | null;
|
|
695
|
+
last_frame_image?: MediaRef | null;
|
|
696
|
+
video_input?: MediaRef | null;
|
|
697
|
+
video_action?: ("generate" | "edit" | "extend") | null;
|
|
698
|
+
custom_tools?: CustomTool[] | null;
|
|
699
|
+
mcp_servers?: string[] | null;
|
|
700
|
+
compaction_settings?: CompactionSettings | null;
|
|
701
|
+
detected_contexts?: {
|
|
702
|
+
[key: string]: string;
|
|
703
|
+
} | null;
|
|
704
|
+
dictionary?: DictionaryConfig | null;
|
|
705
|
+
tts_quality?: ("high_quality" | "fast") | null;
|
|
706
|
+
/** Deprecated input alias for `max_output_tokens`. The server normalizes this name before validation and dispatch; new callers should send `max_output_tokens`. */
|
|
707
|
+
max_tokens?: number | null;
|
|
708
|
+
/** Deprecated input alias for `count`. The server normalizes this name before validation and dispatch; new callers should send `count`. */
|
|
709
|
+
n?: number | null;
|
|
710
|
+
/** Deprecated input alias for `count`. The server normalizes this name before validation and dispatch; new callers should send `count`. */
|
|
711
|
+
num_outputs?: number | null;
|
|
712
|
+
/** Deprecated input alias for `count`. The server normalizes this name before validation and dispatch; new callers should send `count`. */
|
|
713
|
+
number_of_images?: number | null;
|
|
714
|
+
/** Deprecated input alias for `render_quality`. The server normalizes this name before validation and dispatch; new callers should send `render_quality`. */
|
|
715
|
+
quality?: ("low" | "medium" | "high" | "auto") | null;
|
|
716
|
+
/** Deprecated input alias for `encode_quality`. The server normalizes this name before validation and dispatch; new callers should send `encode_quality`. */
|
|
717
|
+
output_quality?: number | null;
|
|
718
|
+
/** Deprecated input alias for `duration_seconds`. The server normalizes this name before validation and dispatch; new callers should send `duration_seconds`. */
|
|
719
|
+
seconds?: number | null;
|
|
720
|
+
/** Deprecated input alias for `duration_seconds`. The server normalizes this name before validation and dispatch; new callers should send `duration_seconds`. */
|
|
721
|
+
duration?: number | null;
|
|
722
|
+
};
|
|
723
|
+
/** ListGroupBookmark */
|
|
724
|
+
type ListGroupBookmark = {
|
|
725
|
+
type?: "list_group";
|
|
726
|
+
list_id: string;
|
|
727
|
+
group_name: string;
|
|
728
|
+
list_name?: string | null;
|
|
729
|
+
[key: string]: unknown;
|
|
730
|
+
};
|
|
731
|
+
/** ListInputPart */
|
|
732
|
+
type ListInputPart = {
|
|
733
|
+
metadata?: {
|
|
734
|
+
[key: string]: unknown;
|
|
735
|
+
};
|
|
736
|
+
type: "input_list";
|
|
737
|
+
bookmarks: (FullListBookmark | ListGroupBookmark | ListItemBookmark)[];
|
|
738
|
+
convert_to_text?: boolean;
|
|
739
|
+
optional_context?: boolean;
|
|
740
|
+
keep_fresh?: boolean;
|
|
741
|
+
editable?: boolean | null;
|
|
742
|
+
};
|
|
743
|
+
/** ListItemBookmark */
|
|
744
|
+
type ListItemBookmark = {
|
|
745
|
+
type?: "list_item";
|
|
746
|
+
list_id: string;
|
|
747
|
+
item_id: string;
|
|
748
|
+
list_name?: string | null;
|
|
749
|
+
[key: string]: unknown;
|
|
750
|
+
};
|
|
751
|
+
/** A live id-backed reference; snapshots are not meaningful for opaque resources. */
|
|
752
|
+
type LiveResourceRefInput = {
|
|
753
|
+
id: string;
|
|
754
|
+
mode?: "reference";
|
|
755
|
+
[key: string]: unknown;
|
|
756
|
+
};
|
|
757
|
+
/** The Holder a test run / preview uses instead of the resolved one. */
|
|
758
|
+
type MandateTestHolder = {
|
|
759
|
+
type: "agent" | "workflow";
|
|
760
|
+
id: string;
|
|
761
|
+
version_id?: string | null;
|
|
762
|
+
};
|
|
763
|
+
/** Canonical media reference shared across every API that takes media. */
|
|
764
|
+
type MediaRef = {
|
|
765
|
+
/** cld_files UUID. Preferred form; returned by POST /files/upload. */
|
|
766
|
+
file_id?: string | null;
|
|
767
|
+
/** Any URL we issued (share link, /files/{id}/url, /files/{id}/download, raw S3 URL) or a truly external https://. The server recognizes ours and resolves to bytes; external URLs are passed through to pr */
|
|
768
|
+
url?: string | null;
|
|
769
|
+
/** Native cloud URI: s3://bucket/key, gs://..., azure://... */
|
|
770
|
+
file_uri?: string | null;
|
|
771
|
+
/** Hint from the client. Server REPLACES with the canonical cld_files.mime_type when the reference resolves to one of our files. */
|
|
772
|
+
mime_type?: string | null;
|
|
773
|
+
/** Free-form per-API metadata. Opaque to the resolver. */
|
|
774
|
+
metadata?: {
|
|
775
|
+
[key: string]: JsonValue;
|
|
776
|
+
};
|
|
777
|
+
/** Optional name of a registered vision class (e.g. 'anthropic_opus_hires', 'gemini3_high'). When set, resolution produces a derived variant of the master file using the host-registered encoder for the ' */
|
|
778
|
+
vision_class?: string | null;
|
|
779
|
+
/** Inline bytes (base64). Set by resolver when needs_bytes=True. */
|
|
780
|
+
base64_data?: string | null;
|
|
781
|
+
/** Fresh presigned URL the resolver minted (provider-fetchable). */
|
|
782
|
+
resolved_url?: string | null;
|
|
783
|
+
/** Resolved byte size from the canonical file row or downloaded content. */
|
|
784
|
+
file_size?: number | null;
|
|
785
|
+
/** Owner user id loaded from the canonical file row during resolution. */
|
|
786
|
+
owner_id?: string | null;
|
|
787
|
+
/** True iff the resolver matched the reference to a cld_files row. */
|
|
788
|
+
is_ours?: boolean;
|
|
789
|
+
/** Set when resolution failed; surface to the caller for logging. */
|
|
790
|
+
resolver_error?: string | null;
|
|
791
|
+
/** Set to True by the boundary normaliser. Resolvers short-circuit when this is True (idempotency). Internal — clients do not set. */
|
|
792
|
+
is_resolved?: boolean;
|
|
793
|
+
[key: string]: unknown;
|
|
794
|
+
};
|
|
795
|
+
/** The canonical cross-provider citation shape — the FE contract. */
|
|
796
|
+
type NormalizedCitation = {
|
|
797
|
+
kind: "document_char" | "document_page" | "document_block" | "search_result" | "web" | "grounding";
|
|
798
|
+
provider: "anthropic" | "openai" | "google" | "xai";
|
|
799
|
+
cited_text?: string | null;
|
|
800
|
+
title?: string | null;
|
|
801
|
+
url?: string | null;
|
|
802
|
+
source_index?: number;
|
|
803
|
+
file_id?: string | null;
|
|
804
|
+
page?: number | null;
|
|
805
|
+
end_page?: number | null;
|
|
806
|
+
source_start?: number | null;
|
|
807
|
+
source_end?: number | null;
|
|
808
|
+
answer_start?: number | null;
|
|
809
|
+
answer_end?: number | null;
|
|
810
|
+
raw?: {
|
|
811
|
+
[key: string]: unknown;
|
|
812
|
+
};
|
|
813
|
+
};
|
|
814
|
+
/** NotesInputPart */
|
|
815
|
+
type NotesInputPart = {
|
|
816
|
+
metadata?: {
|
|
817
|
+
[key: string]: unknown;
|
|
818
|
+
};
|
|
819
|
+
type: "input_notes";
|
|
820
|
+
note_ids: (string | ResourceRefInput)[];
|
|
821
|
+
template?: string;
|
|
822
|
+
convert_to_text?: boolean;
|
|
823
|
+
optional_context?: boolean;
|
|
824
|
+
keep_fresh?: boolean;
|
|
825
|
+
editable?: boolean | null;
|
|
826
|
+
};
|
|
827
|
+
/** OpenAI ``json_schema`` inner envelope — matches ``agx_agent.output_schema``. */
|
|
828
|
+
type OutputSchemaEnvelope = {
|
|
829
|
+
name?: string | null;
|
|
830
|
+
schema?: JsonSchemaObjectDocument | null;
|
|
831
|
+
strict?: boolean | null;
|
|
832
|
+
};
|
|
833
|
+
/** Request field ``page_context``: this turn's conversation is the page's own, or its page */
|
|
834
|
+
type PageContext = {
|
|
835
|
+
mode: "own" | "off";
|
|
836
|
+
/** The keys this page's own conversation (or a switched-off page) never receives — the page's declared list. Omitted: the default for the mode. */
|
|
837
|
+
withheld?: string[] | null;
|
|
838
|
+
};
|
|
839
|
+
/** A webpage entry that has already been scraped by the client. */
|
|
840
|
+
type PreFetchedUrl = {
|
|
841
|
+
url: string;
|
|
842
|
+
textContent: string;
|
|
843
|
+
title?: string | null;
|
|
844
|
+
scrapedAt?: string | null;
|
|
845
|
+
charCount?: number | null;
|
|
846
|
+
[key: string]: unknown;
|
|
847
|
+
};
|
|
848
|
+
/** ProjectInputPart */
|
|
849
|
+
type ProjectInputPart = {
|
|
850
|
+
metadata?: {
|
|
851
|
+
[key: string]: unknown;
|
|
852
|
+
};
|
|
853
|
+
convert_to_text?: boolean;
|
|
854
|
+
optional_context?: boolean;
|
|
855
|
+
keep_fresh?: boolean;
|
|
856
|
+
editable?: boolean | null;
|
|
857
|
+
template?: ("full" | "compact" | "minimal") | null;
|
|
858
|
+
type: "input_project";
|
|
859
|
+
project_ids: string[];
|
|
860
|
+
};
|
|
861
|
+
/** PromptStartRequest */
|
|
862
|
+
type PromptStartRequest = {
|
|
863
|
+
/** Organization explicitly selected for this new AI conversation. Required except for fingerprint guests, whose organization is resolved by the AI funnel. */
|
|
864
|
+
organization_id?: string | null;
|
|
865
|
+
/** Optional associated project selected by the caller. */
|
|
866
|
+
project_id?: string | null;
|
|
867
|
+
/** Optional associated task selected by the caller. */
|
|
868
|
+
task_id?: string | null;
|
|
869
|
+
/** Stable application slug that initiated the request. */
|
|
870
|
+
source_app?: string | null;
|
|
871
|
+
/** Stable feature slug within the source application. */
|
|
872
|
+
source_feature?: string | null;
|
|
873
|
+
/** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
|
|
874
|
+
initiation?: ("user" | "auto") | null;
|
|
875
|
+
/** Active context-scope ids selected by the caller and membership-validated server-side. */
|
|
876
|
+
scope_ids?: string[] | null;
|
|
877
|
+
/** Active scope-type ids selected by the caller (type-level selection with no specific scope chosen). */
|
|
878
|
+
active_scope_type_ids?: string[] | null;
|
|
879
|
+
/** Durable resource identity from which authoritative organization and task context is reloaded. */
|
|
880
|
+
context_anchor?: ContextAnchor | null;
|
|
881
|
+
store: boolean;
|
|
882
|
+
/** Specific connected desktop instance allowed to claim delegated local tools. */
|
|
883
|
+
target_instance_id?: string | null;
|
|
884
|
+
conversation_id: string;
|
|
885
|
+
is_new: boolean;
|
|
886
|
+
user_input?: string | ((TextPart | ThinkingPart | ToolCallPart | ToolResultPart | (UserImageMediaPart | UserAudioMediaPart | UserVideoMediaPart | UserDocumentMediaPart | UserYouTubeMediaPart) | CodeExecPart | CodeResultPart | WebSearchPart | WebpageInputPart | NotesInputPart | TaskInputPart | AgentInputPart | ProjectInputPart | AgentAppInputPart | TranscriptInputPart | TranscriptSessionInputPart | WorkbookInputPart | DocumentInputPart | TableInputPart | ListInputPart | DataInputPart | ContextInputPart | RemarksInputPart | DecisionQuestionsPart | DecisionAnswersPart | SpeechScriptPart)[]) | null;
|
|
887
|
+
variables?: {
|
|
888
|
+
[key: string]: unknown;
|
|
889
|
+
} | null;
|
|
890
|
+
config_overrides?: LLMParams | null;
|
|
891
|
+
stream?: boolean;
|
|
892
|
+
debug?: boolean;
|
|
893
|
+
tools?: (RegisteredToolSpec | InlineToolSpec | AgentToolSpec)[];
|
|
894
|
+
tools_replace?: ((RegisteredToolSpec | InlineToolSpec | AgentToolSpec)[]) | null;
|
|
895
|
+
client?: ClientContext | null;
|
|
896
|
+
user?: UserOverrides | null;
|
|
897
|
+
ide_state?: IdeState | null;
|
|
898
|
+
context?: {
|
|
899
|
+
[key: string]: unknown;
|
|
900
|
+
};
|
|
901
|
+
/** The context keys the client withheld this turn (off by the page, the agent or the person's rule). When sent, the context receipt lists saved-rule rows only for these keys; omitted, it lists every save */
|
|
902
|
+
context_withheld?: string[] | null;
|
|
903
|
+
/** This conversation is the page's own (mode 'own') or the person switched the page off (mode 'off'): the page's values, the screens around it and what identifies the conversation are withheld by the con */
|
|
904
|
+
page_context?: PageContext | null;
|
|
905
|
+
};
|
|
906
|
+
/** RegisteredToolSpec */
|
|
907
|
+
type RegisteredToolSpec = {
|
|
908
|
+
kind?: "registered";
|
|
909
|
+
/** Registry name. Required. tool_id may also be provided for UUID lookup. */
|
|
910
|
+
name: string;
|
|
911
|
+
/** Optional registry UUID. When set, takes precedence over name for lookup. */
|
|
912
|
+
tool_id?: string | null;
|
|
913
|
+
/** When True, the executor short-circuits dispatch and emits tool_delegated for the client to execute. When False (default), the server runs the tool via its registry implementation. */
|
|
914
|
+
delegate?: boolean;
|
|
915
|
+
};
|
|
916
|
+
/** One answered question. ``name``/``type`` reuse the decision_questions */
|
|
917
|
+
type RemarkAnswer = {
|
|
918
|
+
question: string;
|
|
919
|
+
answer: string | boolean | number | string[];
|
|
920
|
+
name?: string | null;
|
|
921
|
+
type?: ("noul" | "choice" | "score" | "text") | null;
|
|
922
|
+
};
|
|
923
|
+
/** One staged remark. Structured on the wire and in storage; only the */
|
|
924
|
+
type RemarkItem = {
|
|
925
|
+
kind: "comment" | "choice" | "edit" | "answers" | "interaction";
|
|
926
|
+
target?: RemarkTarget | null;
|
|
927
|
+
quote?: string | null;
|
|
928
|
+
body?: string | null;
|
|
929
|
+
diff?: string | null;
|
|
930
|
+
answers?: RemarkAnswer[] | null;
|
|
931
|
+
title?: string | null;
|
|
932
|
+
comment_id?: string | null;
|
|
933
|
+
id?: string | null;
|
|
934
|
+
handle?: string | null;
|
|
935
|
+
thread?: RemarkThreadEntry[] | null;
|
|
936
|
+
block_state_ref?: BlockStateRef | null;
|
|
937
|
+
metadata?: {
|
|
938
|
+
[key: string]: unknown;
|
|
939
|
+
};
|
|
940
|
+
};
|
|
941
|
+
/** What the remark is about. A chat reply (``message_id``) or any other */
|
|
942
|
+
type RemarkTarget = {
|
|
943
|
+
message_id?: string | null;
|
|
944
|
+
record_token?: string | null;
|
|
945
|
+
record_id?: string | null;
|
|
946
|
+
record_title?: string | null;
|
|
947
|
+
};
|
|
948
|
+
/** One message of an existing comment thread, snapshotted onto a remark */
|
|
949
|
+
type RemarkThreadEntry = {
|
|
950
|
+
author_name: string;
|
|
951
|
+
author_kind: "person" | "agent";
|
|
952
|
+
body: string;
|
|
953
|
+
created_at?: string | null;
|
|
954
|
+
};
|
|
955
|
+
/** RemarksInputPart */
|
|
956
|
+
type RemarksInputPart = {
|
|
957
|
+
metadata?: {
|
|
958
|
+
[key: string]: unknown;
|
|
959
|
+
};
|
|
960
|
+
type: "input_remarks";
|
|
961
|
+
items: RemarkItem[];
|
|
962
|
+
convert_to_text?: boolean;
|
|
963
|
+
optional_context?: boolean;
|
|
964
|
+
keep_fresh?: boolean;
|
|
965
|
+
editable?: boolean | null;
|
|
966
|
+
};
|
|
967
|
+
/** ResourceContextPolicy */
|
|
968
|
+
type ResourceContextPolicy = {
|
|
969
|
+
promote?: ResourcePromotion[];
|
|
970
|
+
exclude?: string[];
|
|
971
|
+
};
|
|
972
|
+
/** ResourcePromotion */
|
|
973
|
+
type ResourcePromotion = {
|
|
974
|
+
representation: string;
|
|
975
|
+
max_chars?: number;
|
|
976
|
+
};
|
|
977
|
+
type ResourceRefInput = LiveResourceRefInput | SnapshotContentResourceRefInput | SnapshotTextResourceRefInput | SnapshotBodyResourceRefInput | SnapshotDescriptionResourceRefInput | SnapshotValueResourceRefInput;
|
|
978
|
+
/** ResponseFormatJsonObject */
|
|
979
|
+
type ResponseFormatJsonObject = {
|
|
980
|
+
type: "json_object";
|
|
981
|
+
};
|
|
982
|
+
/** ResponseFormatJsonSchema */
|
|
983
|
+
type ResponseFormatJsonSchema = {
|
|
984
|
+
type: "json_schema";
|
|
985
|
+
json_schema?: OutputSchemaEnvelope | null;
|
|
986
|
+
name?: string | null;
|
|
987
|
+
schema?: JsonSchemaObjectDocument | null;
|
|
988
|
+
strict?: boolean | null;
|
|
989
|
+
};
|
|
990
|
+
/** ResponseFormatText */
|
|
991
|
+
type ResponseFormatText = {
|
|
992
|
+
type: "text";
|
|
993
|
+
};
|
|
994
|
+
/** RunNowResponse */
|
|
995
|
+
type RunNowResponse = {
|
|
996
|
+
run_id: string;
|
|
997
|
+
};
|
|
998
|
+
/** SandboxBindingRequest */
|
|
999
|
+
type SandboxBindingRequest = {
|
|
1000
|
+
/** Orchestrator sandbox id (sbx-XXX) */
|
|
1001
|
+
sandbox_id: string;
|
|
1002
|
+
/** Orchestrator URL up to and including /sandboxes/<id> (no trailing slash). */
|
|
1003
|
+
base_url: string;
|
|
1004
|
+
/** X-Sandbox-Access-Token bearer */
|
|
1005
|
+
access_token: string;
|
|
1006
|
+
/** Workspace root inside the sandbox */
|
|
1007
|
+
root_path?: string;
|
|
1008
|
+
/** Semantic filesystem namespace. This is explicit so routing never guesses the target OS or machine kind from path syntax. */
|
|
1009
|
+
target_kind?: "sandbox" | "local_machine";
|
|
1010
|
+
};
|
|
1011
|
+
/** SnapshotBodyResourceRefInput */
|
|
1012
|
+
type SnapshotBodyResourceRefInput = {
|
|
1013
|
+
mode: "snapshot";
|
|
1014
|
+
body: string;
|
|
1015
|
+
[key: string]: unknown;
|
|
1016
|
+
};
|
|
1017
|
+
/** SnapshotContentResourceRefInput */
|
|
1018
|
+
type SnapshotContentResourceRefInput = {
|
|
1019
|
+
mode: "snapshot";
|
|
1020
|
+
content: string;
|
|
1021
|
+
[key: string]: unknown;
|
|
1022
|
+
};
|
|
1023
|
+
/** SnapshotDescriptionResourceRefInput */
|
|
1024
|
+
type SnapshotDescriptionResourceRefInput = {
|
|
1025
|
+
mode: "snapshot";
|
|
1026
|
+
description: string;
|
|
1027
|
+
[key: string]: unknown;
|
|
1028
|
+
};
|
|
1029
|
+
/** SnapshotTextResourceRefInput */
|
|
1030
|
+
type SnapshotTextResourceRefInput = {
|
|
1031
|
+
mode: "snapshot";
|
|
1032
|
+
text: string;
|
|
1033
|
+
[key: string]: unknown;
|
|
1034
|
+
};
|
|
1035
|
+
/** SnapshotValueResourceRefInput */
|
|
1036
|
+
type SnapshotValueResourceRefInput = {
|
|
1037
|
+
mode: "snapshot";
|
|
1038
|
+
value: string;
|
|
1039
|
+
[key: string]: unknown;
|
|
1040
|
+
};
|
|
1041
|
+
/** SpeechScriptPart */
|
|
1042
|
+
type SpeechScriptPart = {
|
|
1043
|
+
metadata?: {
|
|
1044
|
+
[key: string]: unknown;
|
|
1045
|
+
};
|
|
1046
|
+
type: "speech_script";
|
|
1047
|
+
__kind?: "speech_script";
|
|
1048
|
+
turns: SpeechTurn[];
|
|
1049
|
+
};
|
|
1050
|
+
/** One spoken turn. Not a kind: it has no meaning outside its script. */
|
|
1051
|
+
type SpeechTurn = {
|
|
1052
|
+
/** The registered kind this payload is an instance of, when it is one. */
|
|
1053
|
+
__kind?: string;
|
|
1054
|
+
/** The speaker's name. Turns with the same name are the same speaker. For multi-speaker vendors (Gemini) this is the transcript label. */
|
|
1055
|
+
speaker: string;
|
|
1056
|
+
/** The voice this speaker uses: a literal provider voice id from the model's catalog, or a {{variable}}. Empty = bound to the agent's Voice setting (tts_voice). */
|
|
1057
|
+
voice?: string | null;
|
|
1058
|
+
/** What is said. Any {{variable}} is filled at run time. */
|
|
1059
|
+
text: string;
|
|
1060
|
+
/** Free-text performance direction for this turn only (e.g. 'warm, a little amused'). */
|
|
1061
|
+
direction?: string | null;
|
|
1062
|
+
/** Silence after this turn, in milliseconds. */
|
|
1063
|
+
pause_after_ms?: number | null;
|
|
1064
|
+
};
|
|
1065
|
+
/** Safe result of importing a provider item into canonical Matrx Files. */
|
|
1066
|
+
type StorageImportResult = {
|
|
1067
|
+
file_id: string;
|
|
1068
|
+
file_path: string;
|
|
1069
|
+
checksum?: string | null;
|
|
1070
|
+
version_number: number;
|
|
1071
|
+
created: boolean;
|
|
1072
|
+
source: ExternalSourceMetadata;
|
|
1073
|
+
};
|
|
1074
|
+
/** Per-request delta against the surface's cached/declared manifest. */
|
|
1075
|
+
type SurfaceAmendments = {
|
|
1076
|
+
add?: (RegisteredToolSpec | InlineToolSpec | AgentToolSpec)[];
|
|
1077
|
+
remove?: string[];
|
|
1078
|
+
};
|
|
1079
|
+
/** TableCellBookmark */
|
|
1080
|
+
type TableCellBookmark = {
|
|
1081
|
+
type?: "table_cell";
|
|
1082
|
+
table_id: string;
|
|
1083
|
+
row_id: string;
|
|
1084
|
+
column_name: string;
|
|
1085
|
+
table_name?: string | null;
|
|
1086
|
+
[key: string]: unknown;
|
|
1087
|
+
};
|
|
1088
|
+
/** TableColumnBookmark */
|
|
1089
|
+
type TableColumnBookmark = {
|
|
1090
|
+
type?: "table_column";
|
|
1091
|
+
table_id: string;
|
|
1092
|
+
column_name: string;
|
|
1093
|
+
table_name?: string | null;
|
|
1094
|
+
[key: string]: unknown;
|
|
1095
|
+
};
|
|
1096
|
+
/** TableInputPart */
|
|
1097
|
+
type TableInputPart = {
|
|
1098
|
+
metadata?: {
|
|
1099
|
+
[key: string]: unknown;
|
|
1100
|
+
};
|
|
1101
|
+
type: "input_table";
|
|
1102
|
+
bookmarks: (FullTableBookmark | TableColumnBookmark | TableRowBookmark | TableCellBookmark | TableSchemaBookmark)[];
|
|
1103
|
+
convert_to_text?: boolean;
|
|
1104
|
+
optional_context?: boolean;
|
|
1105
|
+
keep_fresh?: boolean;
|
|
1106
|
+
editable?: boolean | null;
|
|
1107
|
+
};
|
|
1108
|
+
/** TableRowBookmark */
|
|
1109
|
+
type TableRowBookmark = {
|
|
1110
|
+
type?: "table_row";
|
|
1111
|
+
table_id: string;
|
|
1112
|
+
row_id: string;
|
|
1113
|
+
table_name?: string | null;
|
|
1114
|
+
[key: string]: unknown;
|
|
1115
|
+
};
|
|
1116
|
+
/** TableSchemaBookmark */
|
|
1117
|
+
type TableSchemaBookmark = {
|
|
1118
|
+
type?: "table_schema";
|
|
1119
|
+
table_id: string;
|
|
1120
|
+
table_name?: string | null;
|
|
1121
|
+
[key: string]: unknown;
|
|
1122
|
+
};
|
|
1123
|
+
/** TaskInputPart */
|
|
1124
|
+
type TaskInputPart = {
|
|
1125
|
+
metadata?: {
|
|
1126
|
+
[key: string]: unknown;
|
|
1127
|
+
};
|
|
1128
|
+
type: "input_task";
|
|
1129
|
+
task_ids: (string | ResourceRefInput)[];
|
|
1130
|
+
template?: string;
|
|
1131
|
+
convert_to_text?: boolean;
|
|
1132
|
+
optional_context?: boolean;
|
|
1133
|
+
keep_fresh?: boolean;
|
|
1134
|
+
editable?: boolean | null;
|
|
1135
|
+
};
|
|
1136
|
+
/** TextPart */
|
|
1137
|
+
type TextPart = {
|
|
1138
|
+
metadata?: {
|
|
1139
|
+
[key: string]: unknown;
|
|
1140
|
+
};
|
|
1141
|
+
type: "text";
|
|
1142
|
+
text?: string;
|
|
1143
|
+
id?: string;
|
|
1144
|
+
citations?: NormalizedCitation[];
|
|
1145
|
+
};
|
|
1146
|
+
/** ThinkingPart */
|
|
1147
|
+
type ThinkingPart = {
|
|
1148
|
+
metadata?: {
|
|
1149
|
+
[key: string]: unknown;
|
|
1150
|
+
};
|
|
1151
|
+
type: "thinking";
|
|
1152
|
+
text?: string;
|
|
1153
|
+
id?: string;
|
|
1154
|
+
provider?: ("openai" | "anthropic" | "google" | "cerebras" | "moonshot" | "together" | "groq" | "xai" | "generic_openai") | null;
|
|
1155
|
+
signature?: string | null;
|
|
1156
|
+
signature_encoding?: "base64" | null;
|
|
1157
|
+
summary?: unknown[];
|
|
1158
|
+
};
|
|
1159
|
+
/** Where a reply landed in a comment thread — what a client opens (THREADS */
|
|
1160
|
+
type ThreadLink = {
|
|
1161
|
+
entity_type: string;
|
|
1162
|
+
entity_id: string;
|
|
1163
|
+
root_id: string;
|
|
1164
|
+
reply_id: string;
|
|
1165
|
+
handle: string;
|
|
1166
|
+
};
|
|
1167
|
+
/** ToolCallPart */
|
|
1168
|
+
type ToolCallPart = {
|
|
1169
|
+
metadata?: {
|
|
1170
|
+
[key: string]: unknown;
|
|
1171
|
+
};
|
|
1172
|
+
type: "tool_call";
|
|
1173
|
+
call_id?: string;
|
|
1174
|
+
name?: string;
|
|
1175
|
+
arguments?: {
|
|
1176
|
+
[key: string]: unknown;
|
|
1177
|
+
};
|
|
1178
|
+
};
|
|
1179
|
+
/** ToolResultPart */
|
|
1180
|
+
type ToolResultPart = {
|
|
1181
|
+
metadata?: {
|
|
1182
|
+
[key: string]: unknown;
|
|
1183
|
+
};
|
|
1184
|
+
type: "tool_result";
|
|
1185
|
+
call_id?: string;
|
|
1186
|
+
tool_use_id?: string;
|
|
1187
|
+
name?: string;
|
|
1188
|
+
is_error?: boolean;
|
|
1189
|
+
output_chars?: number;
|
|
1190
|
+
output_preview?: {
|
|
1191
|
+
[key: string]: unknown;
|
|
1192
|
+
} | null;
|
|
1193
|
+
};
|
|
1194
|
+
/** TranscriptInputPart */
|
|
1195
|
+
type TranscriptInputPart = {
|
|
1196
|
+
metadata?: {
|
|
1197
|
+
[key: string]: unknown;
|
|
1198
|
+
};
|
|
1199
|
+
convert_to_text?: boolean;
|
|
1200
|
+
optional_context?: boolean;
|
|
1201
|
+
keep_fresh?: boolean;
|
|
1202
|
+
editable?: boolean | null;
|
|
1203
|
+
template?: ("full" | "compact" | "minimal") | null;
|
|
1204
|
+
type: "input_transcript";
|
|
1205
|
+
transcript_ids: string[];
|
|
1206
|
+
};
|
|
1207
|
+
/** TranscriptSessionInputPart */
|
|
1208
|
+
type TranscriptSessionInputPart = {
|
|
1209
|
+
metadata?: {
|
|
1210
|
+
[key: string]: unknown;
|
|
1211
|
+
};
|
|
1212
|
+
convert_to_text?: boolean;
|
|
1213
|
+
optional_context?: boolean;
|
|
1214
|
+
keep_fresh?: boolean;
|
|
1215
|
+
editable?: boolean | null;
|
|
1216
|
+
template?: ("full" | "compact" | "minimal") | null;
|
|
1217
|
+
type: "input_transcript_session";
|
|
1218
|
+
transcript_session_ids: string[];
|
|
1219
|
+
};
|
|
1220
|
+
/** One pre-rendered dialogue turn for ElevenLabs ``text_to_dialogue`` — the */
|
|
1221
|
+
type TtsDialogueTurn = {
|
|
1222
|
+
/** Spoken text for this turn. */
|
|
1223
|
+
text: string;
|
|
1224
|
+
/** Provider-native voice id speaking this turn. */
|
|
1225
|
+
voice_id: string;
|
|
1226
|
+
};
|
|
1227
|
+
/** TtsVoiceSpeaker */
|
|
1228
|
+
type TtsVoiceSpeaker = {
|
|
1229
|
+
/** Speaker label in multi-speaker TTS scripts. */
|
|
1230
|
+
name: string;
|
|
1231
|
+
/** Provider-native voice id or name. */
|
|
1232
|
+
voice: string;
|
|
1233
|
+
/** Optional speaker gender ('male' / 'female'). Never sent to a provider — it lets TTSVoiceConfig pair voices with the SCRIPT's speaker labels by gender when the two disagree, instead of positionally (wh */
|
|
1234
|
+
gender?: string;
|
|
1235
|
+
};
|
|
1236
|
+
/** Round-tripped user preferences row. */
|
|
1237
|
+
type UserAnalysisPreferencesResponse = {
|
|
1238
|
+
per_detector_enabled?: {
|
|
1239
|
+
[key: string]: boolean;
|
|
1240
|
+
};
|
|
1241
|
+
default_tier_per_detector?: {
|
|
1242
|
+
[key: string]: string;
|
|
1243
|
+
};
|
|
1244
|
+
custom_patterns?: JsonValue[];
|
|
1245
|
+
default_redaction_mode?: string;
|
|
1246
|
+
per_file_type_overrides?: {
|
|
1247
|
+
[key: string]: JsonValue;
|
|
1248
|
+
};
|
|
1249
|
+
substitute_formats?: {
|
|
1250
|
+
[key: string]: string;
|
|
1251
|
+
};
|
|
1252
|
+
updated_at?: JsonValue | null;
|
|
1253
|
+
[key: string]: unknown;
|
|
1254
|
+
};
|
|
1255
|
+
/** UserAudioMediaPart */
|
|
1256
|
+
type UserAudioMediaPart = {
|
|
1257
|
+
url: string;
|
|
1258
|
+
} | {
|
|
1259
|
+
file_id: string;
|
|
1260
|
+
} | {
|
|
1261
|
+
base64_data: string;
|
|
1262
|
+
};
|
|
1263
|
+
/** UserDocumentMediaPart */
|
|
1264
|
+
type UserDocumentMediaPart = {
|
|
1265
|
+
url: string;
|
|
1266
|
+
} | {
|
|
1267
|
+
file_id: string;
|
|
1268
|
+
} | {
|
|
1269
|
+
base64_data: string;
|
|
1270
|
+
};
|
|
1271
|
+
/** UserImageMediaPart */
|
|
1272
|
+
type UserImageMediaPart = {
|
|
1273
|
+
url: string;
|
|
1274
|
+
} | {
|
|
1275
|
+
file_id: string;
|
|
1276
|
+
} | {
|
|
1277
|
+
base64_data: string;
|
|
1278
|
+
};
|
|
1279
|
+
/** Per-request user-level inclusion / exclusion overrides. */
|
|
1280
|
+
type UserOverrides = {
|
|
1281
|
+
add?: string[];
|
|
1282
|
+
remove?: string[];
|
|
1283
|
+
apply_policy?: ("auto" | "ask" | "off") | null;
|
|
1284
|
+
auto_tools?: boolean | null;
|
|
1285
|
+
};
|
|
1286
|
+
/** UserVideoMediaPart */
|
|
1287
|
+
type UserVideoMediaPart = {
|
|
1288
|
+
url: string;
|
|
1289
|
+
} | {
|
|
1290
|
+
file_id: string;
|
|
1291
|
+
} | {
|
|
1292
|
+
base64_data: string;
|
|
1293
|
+
};
|
|
1294
|
+
/** UserYouTubeMediaPart */
|
|
1295
|
+
type UserYouTubeMediaPart = {
|
|
1296
|
+
metadata?: {
|
|
1297
|
+
[key: string]: unknown;
|
|
1298
|
+
};
|
|
1299
|
+
type: "media";
|
|
1300
|
+
kind: "youtube";
|
|
1301
|
+
url: string;
|
|
1302
|
+
external_url?: string | null;
|
|
1303
|
+
origin?: "external";
|
|
1304
|
+
mime_type?: string | null;
|
|
1305
|
+
};
|
|
1306
|
+
/** ValidateCronRequest */
|
|
1307
|
+
type ValidateCronRequest = {
|
|
1308
|
+
expression: string;
|
|
1309
|
+
tz?: string;
|
|
1310
|
+
next_n?: number;
|
|
1311
|
+
};
|
|
1312
|
+
/** ValidateCronResponse */
|
|
1313
|
+
type ValidateCronResponse = {
|
|
1314
|
+
valid: boolean;
|
|
1315
|
+
error?: string | null;
|
|
1316
|
+
next_fires_utc?: string[];
|
|
1317
|
+
};
|
|
1318
|
+
/** WebSearchPart */
|
|
1319
|
+
type WebSearchPart = {
|
|
1320
|
+
metadata?: {
|
|
1321
|
+
[key: string]: unknown;
|
|
1322
|
+
};
|
|
1323
|
+
type: "web_search";
|
|
1324
|
+
id?: string;
|
|
1325
|
+
status?: string;
|
|
1326
|
+
};
|
|
1327
|
+
/** WebpageInputPart */
|
|
1328
|
+
type WebpageInputPart = {
|
|
1329
|
+
metadata?: {
|
|
1330
|
+
[key: string]: unknown;
|
|
1331
|
+
};
|
|
1332
|
+
type: "input_webpage";
|
|
1333
|
+
urls: (string | PreFetchedUrl)[];
|
|
1334
|
+
convert_to_text?: boolean;
|
|
1335
|
+
optional_context?: boolean;
|
|
1336
|
+
keep_fresh?: boolean;
|
|
1337
|
+
editable?: boolean | null;
|
|
1338
|
+
};
|
|
1339
|
+
/** WorkbookInputPart */
|
|
1340
|
+
type WorkbookInputPart = {
|
|
1341
|
+
metadata?: {
|
|
1342
|
+
[key: string]: unknown;
|
|
1343
|
+
};
|
|
1344
|
+
convert_to_text?: boolean;
|
|
1345
|
+
optional_context?: boolean;
|
|
1346
|
+
keep_fresh?: boolean;
|
|
1347
|
+
editable?: boolean | null;
|
|
1348
|
+
template?: ("full" | "compact" | "minimal") | null;
|
|
1349
|
+
type: "input_workbook";
|
|
1350
|
+
workbook_ids: (string | LiveResourceRefInput)[];
|
|
1351
|
+
};
|
|
1352
|
+
|
|
1353
|
+
export type { ActionNeeded, ActionNeededAction, ActionNeededChoice, ActionNeededKind, ActionNeededStatus, AgentAppInputPart, AgentInputPart, AgentStartRequest, AgentToolSpec, Asset, AssetVariant, BlockStateRef, CacheBypass, CalendarCreateResult, CalendarEventAttendee, CalendarLocalRefreshResult, ChatMessageInput, ChatToolCallInput, ClientContext, CodeExecPart, CodeResultPart, CompactionSettings, ComputeNextDueResponse, ContextAnchor, ContextInputPart, CustomTool, CustomToolInputSchema, DataInputPart, DataRefSort, DbFieldRef, DbQueryRef, DbRecordRef, DecisionAnswer, DecisionAnswersPart, DecisionQuestion, DecisionQuestionsPart, DecisionUsage_Input, DictionaryConfig, DictionaryEntry, DirectiveItemApplied, DirectiveItemFailed, DocumentInputPart, ExternalSourceMetadata, FullListBookmark, FullTableBookmark, GlossaryEntry, IdeDiagnostic, IdeFileState, IdeGitState, IdeState, IdeWorkspaceState, ImageLora, InlineToolSpec, JsonSchemaObjectDocument, JsonSchemaProperty, JsonValue, LLMParams, ListGroupBookmark, ListInputPart, ListItemBookmark, LiveResourceRefInput, MandateTestHolder, MediaRef, NormalizedCitation, NotesInputPart, OutputSchemaEnvelope, PageContext, PreFetchedUrl, ProjectInputPart, PromptStartRequest, RegisteredToolSpec, RemarkAnswer, RemarkItem, RemarkTarget, RemarkThreadEntry, RemarksInputPart, ResourceContextPolicy, ResourcePromotion, ResourceRefInput, ResponseFormatJsonObject, ResponseFormatJsonSchema, ResponseFormatText, RunNowResponse, SandboxBindingRequest, SnapshotBodyResourceRefInput, SnapshotContentResourceRefInput, SnapshotDescriptionResourceRefInput, SnapshotTextResourceRefInput, SnapshotValueResourceRefInput, SpeechScriptPart, SpeechTurn, StorageImportResult, SurfaceAmendments, TableCellBookmark, TableColumnBookmark, TableInputPart, TableRowBookmark, TableSchemaBookmark, TaskInputPart, TextPart, ThinkingPart, ThreadLink, ToolCallPart, ToolResultPart, TranscriptInputPart, TranscriptSessionInputPart, TtsDialogueTurn, TtsVoiceSpeaker, UserAnalysisPreferencesResponse, UserAudioMediaPart, UserDocumentMediaPart, UserImageMediaPart, UserOverrides, UserVideoMediaPart, UserYouTubeMediaPart, ValidateCronRequest, ValidateCronResponse, WebSearchPart, WebpageInputPart, WorkbookInputPart };
|