@deepraxis/sdk 0.1.1-dev.c64b603 → 0.1.1-dev.d775f1e
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/METHODS.md +1 -59
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +5 -107
- package/dist/generated/sdk.gen.js +4 -252
- package/dist/generated/types.gen.d.ts +940 -2762
- package/dist/operations.generated.d.ts +10 -328
- package/dist/operations.generated.js +10 -390
- package/dist/resources.generated.d.ts +9 -408
- package/dist/resources.generated.js +0 -31
- package/package.json +1 -1
|
@@ -1,6 +1,261 @@
|
|
|
1
1
|
export type ClientOptions = {
|
|
2
2
|
baseUrl: 'https://api.deepraxis.com' | (string & {});
|
|
3
3
|
};
|
|
4
|
+
/**
|
|
5
|
+
* Praxis extension: Streamable HTTP, SSE or trusted stdio MCP servers, persisted with the agent version. Optional fields remain omitted when not supplied.
|
|
6
|
+
*/
|
|
7
|
+
export type AgentManaged36 = {
|
|
8
|
+
/**
|
|
9
|
+
* Streamable HTTP transport.
|
|
10
|
+
*/
|
|
11
|
+
type: 'url';
|
|
12
|
+
/**
|
|
13
|
+
* Name of the MCP server; the mcp_toolset entry that refers to it uses the same name in mcp_server_name.
|
|
14
|
+
*/
|
|
15
|
+
name: string;
|
|
16
|
+
/**
|
|
17
|
+
* HTTP or HTTPS MCP server endpoint.
|
|
18
|
+
*/
|
|
19
|
+
url: string;
|
|
20
|
+
/**
|
|
21
|
+
* Praxis extension: request headers. Platform identity headers take precedence, case-insensitively.
|
|
22
|
+
*/
|
|
23
|
+
headers?: {
|
|
24
|
+
[key: string]: string;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* Praxis extension: timeout in milliseconds. Applied to stdio; HTTP/SSE currently use the connection SDK default.
|
|
28
|
+
*/
|
|
29
|
+
timeout_ms?: number;
|
|
30
|
+
} | {
|
|
31
|
+
/**
|
|
32
|
+
* Legacy SSE transport.
|
|
33
|
+
*/
|
|
34
|
+
type: 'sse';
|
|
35
|
+
/**
|
|
36
|
+
* Name of the MCP server; the mcp_toolset entry that refers to it uses the same name in mcp_server_name.
|
|
37
|
+
*/
|
|
38
|
+
name: string;
|
|
39
|
+
/**
|
|
40
|
+
* HTTP or HTTPS MCP server endpoint.
|
|
41
|
+
*/
|
|
42
|
+
url: string;
|
|
43
|
+
/**
|
|
44
|
+
* Praxis extension: request headers. Platform identity headers take precedence, case-insensitively.
|
|
45
|
+
*/
|
|
46
|
+
headers?: {
|
|
47
|
+
[key: string]: string;
|
|
48
|
+
};
|
|
49
|
+
/**
|
|
50
|
+
* Praxis extension: timeout in milliseconds. Applied to stdio; HTTP/SSE currently use the connection SDK default.
|
|
51
|
+
*/
|
|
52
|
+
timeout_ms?: number;
|
|
53
|
+
} | {
|
|
54
|
+
/**
|
|
55
|
+
* Run a command on the agent computer.
|
|
56
|
+
*/
|
|
57
|
+
type: 'stdio';
|
|
58
|
+
/**
|
|
59
|
+
* Name of the MCP server; the mcp_toolset entry that refers to it uses the same name in mcp_server_name.
|
|
60
|
+
*/
|
|
61
|
+
name: string;
|
|
62
|
+
/**
|
|
63
|
+
* Executable command on the agent computer.
|
|
64
|
+
*/
|
|
65
|
+
command: string;
|
|
66
|
+
/**
|
|
67
|
+
* Command arguments; omitted means no arguments.
|
|
68
|
+
*/
|
|
69
|
+
args?: Array<string>;
|
|
70
|
+
/**
|
|
71
|
+
* Praxis extension: environment variables for the command on the agent computer.
|
|
72
|
+
*/
|
|
73
|
+
env?: {
|
|
74
|
+
[key: string]: string;
|
|
75
|
+
};
|
|
76
|
+
/**
|
|
77
|
+
* Praxis extension: timeout in milliseconds. Applied to stdio; HTTP/SSE currently use the connection SDK default.
|
|
78
|
+
*/
|
|
79
|
+
timeout_ms?: number;
|
|
80
|
+
};
|
|
81
|
+
/**
|
|
82
|
+
* Free-form string key/value pairs stored with the agent for your own bookkeeping.
|
|
83
|
+
*/
|
|
84
|
+
export type AgentManaged37 = {
|
|
85
|
+
[key: string]: string;
|
|
86
|
+
};
|
|
87
|
+
export type AgentManaged2 = {
|
|
88
|
+
/**
|
|
89
|
+
* Always `low`. Lowest reasoning effort of the supported levels.
|
|
90
|
+
*/
|
|
91
|
+
type: 'low';
|
|
92
|
+
};
|
|
93
|
+
export type AgentManaged3 = {
|
|
94
|
+
/**
|
|
95
|
+
* Always `medium`. Middle reasoning effort.
|
|
96
|
+
*/
|
|
97
|
+
type: 'medium';
|
|
98
|
+
};
|
|
99
|
+
export type AgentManaged4 = {
|
|
100
|
+
/**
|
|
101
|
+
* Always `high`. High reasoning effort.
|
|
102
|
+
*/
|
|
103
|
+
type: 'high';
|
|
104
|
+
};
|
|
105
|
+
export type AgentManaged5 = {
|
|
106
|
+
/**
|
|
107
|
+
* Always `xhigh`. Extra-high reasoning effort, above high; only models that list it in thinking.efforts accept it.
|
|
108
|
+
*/
|
|
109
|
+
type: 'xhigh';
|
|
110
|
+
};
|
|
111
|
+
export type AgentManaged6 = {
|
|
112
|
+
/**
|
|
113
|
+
* Always `max`. Maximum effort level of the Managed Agents shape, above xhigh.
|
|
114
|
+
*/
|
|
115
|
+
type: 'max';
|
|
116
|
+
};
|
|
117
|
+
export type AgentManaged39 = {
|
|
118
|
+
/**
|
|
119
|
+
* Agents the coordinator may spawn as session threads, each resolved to a specific
|
|
120
|
+
* version.
|
|
121
|
+
*/
|
|
122
|
+
agents: Array<AgentManaged40 | AgentManaged41>;
|
|
123
|
+
/**
|
|
124
|
+
* Always `coordinator`. The agent coordinates the roster in agents and can delegate to its members.
|
|
125
|
+
*/
|
|
126
|
+
type: 'coordinator';
|
|
127
|
+
};
|
|
128
|
+
export type AgentManaged42 = {
|
|
129
|
+
/**
|
|
130
|
+
* Id of the skill to attach.
|
|
131
|
+
*/
|
|
132
|
+
skill_id: string;
|
|
133
|
+
/**
|
|
134
|
+
* Always `anthropic`. A skill provided by Anthropic, identified by skill_id.
|
|
135
|
+
*/
|
|
136
|
+
type: 'anthropic';
|
|
137
|
+
/**
|
|
138
|
+
* Version of the skill: omit or `latest` to follow the newest version at each new session; give a version id to pin it.
|
|
139
|
+
*/
|
|
140
|
+
version: string;
|
|
141
|
+
};
|
|
142
|
+
export type AgentManaged43 = {
|
|
143
|
+
/**
|
|
144
|
+
* Id of the skill to attach.
|
|
145
|
+
*/
|
|
146
|
+
skill_id: string;
|
|
147
|
+
/**
|
|
148
|
+
* Always `custom`. A skill created by you, identified by skill_id.
|
|
149
|
+
*/
|
|
150
|
+
type: 'custom';
|
|
151
|
+
/**
|
|
152
|
+
* Version of the skill: omit or `latest` to follow the newest version at each new session; give a version id to pin it.
|
|
153
|
+
*/
|
|
154
|
+
version: string;
|
|
155
|
+
};
|
|
156
|
+
export type AgentManaged44 = {
|
|
157
|
+
/**
|
|
158
|
+
* Per-tool settings that override default_config. Tools that are not listed follow default_config.
|
|
159
|
+
*/
|
|
160
|
+
configs: Array<AgentManaged45 | AgentManaged46 | AgentManaged47 | AgentManaged48 | AgentManaged49 | AgentManaged50 | AgentManaged51 | AgentManaged52 | {
|
|
161
|
+
/**
|
|
162
|
+
* Name of the native tool this entry configures.
|
|
163
|
+
*/
|
|
164
|
+
name: 'task_output' | 'task_stop' | 'monitor' | 'agent' | 'send_message' | 'codemode' | 'skill';
|
|
165
|
+
/**
|
|
166
|
+
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
167
|
+
*/
|
|
168
|
+
enabled: boolean;
|
|
169
|
+
/**
|
|
170
|
+
* Whether a call to this tool runs automatically (always_allow) or waits for user.tool_confirmation (always_ask). Omitted means the toolset default.
|
|
171
|
+
*/
|
|
172
|
+
permission_policy: {
|
|
173
|
+
/**
|
|
174
|
+
* Permission policy kind.
|
|
175
|
+
*/
|
|
176
|
+
type: 'always_allow' | 'always_ask';
|
|
177
|
+
};
|
|
178
|
+
}>;
|
|
179
|
+
/**
|
|
180
|
+
* Resolved default configuration for agent tools.
|
|
181
|
+
*/
|
|
182
|
+
default_config: AgentManaged53;
|
|
183
|
+
/**
|
|
184
|
+
* Always `agent_toolset_20260401`. The native toolset entry (bash, edit, glob, grep, read, write, web_search, web_fetch, task_output, task_stop, monitor, agent, send_message).
|
|
185
|
+
*/
|
|
186
|
+
type: 'agent_toolset_20260401';
|
|
187
|
+
};
|
|
188
|
+
/**
|
|
189
|
+
* Exactly one toolset per declared MCP server. Tools default to enabled and always_ask; per-tool overrides inherit omitted settings.
|
|
190
|
+
*/
|
|
191
|
+
export type AgentManaged54 = {
|
|
192
|
+
/**
|
|
193
|
+
* Always `mcp_toolset`. An entry that exposes the tools of one MCP server from mcp_servers.
|
|
194
|
+
*/
|
|
195
|
+
type: 'mcp_toolset';
|
|
196
|
+
/**
|
|
197
|
+
* Name of the MCP server in mcp_servers whose tools this entry exposes.
|
|
198
|
+
*/
|
|
199
|
+
mcp_server_name: string;
|
|
200
|
+
/**
|
|
201
|
+
* Settings applied to every tool of this toolset that configs does not name. When omitted, tools are enabled with the always_allow policy.
|
|
202
|
+
*/
|
|
203
|
+
default_config?: {
|
|
204
|
+
/**
|
|
205
|
+
* Whether tools of the toolset are offered to the model when configs does not name them. Null or omitted means enabled.
|
|
206
|
+
*/
|
|
207
|
+
enabled?: boolean | null;
|
|
208
|
+
/**
|
|
209
|
+
* Permission policy for tools that configs does not name: always_allow runs calls automatically, always_ask waits for user.tool_confirmation.
|
|
210
|
+
*/
|
|
211
|
+
permission_policy?: null | {
|
|
212
|
+
/**
|
|
213
|
+
* Permission policy kind.
|
|
214
|
+
*/
|
|
215
|
+
type: 'always_allow' | 'always_ask';
|
|
216
|
+
};
|
|
217
|
+
} | null;
|
|
218
|
+
/**
|
|
219
|
+
* Per-tool settings that override default_config. Tools that are not listed follow default_config.
|
|
220
|
+
*/
|
|
221
|
+
configs?: Array<{
|
|
222
|
+
/**
|
|
223
|
+
* Bare tool name reported by the MCP server.
|
|
224
|
+
*/
|
|
225
|
+
name: string;
|
|
226
|
+
/**
|
|
227
|
+
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
228
|
+
*/
|
|
229
|
+
enabled?: boolean | null;
|
|
230
|
+
/**
|
|
231
|
+
* Whether a call to this tool runs automatically (always_allow) or waits for user.tool_confirmation (always_ask). Omitted means the toolset default.
|
|
232
|
+
*/
|
|
233
|
+
permission_policy?: null | {
|
|
234
|
+
/**
|
|
235
|
+
* Permission policy kind.
|
|
236
|
+
*/
|
|
237
|
+
type: 'always_allow' | 'always_ask';
|
|
238
|
+
};
|
|
239
|
+
}> | null;
|
|
240
|
+
};
|
|
241
|
+
export type AgentManaged57 = {
|
|
242
|
+
/**
|
|
243
|
+
* What the custom tool does and when the model should call it.
|
|
244
|
+
*/
|
|
245
|
+
description: string;
|
|
246
|
+
/**
|
|
247
|
+
* JSON Schema for custom tool input parameters.
|
|
248
|
+
*/
|
|
249
|
+
input_schema: AgentManaged33;
|
|
250
|
+
/**
|
|
251
|
+
* Name of the custom tool, as the model sees and calls it.
|
|
252
|
+
*/
|
|
253
|
+
name: string;
|
|
254
|
+
/**
|
|
255
|
+
* Always `custom`. A custom tool defined by name, description and input_schema; its calls are answered by the client with user.custom_tool_result.
|
|
256
|
+
*/
|
|
257
|
+
type: 'custom';
|
|
258
|
+
};
|
|
4
259
|
export type AgentError = {
|
|
5
260
|
type: 'error';
|
|
6
261
|
error: {
|
|
@@ -3966,488 +4221,233 @@ export type AgentManaged184 = {
|
|
|
3966
4221
|
*/
|
|
3967
4222
|
type: 'session_deleted';
|
|
3968
4223
|
};
|
|
4224
|
+
export type AgentManaged171 = {
|
|
4225
|
+
/**
|
|
4226
|
+
* Full `agent` definitions the coordinator may spawn as session threads.
|
|
4227
|
+
*/
|
|
4228
|
+
agents: Array<AgentManaged41 | AgentManaged172>;
|
|
4229
|
+
/**
|
|
4230
|
+
* Always `coordinator`. The agent coordinates the roster in agents and can delegate to its members.
|
|
4231
|
+
*/
|
|
4232
|
+
type: 'coordinator';
|
|
4233
|
+
};
|
|
4234
|
+
/**
|
|
4235
|
+
* Session spending limit, {type: "limit", max_list_cost: {amount, currency}}; null when unlimited. amount is in US dollars: send an integer or up to 2 decimals ("0.50"), and responses carry exactly 2 decimals ("20.00"). Creation defaults to USD 20.00 when omitted. More decimals, zero or a number return 400. Removing the limit with null prevents setting it again for that session.
|
|
4236
|
+
*/
|
|
4237
|
+
export type AgentManaged76 = {
|
|
4238
|
+
/**
|
|
4239
|
+
* A monetary amount in a specific currency.
|
|
4240
|
+
*/
|
|
4241
|
+
max_list_cost: AgentManaged77;
|
|
4242
|
+
/**
|
|
4243
|
+
* Budget kind; always limit. Any other value, including max_list_cost, returns 400 budget.type must be "limit".
|
|
4244
|
+
*/
|
|
4245
|
+
type: 'limit';
|
|
4246
|
+
};
|
|
4247
|
+
/**
|
|
4248
|
+
* Free-form string key/value pairs stored with the session, changed through sessions.update patch semantics.
|
|
4249
|
+
*/
|
|
4250
|
+
export type AgentManaged173 = {
|
|
4251
|
+
[key: string]: string;
|
|
4252
|
+
};
|
|
4253
|
+
export type AgentManaged174 = {
|
|
4254
|
+
/**
|
|
4255
|
+
* A timestamp in RFC 3339 format
|
|
4256
|
+
*/
|
|
4257
|
+
completed_at: null | string;
|
|
4258
|
+
/**
|
|
4259
|
+
* What the agent should produce.
|
|
4260
|
+
*/
|
|
4261
|
+
description: string;
|
|
4262
|
+
/**
|
|
4263
|
+
* Grader's verdict text from the most recent evaluation. For `satisfied`, explains
|
|
4264
|
+
* why criteria are met; for `needs_revision` (intermediate), what's missing; for
|
|
4265
|
+
* `failed`, why unrecoverable.
|
|
4266
|
+
*/
|
|
4267
|
+
explanation: null | string;
|
|
4268
|
+
/**
|
|
4269
|
+
* 0-indexed revision cycle the outcome is currently on.
|
|
4270
|
+
*/
|
|
4271
|
+
iteration: number;
|
|
4272
|
+
/**
|
|
4273
|
+
* Server-generated outc\_ ID for this outcome.
|
|
4274
|
+
*/
|
|
4275
|
+
outcome_id: string;
|
|
4276
|
+
/**
|
|
4277
|
+
* Current evaluation state. `pending` before the agent begins work; `running`
|
|
4278
|
+
* while producing or revising; `evaluating` while the grader scores;
|
|
4279
|
+
* `satisfied`/`max_iterations_reached`/`failed`/`interrupted` are terminal.
|
|
4280
|
+
*/
|
|
4281
|
+
result: string;
|
|
4282
|
+
/**
|
|
4283
|
+
* Always `outcome_evaluation`. Record of one outcome evaluation.
|
|
4284
|
+
*/
|
|
4285
|
+
type: 'outcome_evaluation';
|
|
4286
|
+
};
|
|
4287
|
+
export type AgentManaged175 = {
|
|
4288
|
+
/**
|
|
4289
|
+
* Resource id, the resource_id of sessions.resources calls.
|
|
4290
|
+
*/
|
|
4291
|
+
id: string;
|
|
4292
|
+
/**
|
|
4293
|
+
* A timestamp in RFC 3339 format
|
|
4294
|
+
*/
|
|
4295
|
+
created_at: string;
|
|
4296
|
+
/**
|
|
4297
|
+
* Path inside the machine where the file is mounted; defaults to /mnt/session/uploads/<file_id>, and custom paths are rooted there.
|
|
4298
|
+
*/
|
|
4299
|
+
mount_path: string;
|
|
4300
|
+
/**
|
|
4301
|
+
* Always `github_repository`. A GitHub repository resource; not supported on this platform.
|
|
4302
|
+
*/
|
|
4303
|
+
type: 'github_repository';
|
|
4304
|
+
/**
|
|
4305
|
+
* A timestamp in RFC 3339 format
|
|
4306
|
+
*/
|
|
4307
|
+
updated_at: string;
|
|
4308
|
+
/**
|
|
4309
|
+
* Repository URL.
|
|
4310
|
+
*/
|
|
4311
|
+
url: string;
|
|
4312
|
+
/**
|
|
4313
|
+
* Branch or commit to check out.
|
|
4314
|
+
*/
|
|
4315
|
+
checkout?: null | AgentManaged80 | AgentManaged81;
|
|
4316
|
+
};
|
|
4317
|
+
export type AgentManaged176 = {
|
|
4318
|
+
/**
|
|
4319
|
+
* Resource id, the resource_id of sessions.resources calls.
|
|
4320
|
+
*/
|
|
4321
|
+
id: string;
|
|
4322
|
+
/**
|
|
4323
|
+
* A timestamp in RFC 3339 format
|
|
4324
|
+
*/
|
|
4325
|
+
created_at: string;
|
|
4326
|
+
/**
|
|
4327
|
+
* Id of the uploaded file; it must exist and belong to your tenant.
|
|
4328
|
+
*/
|
|
4329
|
+
file_id: string;
|
|
4330
|
+
/**
|
|
4331
|
+
* Path inside the machine where the file is mounted; defaults to /mnt/session/uploads/<file_id>, and custom paths are rooted there.
|
|
4332
|
+
*/
|
|
4333
|
+
mount_path: string;
|
|
4334
|
+
/**
|
|
4335
|
+
* Always `file`. A file resource: an uploaded file mounted into the session's machine.
|
|
4336
|
+
*/
|
|
4337
|
+
type: 'file';
|
|
4338
|
+
/**
|
|
4339
|
+
* A timestamp in RFC 3339 format
|
|
4340
|
+
*/
|
|
4341
|
+
updated_at: string;
|
|
4342
|
+
};
|
|
4343
|
+
export type AgentManaged177 = {
|
|
4344
|
+
/**
|
|
4345
|
+
* The memory store ID (memstore\_...). Must belong to the caller's organization
|
|
4346
|
+
* and workspace.
|
|
4347
|
+
*/
|
|
4348
|
+
memory_store_id: string;
|
|
4349
|
+
/**
|
|
4350
|
+
* Always `memory_store`. A memory store resource; not supported on this platform.
|
|
4351
|
+
*/
|
|
4352
|
+
type: 'memory_store';
|
|
4353
|
+
/**
|
|
4354
|
+
* Access mode for an attached memory store.
|
|
4355
|
+
*/
|
|
4356
|
+
access?: null | 'read_write' | 'read_only';
|
|
4357
|
+
/**
|
|
4358
|
+
* Description of the memory store, snapshotted at attach time. Rendered into the
|
|
4359
|
+
* agent's system prompt. Empty string when the store has no description.
|
|
4360
|
+
*/
|
|
4361
|
+
description?: string;
|
|
4362
|
+
/**
|
|
4363
|
+
* Per-attachment guidance for the agent on how to use this store. Rendered into
|
|
4364
|
+
* the memory section of the system prompt. Max 4096 chars.
|
|
4365
|
+
*/
|
|
4366
|
+
instructions?: null | string;
|
|
4367
|
+
/**
|
|
4368
|
+
* Filesystem path where the store is mounted in the session container, e.g.
|
|
4369
|
+
* /mnt/memory/user-preferences. Derived from the store's name. Output-only.
|
|
4370
|
+
*/
|
|
4371
|
+
mount_path?: null | string;
|
|
4372
|
+
/**
|
|
4373
|
+
* Display name of the memory store, snapshotted at attach time. Later edits to the
|
|
4374
|
+
* store's name do not propagate to this resource.
|
|
4375
|
+
*/
|
|
4376
|
+
name?: null | string;
|
|
4377
|
+
};
|
|
4378
|
+
/**
|
|
4379
|
+
* Cumulative timing statistics of the session.
|
|
4380
|
+
*/
|
|
4381
|
+
export type AgentManaged178 = {
|
|
4382
|
+
/**
|
|
4383
|
+
* Cumulative time in seconds the session spent in `running` status. Excludes idle
|
|
4384
|
+
* time.
|
|
4385
|
+
*/
|
|
4386
|
+
active_seconds?: number;
|
|
4387
|
+
/**
|
|
4388
|
+
* Elapsed time since session creation in seconds. For terminated sessions, frozen
|
|
4389
|
+
* at the final update.
|
|
4390
|
+
*/
|
|
4391
|
+
duration_seconds?: number;
|
|
4392
|
+
};
|
|
4393
|
+
/**
|
|
4394
|
+
* Cumulative token usage and list cost of the session so far.
|
|
4395
|
+
*/
|
|
4396
|
+
export type AgentManaged179 = {
|
|
4397
|
+
/**
|
|
4398
|
+
* Cumulative time in seconds during which the session had at least one thread in
|
|
4399
|
+
* running status. Overlapping activity from concurrent threads is counted once,
|
|
4400
|
+
* unlike `stats.active_seconds`, which sums each thread's own active time. This is
|
|
4401
|
+
* the duration the session's runtime cost is priced on.
|
|
4402
|
+
*/
|
|
4403
|
+
active_seconds?: number;
|
|
4404
|
+
/**
|
|
4405
|
+
* Prompt-cache creation token usage broken down by cache lifetime.
|
|
4406
|
+
*/
|
|
4407
|
+
cache_creation?: AgentManaged180;
|
|
4408
|
+
/**
|
|
4409
|
+
* Total tokens read from prompt cache.
|
|
4410
|
+
*/
|
|
4411
|
+
cache_read_input_tokens?: number;
|
|
4412
|
+
/**
|
|
4413
|
+
* Total input tokens consumed across all turns.
|
|
4414
|
+
*/
|
|
4415
|
+
input_tokens?: number;
|
|
4416
|
+
/**
|
|
4417
|
+
* A monetary amount in a specific currency.
|
|
4418
|
+
*/
|
|
4419
|
+
list_cost?: null | AgentManaged77;
|
|
4420
|
+
/**
|
|
4421
|
+
* Total output tokens generated across all turns.
|
|
4422
|
+
*/
|
|
4423
|
+
output_tokens?: number;
|
|
4424
|
+
/**
|
|
4425
|
+
* Cumulative count of server-executed tool invocations, broken down by tool.
|
|
4426
|
+
*/
|
|
4427
|
+
server_tool_use?: null | AgentManaged181;
|
|
4428
|
+
/**
|
|
4429
|
+
* Praxis extension: priced runtime of this session (the time it was running), billed separately from list_cost and not counted against the budget. amount is in US dollars as a decimal string with exactly 6 decimals, e.g. "0.000280". Each thread's runtime is reported on that thread. /agent/v1 only.
|
|
4430
|
+
*/
|
|
4431
|
+
runtime_cost?: {
|
|
4432
|
+
/**
|
|
4433
|
+
* Runtime cost in US dollars, decimal string with exactly 6 decimals.
|
|
4434
|
+
*/
|
|
4435
|
+
amount: string;
|
|
4436
|
+
/**
|
|
4437
|
+
* Always USD.
|
|
4438
|
+
*/
|
|
4439
|
+
currency: 'USD';
|
|
4440
|
+
};
|
|
4441
|
+
};
|
|
4442
|
+
export type AgentManaged183 = {
|
|
4443
|
+
[key: string]: null | string;
|
|
4444
|
+
};
|
|
3969
4445
|
/**
|
|
3970
4446
|
* Praxis extension: Streamable HTTP, SSE or trusted stdio MCP servers, persisted with the agent version. Optional fields remain omitted when not supplied.
|
|
3971
4447
|
*/
|
|
3972
|
-
export type
|
|
4448
|
+
export type AgentManaged7 = {
|
|
3973
4449
|
/**
|
|
3974
|
-
*
|
|
3975
|
-
*/
|
|
3976
|
-
type: 'url';
|
|
3977
|
-
/**
|
|
3978
|
-
* Name of the MCP server; the mcp_toolset entry that refers to it uses the same name in mcp_server_name.
|
|
3979
|
-
*/
|
|
3980
|
-
name: string;
|
|
3981
|
-
/**
|
|
3982
|
-
* HTTP or HTTPS MCP server endpoint.
|
|
3983
|
-
*/
|
|
3984
|
-
url: string;
|
|
3985
|
-
/**
|
|
3986
|
-
* Praxis extension: request headers. Platform identity headers take precedence, case-insensitively.
|
|
3987
|
-
*/
|
|
3988
|
-
headers?: {
|
|
3989
|
-
[key: string]: string;
|
|
3990
|
-
};
|
|
3991
|
-
/**
|
|
3992
|
-
* Praxis extension: timeout in milliseconds. Applied to stdio; HTTP/SSE currently use the connection SDK default.
|
|
3993
|
-
*/
|
|
3994
|
-
timeout_ms?: number;
|
|
3995
|
-
} | {
|
|
3996
|
-
/**
|
|
3997
|
-
* Legacy SSE transport.
|
|
3998
|
-
*/
|
|
3999
|
-
type: 'sse';
|
|
4000
|
-
/**
|
|
4001
|
-
* Name of the MCP server; the mcp_toolset entry that refers to it uses the same name in mcp_server_name.
|
|
4002
|
-
*/
|
|
4003
|
-
name: string;
|
|
4004
|
-
/**
|
|
4005
|
-
* HTTP or HTTPS MCP server endpoint.
|
|
4006
|
-
*/
|
|
4007
|
-
url: string;
|
|
4008
|
-
/**
|
|
4009
|
-
* Praxis extension: request headers. Platform identity headers take precedence, case-insensitively.
|
|
4010
|
-
*/
|
|
4011
|
-
headers?: {
|
|
4012
|
-
[key: string]: string;
|
|
4013
|
-
};
|
|
4014
|
-
/**
|
|
4015
|
-
* Praxis extension: timeout in milliseconds. Applied to stdio; HTTP/SSE currently use the connection SDK default.
|
|
4016
|
-
*/
|
|
4017
|
-
timeout_ms?: number;
|
|
4018
|
-
} | {
|
|
4019
|
-
/**
|
|
4020
|
-
* Run a command on the agent computer.
|
|
4021
|
-
*/
|
|
4022
|
-
type: 'stdio';
|
|
4023
|
-
/**
|
|
4024
|
-
* Name of the MCP server; the mcp_toolset entry that refers to it uses the same name in mcp_server_name.
|
|
4025
|
-
*/
|
|
4026
|
-
name: string;
|
|
4027
|
-
/**
|
|
4028
|
-
* Executable command on the agent computer.
|
|
4029
|
-
*/
|
|
4030
|
-
command: string;
|
|
4031
|
-
/**
|
|
4032
|
-
* Command arguments; omitted means no arguments.
|
|
4033
|
-
*/
|
|
4034
|
-
args?: Array<string>;
|
|
4035
|
-
/**
|
|
4036
|
-
* Praxis extension: environment variables for the command on the agent computer.
|
|
4037
|
-
*/
|
|
4038
|
-
env?: {
|
|
4039
|
-
[key: string]: string;
|
|
4040
|
-
};
|
|
4041
|
-
/**
|
|
4042
|
-
* Praxis extension: timeout in milliseconds. Applied to stdio; HTTP/SSE currently use the connection SDK default.
|
|
4043
|
-
*/
|
|
4044
|
-
timeout_ms?: number;
|
|
4045
|
-
};
|
|
4046
|
-
export type AgentManaged2 = {
|
|
4047
|
-
/**
|
|
4048
|
-
* Always `low`. Lowest reasoning effort of the supported levels.
|
|
4049
|
-
*/
|
|
4050
|
-
type: 'low';
|
|
4051
|
-
};
|
|
4052
|
-
export type AgentManaged3 = {
|
|
4053
|
-
/**
|
|
4054
|
-
* Always `medium`. Middle reasoning effort.
|
|
4055
|
-
*/
|
|
4056
|
-
type: 'medium';
|
|
4057
|
-
};
|
|
4058
|
-
export type AgentManaged4 = {
|
|
4059
|
-
/**
|
|
4060
|
-
* Always `high`. High reasoning effort.
|
|
4061
|
-
*/
|
|
4062
|
-
type: 'high';
|
|
4063
|
-
};
|
|
4064
|
-
export type AgentManaged5 = {
|
|
4065
|
-
/**
|
|
4066
|
-
* Always `xhigh`. Extra-high reasoning effort, above high; only models that list it in thinking.efforts accept it.
|
|
4067
|
-
*/
|
|
4068
|
-
type: 'xhigh';
|
|
4069
|
-
};
|
|
4070
|
-
export type AgentManaged6 = {
|
|
4071
|
-
/**
|
|
4072
|
-
* Always `max`. Maximum effort level of the Managed Agents shape, above xhigh.
|
|
4073
|
-
*/
|
|
4074
|
-
type: 'max';
|
|
4075
|
-
};
|
|
4076
|
-
export type AgentManaged171 = {
|
|
4077
|
-
/**
|
|
4078
|
-
* Full `agent` definitions the coordinator may spawn as session threads.
|
|
4079
|
-
*/
|
|
4080
|
-
agents: Array<AgentManaged41 | AgentManaged172>;
|
|
4081
|
-
/**
|
|
4082
|
-
* Always `coordinator`. The agent coordinates the roster in agents and can delegate to its members.
|
|
4083
|
-
*/
|
|
4084
|
-
type: 'coordinator';
|
|
4085
|
-
};
|
|
4086
|
-
export type AgentManaged42 = {
|
|
4087
|
-
/**
|
|
4088
|
-
* Id of the skill to attach.
|
|
4089
|
-
*/
|
|
4090
|
-
skill_id: string;
|
|
4091
|
-
/**
|
|
4092
|
-
* Always `anthropic`. A skill provided by Anthropic, identified by skill_id.
|
|
4093
|
-
*/
|
|
4094
|
-
type: 'anthropic';
|
|
4095
|
-
/**
|
|
4096
|
-
* Version of the skill: omit or `latest` to follow the newest version at each new session; give a version id to pin it.
|
|
4097
|
-
*/
|
|
4098
|
-
version: string;
|
|
4099
|
-
};
|
|
4100
|
-
export type AgentManaged43 = {
|
|
4101
|
-
/**
|
|
4102
|
-
* Id of the skill to attach.
|
|
4103
|
-
*/
|
|
4104
|
-
skill_id: string;
|
|
4105
|
-
/**
|
|
4106
|
-
* Always `custom`. A skill created by you, identified by skill_id.
|
|
4107
|
-
*/
|
|
4108
|
-
type: 'custom';
|
|
4109
|
-
/**
|
|
4110
|
-
* Version of the skill: omit or `latest` to follow the newest version at each new session; give a version id to pin it.
|
|
4111
|
-
*/
|
|
4112
|
-
version: string;
|
|
4113
|
-
};
|
|
4114
|
-
export type AgentManaged44 = {
|
|
4115
|
-
/**
|
|
4116
|
-
* Per-tool settings that override default_config. Tools that are not listed follow default_config.
|
|
4117
|
-
*/
|
|
4118
|
-
configs: Array<AgentManaged45 | AgentManaged46 | AgentManaged47 | AgentManaged48 | AgentManaged49 | AgentManaged50 | AgentManaged51 | AgentManaged52 | {
|
|
4119
|
-
/**
|
|
4120
|
-
* Name of the native tool this entry configures.
|
|
4121
|
-
*/
|
|
4122
|
-
name: 'task_output' | 'task_stop' | 'monitor' | 'agent' | 'send_message' | 'codemode' | 'skill';
|
|
4123
|
-
/**
|
|
4124
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
4125
|
-
*/
|
|
4126
|
-
enabled: boolean;
|
|
4127
|
-
/**
|
|
4128
|
-
* Whether a call to this tool runs automatically (always_allow) or waits for user.tool_confirmation (always_ask). Omitted means the toolset default.
|
|
4129
|
-
*/
|
|
4130
|
-
permission_policy: {
|
|
4131
|
-
/**
|
|
4132
|
-
* Permission policy kind.
|
|
4133
|
-
*/
|
|
4134
|
-
type: 'always_allow' | 'always_ask';
|
|
4135
|
-
};
|
|
4136
|
-
}>;
|
|
4137
|
-
/**
|
|
4138
|
-
* Resolved default configuration for agent tools.
|
|
4139
|
-
*/
|
|
4140
|
-
default_config: AgentManaged53;
|
|
4141
|
-
/**
|
|
4142
|
-
* Always `agent_toolset_20260401`. The native toolset entry (bash, edit, glob, grep, read, write, web_search, web_fetch, task_output, task_stop, monitor, agent, send_message).
|
|
4143
|
-
*/
|
|
4144
|
-
type: 'agent_toolset_20260401';
|
|
4145
|
-
};
|
|
4146
|
-
/**
|
|
4147
|
-
* Exactly one toolset per declared MCP server. Tools default to enabled and always_ask; per-tool overrides inherit omitted settings.
|
|
4148
|
-
*/
|
|
4149
|
-
export type AgentManaged54 = {
|
|
4150
|
-
/**
|
|
4151
|
-
* Always `mcp_toolset`. An entry that exposes the tools of one MCP server from mcp_servers.
|
|
4152
|
-
*/
|
|
4153
|
-
type: 'mcp_toolset';
|
|
4154
|
-
/**
|
|
4155
|
-
* Name of the MCP server in mcp_servers whose tools this entry exposes.
|
|
4156
|
-
*/
|
|
4157
|
-
mcp_server_name: string;
|
|
4158
|
-
/**
|
|
4159
|
-
* Settings applied to every tool of this toolset that configs does not name. When omitted, tools are enabled with the always_allow policy.
|
|
4160
|
-
*/
|
|
4161
|
-
default_config?: {
|
|
4162
|
-
/**
|
|
4163
|
-
* Whether tools of the toolset are offered to the model when configs does not name them. Null or omitted means enabled.
|
|
4164
|
-
*/
|
|
4165
|
-
enabled?: boolean | null;
|
|
4166
|
-
/**
|
|
4167
|
-
* Permission policy for tools that configs does not name: always_allow runs calls automatically, always_ask waits for user.tool_confirmation.
|
|
4168
|
-
*/
|
|
4169
|
-
permission_policy?: null | {
|
|
4170
|
-
/**
|
|
4171
|
-
* Permission policy kind.
|
|
4172
|
-
*/
|
|
4173
|
-
type: 'always_allow' | 'always_ask';
|
|
4174
|
-
};
|
|
4175
|
-
} | null;
|
|
4176
|
-
/**
|
|
4177
|
-
* Per-tool settings that override default_config. Tools that are not listed follow default_config.
|
|
4178
|
-
*/
|
|
4179
|
-
configs?: Array<{
|
|
4180
|
-
/**
|
|
4181
|
-
* Bare tool name reported by the MCP server.
|
|
4182
|
-
*/
|
|
4183
|
-
name: string;
|
|
4184
|
-
/**
|
|
4185
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
4186
|
-
*/
|
|
4187
|
-
enabled?: boolean | null;
|
|
4188
|
-
/**
|
|
4189
|
-
* Whether a call to this tool runs automatically (always_allow) or waits for user.tool_confirmation (always_ask). Omitted means the toolset default.
|
|
4190
|
-
*/
|
|
4191
|
-
permission_policy?: null | {
|
|
4192
|
-
/**
|
|
4193
|
-
* Permission policy kind.
|
|
4194
|
-
*/
|
|
4195
|
-
type: 'always_allow' | 'always_ask';
|
|
4196
|
-
};
|
|
4197
|
-
}> | null;
|
|
4198
|
-
};
|
|
4199
|
-
export type AgentManaged57 = {
|
|
4200
|
-
/**
|
|
4201
|
-
* What the custom tool does and when the model should call it.
|
|
4202
|
-
*/
|
|
4203
|
-
description: string;
|
|
4204
|
-
/**
|
|
4205
|
-
* JSON Schema for custom tool input parameters.
|
|
4206
|
-
*/
|
|
4207
|
-
input_schema: AgentManaged33;
|
|
4208
|
-
/**
|
|
4209
|
-
* Name of the custom tool, as the model sees and calls it.
|
|
4210
|
-
*/
|
|
4211
|
-
name: string;
|
|
4212
|
-
/**
|
|
4213
|
-
* Always `custom`. A custom tool defined by name, description and input_schema; its calls are answered by the client with user.custom_tool_result.
|
|
4214
|
-
*/
|
|
4215
|
-
type: 'custom';
|
|
4216
|
-
};
|
|
4217
|
-
/**
|
|
4218
|
-
* Session spending limit, {type: "limit", max_list_cost: {amount, currency}}; null when unlimited. amount is in US dollars: send an integer or up to 2 decimals ("0.50"), and responses carry exactly 2 decimals ("20.00"). Creation defaults to USD 20.00 when omitted. More decimals, zero or a number return 400. Removing the limit with null prevents setting it again for that session.
|
|
4219
|
-
*/
|
|
4220
|
-
export type AgentManaged76 = {
|
|
4221
|
-
/**
|
|
4222
|
-
* A monetary amount in a specific currency.
|
|
4223
|
-
*/
|
|
4224
|
-
max_list_cost: AgentManaged77;
|
|
4225
|
-
/**
|
|
4226
|
-
* Budget kind; always limit. Any other value, including max_list_cost, returns 400 budget.type must be "limit".
|
|
4227
|
-
*/
|
|
4228
|
-
type: 'limit';
|
|
4229
|
-
};
|
|
4230
|
-
/**
|
|
4231
|
-
* Free-form string key/value pairs stored with the session, changed through sessions.update patch semantics.
|
|
4232
|
-
*/
|
|
4233
|
-
export type AgentManaged173 = {
|
|
4234
|
-
[key: string]: string;
|
|
4235
|
-
};
|
|
4236
|
-
export type AgentManaged174 = {
|
|
4237
|
-
/**
|
|
4238
|
-
* A timestamp in RFC 3339 format
|
|
4239
|
-
*/
|
|
4240
|
-
completed_at: null | string;
|
|
4241
|
-
/**
|
|
4242
|
-
* What the agent should produce.
|
|
4243
|
-
*/
|
|
4244
|
-
description: string;
|
|
4245
|
-
/**
|
|
4246
|
-
* Grader's verdict text from the most recent evaluation. For `satisfied`, explains
|
|
4247
|
-
* why criteria are met; for `needs_revision` (intermediate), what's missing; for
|
|
4248
|
-
* `failed`, why unrecoverable.
|
|
4249
|
-
*/
|
|
4250
|
-
explanation: null | string;
|
|
4251
|
-
/**
|
|
4252
|
-
* 0-indexed revision cycle the outcome is currently on.
|
|
4253
|
-
*/
|
|
4254
|
-
iteration: number;
|
|
4255
|
-
/**
|
|
4256
|
-
* Server-generated outc\_ ID for this outcome.
|
|
4257
|
-
*/
|
|
4258
|
-
outcome_id: string;
|
|
4259
|
-
/**
|
|
4260
|
-
* Current evaluation state. `pending` before the agent begins work; `running`
|
|
4261
|
-
* while producing or revising; `evaluating` while the grader scores;
|
|
4262
|
-
* `satisfied`/`max_iterations_reached`/`failed`/`interrupted` are terminal.
|
|
4263
|
-
*/
|
|
4264
|
-
result: string;
|
|
4265
|
-
/**
|
|
4266
|
-
* Always `outcome_evaluation`. Record of one outcome evaluation.
|
|
4267
|
-
*/
|
|
4268
|
-
type: 'outcome_evaluation';
|
|
4269
|
-
};
|
|
4270
|
-
export type AgentManaged175 = {
|
|
4271
|
-
/**
|
|
4272
|
-
* Resource id, the resource_id of sessions.resources calls.
|
|
4273
|
-
*/
|
|
4274
|
-
id: string;
|
|
4275
|
-
/**
|
|
4276
|
-
* A timestamp in RFC 3339 format
|
|
4277
|
-
*/
|
|
4278
|
-
created_at: string;
|
|
4279
|
-
/**
|
|
4280
|
-
* Path inside the machine where the file is mounted; defaults to /mnt/session/uploads/<file_id>, and custom paths are rooted there.
|
|
4281
|
-
*/
|
|
4282
|
-
mount_path: string;
|
|
4283
|
-
/**
|
|
4284
|
-
* Always `github_repository`. A GitHub repository resource; not supported on this platform.
|
|
4285
|
-
*/
|
|
4286
|
-
type: 'github_repository';
|
|
4287
|
-
/**
|
|
4288
|
-
* A timestamp in RFC 3339 format
|
|
4289
|
-
*/
|
|
4290
|
-
updated_at: string;
|
|
4291
|
-
/**
|
|
4292
|
-
* Repository URL.
|
|
4293
|
-
*/
|
|
4294
|
-
url: string;
|
|
4295
|
-
/**
|
|
4296
|
-
* Branch or commit to check out.
|
|
4297
|
-
*/
|
|
4298
|
-
checkout?: null | AgentManaged80 | AgentManaged81;
|
|
4299
|
-
};
|
|
4300
|
-
export type AgentManaged176 = {
|
|
4301
|
-
/**
|
|
4302
|
-
* Resource id, the resource_id of sessions.resources calls.
|
|
4303
|
-
*/
|
|
4304
|
-
id: string;
|
|
4305
|
-
/**
|
|
4306
|
-
* A timestamp in RFC 3339 format
|
|
4307
|
-
*/
|
|
4308
|
-
created_at: string;
|
|
4309
|
-
/**
|
|
4310
|
-
* Id of the uploaded file; it must exist and belong to your tenant.
|
|
4311
|
-
*/
|
|
4312
|
-
file_id: string;
|
|
4313
|
-
/**
|
|
4314
|
-
* Path inside the machine where the file is mounted; defaults to /mnt/session/uploads/<file_id>, and custom paths are rooted there.
|
|
4315
|
-
*/
|
|
4316
|
-
mount_path: string;
|
|
4317
|
-
/**
|
|
4318
|
-
* Always `file`. A file resource: an uploaded file mounted into the session's machine.
|
|
4319
|
-
*/
|
|
4320
|
-
type: 'file';
|
|
4321
|
-
/**
|
|
4322
|
-
* A timestamp in RFC 3339 format
|
|
4323
|
-
*/
|
|
4324
|
-
updated_at: string;
|
|
4325
|
-
};
|
|
4326
|
-
export type AgentManaged177 = {
|
|
4327
|
-
/**
|
|
4328
|
-
* The memory store ID (memstore\_...). Must belong to the caller's organization
|
|
4329
|
-
* and workspace.
|
|
4330
|
-
*/
|
|
4331
|
-
memory_store_id: string;
|
|
4332
|
-
/**
|
|
4333
|
-
* Always `memory_store`. A memory store resource; not supported on this platform.
|
|
4334
|
-
*/
|
|
4335
|
-
type: 'memory_store';
|
|
4336
|
-
/**
|
|
4337
|
-
* Access mode for an attached memory store.
|
|
4338
|
-
*/
|
|
4339
|
-
access?: null | 'read_write' | 'read_only';
|
|
4340
|
-
/**
|
|
4341
|
-
* Description of the memory store, snapshotted at attach time. Rendered into the
|
|
4342
|
-
* agent's system prompt. Empty string when the store has no description.
|
|
4343
|
-
*/
|
|
4344
|
-
description?: string;
|
|
4345
|
-
/**
|
|
4346
|
-
* Per-attachment guidance for the agent on how to use this store. Rendered into
|
|
4347
|
-
* the memory section of the system prompt. Max 4096 chars.
|
|
4348
|
-
*/
|
|
4349
|
-
instructions?: null | string;
|
|
4350
|
-
/**
|
|
4351
|
-
* Filesystem path where the store is mounted in the session container, e.g.
|
|
4352
|
-
* /mnt/memory/user-preferences. Derived from the store's name. Output-only.
|
|
4353
|
-
*/
|
|
4354
|
-
mount_path?: null | string;
|
|
4355
|
-
/**
|
|
4356
|
-
* Display name of the memory store, snapshotted at attach time. Later edits to the
|
|
4357
|
-
* store's name do not propagate to this resource.
|
|
4358
|
-
*/
|
|
4359
|
-
name?: null | string;
|
|
4360
|
-
};
|
|
4361
|
-
/**
|
|
4362
|
-
* Cumulative timing statistics of the session.
|
|
4363
|
-
*/
|
|
4364
|
-
export type AgentManaged178 = {
|
|
4365
|
-
/**
|
|
4366
|
-
* Cumulative time in seconds the session spent in `running` status. Excludes idle
|
|
4367
|
-
* time.
|
|
4368
|
-
*/
|
|
4369
|
-
active_seconds?: number;
|
|
4370
|
-
/**
|
|
4371
|
-
* Elapsed time since session creation in seconds. For terminated sessions, frozen
|
|
4372
|
-
* at the final update.
|
|
4373
|
-
*/
|
|
4374
|
-
duration_seconds?: number;
|
|
4375
|
-
};
|
|
4376
|
-
/**
|
|
4377
|
-
* Cumulative token usage and list cost of the session so far.
|
|
4378
|
-
*/
|
|
4379
|
-
export type AgentManaged179 = {
|
|
4380
|
-
/**
|
|
4381
|
-
* Cumulative time in seconds during which the session had at least one thread in
|
|
4382
|
-
* running status. Overlapping activity from concurrent threads is counted once,
|
|
4383
|
-
* unlike `stats.active_seconds`, which sums each thread's own active time. This is
|
|
4384
|
-
* the duration the session's runtime cost is priced on.
|
|
4385
|
-
*/
|
|
4386
|
-
active_seconds?: number;
|
|
4387
|
-
/**
|
|
4388
|
-
* Prompt-cache creation token usage broken down by cache lifetime.
|
|
4389
|
-
*/
|
|
4390
|
-
cache_creation?: AgentManaged180;
|
|
4391
|
-
/**
|
|
4392
|
-
* Total tokens read from prompt cache.
|
|
4393
|
-
*/
|
|
4394
|
-
cache_read_input_tokens?: number;
|
|
4395
|
-
/**
|
|
4396
|
-
* Total input tokens consumed across all turns.
|
|
4397
|
-
*/
|
|
4398
|
-
input_tokens?: number;
|
|
4399
|
-
/**
|
|
4400
|
-
* A monetary amount in a specific currency.
|
|
4401
|
-
*/
|
|
4402
|
-
list_cost?: null | AgentManaged77;
|
|
4403
|
-
/**
|
|
4404
|
-
* Total output tokens generated across all turns.
|
|
4405
|
-
*/
|
|
4406
|
-
output_tokens?: number;
|
|
4407
|
-
/**
|
|
4408
|
-
* Cumulative count of server-executed tool invocations, broken down by tool.
|
|
4409
|
-
*/
|
|
4410
|
-
server_tool_use?: null | AgentManaged181;
|
|
4411
|
-
/**
|
|
4412
|
-
* Praxis extension: priced runtime of this session (the time it was running), billed separately from list_cost and not counted against the budget. amount is in US dollars as a decimal string with exactly 6 decimals, e.g. "0.000280". Each thread's runtime is reported on that thread. /agent/v1 only.
|
|
4413
|
-
*/
|
|
4414
|
-
runtime_cost?: {
|
|
4415
|
-
/**
|
|
4416
|
-
* Runtime cost in US dollars, decimal string with exactly 6 decimals.
|
|
4417
|
-
*/
|
|
4418
|
-
amount: string;
|
|
4419
|
-
/**
|
|
4420
|
-
* Always USD.
|
|
4421
|
-
*/
|
|
4422
|
-
currency: 'USD';
|
|
4423
|
-
};
|
|
4424
|
-
};
|
|
4425
|
-
export type AgentManaged183 = {
|
|
4426
|
-
[key: string]: null | string;
|
|
4427
|
-
};
|
|
4428
|
-
/**
|
|
4429
|
-
* Free-form string key/value pairs stored with the agent for your own bookkeeping.
|
|
4430
|
-
*/
|
|
4431
|
-
export type AgentManaged37 = {
|
|
4432
|
-
[key: string]: string;
|
|
4433
|
-
};
|
|
4434
|
-
export type AgentManaged39 = {
|
|
4435
|
-
/**
|
|
4436
|
-
* Agents the coordinator may spawn as session threads, each resolved to a specific
|
|
4437
|
-
* version.
|
|
4438
|
-
*/
|
|
4439
|
-
agents: Array<AgentManaged40 | AgentManaged41>;
|
|
4440
|
-
/**
|
|
4441
|
-
* Always `coordinator`. The agent coordinates the roster in agents and can delegate to its members.
|
|
4442
|
-
*/
|
|
4443
|
-
type: 'coordinator';
|
|
4444
|
-
};
|
|
4445
|
-
/**
|
|
4446
|
-
* Praxis extension: Streamable HTTP, SSE or trusted stdio MCP servers, persisted with the agent version. Optional fields remain omitted when not supplied.
|
|
4447
|
-
*/
|
|
4448
|
-
export type AgentManaged7 = {
|
|
4449
|
-
/**
|
|
4450
|
-
* URL transport for an MCP server declared on the agent.
|
|
4450
|
+
* URL transport for an MCP server declared on the agent.
|
|
4451
4451
|
*/
|
|
4452
4452
|
type: 'url';
|
|
4453
4453
|
/**
|
|
@@ -13304,6 +13304,232 @@ export type TicketRepository = {
|
|
|
13304
13304
|
*/
|
|
13305
13305
|
update_time: string;
|
|
13306
13306
|
};
|
|
13307
|
+
/**
|
|
13308
|
+
* Agent definition the session uses after the change; null when unchanged.
|
|
13309
|
+
*/
|
|
13310
|
+
export type AgentManaged40 = {
|
|
13311
|
+
/**
|
|
13312
|
+
* Agent id (agent_...). Pass it as agent when creating a session and as agent_id in agent calls.
|
|
13313
|
+
*/
|
|
13314
|
+
id: string;
|
|
13315
|
+
/**
|
|
13316
|
+
* Always `agent`. A roster member that refers to an agent by id and pinned version.
|
|
13317
|
+
*/
|
|
13318
|
+
type: 'agent';
|
|
13319
|
+
/**
|
|
13320
|
+
* The latest saved version of the agent, the editable head; it differs from active_version after a save with apply false. Starts at 1 and increments each time the agent is modified.
|
|
13321
|
+
*/
|
|
13322
|
+
version: number;
|
|
13323
|
+
};
|
|
13324
|
+
export type AgentManaged41 = {
|
|
13325
|
+
/**
|
|
13326
|
+
* The advisor model id.
|
|
13327
|
+
*/
|
|
13328
|
+
model: string;
|
|
13329
|
+
/**
|
|
13330
|
+
* Always `advisor`. An advisor whose model is consulted for advice in a separate thread (at most one per coordinator).
|
|
13331
|
+
*/
|
|
13332
|
+
type: 'advisor';
|
|
13333
|
+
};
|
|
13334
|
+
export type AgentManaged45 = {
|
|
13335
|
+
/**
|
|
13336
|
+
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
13337
|
+
*/
|
|
13338
|
+
enabled: boolean;
|
|
13339
|
+
/**
|
|
13340
|
+
* Name of the native tool this entry configures.
|
|
13341
|
+
*/
|
|
13342
|
+
name: 'bash';
|
|
13343
|
+
/**
|
|
13344
|
+
* Permission policy for tool execution.
|
|
13345
|
+
*/
|
|
13346
|
+
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
13347
|
+
/**
|
|
13348
|
+
* Always `bash`. Selects the bash tool, which runs shell commands in the session's machine.
|
|
13349
|
+
*/
|
|
13350
|
+
type: 'bash';
|
|
13351
|
+
};
|
|
13352
|
+
export type AgentManaged46 = {
|
|
13353
|
+
/**
|
|
13354
|
+
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
13355
|
+
*/
|
|
13356
|
+
enabled: boolean;
|
|
13357
|
+
/**
|
|
13358
|
+
* Name of the native tool this entry configures.
|
|
13359
|
+
*/
|
|
13360
|
+
name: 'edit';
|
|
13361
|
+
/**
|
|
13362
|
+
* Permission policy for tool execution.
|
|
13363
|
+
*/
|
|
13364
|
+
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
13365
|
+
/**
|
|
13366
|
+
* Always `edit`. Selects the edit tool, which changes an existing file.
|
|
13367
|
+
*/
|
|
13368
|
+
type: 'edit';
|
|
13369
|
+
};
|
|
13370
|
+
export type AgentManaged47 = {
|
|
13371
|
+
/**
|
|
13372
|
+
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
13373
|
+
*/
|
|
13374
|
+
enabled: boolean;
|
|
13375
|
+
/**
|
|
13376
|
+
* Name of the native tool this entry configures.
|
|
13377
|
+
*/
|
|
13378
|
+
name: 'read';
|
|
13379
|
+
/**
|
|
13380
|
+
* Permission policy for tool execution.
|
|
13381
|
+
*/
|
|
13382
|
+
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
13383
|
+
/**
|
|
13384
|
+
* Always `read`. Selects the read tool, which reads a file.
|
|
13385
|
+
*/
|
|
13386
|
+
type: 'read';
|
|
13387
|
+
};
|
|
13388
|
+
export type AgentManaged48 = {
|
|
13389
|
+
/**
|
|
13390
|
+
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
13391
|
+
*/
|
|
13392
|
+
enabled: boolean;
|
|
13393
|
+
/**
|
|
13394
|
+
* Name of the native tool this entry configures.
|
|
13395
|
+
*/
|
|
13396
|
+
name: 'write';
|
|
13397
|
+
/**
|
|
13398
|
+
* Permission policy for tool execution.
|
|
13399
|
+
*/
|
|
13400
|
+
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
13401
|
+
/**
|
|
13402
|
+
* Always `write`. Selects the write tool, which writes a file.
|
|
13403
|
+
*/
|
|
13404
|
+
type: 'write';
|
|
13405
|
+
};
|
|
13406
|
+
export type AgentManaged49 = {
|
|
13407
|
+
/**
|
|
13408
|
+
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
13409
|
+
*/
|
|
13410
|
+
enabled: boolean;
|
|
13411
|
+
/**
|
|
13412
|
+
* Name of the native tool this entry configures.
|
|
13413
|
+
*/
|
|
13414
|
+
name: 'glob';
|
|
13415
|
+
/**
|
|
13416
|
+
* Permission policy for tool execution.
|
|
13417
|
+
*/
|
|
13418
|
+
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
13419
|
+
/**
|
|
13420
|
+
* Always `glob`. Selects the glob tool, which finds files by name pattern.
|
|
13421
|
+
*/
|
|
13422
|
+
type: 'glob';
|
|
13423
|
+
};
|
|
13424
|
+
export type AgentManaged50 = {
|
|
13425
|
+
/**
|
|
13426
|
+
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
13427
|
+
*/
|
|
13428
|
+
enabled: boolean;
|
|
13429
|
+
/**
|
|
13430
|
+
* Name of the native tool this entry configures.
|
|
13431
|
+
*/
|
|
13432
|
+
name: 'grep';
|
|
13433
|
+
/**
|
|
13434
|
+
* Permission policy for tool execution.
|
|
13435
|
+
*/
|
|
13436
|
+
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
13437
|
+
/**
|
|
13438
|
+
* Always `grep`. Selects the grep tool, which searches file contents.
|
|
13439
|
+
*/
|
|
13440
|
+
type: 'grep';
|
|
13441
|
+
};
|
|
13442
|
+
export type AgentManaged51 = {
|
|
13443
|
+
/**
|
|
13444
|
+
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
13445
|
+
*/
|
|
13446
|
+
enabled: boolean;
|
|
13447
|
+
/**
|
|
13448
|
+
* Name of the native tool this entry configures.
|
|
13449
|
+
*/
|
|
13450
|
+
name: 'web_fetch';
|
|
13451
|
+
/**
|
|
13452
|
+
* Permission policy for tool execution.
|
|
13453
|
+
*/
|
|
13454
|
+
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
13455
|
+
/**
|
|
13456
|
+
* Always `web_fetch`. Selects the web_fetch tool, which fetches a web page.
|
|
13457
|
+
*/
|
|
13458
|
+
type: 'web_fetch';
|
|
13459
|
+
/**
|
|
13460
|
+
* Hosts the tool may fetch or search, as plain hostnames (no scheme, port or path); a listed domain also covers its subdomains. At most 64 entries, and it cannot be combined with blocked_domains.
|
|
13461
|
+
*/
|
|
13462
|
+
allowed_domains?: Array<string>;
|
|
13463
|
+
/**
|
|
13464
|
+
* Hosts the tool must never fetch or search, as plain hostnames (no scheme, port or path); a listed domain also covers its subdomains. At most 64 entries, and it cannot be combined with allowed_domains.
|
|
13465
|
+
*/
|
|
13466
|
+
blocked_domains?: Array<string>;
|
|
13467
|
+
/**
|
|
13468
|
+
* Maximum number of tokens of fetched text content included in context per call; does not apply to binary content such as PDFs. Null for no explicit limit.
|
|
13469
|
+
*/
|
|
13470
|
+
max_content_tokens?: null | number;
|
|
13471
|
+
};
|
|
13472
|
+
export type AgentManaged52 = {
|
|
13473
|
+
/**
|
|
13474
|
+
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
13475
|
+
*/
|
|
13476
|
+
enabled: boolean;
|
|
13477
|
+
/**
|
|
13478
|
+
* Name of the native tool this entry configures.
|
|
13479
|
+
*/
|
|
13480
|
+
name: 'web_search';
|
|
13481
|
+
/**
|
|
13482
|
+
* Permission policy for tool execution.
|
|
13483
|
+
*/
|
|
13484
|
+
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
13485
|
+
/**
|
|
13486
|
+
* Always `web_search`. Selects the web_search tool, which searches the web.
|
|
13487
|
+
*/
|
|
13488
|
+
type: 'web_search';
|
|
13489
|
+
/**
|
|
13490
|
+
* Hosts the tool may fetch or search, as plain hostnames (no scheme, port or path); a listed domain also covers its subdomains. At most 64 entries, and it cannot be combined with blocked_domains.
|
|
13491
|
+
*/
|
|
13492
|
+
allowed_domains?: Array<string>;
|
|
13493
|
+
/**
|
|
13494
|
+
* Hosts the tool must never fetch or search, as plain hostnames (no scheme, port or path); a listed domain also covers its subdomains. At most 64 entries, and it cannot be combined with allowed_domains.
|
|
13495
|
+
*/
|
|
13496
|
+
blocked_domains?: Array<string>;
|
|
13497
|
+
/**
|
|
13498
|
+
* Approximate user location for search result localization.
|
|
13499
|
+
*/
|
|
13500
|
+
user_location?: null | AgentManaged27;
|
|
13501
|
+
};
|
|
13502
|
+
/**
|
|
13503
|
+
* Settings applied to every tool of this toolset that configs does not name. When omitted, tools are enabled with the always_allow policy.
|
|
13504
|
+
*/
|
|
13505
|
+
export type AgentManaged53 = {
|
|
13506
|
+
/**
|
|
13507
|
+
* Whether tools of the toolset are offered to the model when configs does not name them. Null or omitted means enabled.
|
|
13508
|
+
*/
|
|
13509
|
+
enabled: boolean;
|
|
13510
|
+
/**
|
|
13511
|
+
* Permission policy for tool execution.
|
|
13512
|
+
*/
|
|
13513
|
+
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
13514
|
+
};
|
|
13515
|
+
/**
|
|
13516
|
+
* JSON Schema of the custom tool's input object, passed to the model as the tool's parameters.
|
|
13517
|
+
*/
|
|
13518
|
+
export type AgentManaged33 = {
|
|
13519
|
+
/**
|
|
13520
|
+
* Always `object`. The input is a JSON object.
|
|
13521
|
+
*/
|
|
13522
|
+
type: 'object';
|
|
13523
|
+
/**
|
|
13524
|
+
* JSON Schema of each input property, keyed by property name.
|
|
13525
|
+
*/
|
|
13526
|
+
properties?: null | AgentManaged34;
|
|
13527
|
+
/**
|
|
13528
|
+
* Names of the input properties the model must supply.
|
|
13529
|
+
*/
|
|
13530
|
+
required?: null | Array<string>;
|
|
13531
|
+
[key: string]: unknown;
|
|
13532
|
+
};
|
|
13307
13533
|
/**
|
|
13308
13534
|
* File expiration policy
|
|
13309
13535
|
*
|
|
@@ -17863,16 +18089,6 @@ export type SandboxError = {
|
|
|
17863
18089
|
*/
|
|
17864
18090
|
message: string;
|
|
17865
18091
|
};
|
|
17866
|
-
export type AgentManaged41 = {
|
|
17867
|
-
/**
|
|
17868
|
-
* The advisor model id.
|
|
17869
|
-
*/
|
|
17870
|
-
model: string;
|
|
17871
|
-
/**
|
|
17872
|
-
* Always `advisor`. An advisor whose model is consulted for advice in a separate thread (at most one per coordinator).
|
|
17873
|
-
*/
|
|
17874
|
-
type: 'advisor';
|
|
17875
|
-
};
|
|
17876
18092
|
export type AgentManaged172 = {
|
|
17877
18093
|
/**
|
|
17878
18094
|
* Agent id (agent_...). Pass it as agent when creating a session and as agent_id in agent calls.
|
|
@@ -17915,205 +18131,6 @@ export type AgentManaged172 = {
|
|
|
17915
18131
|
*/
|
|
17916
18132
|
version: number;
|
|
17917
18133
|
};
|
|
17918
|
-
export type AgentManaged45 = {
|
|
17919
|
-
/**
|
|
17920
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
17921
|
-
*/
|
|
17922
|
-
enabled: boolean;
|
|
17923
|
-
/**
|
|
17924
|
-
* Name of the native tool this entry configures.
|
|
17925
|
-
*/
|
|
17926
|
-
name: 'bash';
|
|
17927
|
-
/**
|
|
17928
|
-
* Permission policy for tool execution.
|
|
17929
|
-
*/
|
|
17930
|
-
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
17931
|
-
/**
|
|
17932
|
-
* Always `bash`. Selects the bash tool, which runs shell commands in the session's machine.
|
|
17933
|
-
*/
|
|
17934
|
-
type: 'bash';
|
|
17935
|
-
};
|
|
17936
|
-
export type AgentManaged46 = {
|
|
17937
|
-
/**
|
|
17938
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
17939
|
-
*/
|
|
17940
|
-
enabled: boolean;
|
|
17941
|
-
/**
|
|
17942
|
-
* Name of the native tool this entry configures.
|
|
17943
|
-
*/
|
|
17944
|
-
name: 'edit';
|
|
17945
|
-
/**
|
|
17946
|
-
* Permission policy for tool execution.
|
|
17947
|
-
*/
|
|
17948
|
-
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
17949
|
-
/**
|
|
17950
|
-
* Always `edit`. Selects the edit tool, which changes an existing file.
|
|
17951
|
-
*/
|
|
17952
|
-
type: 'edit';
|
|
17953
|
-
};
|
|
17954
|
-
export type AgentManaged47 = {
|
|
17955
|
-
/**
|
|
17956
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
17957
|
-
*/
|
|
17958
|
-
enabled: boolean;
|
|
17959
|
-
/**
|
|
17960
|
-
* Name of the native tool this entry configures.
|
|
17961
|
-
*/
|
|
17962
|
-
name: 'read';
|
|
17963
|
-
/**
|
|
17964
|
-
* Permission policy for tool execution.
|
|
17965
|
-
*/
|
|
17966
|
-
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
17967
|
-
/**
|
|
17968
|
-
* Always `read`. Selects the read tool, which reads a file.
|
|
17969
|
-
*/
|
|
17970
|
-
type: 'read';
|
|
17971
|
-
};
|
|
17972
|
-
export type AgentManaged48 = {
|
|
17973
|
-
/**
|
|
17974
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
17975
|
-
*/
|
|
17976
|
-
enabled: boolean;
|
|
17977
|
-
/**
|
|
17978
|
-
* Name of the native tool this entry configures.
|
|
17979
|
-
*/
|
|
17980
|
-
name: 'write';
|
|
17981
|
-
/**
|
|
17982
|
-
* Permission policy for tool execution.
|
|
17983
|
-
*/
|
|
17984
|
-
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
17985
|
-
/**
|
|
17986
|
-
* Always `write`. Selects the write tool, which writes a file.
|
|
17987
|
-
*/
|
|
17988
|
-
type: 'write';
|
|
17989
|
-
};
|
|
17990
|
-
export type AgentManaged49 = {
|
|
17991
|
-
/**
|
|
17992
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
17993
|
-
*/
|
|
17994
|
-
enabled: boolean;
|
|
17995
|
-
/**
|
|
17996
|
-
* Name of the native tool this entry configures.
|
|
17997
|
-
*/
|
|
17998
|
-
name: 'glob';
|
|
17999
|
-
/**
|
|
18000
|
-
* Permission policy for tool execution.
|
|
18001
|
-
*/
|
|
18002
|
-
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
18003
|
-
/**
|
|
18004
|
-
* Always `glob`. Selects the glob tool, which finds files by name pattern.
|
|
18005
|
-
*/
|
|
18006
|
-
type: 'glob';
|
|
18007
|
-
};
|
|
18008
|
-
export type AgentManaged50 = {
|
|
18009
|
-
/**
|
|
18010
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
18011
|
-
*/
|
|
18012
|
-
enabled: boolean;
|
|
18013
|
-
/**
|
|
18014
|
-
* Name of the native tool this entry configures.
|
|
18015
|
-
*/
|
|
18016
|
-
name: 'grep';
|
|
18017
|
-
/**
|
|
18018
|
-
* Permission policy for tool execution.
|
|
18019
|
-
*/
|
|
18020
|
-
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
18021
|
-
/**
|
|
18022
|
-
* Always `grep`. Selects the grep tool, which searches file contents.
|
|
18023
|
-
*/
|
|
18024
|
-
type: 'grep';
|
|
18025
|
-
};
|
|
18026
|
-
export type AgentManaged51 = {
|
|
18027
|
-
/**
|
|
18028
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
18029
|
-
*/
|
|
18030
|
-
enabled: boolean;
|
|
18031
|
-
/**
|
|
18032
|
-
* Name of the native tool this entry configures.
|
|
18033
|
-
*/
|
|
18034
|
-
name: 'web_fetch';
|
|
18035
|
-
/**
|
|
18036
|
-
* Permission policy for tool execution.
|
|
18037
|
-
*/
|
|
18038
|
-
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
18039
|
-
/**
|
|
18040
|
-
* Always `web_fetch`. Selects the web_fetch tool, which fetches a web page.
|
|
18041
|
-
*/
|
|
18042
|
-
type: 'web_fetch';
|
|
18043
|
-
/**
|
|
18044
|
-
* Hosts the tool may fetch or search, as plain hostnames (no scheme, port or path); a listed domain also covers its subdomains. At most 64 entries, and it cannot be combined with blocked_domains.
|
|
18045
|
-
*/
|
|
18046
|
-
allowed_domains?: Array<string>;
|
|
18047
|
-
/**
|
|
18048
|
-
* Hosts the tool must never fetch or search, as plain hostnames (no scheme, port or path); a listed domain also covers its subdomains. At most 64 entries, and it cannot be combined with allowed_domains.
|
|
18049
|
-
*/
|
|
18050
|
-
blocked_domains?: Array<string>;
|
|
18051
|
-
/**
|
|
18052
|
-
* Maximum number of tokens of fetched text content included in context per call; does not apply to binary content such as PDFs. Null for no explicit limit.
|
|
18053
|
-
*/
|
|
18054
|
-
max_content_tokens?: null | number;
|
|
18055
|
-
};
|
|
18056
|
-
export type AgentManaged52 = {
|
|
18057
|
-
/**
|
|
18058
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
18059
|
-
*/
|
|
18060
|
-
enabled: boolean;
|
|
18061
|
-
/**
|
|
18062
|
-
* Name of the native tool this entry configures.
|
|
18063
|
-
*/
|
|
18064
|
-
name: 'web_search';
|
|
18065
|
-
/**
|
|
18066
|
-
* Permission policy for tool execution.
|
|
18067
|
-
*/
|
|
18068
|
-
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
18069
|
-
/**
|
|
18070
|
-
* Always `web_search`. Selects the web_search tool, which searches the web.
|
|
18071
|
-
*/
|
|
18072
|
-
type: 'web_search';
|
|
18073
|
-
/**
|
|
18074
|
-
* Hosts the tool may fetch or search, as plain hostnames (no scheme, port or path); a listed domain also covers its subdomains. At most 64 entries, and it cannot be combined with blocked_domains.
|
|
18075
|
-
*/
|
|
18076
|
-
allowed_domains?: Array<string>;
|
|
18077
|
-
/**
|
|
18078
|
-
* Hosts the tool must never fetch or search, as plain hostnames (no scheme, port or path); a listed domain also covers its subdomains. At most 64 entries, and it cannot be combined with allowed_domains.
|
|
18079
|
-
*/
|
|
18080
|
-
blocked_domains?: Array<string>;
|
|
18081
|
-
/**
|
|
18082
|
-
* Approximate user location for search result localization.
|
|
18083
|
-
*/
|
|
18084
|
-
user_location?: null | AgentManaged27;
|
|
18085
|
-
};
|
|
18086
|
-
/**
|
|
18087
|
-
* Settings applied to every tool of this toolset that configs does not name. When omitted, tools are enabled with the always_allow policy.
|
|
18088
|
-
*/
|
|
18089
|
-
export type AgentManaged53 = {
|
|
18090
|
-
/**
|
|
18091
|
-
* Whether tools of the toolset are offered to the model when configs does not name them. Null or omitted means enabled.
|
|
18092
|
-
*/
|
|
18093
|
-
enabled: boolean;
|
|
18094
|
-
/**
|
|
18095
|
-
* Permission policy for tool execution.
|
|
18096
|
-
*/
|
|
18097
|
-
permission_policy: AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
18098
|
-
};
|
|
18099
|
-
/**
|
|
18100
|
-
* JSON Schema of the custom tool's input object, passed to the model as the tool's parameters.
|
|
18101
|
-
*/
|
|
18102
|
-
export type AgentManaged33 = {
|
|
18103
|
-
/**
|
|
18104
|
-
* Always `object`. The input is a JSON object.
|
|
18105
|
-
*/
|
|
18106
|
-
type: 'object';
|
|
18107
|
-
/**
|
|
18108
|
-
* JSON Schema of each input property, keyed by property name.
|
|
18109
|
-
*/
|
|
18110
|
-
properties?: null | AgentManaged34;
|
|
18111
|
-
/**
|
|
18112
|
-
* Names of the input properties the model must supply.
|
|
18113
|
-
*/
|
|
18114
|
-
required?: null | Array<string>;
|
|
18115
|
-
[key: string]: unknown;
|
|
18116
|
-
};
|
|
18117
18134
|
/**
|
|
18118
18135
|
* Largest list-price cost the session may reach, as {amount, currency}. amount is in US dollars with at most 2 decimals, not cents.
|
|
18119
18136
|
*/
|
|
@@ -18173,23 +18190,6 @@ export type AgentManaged181 = {
|
|
|
18173
18190
|
*/
|
|
18174
18191
|
web_search_requests?: number;
|
|
18175
18192
|
};
|
|
18176
|
-
/**
|
|
18177
|
-
* Agent definition the session uses after the change; null when unchanged.
|
|
18178
|
-
*/
|
|
18179
|
-
export type AgentManaged40 = {
|
|
18180
|
-
/**
|
|
18181
|
-
* Agent id (agent_...). Pass it as agent when creating a session and as agent_id in agent calls.
|
|
18182
|
-
*/
|
|
18183
|
-
id: string;
|
|
18184
|
-
/**
|
|
18185
|
-
* Always `agent`. A roster member that refers to an agent by id and pinned version.
|
|
18186
|
-
*/
|
|
18187
|
-
type: 'agent';
|
|
18188
|
-
/**
|
|
18189
|
-
* The latest saved version of the agent, the editable head; it differs from active_version after a save with apply false. Starts at 1 and increments each time the agent is modified.
|
|
18190
|
-
*/
|
|
18191
|
-
version: number;
|
|
18192
|
-
};
|
|
18193
18193
|
export type AgentManaged11 = {
|
|
18194
18194
|
/**
|
|
18195
18195
|
* Reference to the agent being created or updated as a member of its own roster.
|
|
@@ -22175,6 +22175,49 @@ export type VaultVaultTemplate = {
|
|
|
22175
22175
|
*/
|
|
22176
22176
|
value_hint: string | null;
|
|
22177
22177
|
};
|
|
22178
|
+
export type AgentManaged17 = {
|
|
22179
|
+
/**
|
|
22180
|
+
* Permission policy that allows a tool call without confirmation, subject to the session permission mode and rules.
|
|
22181
|
+
*/
|
|
22182
|
+
type: 'always_allow';
|
|
22183
|
+
};
|
|
22184
|
+
export type AgentManaged18 = {
|
|
22185
|
+
/**
|
|
22186
|
+
* Permission policy that requests confirmation before a tool call, subject to the session permission mode and rules.
|
|
22187
|
+
*/
|
|
22188
|
+
type: 'always_ask';
|
|
22189
|
+
};
|
|
22190
|
+
export type AgentManaged19 = {
|
|
22191
|
+
/**
|
|
22192
|
+
* Always `auto`. Reserved: a server-side judgement per call. Not yet supported; sending it returns 400.
|
|
22193
|
+
*/
|
|
22194
|
+
type: 'auto';
|
|
22195
|
+
};
|
|
22196
|
+
export type AgentManaged27 = {
|
|
22197
|
+
/**
|
|
22198
|
+
* Approximate user location for localizing web search results.
|
|
22199
|
+
*/
|
|
22200
|
+
type: 'approximate';
|
|
22201
|
+
/**
|
|
22202
|
+
* City name.
|
|
22203
|
+
*/
|
|
22204
|
+
city?: null | string;
|
|
22205
|
+
/**
|
|
22206
|
+
* Two-letter ISO 3166-1 country code, uppercase.
|
|
22207
|
+
*/
|
|
22208
|
+
country?: null | string;
|
|
22209
|
+
/**
|
|
22210
|
+
* Region or state name.
|
|
22211
|
+
*/
|
|
22212
|
+
region?: null | string;
|
|
22213
|
+
/**
|
|
22214
|
+
* IANA timezone identifier, e.g. "America/Los_Angeles".
|
|
22215
|
+
*/
|
|
22216
|
+
timezone?: null | string;
|
|
22217
|
+
};
|
|
22218
|
+
export type AgentManaged34 = {
|
|
22219
|
+
[key: string]: unknown;
|
|
22220
|
+
};
|
|
22178
22221
|
export type OwnFileMisalignmentErrorDetailsResource = {
|
|
22179
22222
|
/**
|
|
22180
22223
|
* An optional classification; clients must accept additional values.
|
|
@@ -25832,49 +25875,6 @@ export type AnthropicServerToolUsage = {
|
|
|
25832
25875
|
* Action taken when the sandbox times out.
|
|
25833
25876
|
*/
|
|
25834
25877
|
export type SandboxSandboxOnTimeout = 'kill' | 'pause';
|
|
25835
|
-
export type AgentManaged17 = {
|
|
25836
|
-
/**
|
|
25837
|
-
* Permission policy that allows a tool call without confirmation, subject to the session permission mode and rules.
|
|
25838
|
-
*/
|
|
25839
|
-
type: 'always_allow';
|
|
25840
|
-
};
|
|
25841
|
-
export type AgentManaged18 = {
|
|
25842
|
-
/**
|
|
25843
|
-
* Permission policy that requests confirmation before a tool call, subject to the session permission mode and rules.
|
|
25844
|
-
*/
|
|
25845
|
-
type: 'always_ask';
|
|
25846
|
-
};
|
|
25847
|
-
export type AgentManaged19 = {
|
|
25848
|
-
/**
|
|
25849
|
-
* Always `auto`. Reserved: a server-side judgement per call. Not yet supported; sending it returns 400.
|
|
25850
|
-
*/
|
|
25851
|
-
type: 'auto';
|
|
25852
|
-
};
|
|
25853
|
-
export type AgentManaged27 = {
|
|
25854
|
-
/**
|
|
25855
|
-
* Approximate user location for localizing web search results.
|
|
25856
|
-
*/
|
|
25857
|
-
type: 'approximate';
|
|
25858
|
-
/**
|
|
25859
|
-
* City name.
|
|
25860
|
-
*/
|
|
25861
|
-
city?: null | string;
|
|
25862
|
-
/**
|
|
25863
|
-
* Two-letter ISO 3166-1 country code, uppercase.
|
|
25864
|
-
*/
|
|
25865
|
-
country?: null | string;
|
|
25866
|
-
/**
|
|
25867
|
-
* Region or state name.
|
|
25868
|
-
*/
|
|
25869
|
-
region?: null | string;
|
|
25870
|
-
/**
|
|
25871
|
-
* IANA timezone identifier, e.g. "America/Los_Angeles".
|
|
25872
|
-
*/
|
|
25873
|
-
timezone?: null | string;
|
|
25874
|
-
};
|
|
25875
|
-
export type AgentManaged34 = {
|
|
25876
|
-
[key: string]: unknown;
|
|
25877
|
-
};
|
|
25878
25878
|
export type AgentManaged213 = {
|
|
25879
25879
|
/**
|
|
25880
25880
|
* Always `retrying`. The server retries automatically.
|
|
@@ -27070,6 +27070,12 @@ export type PraxisSdkSseGetAutomationV1RunsIdLogs = ({
|
|
|
27070
27070
|
[key: string]: unknown;
|
|
27071
27071
|
};
|
|
27072
27072
|
};
|
|
27073
|
+
/**
|
|
27074
|
+
* Free-form string key/value pairs stored with the agent for your own bookkeeping.
|
|
27075
|
+
*/
|
|
27076
|
+
export type AgentManaged37Writable = {
|
|
27077
|
+
[key: string]: string;
|
|
27078
|
+
};
|
|
27073
27079
|
/**
|
|
27074
27080
|
* Models to use for completion
|
|
27075
27081
|
*/
|
|
@@ -27083,12 +27089,6 @@ export type AgentManaged173Writable = {
|
|
|
27083
27089
|
export type AgentManaged183Writable = {
|
|
27084
27090
|
[key: string]: null | string;
|
|
27085
27091
|
};
|
|
27086
|
-
/**
|
|
27087
|
-
* Free-form string key/value pairs stored with the agent for your own bookkeeping.
|
|
27088
|
-
*/
|
|
27089
|
-
export type AgentManaged37Writable = {
|
|
27090
|
-
[key: string]: string;
|
|
27091
|
-
};
|
|
27092
27092
|
/**
|
|
27093
27093
|
* Free-form string key/value pairs.
|
|
27094
27094
|
*/
|
|
@@ -27325,7 +27325,7 @@ export type ApplyAgentVersionErrors = {
|
|
|
27325
27325
|
export type ApplyAgentVersionError = ApplyAgentVersionErrors[keyof ApplyAgentVersionErrors];
|
|
27326
27326
|
export type ApplyAgentVersionResponses = {
|
|
27327
27327
|
/**
|
|
27328
|
-
*
|
|
27328
|
+
* Effective agent configuration and newest saved version number; no new version was created.
|
|
27329
27329
|
*/
|
|
27330
27330
|
200: {
|
|
27331
27331
|
/**
|
|
@@ -27345,88 +27345,10 @@ export type ApplyAgentVersionResponses = {
|
|
|
27345
27345
|
*/
|
|
27346
27346
|
description: null | string;
|
|
27347
27347
|
/**
|
|
27348
|
-
* Praxis extension:
|
|
27349
|
-
*/
|
|
27350
|
-
mcp_servers: Array<{
|
|
27351
|
-
/**
|
|
27352
|
-
* Streamable HTTP transport.
|
|
27353
|
-
*/
|
|
27354
|
-
type: 'url';
|
|
27355
|
-
/**
|
|
27356
|
-
* Name of the MCP server; the mcp_toolset entry that refers to it uses the same name in mcp_server_name.
|
|
27357
|
-
*/
|
|
27358
|
-
name: string;
|
|
27359
|
-
/**
|
|
27360
|
-
* HTTP or HTTPS MCP server endpoint.
|
|
27361
|
-
*/
|
|
27362
|
-
url: string;
|
|
27363
|
-
/**
|
|
27364
|
-
* Praxis extension: request headers. Platform identity headers take precedence, case-insensitively.
|
|
27365
|
-
*/
|
|
27366
|
-
headers?: {
|
|
27367
|
-
[key: string]: string;
|
|
27368
|
-
};
|
|
27369
|
-
/**
|
|
27370
|
-
* Praxis extension: timeout in milliseconds. Applied to stdio; HTTP/SSE currently use the connection SDK default.
|
|
27371
|
-
*/
|
|
27372
|
-
timeout_ms?: number;
|
|
27373
|
-
} | {
|
|
27374
|
-
/**
|
|
27375
|
-
* Legacy SSE transport.
|
|
27376
|
-
*/
|
|
27377
|
-
type: 'sse';
|
|
27378
|
-
/**
|
|
27379
|
-
* Name of the MCP server; the mcp_toolset entry that refers to it uses the same name in mcp_server_name.
|
|
27380
|
-
*/
|
|
27381
|
-
name: string;
|
|
27382
|
-
/**
|
|
27383
|
-
* HTTP or HTTPS MCP server endpoint.
|
|
27384
|
-
*/
|
|
27385
|
-
url: string;
|
|
27386
|
-
/**
|
|
27387
|
-
* Praxis extension: request headers. Platform identity headers take precedence, case-insensitively.
|
|
27388
|
-
*/
|
|
27389
|
-
headers?: {
|
|
27390
|
-
[key: string]: string;
|
|
27391
|
-
};
|
|
27392
|
-
/**
|
|
27393
|
-
* Praxis extension: timeout in milliseconds. Applied to stdio; HTTP/SSE currently use the connection SDK default.
|
|
27394
|
-
*/
|
|
27395
|
-
timeout_ms?: number;
|
|
27396
|
-
} | {
|
|
27397
|
-
/**
|
|
27398
|
-
* Run a command on the agent computer.
|
|
27399
|
-
*/
|
|
27400
|
-
type: 'stdio';
|
|
27401
|
-
/**
|
|
27402
|
-
* Name of the MCP server; the mcp_toolset entry that refers to it uses the same name in mcp_server_name.
|
|
27403
|
-
*/
|
|
27404
|
-
name: string;
|
|
27405
|
-
/**
|
|
27406
|
-
* Executable command on the agent computer.
|
|
27407
|
-
*/
|
|
27408
|
-
command: string;
|
|
27409
|
-
/**
|
|
27410
|
-
* Command arguments; omitted means no arguments.
|
|
27411
|
-
*/
|
|
27412
|
-
args?: Array<string>;
|
|
27413
|
-
/**
|
|
27414
|
-
* Praxis extension: environment variables for the command on the agent computer.
|
|
27415
|
-
*/
|
|
27416
|
-
env?: {
|
|
27417
|
-
[key: string]: string;
|
|
27418
|
-
};
|
|
27419
|
-
/**
|
|
27420
|
-
* Praxis extension: timeout in milliseconds. Applied to stdio; HTTP/SSE currently use the connection SDK default.
|
|
27421
|
-
*/
|
|
27422
|
-
timeout_ms?: number;
|
|
27423
|
-
}>;
|
|
27424
|
-
/**
|
|
27425
|
-
* Free-form string key/value pairs stored with the agent for your own bookkeeping.
|
|
27348
|
+
* Praxis extension: HTTP, SSE or trusted stdio MCP servers paired with mcp_toolset entries and saved with the agent version.
|
|
27426
27349
|
*/
|
|
27427
|
-
|
|
27428
|
-
|
|
27429
|
-
};
|
|
27350
|
+
mcp_servers: Array<AgentManaged36>;
|
|
27351
|
+
metadata: AgentManaged37;
|
|
27430
27352
|
/**
|
|
27431
27353
|
* Model identifier and configuration.
|
|
27432
27354
|
*/
|
|
@@ -27439,32 +27361,7 @@ export type ApplyAgentVersionResponses = {
|
|
|
27439
27361
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
27440
27362
|
* Messages call the session makes.
|
|
27441
27363
|
*/
|
|
27442
|
-
effort?:
|
|
27443
|
-
/**
|
|
27444
|
-
* Always `low`. Lowest reasoning effort of the supported levels.
|
|
27445
|
-
*/
|
|
27446
|
-
type: 'low';
|
|
27447
|
-
} | {
|
|
27448
|
-
/**
|
|
27449
|
-
* Always `medium`. Middle reasoning effort.
|
|
27450
|
-
*/
|
|
27451
|
-
type: 'medium';
|
|
27452
|
-
} | {
|
|
27453
|
-
/**
|
|
27454
|
-
* Always `high`. High reasoning effort.
|
|
27455
|
-
*/
|
|
27456
|
-
type: 'high';
|
|
27457
|
-
} | {
|
|
27458
|
-
/**
|
|
27459
|
-
* Always `xhigh`. Extra-high reasoning effort, above high; only models that list it in thinking.efforts accept it.
|
|
27460
|
-
*/
|
|
27461
|
-
type: 'xhigh';
|
|
27462
|
-
} | {
|
|
27463
|
-
/**
|
|
27464
|
-
* Always `max`. Maximum effort level of the Managed Agents shape, above xhigh.
|
|
27465
|
-
*/
|
|
27466
|
-
type: 'max';
|
|
27467
|
-
};
|
|
27364
|
+
effort?: AgentManaged2 | AgentManaged3 | AgentManaged4 | AgentManaged5 | AgentManaged6;
|
|
27468
27365
|
/**
|
|
27469
27366
|
* Geographic region for model inference. When unset, requests fall through to the
|
|
27470
27367
|
* workspace's default_inference_geo.
|
|
@@ -27487,41 +27384,9 @@ export type ApplyAgentVersionResponses = {
|
|
|
27487
27384
|
};
|
|
27488
27385
|
};
|
|
27489
27386
|
/**
|
|
27490
|
-
*
|
|
27387
|
+
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
27491
27388
|
*/
|
|
27492
|
-
multiagent: null |
|
|
27493
|
-
/**
|
|
27494
|
-
* Agents the coordinator may spawn as session threads, each resolved to a specific
|
|
27495
|
-
* version.
|
|
27496
|
-
*/
|
|
27497
|
-
agents: Array<{
|
|
27498
|
-
/**
|
|
27499
|
-
* Agent id (agent_...). Pass it as agent when creating a session and as agent_id in agent calls.
|
|
27500
|
-
*/
|
|
27501
|
-
id: string;
|
|
27502
|
-
/**
|
|
27503
|
-
* Always `agent`. A roster member that refers to an agent by id and pinned version.
|
|
27504
|
-
*/
|
|
27505
|
-
type: 'agent';
|
|
27506
|
-
/**
|
|
27507
|
-
* The latest saved version of the agent, the editable head; it differs from active_version after a save with apply false. Starts at 1 and increments each time the agent is modified.
|
|
27508
|
-
*/
|
|
27509
|
-
version: number;
|
|
27510
|
-
} | {
|
|
27511
|
-
/**
|
|
27512
|
-
* The advisor model id.
|
|
27513
|
-
*/
|
|
27514
|
-
model: string;
|
|
27515
|
-
/**
|
|
27516
|
-
* Always `advisor`. An advisor whose model is consulted for advice in a separate thread (at most one per coordinator).
|
|
27517
|
-
*/
|
|
27518
|
-
type: 'advisor';
|
|
27519
|
-
}>;
|
|
27520
|
-
/**
|
|
27521
|
-
* Always `coordinator`. The agent coordinates the roster in agents and can delegate to its members.
|
|
27522
|
-
*/
|
|
27523
|
-
type: 'coordinator';
|
|
27524
|
-
};
|
|
27389
|
+
multiagent: null | AgentManaged39;
|
|
27525
27390
|
/**
|
|
27526
27391
|
* Display name of the agent, as set on create or update. It is a label, not a unique key.
|
|
27527
27392
|
*/
|
|
@@ -27529,33 +27394,7 @@ export type ApplyAgentVersionResponses = {
|
|
|
27529
27394
|
/**
|
|
27530
27395
|
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
27531
27396
|
*/
|
|
27532
|
-
skills: Array<
|
|
27533
|
-
/**
|
|
27534
|
-
* Id of the skill to attach.
|
|
27535
|
-
*/
|
|
27536
|
-
skill_id: string;
|
|
27537
|
-
/**
|
|
27538
|
-
* Always `anthropic`. A skill provided by Anthropic, identified by skill_id.
|
|
27539
|
-
*/
|
|
27540
|
-
type: 'anthropic';
|
|
27541
|
-
/**
|
|
27542
|
-
* Version of the skill: omit or `latest` to follow the newest version at each new session; give a version id to pin it.
|
|
27543
|
-
*/
|
|
27544
|
-
version: string;
|
|
27545
|
-
} | {
|
|
27546
|
-
/**
|
|
27547
|
-
* Id of the skill to attach.
|
|
27548
|
-
*/
|
|
27549
|
-
skill_id: string;
|
|
27550
|
-
/**
|
|
27551
|
-
* Always `custom`. A skill created by you, identified by skill_id.
|
|
27552
|
-
*/
|
|
27553
|
-
type: 'custom';
|
|
27554
|
-
/**
|
|
27555
|
-
* Version of the skill: omit or `latest` to follow the newest version at each new session; give a version id to pin it.
|
|
27556
|
-
*/
|
|
27557
|
-
version: string;
|
|
27558
|
-
}>;
|
|
27397
|
+
skills: Array<AgentManaged42 | AgentManaged43>;
|
|
27559
27398
|
/**
|
|
27560
27399
|
* System prompt given to the model at the start of every session of this agent; null when none was set.
|
|
27561
27400
|
*/
|
|
@@ -27563,445 +27402,7 @@ export type ApplyAgentVersionResponses = {
|
|
|
27563
27402
|
/**
|
|
27564
27403
|
* Tools of the agent: one agent_toolset_20260401 entry for the native tools (all resolved settings are returned, ready to send back on update), plus mcp_toolset entries and custom tool definitions. Custom calls emit agent.custom_tool_use and wait for user.custom_tool_result. Keep bash enabled to use codemode, skill and subagents.
|
|
27565
27404
|
*/
|
|
27566
|
-
tools: Array<
|
|
27567
|
-
/**
|
|
27568
|
-
* Per-tool settings that override default_config. Tools that are not listed follow default_config.
|
|
27569
|
-
*/
|
|
27570
|
-
configs: Array<{
|
|
27571
|
-
/**
|
|
27572
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
27573
|
-
*/
|
|
27574
|
-
enabled: boolean;
|
|
27575
|
-
/**
|
|
27576
|
-
* Name of the native tool this entry configures.
|
|
27577
|
-
*/
|
|
27578
|
-
name: 'bash';
|
|
27579
|
-
/**
|
|
27580
|
-
* Permission policy for tool execution.
|
|
27581
|
-
*/
|
|
27582
|
-
permission_policy: {
|
|
27583
|
-
/**
|
|
27584
|
-
* Always `always_allow`. Calls run without asking.
|
|
27585
|
-
*/
|
|
27586
|
-
type: 'always_allow';
|
|
27587
|
-
} | {
|
|
27588
|
-
/**
|
|
27589
|
-
* Always `always_ask`. Calls wait for user.tool_confirmation before running.
|
|
27590
|
-
*/
|
|
27591
|
-
type: 'always_ask';
|
|
27592
|
-
} | {
|
|
27593
|
-
/**
|
|
27594
|
-
* Always `auto`. Reserved: a server-side judgement per call. Not yet supported; sending it returns 400.
|
|
27595
|
-
*/
|
|
27596
|
-
type: 'auto';
|
|
27597
|
-
};
|
|
27598
|
-
/**
|
|
27599
|
-
* Always `bash`. Selects the bash tool, which runs shell commands in the session's machine.
|
|
27600
|
-
*/
|
|
27601
|
-
type: 'bash';
|
|
27602
|
-
} | {
|
|
27603
|
-
/**
|
|
27604
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
27605
|
-
*/
|
|
27606
|
-
enabled: boolean;
|
|
27607
|
-
/**
|
|
27608
|
-
* Name of the native tool this entry configures.
|
|
27609
|
-
*/
|
|
27610
|
-
name: 'edit';
|
|
27611
|
-
/**
|
|
27612
|
-
* Permission policy for tool execution.
|
|
27613
|
-
*/
|
|
27614
|
-
permission_policy: {
|
|
27615
|
-
/**
|
|
27616
|
-
* Always `always_allow`. Calls run without asking.
|
|
27617
|
-
*/
|
|
27618
|
-
type: 'always_allow';
|
|
27619
|
-
} | {
|
|
27620
|
-
/**
|
|
27621
|
-
* Always `always_ask`. Calls wait for user.tool_confirmation before running.
|
|
27622
|
-
*/
|
|
27623
|
-
type: 'always_ask';
|
|
27624
|
-
} | {
|
|
27625
|
-
/**
|
|
27626
|
-
* Always `auto`. Reserved: a server-side judgement per call. Not yet supported; sending it returns 400.
|
|
27627
|
-
*/
|
|
27628
|
-
type: 'auto';
|
|
27629
|
-
};
|
|
27630
|
-
/**
|
|
27631
|
-
* Always `edit`. Selects the edit tool, which changes an existing file.
|
|
27632
|
-
*/
|
|
27633
|
-
type: 'edit';
|
|
27634
|
-
} | {
|
|
27635
|
-
/**
|
|
27636
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
27637
|
-
*/
|
|
27638
|
-
enabled: boolean;
|
|
27639
|
-
/**
|
|
27640
|
-
* Name of the native tool this entry configures.
|
|
27641
|
-
*/
|
|
27642
|
-
name: 'read';
|
|
27643
|
-
/**
|
|
27644
|
-
* Permission policy for tool execution.
|
|
27645
|
-
*/
|
|
27646
|
-
permission_policy: {
|
|
27647
|
-
/**
|
|
27648
|
-
* Always `always_allow`. Calls run without asking.
|
|
27649
|
-
*/
|
|
27650
|
-
type: 'always_allow';
|
|
27651
|
-
} | {
|
|
27652
|
-
/**
|
|
27653
|
-
* Always `always_ask`. Calls wait for user.tool_confirmation before running.
|
|
27654
|
-
*/
|
|
27655
|
-
type: 'always_ask';
|
|
27656
|
-
} | {
|
|
27657
|
-
/**
|
|
27658
|
-
* Always `auto`. Reserved: a server-side judgement per call. Not yet supported; sending it returns 400.
|
|
27659
|
-
*/
|
|
27660
|
-
type: 'auto';
|
|
27661
|
-
};
|
|
27662
|
-
/**
|
|
27663
|
-
* Always `read`. Selects the read tool, which reads a file.
|
|
27664
|
-
*/
|
|
27665
|
-
type: 'read';
|
|
27666
|
-
} | {
|
|
27667
|
-
/**
|
|
27668
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
27669
|
-
*/
|
|
27670
|
-
enabled: boolean;
|
|
27671
|
-
/**
|
|
27672
|
-
* Name of the native tool this entry configures.
|
|
27673
|
-
*/
|
|
27674
|
-
name: 'write';
|
|
27675
|
-
/**
|
|
27676
|
-
* Permission policy for tool execution.
|
|
27677
|
-
*/
|
|
27678
|
-
permission_policy: {
|
|
27679
|
-
/**
|
|
27680
|
-
* Always `always_allow`. Calls run without asking.
|
|
27681
|
-
*/
|
|
27682
|
-
type: 'always_allow';
|
|
27683
|
-
} | {
|
|
27684
|
-
/**
|
|
27685
|
-
* Always `always_ask`. Calls wait for user.tool_confirmation before running.
|
|
27686
|
-
*/
|
|
27687
|
-
type: 'always_ask';
|
|
27688
|
-
} | {
|
|
27689
|
-
/**
|
|
27690
|
-
* Always `auto`. Reserved: a server-side judgement per call. Not yet supported; sending it returns 400.
|
|
27691
|
-
*/
|
|
27692
|
-
type: 'auto';
|
|
27693
|
-
};
|
|
27694
|
-
/**
|
|
27695
|
-
* Always `write`. Selects the write tool, which writes a file.
|
|
27696
|
-
*/
|
|
27697
|
-
type: 'write';
|
|
27698
|
-
} | {
|
|
27699
|
-
/**
|
|
27700
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
27701
|
-
*/
|
|
27702
|
-
enabled: boolean;
|
|
27703
|
-
/**
|
|
27704
|
-
* Name of the native tool this entry configures.
|
|
27705
|
-
*/
|
|
27706
|
-
name: 'glob';
|
|
27707
|
-
/**
|
|
27708
|
-
* Permission policy for tool execution.
|
|
27709
|
-
*/
|
|
27710
|
-
permission_policy: {
|
|
27711
|
-
/**
|
|
27712
|
-
* Always `always_allow`. Calls run without asking.
|
|
27713
|
-
*/
|
|
27714
|
-
type: 'always_allow';
|
|
27715
|
-
} | {
|
|
27716
|
-
/**
|
|
27717
|
-
* Always `always_ask`. Calls wait for user.tool_confirmation before running.
|
|
27718
|
-
*/
|
|
27719
|
-
type: 'always_ask';
|
|
27720
|
-
} | {
|
|
27721
|
-
/**
|
|
27722
|
-
* Always `auto`. Reserved: a server-side judgement per call. Not yet supported; sending it returns 400.
|
|
27723
|
-
*/
|
|
27724
|
-
type: 'auto';
|
|
27725
|
-
};
|
|
27726
|
-
/**
|
|
27727
|
-
* Always `glob`. Selects the glob tool, which finds files by name pattern.
|
|
27728
|
-
*/
|
|
27729
|
-
type: 'glob';
|
|
27730
|
-
} | {
|
|
27731
|
-
/**
|
|
27732
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
27733
|
-
*/
|
|
27734
|
-
enabled: boolean;
|
|
27735
|
-
/**
|
|
27736
|
-
* Name of the native tool this entry configures.
|
|
27737
|
-
*/
|
|
27738
|
-
name: 'grep';
|
|
27739
|
-
/**
|
|
27740
|
-
* Permission policy for tool execution.
|
|
27741
|
-
*/
|
|
27742
|
-
permission_policy: {
|
|
27743
|
-
/**
|
|
27744
|
-
* Always `always_allow`. Calls run without asking.
|
|
27745
|
-
*/
|
|
27746
|
-
type: 'always_allow';
|
|
27747
|
-
} | {
|
|
27748
|
-
/**
|
|
27749
|
-
* Always `always_ask`. Calls wait for user.tool_confirmation before running.
|
|
27750
|
-
*/
|
|
27751
|
-
type: 'always_ask';
|
|
27752
|
-
} | {
|
|
27753
|
-
/**
|
|
27754
|
-
* Always `auto`. Reserved: a server-side judgement per call. Not yet supported; sending it returns 400.
|
|
27755
|
-
*/
|
|
27756
|
-
type: 'auto';
|
|
27757
|
-
};
|
|
27758
|
-
/**
|
|
27759
|
-
* Always `grep`. Selects the grep tool, which searches file contents.
|
|
27760
|
-
*/
|
|
27761
|
-
type: 'grep';
|
|
27762
|
-
} | {
|
|
27763
|
-
/**
|
|
27764
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
27765
|
-
*/
|
|
27766
|
-
enabled: boolean;
|
|
27767
|
-
/**
|
|
27768
|
-
* Name of the native tool this entry configures.
|
|
27769
|
-
*/
|
|
27770
|
-
name: 'web_fetch';
|
|
27771
|
-
/**
|
|
27772
|
-
* Permission policy for tool execution.
|
|
27773
|
-
*/
|
|
27774
|
-
permission_policy: {
|
|
27775
|
-
/**
|
|
27776
|
-
* Always `always_allow`. Calls run without asking.
|
|
27777
|
-
*/
|
|
27778
|
-
type: 'always_allow';
|
|
27779
|
-
} | {
|
|
27780
|
-
/**
|
|
27781
|
-
* Always `always_ask`. Calls wait for user.tool_confirmation before running.
|
|
27782
|
-
*/
|
|
27783
|
-
type: 'always_ask';
|
|
27784
|
-
} | {
|
|
27785
|
-
/**
|
|
27786
|
-
* Always `auto`. Reserved: a server-side judgement per call. Not yet supported; sending it returns 400.
|
|
27787
|
-
*/
|
|
27788
|
-
type: 'auto';
|
|
27789
|
-
};
|
|
27790
|
-
/**
|
|
27791
|
-
* Always `web_fetch`. Selects the web_fetch tool, which fetches a web page.
|
|
27792
|
-
*/
|
|
27793
|
-
type: 'web_fetch';
|
|
27794
|
-
/**
|
|
27795
|
-
* Hosts the tool may fetch or search, as plain hostnames (no scheme, port or path); a listed domain also covers its subdomains. At most 64 entries, and it cannot be combined with blocked_domains.
|
|
27796
|
-
*/
|
|
27797
|
-
allowed_domains?: Array<string>;
|
|
27798
|
-
/**
|
|
27799
|
-
* Hosts the tool must never fetch or search, as plain hostnames (no scheme, port or path); a listed domain also covers its subdomains. At most 64 entries, and it cannot be combined with allowed_domains.
|
|
27800
|
-
*/
|
|
27801
|
-
blocked_domains?: Array<string>;
|
|
27802
|
-
/**
|
|
27803
|
-
* Maximum number of tokens of fetched text content included in context per call; does not apply to binary content such as PDFs. Null for no explicit limit.
|
|
27804
|
-
*/
|
|
27805
|
-
max_content_tokens?: null | number;
|
|
27806
|
-
} | {
|
|
27807
|
-
/**
|
|
27808
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
27809
|
-
*/
|
|
27810
|
-
enabled: boolean;
|
|
27811
|
-
/**
|
|
27812
|
-
* Name of the native tool this entry configures.
|
|
27813
|
-
*/
|
|
27814
|
-
name: 'web_search';
|
|
27815
|
-
/**
|
|
27816
|
-
* Permission policy for tool execution.
|
|
27817
|
-
*/
|
|
27818
|
-
permission_policy: {
|
|
27819
|
-
/**
|
|
27820
|
-
* Always `always_allow`. Calls run without asking.
|
|
27821
|
-
*/
|
|
27822
|
-
type: 'always_allow';
|
|
27823
|
-
} | {
|
|
27824
|
-
/**
|
|
27825
|
-
* Always `always_ask`. Calls wait for user.tool_confirmation before running.
|
|
27826
|
-
*/
|
|
27827
|
-
type: 'always_ask';
|
|
27828
|
-
} | {
|
|
27829
|
-
/**
|
|
27830
|
-
* Always `auto`. Reserved: a server-side judgement per call. Not yet supported; sending it returns 400.
|
|
27831
|
-
*/
|
|
27832
|
-
type: 'auto';
|
|
27833
|
-
};
|
|
27834
|
-
/**
|
|
27835
|
-
* Always `web_search`. Selects the web_search tool, which searches the web.
|
|
27836
|
-
*/
|
|
27837
|
-
type: 'web_search';
|
|
27838
|
-
/**
|
|
27839
|
-
* Hosts the tool may fetch or search, as plain hostnames (no scheme, port or path); a listed domain also covers its subdomains. At most 64 entries, and it cannot be combined with blocked_domains.
|
|
27840
|
-
*/
|
|
27841
|
-
allowed_domains?: Array<string>;
|
|
27842
|
-
/**
|
|
27843
|
-
* Hosts the tool must never fetch or search, as plain hostnames (no scheme, port or path); a listed domain also covers its subdomains. At most 64 entries, and it cannot be combined with allowed_domains.
|
|
27844
|
-
*/
|
|
27845
|
-
blocked_domains?: Array<string>;
|
|
27846
|
-
/**
|
|
27847
|
-
* Approximate user location for search result localization.
|
|
27848
|
-
*/
|
|
27849
|
-
user_location?: null | {
|
|
27850
|
-
/**
|
|
27851
|
-
* Location precision. Only "approximate" is supported.
|
|
27852
|
-
*/
|
|
27853
|
-
type: 'approximate';
|
|
27854
|
-
/**
|
|
27855
|
-
* City name.
|
|
27856
|
-
*/
|
|
27857
|
-
city?: null | string;
|
|
27858
|
-
/**
|
|
27859
|
-
* Two-letter ISO 3166-1 country code, uppercase.
|
|
27860
|
-
*/
|
|
27861
|
-
country?: null | string;
|
|
27862
|
-
/**
|
|
27863
|
-
* Region or state name.
|
|
27864
|
-
*/
|
|
27865
|
-
region?: null | string;
|
|
27866
|
-
/**
|
|
27867
|
-
* IANA timezone identifier, e.g. "America/Los_Angeles".
|
|
27868
|
-
*/
|
|
27869
|
-
timezone?: null | string;
|
|
27870
|
-
};
|
|
27871
|
-
} | {
|
|
27872
|
-
/**
|
|
27873
|
-
* Name of the native tool this entry configures.
|
|
27874
|
-
*/
|
|
27875
|
-
name: 'task_output' | 'task_stop' | 'monitor' | 'agent' | 'send_message' | 'codemode' | 'skill';
|
|
27876
|
-
/**
|
|
27877
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
27878
|
-
*/
|
|
27879
|
-
enabled: boolean;
|
|
27880
|
-
/**
|
|
27881
|
-
* Whether a call to this tool runs automatically (always_allow) or waits for user.tool_confirmation (always_ask). Omitted means the toolset default.
|
|
27882
|
-
*/
|
|
27883
|
-
permission_policy: {
|
|
27884
|
-
/**
|
|
27885
|
-
* Permission policy kind.
|
|
27886
|
-
*/
|
|
27887
|
-
type: 'always_allow' | 'always_ask';
|
|
27888
|
-
};
|
|
27889
|
-
}>;
|
|
27890
|
-
/**
|
|
27891
|
-
* Resolved default configuration for agent tools.
|
|
27892
|
-
*/
|
|
27893
|
-
default_config: {
|
|
27894
|
-
/**
|
|
27895
|
-
* Whether tools of the toolset are offered to the model when configs does not name them. Null or omitted means enabled.
|
|
27896
|
-
*/
|
|
27897
|
-
enabled: boolean;
|
|
27898
|
-
/**
|
|
27899
|
-
* Permission policy for tool execution.
|
|
27900
|
-
*/
|
|
27901
|
-
permission_policy: {
|
|
27902
|
-
/**
|
|
27903
|
-
* Always `always_allow`. Calls run without asking.
|
|
27904
|
-
*/
|
|
27905
|
-
type: 'always_allow';
|
|
27906
|
-
} | {
|
|
27907
|
-
/**
|
|
27908
|
-
* Always `always_ask`. Calls wait for user.tool_confirmation before running.
|
|
27909
|
-
*/
|
|
27910
|
-
type: 'always_ask';
|
|
27911
|
-
} | {
|
|
27912
|
-
/**
|
|
27913
|
-
* Always `auto`. Reserved: a server-side judgement per call. Not yet supported; sending it returns 400.
|
|
27914
|
-
*/
|
|
27915
|
-
type: 'auto';
|
|
27916
|
-
};
|
|
27917
|
-
};
|
|
27918
|
-
/**
|
|
27919
|
-
* Always `agent_toolset_20260401`. The native toolset entry (bash, edit, glob, grep, read, write, web_search, web_fetch, task_output, task_stop, monitor, agent, send_message).
|
|
27920
|
-
*/
|
|
27921
|
-
type: 'agent_toolset_20260401';
|
|
27922
|
-
} | {
|
|
27923
|
-
/**
|
|
27924
|
-
* Always `mcp_toolset`. An entry that exposes the tools of one MCP server from mcp_servers.
|
|
27925
|
-
*/
|
|
27926
|
-
type: 'mcp_toolset';
|
|
27927
|
-
/**
|
|
27928
|
-
* Name of the MCP server in mcp_servers whose tools this entry exposes.
|
|
27929
|
-
*/
|
|
27930
|
-
mcp_server_name: string;
|
|
27931
|
-
/**
|
|
27932
|
-
* Settings applied to every tool of this toolset that configs does not name. When omitted, tools are enabled with the always_allow policy.
|
|
27933
|
-
*/
|
|
27934
|
-
default_config?: {
|
|
27935
|
-
/**
|
|
27936
|
-
* Whether tools of the toolset are offered to the model when configs does not name them. Null or omitted means enabled.
|
|
27937
|
-
*/
|
|
27938
|
-
enabled?: boolean | null;
|
|
27939
|
-
/**
|
|
27940
|
-
* Permission policy for tools that configs does not name: always_allow runs calls automatically, always_ask waits for user.tool_confirmation.
|
|
27941
|
-
*/
|
|
27942
|
-
permission_policy?: null | {
|
|
27943
|
-
/**
|
|
27944
|
-
* Permission policy kind.
|
|
27945
|
-
*/
|
|
27946
|
-
type: 'always_allow' | 'always_ask';
|
|
27947
|
-
};
|
|
27948
|
-
} | null;
|
|
27949
|
-
/**
|
|
27950
|
-
* Per-tool settings that override default_config. Tools that are not listed follow default_config.
|
|
27951
|
-
*/
|
|
27952
|
-
configs?: Array<{
|
|
27953
|
-
/**
|
|
27954
|
-
* Bare tool name reported by the MCP server.
|
|
27955
|
-
*/
|
|
27956
|
-
name: string;
|
|
27957
|
-
/**
|
|
27958
|
-
* Whether the tool is offered to the model. Null or omitted means the toolset default applies (enabled unless default_config says otherwise).
|
|
27959
|
-
*/
|
|
27960
|
-
enabled?: boolean | null;
|
|
27961
|
-
/**
|
|
27962
|
-
* Whether a call to this tool runs automatically (always_allow) or waits for user.tool_confirmation (always_ask). Omitted means the toolset default.
|
|
27963
|
-
*/
|
|
27964
|
-
permission_policy?: null | {
|
|
27965
|
-
/**
|
|
27966
|
-
* Permission policy kind.
|
|
27967
|
-
*/
|
|
27968
|
-
type: 'always_allow' | 'always_ask';
|
|
27969
|
-
};
|
|
27970
|
-
}> | null;
|
|
27971
|
-
} | {
|
|
27972
|
-
/**
|
|
27973
|
-
* What the custom tool does and when the model should call it.
|
|
27974
|
-
*/
|
|
27975
|
-
description: string;
|
|
27976
|
-
/**
|
|
27977
|
-
* JSON Schema for custom tool input parameters.
|
|
27978
|
-
*/
|
|
27979
|
-
input_schema: {
|
|
27980
|
-
/**
|
|
27981
|
-
* Always `object`. The input is a JSON object.
|
|
27982
|
-
*/
|
|
27983
|
-
type: 'object';
|
|
27984
|
-
/**
|
|
27985
|
-
* JSON Schema of each input property, keyed by property name.
|
|
27986
|
-
*/
|
|
27987
|
-
properties?: null | {
|
|
27988
|
-
[key: string]: unknown;
|
|
27989
|
-
};
|
|
27990
|
-
/**
|
|
27991
|
-
* Names of the input properties the model must supply.
|
|
27992
|
-
*/
|
|
27993
|
-
required?: null | Array<string>;
|
|
27994
|
-
[key: string]: unknown;
|
|
27995
|
-
};
|
|
27996
|
-
/**
|
|
27997
|
-
* Name of the custom tool, as the model sees and calls it.
|
|
27998
|
-
*/
|
|
27999
|
-
name: string;
|
|
28000
|
-
/**
|
|
28001
|
-
* Always `custom`. A custom tool defined by name, description and input_schema; its calls are answered by the client with user.custom_tool_result.
|
|
28002
|
-
*/
|
|
28003
|
-
type: 'custom';
|
|
28004
|
-
}>;
|
|
27405
|
+
tools: Array<AgentManaged44 | AgentManaged54 | AgentManaged57>;
|
|
28005
27406
|
/**
|
|
28006
27407
|
* Always `agent`. An agent definition.
|
|
28007
27408
|
*/
|
|
@@ -28011,12 +27412,15 @@ export type ApplyAgentVersionResponses = {
|
|
|
28011
27412
|
*/
|
|
28012
27413
|
updated_at: string;
|
|
28013
27414
|
/**
|
|
28014
|
-
*
|
|
28015
|
-
* modified.
|
|
27415
|
+
* Version of this returned configuration. Default retrieve returns the effective version; an explicit version query or a version-history item returns that saved version.
|
|
28016
27416
|
*/
|
|
28017
27417
|
version: number;
|
|
28018
27418
|
/**
|
|
28019
|
-
*
|
|
27419
|
+
* Newest saved version number, including an unapplied save. Returned by default retrieve, update and apply; use it for optimistic concurrency when updating.
|
|
27420
|
+
*/
|
|
27421
|
+
latest_version?: number;
|
|
27422
|
+
/**
|
|
27423
|
+
* Agent-level currently effective version used by new sessions and newly issued embed tokens. This same value appears on every history item; it is not that item's version. Saving with apply false leaves it unchanged. Existing sessions and tokens retain their version.
|
|
28020
27424
|
*/
|
|
28021
27425
|
active_version: number;
|
|
28022
27426
|
/**
|
|
@@ -29787,557 +29191,6 @@ export type SetRunFeedbackResponses = {
|
|
|
29787
29191
|
};
|
|
29788
29192
|
};
|
|
29789
29193
|
export type SetRunFeedbackResponse = SetRunFeedbackResponses[keyof SetRunFeedbackResponses];
|
|
29790
|
-
export type ListEndUsersData = {
|
|
29791
|
-
body?: never;
|
|
29792
|
-
path: {
|
|
29793
|
-
/**
|
|
29794
|
-
* Active service agent identifier from agent creation or listing.
|
|
29795
|
-
*/
|
|
29796
|
-
agent_id: string;
|
|
29797
|
-
};
|
|
29798
|
-
query?: {
|
|
29799
|
-
/**
|
|
29800
|
-
* Maximum users per page; defaults to 20.
|
|
29801
|
-
*/
|
|
29802
|
-
limit?: number;
|
|
29803
|
-
/**
|
|
29804
|
-
* next_page from the previous response with the same agent, q and limit.
|
|
29805
|
-
*/
|
|
29806
|
-
page?: string;
|
|
29807
|
-
/**
|
|
29808
|
-
* Case-sensitive literal prefix of external_user_id; omit or use an empty string for all users.
|
|
29809
|
-
*/
|
|
29810
|
-
q?: string;
|
|
29811
|
-
};
|
|
29812
|
-
url: '/agent/v1/agents/{agent_id}/end_users';
|
|
29813
|
-
};
|
|
29814
|
-
export type ListEndUsersErrors = {
|
|
29815
|
-
/**
|
|
29816
|
-
* Invalid identifier, prefix, limit, cursor or blocklist size; correct the reported input.
|
|
29817
|
-
*/
|
|
29818
|
-
400: unknown;
|
|
29819
|
-
/**
|
|
29820
|
-
* Authenticate with a host credential.
|
|
29821
|
-
*/
|
|
29822
|
-
401: unknown;
|
|
29823
|
-
/**
|
|
29824
|
-
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
29825
|
-
*/
|
|
29826
|
-
403: AgentError;
|
|
29827
|
-
/**
|
|
29828
|
-
* Agent or requested user is unavailable to this caller, or the caller is an end user.
|
|
29829
|
-
*/
|
|
29830
|
-
404: unknown;
|
|
29831
|
-
};
|
|
29832
|
-
export type ListEndUsersError = ListEndUsersErrors[keyof ListEndUsersErrors];
|
|
29833
|
-
export type ListEndUsersResponses = {
|
|
29834
|
-
/**
|
|
29835
|
-
* Matching users and next page cursor.
|
|
29836
|
-
*/
|
|
29837
|
-
200: {
|
|
29838
|
-
/**
|
|
29839
|
-
* Items of this page, in the order requested by the call.
|
|
29840
|
-
*/
|
|
29841
|
-
data: Array<{
|
|
29842
|
-
/**
|
|
29843
|
-
* Host application's user identifier, scoped to this organization and agent.
|
|
29844
|
-
*/
|
|
29845
|
-
external_user_id: string;
|
|
29846
|
-
/**
|
|
29847
|
-
* Earliest session creation or token issuance time; null for a preemptively blocked user with no history.
|
|
29848
|
-
*/
|
|
29849
|
-
first_seen_at: string | null;
|
|
29850
|
-
/**
|
|
29851
|
-
* Latest session update or token issuance time; null when there is no history.
|
|
29852
|
-
*/
|
|
29853
|
-
last_active_at: string | null;
|
|
29854
|
-
/**
|
|
29855
|
-
* Total sessions for this end user on this agent.
|
|
29856
|
-
*/
|
|
29857
|
-
session_count: number;
|
|
29858
|
-
/**
|
|
29859
|
-
* Accumulated recorded cost of this customer's sessions on this agent: model usage (threads included) plus session runtime; amount "0.000000" when nothing has been recorded.
|
|
29860
|
-
*/
|
|
29861
|
-
cost: {
|
|
29862
|
-
/**
|
|
29863
|
-
* Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
|
|
29864
|
-
*/
|
|
29865
|
-
amount: string;
|
|
29866
|
-
/**
|
|
29867
|
-
* Always USD.
|
|
29868
|
-
*/
|
|
29869
|
-
currency: 'USD';
|
|
29870
|
-
};
|
|
29871
|
-
/**
|
|
29872
|
-
* Whether the embed policy currently prevents this user from receiving tokens and creating sessions.
|
|
29873
|
-
*/
|
|
29874
|
-
blocked: boolean;
|
|
29875
|
-
}>;
|
|
29876
|
-
/**
|
|
29877
|
-
* Cursor for the same agent, q and limit; null when exhausted.
|
|
29878
|
-
*/
|
|
29879
|
-
next_page: string | null;
|
|
29880
|
-
};
|
|
29881
|
-
};
|
|
29882
|
-
export type ListEndUsersResponse = ListEndUsersResponses[keyof ListEndUsersResponses];
|
|
29883
|
-
export type DeleteEndUserData = {
|
|
29884
|
-
body?: never;
|
|
29885
|
-
path: {
|
|
29886
|
-
/**
|
|
29887
|
-
* Active service agent identifier from agent creation or listing.
|
|
29888
|
-
*/
|
|
29889
|
-
agent_id: string;
|
|
29890
|
-
/**
|
|
29891
|
-
* Host user identifier supplied at issuance or from end-user listing.
|
|
29892
|
-
*/
|
|
29893
|
-
external_user_id: string;
|
|
29894
|
-
};
|
|
29895
|
-
query: {
|
|
29896
|
-
/**
|
|
29897
|
-
* Must exactly equal the external_user_id path parameter to confirm destructive deletion.
|
|
29898
|
-
*/
|
|
29899
|
-
confirm: string;
|
|
29900
|
-
};
|
|
29901
|
-
url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}';
|
|
29902
|
-
};
|
|
29903
|
-
export type DeleteEndUserErrors = {
|
|
29904
|
-
/**
|
|
29905
|
-
* Invalid identifier, prefix, limit, cursor or blocklist size; correct the reported input.
|
|
29906
|
-
*/
|
|
29907
|
-
400: unknown;
|
|
29908
|
-
/**
|
|
29909
|
-
* Authenticate with a host credential.
|
|
29910
|
-
*/
|
|
29911
|
-
401: unknown;
|
|
29912
|
-
/**
|
|
29913
|
-
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
29914
|
-
*/
|
|
29915
|
-
403: AgentError;
|
|
29916
|
-
/**
|
|
29917
|
-
* Agent or requested user is unavailable to this caller, or the caller is an end user.
|
|
29918
|
-
*/
|
|
29919
|
-
404: unknown;
|
|
29920
|
-
};
|
|
29921
|
-
export type DeleteEndUserError = DeleteEndUserErrors[keyof DeleteEndUserErrors];
|
|
29922
|
-
export type DeleteEndUserResponses = {
|
|
29923
|
-
/**
|
|
29924
|
-
* Deletion accepted; poll the deletion endpoint until done or failed.
|
|
29925
|
-
*/
|
|
29926
|
-
202: {
|
|
29927
|
-
/**
|
|
29928
|
-
* Deletion task identifier.
|
|
29929
|
-
*/
|
|
29930
|
-
id: string;
|
|
29931
|
-
/**
|
|
29932
|
-
* Accepted for asynchronous processing; poll deletion for progress.
|
|
29933
|
-
*/
|
|
29934
|
-
status: 'pending';
|
|
29935
|
-
};
|
|
29936
|
-
};
|
|
29937
|
-
export type DeleteEndUserResponse = DeleteEndUserResponses[keyof DeleteEndUserResponses];
|
|
29938
|
-
export type GetEndUserData = {
|
|
29939
|
-
body?: never;
|
|
29940
|
-
path: {
|
|
29941
|
-
/**
|
|
29942
|
-
* Active service agent identifier from agent creation or listing.
|
|
29943
|
-
*/
|
|
29944
|
-
agent_id: string;
|
|
29945
|
-
/**
|
|
29946
|
-
* Host user identifier supplied at issuance or from end-user listing.
|
|
29947
|
-
*/
|
|
29948
|
-
external_user_id: string;
|
|
29949
|
-
};
|
|
29950
|
-
query?: never;
|
|
29951
|
-
url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}';
|
|
29952
|
-
};
|
|
29953
|
-
export type GetEndUserErrors = {
|
|
29954
|
-
/**
|
|
29955
|
-
* Invalid identifier, prefix, limit, cursor or blocklist size; correct the reported input.
|
|
29956
|
-
*/
|
|
29957
|
-
400: unknown;
|
|
29958
|
-
/**
|
|
29959
|
-
* Authenticate with a host credential.
|
|
29960
|
-
*/
|
|
29961
|
-
401: unknown;
|
|
29962
|
-
/**
|
|
29963
|
-
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
29964
|
-
*/
|
|
29965
|
-
403: AgentError;
|
|
29966
|
-
/**
|
|
29967
|
-
* Agent or requested user is unavailable to this caller, or the caller is an end user.
|
|
29968
|
-
*/
|
|
29969
|
-
404: unknown;
|
|
29970
|
-
};
|
|
29971
|
-
export type GetEndUserError = GetEndUserErrors[keyof GetEndUserErrors];
|
|
29972
|
-
export type GetEndUserResponses = {
|
|
29973
|
-
/**
|
|
29974
|
-
* Current end-user view.
|
|
29975
|
-
*/
|
|
29976
|
-
200: {
|
|
29977
|
-
/**
|
|
29978
|
-
* Host application's user identifier, scoped to this organization and agent.
|
|
29979
|
-
*/
|
|
29980
|
-
external_user_id: string;
|
|
29981
|
-
/**
|
|
29982
|
-
* Earliest session creation or token issuance time; null for a preemptively blocked user with no history.
|
|
29983
|
-
*/
|
|
29984
|
-
first_seen_at: string | null;
|
|
29985
|
-
/**
|
|
29986
|
-
* Latest session update or token issuance time; null when there is no history.
|
|
29987
|
-
*/
|
|
29988
|
-
last_active_at: string | null;
|
|
29989
|
-
/**
|
|
29990
|
-
* Total sessions for this end user on this agent.
|
|
29991
|
-
*/
|
|
29992
|
-
session_count: number;
|
|
29993
|
-
/**
|
|
29994
|
-
* Accumulated recorded cost of this customer's sessions on this agent: model usage (threads included) plus session runtime; amount "0.000000" when nothing has been recorded.
|
|
29995
|
-
*/
|
|
29996
|
-
cost: {
|
|
29997
|
-
/**
|
|
29998
|
-
* Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
|
|
29999
|
-
*/
|
|
30000
|
-
amount: string;
|
|
30001
|
-
/**
|
|
30002
|
-
* Always USD.
|
|
30003
|
-
*/
|
|
30004
|
-
currency: 'USD';
|
|
30005
|
-
};
|
|
30006
|
-
/**
|
|
30007
|
-
* Whether the embed policy currently prevents this user from receiving tokens and creating sessions.
|
|
30008
|
-
*/
|
|
30009
|
-
blocked: boolean;
|
|
30010
|
-
/**
|
|
30011
|
-
* Up to twenty sessions, ordered by most recent update first.
|
|
30012
|
-
*/
|
|
30013
|
-
recent_sessions: Array<{
|
|
30014
|
-
/**
|
|
30015
|
-
* Public sesn_ session identifier, usable with session retrieval.
|
|
30016
|
-
*/
|
|
30017
|
-
id: string;
|
|
30018
|
-
/**
|
|
30019
|
-
* Session title, or null when unset.
|
|
30020
|
-
*/
|
|
30021
|
-
title: string | null;
|
|
30022
|
-
/**
|
|
30023
|
-
* Session entry surface, or null when no surface was recorded.
|
|
30024
|
-
*/
|
|
30025
|
-
source: string | null;
|
|
30026
|
-
/**
|
|
30027
|
-
* Session creation time in UTC.
|
|
30028
|
-
*/
|
|
30029
|
-
created_at: string;
|
|
30030
|
-
/**
|
|
30031
|
-
* Most recent session update time in UTC.
|
|
30032
|
-
*/
|
|
30033
|
-
updated_at: string;
|
|
30034
|
-
}>;
|
|
30035
|
-
};
|
|
30036
|
-
};
|
|
30037
|
-
export type GetEndUserResponse = GetEndUserResponses[keyof GetEndUserResponses];
|
|
30038
|
-
export type GetEndUserDeletionData = {
|
|
30039
|
-
body?: never;
|
|
30040
|
-
path: {
|
|
30041
|
-
/**
|
|
30042
|
-
* Active service agent identifier from agent creation or listing.
|
|
30043
|
-
*/
|
|
30044
|
-
agent_id: string;
|
|
30045
|
-
/**
|
|
30046
|
-
* Host user identifier supplied at issuance or from end-user listing.
|
|
30047
|
-
*/
|
|
30048
|
-
external_user_id: string;
|
|
30049
|
-
};
|
|
30050
|
-
query?: never;
|
|
30051
|
-
url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}/deletion';
|
|
30052
|
-
};
|
|
30053
|
-
export type GetEndUserDeletionErrors = {
|
|
30054
|
-
/**
|
|
30055
|
-
* Invalid identifier, prefix, limit, cursor or blocklist size; correct the reported input.
|
|
30056
|
-
*/
|
|
30057
|
-
400: unknown;
|
|
30058
|
-
/**
|
|
30059
|
-
* Authenticate with a host credential.
|
|
30060
|
-
*/
|
|
30061
|
-
401: unknown;
|
|
30062
|
-
/**
|
|
30063
|
-
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30064
|
-
*/
|
|
30065
|
-
403: AgentError;
|
|
30066
|
-
/**
|
|
30067
|
-
* Agent or requested user is unavailable to this caller, or the caller is an end user.
|
|
30068
|
-
*/
|
|
30069
|
-
404: unknown;
|
|
30070
|
-
};
|
|
30071
|
-
export type GetEndUserDeletionError = GetEndUserDeletionErrors[keyof GetEndUserDeletionErrors];
|
|
30072
|
-
export type GetEndUserDeletionResponses = {
|
|
30073
|
-
/**
|
|
30074
|
-
* Latest deletion task and snapshot counts.
|
|
30075
|
-
*/
|
|
30076
|
-
200: {
|
|
30077
|
-
/**
|
|
30078
|
-
* Deletion task identifier.
|
|
30079
|
-
*/
|
|
30080
|
-
id: string;
|
|
30081
|
-
/**
|
|
30082
|
-
* pending: accepted; snapshotting: exporting recovery data; deleting: verified snapshot exists and erasure is running; done: erasure completed; failed: stopped safely, retry DELETE to resume the same task.
|
|
30083
|
-
*/
|
|
30084
|
-
status: 'pending' | 'snapshotting' | 'deleting' | 'done' | 'failed';
|
|
30085
|
-
/**
|
|
30086
|
-
* Counts from the verified snapshot; empty until snapshotting completes.
|
|
30087
|
-
*/
|
|
30088
|
-
counts: {
|
|
30089
|
-
/**
|
|
30090
|
-
* Number of primary and child sessions in the snapshot.
|
|
30091
|
-
*/
|
|
30092
|
-
sessions?: number;
|
|
30093
|
-
/**
|
|
30094
|
-
* Number of durable session events captured without changing the history.
|
|
30095
|
-
*/
|
|
30096
|
-
events?: number;
|
|
30097
|
-
/**
|
|
30098
|
-
* Number of stored transcript messages in the snapshot.
|
|
30099
|
-
*/
|
|
30100
|
-
messages?: number;
|
|
30101
|
-
/**
|
|
30102
|
-
* Number of backed-up directory, authorization, feedback and projection rows.
|
|
30103
|
-
*/
|
|
30104
|
-
d1_rows?: number;
|
|
30105
|
-
/**
|
|
30106
|
-
* Number of session attachment references; their file bytes are retained.
|
|
30107
|
-
*/
|
|
30108
|
-
attachments?: number;
|
|
30109
|
-
};
|
|
30110
|
-
/**
|
|
30111
|
-
* Operator recovery snapshot key, retained for seven days. Attachment bytes are not copied or deleted.
|
|
30112
|
-
*/
|
|
30113
|
-
snapshot_key?: string;
|
|
30114
|
-
/**
|
|
30115
|
-
* Content-free failure summary; retry the confirmed deletion to resume.
|
|
30116
|
-
*/
|
|
30117
|
-
error?: string;
|
|
30118
|
-
/**
|
|
30119
|
-
* Task creation time in RFC 3339 format.
|
|
30120
|
-
*/
|
|
30121
|
-
created_at: string;
|
|
30122
|
-
/**
|
|
30123
|
-
* Latest task update time in RFC 3339 format.
|
|
30124
|
-
*/
|
|
30125
|
-
updated_at: string;
|
|
30126
|
-
};
|
|
30127
|
-
};
|
|
30128
|
-
export type GetEndUserDeletionResponse = GetEndUserDeletionResponses[keyof GetEndUserDeletionResponses];
|
|
30129
|
-
export type RevokeEndUserTokensData = {
|
|
30130
|
-
body?: never;
|
|
30131
|
-
path: {
|
|
30132
|
-
/**
|
|
30133
|
-
* Active service agent identifier from agent creation or listing.
|
|
30134
|
-
*/
|
|
30135
|
-
agent_id: string;
|
|
30136
|
-
/**
|
|
30137
|
-
* Host user identifier supplied at issuance or from end-user listing.
|
|
30138
|
-
*/
|
|
30139
|
-
external_user_id: string;
|
|
30140
|
-
};
|
|
30141
|
-
query?: never;
|
|
30142
|
-
url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}/revoke_tokens';
|
|
30143
|
-
};
|
|
30144
|
-
export type RevokeEndUserTokensErrors = {
|
|
30145
|
-
/**
|
|
30146
|
-
* Invalid identifier, prefix, limit, cursor or blocklist size; correct the reported input.
|
|
30147
|
-
*/
|
|
30148
|
-
400: unknown;
|
|
30149
|
-
/**
|
|
30150
|
-
* Authenticate with a host credential.
|
|
30151
|
-
*/
|
|
30152
|
-
401: unknown;
|
|
30153
|
-
/**
|
|
30154
|
-
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30155
|
-
*/
|
|
30156
|
-
403: AgentError;
|
|
30157
|
-
/**
|
|
30158
|
-
* Agent or requested user is unavailable to this caller, or the caller is an end user.
|
|
30159
|
-
*/
|
|
30160
|
-
404: unknown;
|
|
30161
|
-
/**
|
|
30162
|
-
* Credential revocation failed; grant timestamps remain unchanged. A requested block remains in effect; retry to finish revocation.
|
|
30163
|
-
*/
|
|
30164
|
-
502: unknown;
|
|
30165
|
-
};
|
|
30166
|
-
export type RevokeEndUserTokensError = RevokeEndUserTokensErrors[keyof RevokeEndUserTokensErrors];
|
|
30167
|
-
export type RevokeEndUserTokensResponses = {
|
|
30168
|
-
/**
|
|
30169
|
-
* Number of newly revoked grants.
|
|
30170
|
-
*/
|
|
30171
|
-
200: {
|
|
30172
|
-
/**
|
|
30173
|
-
* Number of previously unrevoked grants marked revoked by this request.
|
|
30174
|
-
*/
|
|
30175
|
-
revoked: number;
|
|
30176
|
-
};
|
|
30177
|
-
};
|
|
30178
|
-
export type RevokeEndUserTokensResponse = RevokeEndUserTokensResponses[keyof RevokeEndUserTokensResponses];
|
|
30179
|
-
export type BlockEndUserData = {
|
|
30180
|
-
body?: never;
|
|
30181
|
-
path: {
|
|
30182
|
-
/**
|
|
30183
|
-
* Active service agent identifier from agent creation or listing.
|
|
30184
|
-
*/
|
|
30185
|
-
agent_id: string;
|
|
30186
|
-
/**
|
|
30187
|
-
* Host user identifier supplied at issuance or from end-user listing.
|
|
30188
|
-
*/
|
|
30189
|
-
external_user_id: string;
|
|
30190
|
-
};
|
|
30191
|
-
query?: never;
|
|
30192
|
-
url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}/block';
|
|
30193
|
-
};
|
|
30194
|
-
export type BlockEndUserErrors = {
|
|
30195
|
-
/**
|
|
30196
|
-
* Invalid identifier, prefix, limit, cursor or blocklist size; correct the reported input.
|
|
30197
|
-
*/
|
|
30198
|
-
400: unknown;
|
|
30199
|
-
/**
|
|
30200
|
-
* Authenticate with a host credential.
|
|
30201
|
-
*/
|
|
30202
|
-
401: unknown;
|
|
30203
|
-
/**
|
|
30204
|
-
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30205
|
-
*/
|
|
30206
|
-
403: AgentError;
|
|
30207
|
-
/**
|
|
30208
|
-
* Agent or requested user is unavailable to this caller, or the caller is an end user.
|
|
30209
|
-
*/
|
|
30210
|
-
404: unknown;
|
|
30211
|
-
/**
|
|
30212
|
-
* Configure an embed policy before blocking or unblocking; retry if a concurrent policy update caused the conflict.
|
|
30213
|
-
*/
|
|
30214
|
-
409: unknown;
|
|
30215
|
-
/**
|
|
30216
|
-
* Credential revocation failed; grant timestamps remain unchanged. A requested block remains in effect; retry to finish revocation.
|
|
30217
|
-
*/
|
|
30218
|
-
502: unknown;
|
|
30219
|
-
};
|
|
30220
|
-
export type BlockEndUserError = BlockEndUserErrors[keyof BlockEndUserErrors];
|
|
30221
|
-
export type BlockEndUserResponses = {
|
|
30222
|
-
/**
|
|
30223
|
-
* Current end-user view.
|
|
30224
|
-
*/
|
|
30225
|
-
200: {
|
|
30226
|
-
/**
|
|
30227
|
-
* Host application's user identifier, scoped to this organization and agent.
|
|
30228
|
-
*/
|
|
30229
|
-
external_user_id: string;
|
|
30230
|
-
/**
|
|
30231
|
-
* Earliest session creation or token issuance time; null for a preemptively blocked user with no history.
|
|
30232
|
-
*/
|
|
30233
|
-
first_seen_at: string | null;
|
|
30234
|
-
/**
|
|
30235
|
-
* Latest session update or token issuance time; null when there is no history.
|
|
30236
|
-
*/
|
|
30237
|
-
last_active_at: string | null;
|
|
30238
|
-
/**
|
|
30239
|
-
* Total sessions for this end user on this agent.
|
|
30240
|
-
*/
|
|
30241
|
-
session_count: number;
|
|
30242
|
-
/**
|
|
30243
|
-
* Accumulated recorded cost of this customer's sessions on this agent: model usage (threads included) plus session runtime; amount "0.000000" when nothing has been recorded.
|
|
30244
|
-
*/
|
|
30245
|
-
cost: {
|
|
30246
|
-
/**
|
|
30247
|
-
* Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
|
|
30248
|
-
*/
|
|
30249
|
-
amount: string;
|
|
30250
|
-
/**
|
|
30251
|
-
* Always USD.
|
|
30252
|
-
*/
|
|
30253
|
-
currency: 'USD';
|
|
30254
|
-
};
|
|
30255
|
-
/**
|
|
30256
|
-
* Whether the embed policy currently prevents this user from receiving tokens and creating sessions.
|
|
30257
|
-
*/
|
|
30258
|
-
blocked: boolean;
|
|
30259
|
-
};
|
|
30260
|
-
};
|
|
30261
|
-
export type BlockEndUserResponse = BlockEndUserResponses[keyof BlockEndUserResponses];
|
|
30262
|
-
export type UnblockEndUserData = {
|
|
30263
|
-
body?: never;
|
|
30264
|
-
path: {
|
|
30265
|
-
/**
|
|
30266
|
-
* Active service agent identifier from agent creation or listing.
|
|
30267
|
-
*/
|
|
30268
|
-
agent_id: string;
|
|
30269
|
-
/**
|
|
30270
|
-
* Host user identifier supplied at issuance or from end-user listing.
|
|
30271
|
-
*/
|
|
30272
|
-
external_user_id: string;
|
|
30273
|
-
};
|
|
30274
|
-
query?: never;
|
|
30275
|
-
url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}/unblock';
|
|
30276
|
-
};
|
|
30277
|
-
export type UnblockEndUserErrors = {
|
|
30278
|
-
/**
|
|
30279
|
-
* Invalid identifier, prefix, limit, cursor or blocklist size; correct the reported input.
|
|
30280
|
-
*/
|
|
30281
|
-
400: unknown;
|
|
30282
|
-
/**
|
|
30283
|
-
* Authenticate with a host credential.
|
|
30284
|
-
*/
|
|
30285
|
-
401: unknown;
|
|
30286
|
-
/**
|
|
30287
|
-
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30288
|
-
*/
|
|
30289
|
-
403: AgentError;
|
|
30290
|
-
/**
|
|
30291
|
-
* Agent or requested user is unavailable to this caller, or the caller is an end user.
|
|
30292
|
-
*/
|
|
30293
|
-
404: unknown;
|
|
30294
|
-
/**
|
|
30295
|
-
* Configure an embed policy before blocking or unblocking; retry if a concurrent policy update caused the conflict.
|
|
30296
|
-
*/
|
|
30297
|
-
409: unknown;
|
|
30298
|
-
};
|
|
30299
|
-
export type UnblockEndUserError = UnblockEndUserErrors[keyof UnblockEndUserErrors];
|
|
30300
|
-
export type UnblockEndUserResponses = {
|
|
30301
|
-
/**
|
|
30302
|
-
* Current end-user view.
|
|
30303
|
-
*/
|
|
30304
|
-
200: {
|
|
30305
|
-
/**
|
|
30306
|
-
* Host application's user identifier, scoped to this organization and agent.
|
|
30307
|
-
*/
|
|
30308
|
-
external_user_id: string;
|
|
30309
|
-
/**
|
|
30310
|
-
* Earliest session creation or token issuance time; null for a preemptively blocked user with no history.
|
|
30311
|
-
*/
|
|
30312
|
-
first_seen_at: string | null;
|
|
30313
|
-
/**
|
|
30314
|
-
* Latest session update or token issuance time; null when there is no history.
|
|
30315
|
-
*/
|
|
30316
|
-
last_active_at: string | null;
|
|
30317
|
-
/**
|
|
30318
|
-
* Total sessions for this end user on this agent.
|
|
30319
|
-
*/
|
|
30320
|
-
session_count: number;
|
|
30321
|
-
/**
|
|
30322
|
-
* Accumulated recorded cost of this customer's sessions on this agent: model usage (threads included) plus session runtime; amount "0.000000" when nothing has been recorded.
|
|
30323
|
-
*/
|
|
30324
|
-
cost: {
|
|
30325
|
-
/**
|
|
30326
|
-
* Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
|
|
30327
|
-
*/
|
|
30328
|
-
amount: string;
|
|
30329
|
-
/**
|
|
30330
|
-
* Always USD.
|
|
30331
|
-
*/
|
|
30332
|
-
currency: 'USD';
|
|
30333
|
-
};
|
|
30334
|
-
/**
|
|
30335
|
-
* Whether the embed policy currently prevents this user from receiving tokens and creating sessions.
|
|
30336
|
-
*/
|
|
30337
|
-
blocked: boolean;
|
|
30338
|
-
};
|
|
30339
|
-
};
|
|
30340
|
-
export type UnblockEndUserResponse = UnblockEndUserResponses[keyof UnblockEndUserResponses];
|
|
30341
29194
|
export type ListCustomersData = {
|
|
30342
29195
|
body?: never;
|
|
30343
29196
|
path: {
|
|
@@ -31456,439 +30309,6 @@ export type DeleteCurrentCustomerAccessTokenResponses = {
|
|
|
31456
30309
|
204: void;
|
|
31457
30310
|
};
|
|
31458
30311
|
export type DeleteCurrentCustomerAccessTokenResponse = DeleteCurrentCustomerAccessTokenResponses[keyof DeleteCurrentCustomerAccessTokenResponses];
|
|
31459
|
-
export type ExchangeEmbedCodeData = {
|
|
31460
|
-
body: {
|
|
31461
|
-
/**
|
|
31462
|
-
* Single-use credential from the c fragment parameter of hosted_url returned by embed token creation. Valid for 60 seconds.
|
|
31463
|
-
*/
|
|
31464
|
-
code: string;
|
|
31465
|
-
};
|
|
31466
|
-
path?: never;
|
|
31467
|
-
query?: never;
|
|
31468
|
-
url: '/agent/v1/embed/exchange';
|
|
31469
|
-
};
|
|
31470
|
-
export type ExchangeEmbedCodeErrors = {
|
|
31471
|
-
/**
|
|
31472
|
-
* Expected a JSON object containing only code. Correct the request body.
|
|
31473
|
-
*/
|
|
31474
|
-
400: unknown;
|
|
31475
|
-
/**
|
|
31476
|
-
* UNAUTHENTICATED (or INVALID_API_KEY, API_KEY_DISABLED, API_KEY_EXPIRED, INVALID_API_TOKEN, API_TOKEN_EXPIRED, API_TOKEN_REVOKED): the API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
31477
|
-
*/
|
|
31478
|
-
401: AgentError;
|
|
31479
|
-
/**
|
|
31480
|
-
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
31481
|
-
*/
|
|
31482
|
-
403: AgentError;
|
|
31483
|
-
/**
|
|
31484
|
-
* The code is expired, already used or unknown. Return to the host website for a new link; all three cases have the same response body.
|
|
31485
|
-
*/
|
|
31486
|
-
404: unknown;
|
|
31487
|
-
/**
|
|
31488
|
-
* The IP minute limit is reached. Wait for Retry-After before trying a fresh link.
|
|
31489
|
-
*/
|
|
31490
|
-
429: unknown;
|
|
31491
|
-
/**
|
|
31492
|
-
* Exchange or rate limiting is unavailable. Return to the host website for a new link later.
|
|
31493
|
-
*/
|
|
31494
|
-
503: unknown;
|
|
31495
|
-
};
|
|
31496
|
-
export type ExchangeEmbedCodeError = ExchangeEmbedCodeErrors[keyof ExchangeEmbedCodeErrors];
|
|
31497
|
-
export type ExchangeEmbedCodeResponses = {
|
|
31498
|
-
/**
|
|
31499
|
-
* The end-user token and its expiration; the code has been consumed.
|
|
31500
|
-
*/
|
|
31501
|
-
200: {
|
|
31502
|
-
/**
|
|
31503
|
-
* End-user credential for the hosted conversation. Keep it in memory; it cannot be refreshed here.
|
|
31504
|
-
*/
|
|
31505
|
-
token: string;
|
|
31506
|
-
/**
|
|
31507
|
-
* Token expiration as an ISO 8601 UTC timestamp. Return to the host website after expiration.
|
|
31508
|
-
*/
|
|
31509
|
-
expires_at: string;
|
|
31510
|
-
};
|
|
31511
|
-
};
|
|
31512
|
-
export type ExchangeEmbedCodeResponse = ExchangeEmbedCodeResponses[keyof ExchangeEmbedCodeResponses];
|
|
31513
|
-
export type CreateAnonymousEmbedTokenData = {
|
|
31514
|
-
body: {
|
|
31515
|
-
/**
|
|
31516
|
-
* Public key created by the service agent owner; safe to include in browser code.
|
|
31517
|
-
*/
|
|
31518
|
-
publishable_key: string;
|
|
31519
|
-
/**
|
|
31520
|
-
* Secret returned by a previous anonymous issuance for this key. Omit for a new visitor; an unknown secret creates a new visitor.
|
|
31521
|
-
*/
|
|
31522
|
-
visitor_secret?: string;
|
|
31523
|
-
};
|
|
31524
|
-
headers: {
|
|
31525
|
-
/**
|
|
31526
|
-
* Browser page origin from the agent policy allowlist.
|
|
31527
|
-
*/
|
|
31528
|
-
Origin: string;
|
|
31529
|
-
};
|
|
31530
|
-
path?: never;
|
|
31531
|
-
query?: never;
|
|
31532
|
-
url: '/agent/v1/embed_tokens/anonymous';
|
|
31533
|
-
};
|
|
31534
|
-
export type CreateAnonymousEmbedTokenErrors = {
|
|
31535
|
-
/**
|
|
31536
|
-
* Unknown or invalid request fields, or key budget exceeds policy. Correct the request or ask the owner to update the key.
|
|
31537
|
-
*/
|
|
31538
|
-
400: unknown;
|
|
31539
|
-
/**
|
|
31540
|
-
* Unknown or disabled publishable key. Ask the agent owner for an active key.
|
|
31541
|
-
*/
|
|
31542
|
-
401: unknown;
|
|
31543
|
-
/**
|
|
31544
|
-
* EMBED_BUDGET_EXHAUSTED. The daily spending cap is reached; wait for the UTC reset or ask the owner to raise it.
|
|
31545
|
-
*/
|
|
31546
|
-
402: unknown;
|
|
31547
|
-
/**
|
|
31548
|
-
* EMBED_ORIGIN_NOT_ALLOWED or EMBED_USER_BLOCKED. Use an allowed page origin or contact the owner.
|
|
31549
|
-
*/
|
|
31550
|
-
403: unknown;
|
|
31551
|
-
/**
|
|
31552
|
-
* EMBED_RATE_LIMITED. Wait for the IP minute window or UTC daily session cap reset.
|
|
31553
|
-
*/
|
|
31554
|
-
429: unknown;
|
|
31555
|
-
/**
|
|
31556
|
-
* Anonymous issuance or rate limiting is unavailable; retry later.
|
|
31557
|
-
*/
|
|
31558
|
-
503: unknown;
|
|
31559
|
-
};
|
|
31560
|
-
export type CreateAnonymousEmbedTokenResponses = {
|
|
31561
|
-
/**
|
|
31562
|
-
* End-user token and expiration, with a visitor secret only for a new visitor.
|
|
31563
|
-
*/
|
|
31564
|
-
200: {
|
|
31565
|
-
/**
|
|
31566
|
-
* Short-lived end-user bearer credential for this agent's embedded sessions.
|
|
31567
|
-
*/
|
|
31568
|
-
token: string;
|
|
31569
|
-
/**
|
|
31570
|
-
* RFC 3339 expiration; refresh before this time using the same visitor_secret.
|
|
31571
|
-
*/
|
|
31572
|
-
expires_at: string;
|
|
31573
|
-
/**
|
|
31574
|
-
* Newly generated visitor secret; save it locally and include it on later requests. Absent when the supplied secret was recognized.
|
|
31575
|
-
*/
|
|
31576
|
-
visitor_secret?: string;
|
|
31577
|
-
};
|
|
31578
|
-
};
|
|
31579
|
-
export type CreateAnonymousEmbedTokenResponse = CreateAnonymousEmbedTokenResponses[keyof CreateAnonymousEmbedTokenResponses];
|
|
31580
|
-
export type ListEmbedTokensData = {
|
|
31581
|
-
body?: never;
|
|
31582
|
-
path?: never;
|
|
31583
|
-
query?: {
|
|
31584
|
-
/**
|
|
31585
|
-
* Filter by service agent identifier (agent_ or agt_ prefix).
|
|
31586
|
-
*/
|
|
31587
|
-
agent_id?: string;
|
|
31588
|
-
/**
|
|
31589
|
-
* Exact host user identifier supplied at issuance.
|
|
31590
|
-
*/
|
|
31591
|
-
external_user_id?: string;
|
|
31592
|
-
/**
|
|
31593
|
-
* Maximum records per page; defaults to 20.
|
|
31594
|
-
*/
|
|
31595
|
-
limit?: number;
|
|
31596
|
-
/**
|
|
31597
|
-
* next_page from a previous response with the same filters.
|
|
31598
|
-
*/
|
|
31599
|
-
page?: string;
|
|
31600
|
-
};
|
|
31601
|
-
url: '/agent/v1/embed_tokens';
|
|
31602
|
-
};
|
|
31603
|
-
export type ListEmbedTokensErrors = {
|
|
31604
|
-
/**
|
|
31605
|
-
* Invalid filter, limit or cursor; reuse the cursor with its original filters.
|
|
31606
|
-
*/
|
|
31607
|
-
400: unknown;
|
|
31608
|
-
/**
|
|
31609
|
-
* Authenticate with a host credential.
|
|
31610
|
-
*/
|
|
31611
|
-
401: unknown;
|
|
31612
|
-
/**
|
|
31613
|
-
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
31614
|
-
*/
|
|
31615
|
-
403: AgentError;
|
|
31616
|
-
/**
|
|
31617
|
-
* The grant is missing or belongs to another organization, or the caller is an end user.
|
|
31618
|
-
*/
|
|
31619
|
-
404: unknown;
|
|
31620
|
-
/**
|
|
31621
|
-
* Upstream revocation failed; the record remains unrevoked and the request may be retried.
|
|
31622
|
-
*/
|
|
31623
|
-
502: unknown;
|
|
31624
|
-
};
|
|
31625
|
-
export type ListEmbedTokensError = ListEmbedTokensErrors[keyof ListEmbedTokensErrors];
|
|
31626
|
-
export type ListEmbedTokensResponses = {
|
|
31627
|
-
/**
|
|
31628
|
-
* Issuance records and next page cursor.
|
|
31629
|
-
*/
|
|
31630
|
-
200: {
|
|
31631
|
-
/**
|
|
31632
|
-
* Items of this page, in the order requested by the call.
|
|
31633
|
-
*/
|
|
31634
|
-
data: Array<{
|
|
31635
|
-
/**
|
|
31636
|
-
* Grant identifier returned by embed token creation.
|
|
31637
|
-
*/
|
|
31638
|
-
id: string;
|
|
31639
|
-
/**
|
|
31640
|
-
* Toolset type id as used in an agent's tools entry, for example agent_toolset_20260401.
|
|
31641
|
-
*/
|
|
31642
|
-
type: 'embed_token';
|
|
31643
|
-
/**
|
|
31644
|
-
* Service agent identifier.
|
|
31645
|
-
*/
|
|
31646
|
-
agent_id: string;
|
|
31647
|
-
/**
|
|
31648
|
-
* Pinned agent version.
|
|
31649
|
-
*/
|
|
31650
|
-
agent_version: number;
|
|
31651
|
-
/**
|
|
31652
|
-
* Exact host user identifier supplied at issuance.
|
|
31653
|
-
*/
|
|
31654
|
-
external_user_id: string;
|
|
31655
|
-
/**
|
|
31656
|
-
* Issuance time in RFC 3339 format.
|
|
31657
|
-
*/
|
|
31658
|
-
created_at: string;
|
|
31659
|
-
/**
|
|
31660
|
-
* Expiration time in RFC 3339 format.
|
|
31661
|
-
*/
|
|
31662
|
-
expires_at: string;
|
|
31663
|
-
/**
|
|
31664
|
-
* Revocation time in RFC 3339 format, or null while not revoked.
|
|
31665
|
-
*/
|
|
31666
|
-
revoked_at: string | null;
|
|
31667
|
-
/**
|
|
31668
|
-
* Host origin recorded at issuance, or null when absent.
|
|
31669
|
-
*/
|
|
31670
|
-
host_origin: string | null;
|
|
31671
|
-
/**
|
|
31672
|
-
* User or API key that issued the token.
|
|
31673
|
-
*/
|
|
31674
|
-
issued_by: {
|
|
31675
|
-
/**
|
|
31676
|
-
* user identifies a signed-in organization member; api_key identifies the issuing API key.
|
|
31677
|
-
*/
|
|
31678
|
-
type: 'user' | 'api_key';
|
|
31679
|
-
/**
|
|
31680
|
-
* Identifier of the object, as returned by the API; pass it in the path of follow-up calls on the same resource.
|
|
31681
|
-
*/
|
|
31682
|
-
id: string;
|
|
31683
|
-
};
|
|
31684
|
-
}>;
|
|
31685
|
-
/**
|
|
31686
|
-
* Cursor for the next page using the same filters, or null when exhausted.
|
|
31687
|
-
*/
|
|
31688
|
-
next_page: string | null;
|
|
31689
|
-
};
|
|
31690
|
-
};
|
|
31691
|
-
export type ListEmbedTokensResponse = ListEmbedTokensResponses[keyof ListEmbedTokensResponses];
|
|
31692
|
-
export type CreateEmbedTokenData = {
|
|
31693
|
-
body: {
|
|
31694
|
-
/**
|
|
31695
|
-
* Set true to also return a hosted chat URL with a single-use credential valid for 60 seconds. Defaults to false; the agent must have an identity_number.
|
|
31696
|
-
*/
|
|
31697
|
-
hosted?: boolean;
|
|
31698
|
-
/**
|
|
31699
|
-
* Service agent ID or identity_number from agent retrieval; it must belong to your organization and be active.
|
|
31700
|
-
*/
|
|
31701
|
-
agent: string;
|
|
31702
|
-
/**
|
|
31703
|
-
* Existing agent version to pin. Omit to pin the latest version at issuance.
|
|
31704
|
-
*/
|
|
31705
|
-
version?: number;
|
|
31706
|
-
/**
|
|
31707
|
-
* Your application's stable end-user identifier, scoped to this organization and agent.
|
|
31708
|
-
*/
|
|
31709
|
-
external_user_id: string;
|
|
31710
|
-
/**
|
|
31711
|
-
* Token lifetime in seconds. Defaults to the embed policy TTL and cannot exceed its maximum or 3600 seconds.
|
|
31712
|
-
*/
|
|
31713
|
-
ttl_seconds?: number;
|
|
31714
|
-
/**
|
|
31715
|
-
* Session budget in cents. Defaults to the embed policy session budget and cannot exceed its maximum.
|
|
31716
|
-
*/
|
|
31717
|
-
budget_cents?: number;
|
|
31718
|
-
/**
|
|
31719
|
-
* Optional host context as text blocks, limited to 8192 UTF-8 bytes in total.
|
|
31720
|
-
*/
|
|
31721
|
-
system_message?: Array<{
|
|
31722
|
-
/**
|
|
31723
|
-
* The text block kind; text is the only supported kind.
|
|
31724
|
-
*/
|
|
31725
|
-
type: 'text';
|
|
31726
|
-
/**
|
|
31727
|
-
* Host context text. All blocks together must fit within 8192 UTF-8 bytes.
|
|
31728
|
-
*/
|
|
31729
|
-
text: string;
|
|
31730
|
-
}>;
|
|
31731
|
-
/**
|
|
31732
|
-
* Optional system prompt override, accepted only when the embed policy allows agent overrides.
|
|
31733
|
-
*/
|
|
31734
|
-
agent_override?: {
|
|
31735
|
-
/**
|
|
31736
|
-
* Replacement system prompt, or null to clear it for this grant.
|
|
31737
|
-
*/
|
|
31738
|
-
system: string | null;
|
|
31739
|
-
};
|
|
31740
|
-
/**
|
|
31741
|
-
* Optional subset of the policy origin entries, compared exactly. Omit to snapshot every policy origin.
|
|
31742
|
-
*/
|
|
31743
|
-
allowed_origins?: Array<string>;
|
|
31744
|
-
/**
|
|
31745
|
-
* Host metadata preserved verbatim; at most 16 keys of 1–64 characters and string values of at most 512 characters. Defaults to an empty object.
|
|
31746
|
-
*/
|
|
31747
|
-
metadata?: {
|
|
31748
|
-
[key: string]: string;
|
|
31749
|
-
};
|
|
31750
|
-
};
|
|
31751
|
-
path?: never;
|
|
31752
|
-
query?: never;
|
|
31753
|
-
url: '/agent/v1/embed_tokens';
|
|
31754
|
-
};
|
|
31755
|
-
export type CreateEmbedTokenErrors = {
|
|
31756
|
-
/**
|
|
31757
|
-
* Request fields exceed policy limits, the policy or its environment is unavailable, or a hosted agent has no identity_number. Configure the policy or correct the reported field.
|
|
31758
|
-
*/
|
|
31759
|
-
400: unknown;
|
|
31760
|
-
/**
|
|
31761
|
-
* A valid host credential is required; authenticate with your backend API key.
|
|
31762
|
-
*/
|
|
31763
|
-
401: unknown;
|
|
31764
|
-
/**
|
|
31765
|
-
* The end user is blocked by the embed policy; contact the agent owner.
|
|
31766
|
-
*/
|
|
31767
|
-
403: unknown;
|
|
31768
|
-
/**
|
|
31769
|
-
* The service agent or requested version is unavailable to this caller; check the agent identifier and version.
|
|
31770
|
-
*/
|
|
31771
|
-
404: unknown;
|
|
31772
|
-
/**
|
|
31773
|
-
* Token issuance is unavailable; no usable credential was returned.
|
|
31774
|
-
*/
|
|
31775
|
-
502: unknown;
|
|
31776
|
-
};
|
|
31777
|
-
export type CreateEmbedTokenResponses = {
|
|
31778
|
-
/**
|
|
31779
|
-
* Issued end-user token and its grant identifier and expiration.
|
|
31780
|
-
*/
|
|
31781
|
-
201: {
|
|
31782
|
-
/**
|
|
31783
|
-
* Hosted chat link, returned only when hosted is true. Redirect the user here within 60 seconds; its fragment credential can be exchanged only once.
|
|
31784
|
-
*/
|
|
31785
|
-
hosted_url?: string;
|
|
31786
|
-
/**
|
|
31787
|
-
* Grant identifier with the emb_ prefix, identifying this issuance.
|
|
31788
|
-
*/
|
|
31789
|
-
id: string;
|
|
31790
|
-
/**
|
|
31791
|
-
* Short-lived end-user credential to pass to your frontend; keep the host API key on your backend.
|
|
31792
|
-
*/
|
|
31793
|
-
token: string;
|
|
31794
|
-
/**
|
|
31795
|
-
* Token expiration as an ISO 8601 UTC timestamp, as issued by identity.
|
|
31796
|
-
*/
|
|
31797
|
-
expires_at: string;
|
|
31798
|
-
};
|
|
31799
|
-
};
|
|
31800
|
-
export type CreateEmbedTokenResponse = CreateEmbedTokenResponses[keyof CreateEmbedTokenResponses];
|
|
31801
|
-
export type RevokeEmbedTokenData = {
|
|
31802
|
-
body?: never;
|
|
31803
|
-
path: {
|
|
31804
|
-
/**
|
|
31805
|
-
* Grant id returned by issuance or listing.
|
|
31806
|
-
*/
|
|
31807
|
-
id: string;
|
|
31808
|
-
};
|
|
31809
|
-
query?: never;
|
|
31810
|
-
url: '/agent/v1/embed_tokens/{id}/revoke';
|
|
31811
|
-
};
|
|
31812
|
-
export type RevokeEmbedTokenErrors = {
|
|
31813
|
-
/**
|
|
31814
|
-
* Invalid filter, limit or cursor; reuse the cursor with its original filters.
|
|
31815
|
-
*/
|
|
31816
|
-
400: unknown;
|
|
31817
|
-
/**
|
|
31818
|
-
* Authenticate with a host credential.
|
|
31819
|
-
*/
|
|
31820
|
-
401: unknown;
|
|
31821
|
-
/**
|
|
31822
|
-
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
31823
|
-
*/
|
|
31824
|
-
403: AgentError;
|
|
31825
|
-
/**
|
|
31826
|
-
* The grant is missing or belongs to another organization, or the caller is an end user.
|
|
31827
|
-
*/
|
|
31828
|
-
404: unknown;
|
|
31829
|
-
/**
|
|
31830
|
-
* Upstream revocation failed; the record remains unrevoked and the request may be retried.
|
|
31831
|
-
*/
|
|
31832
|
-
502: unknown;
|
|
31833
|
-
};
|
|
31834
|
-
export type RevokeEmbedTokenError = RevokeEmbedTokenErrors[keyof RevokeEmbedTokenErrors];
|
|
31835
|
-
export type RevokeEmbedTokenResponses = {
|
|
31836
|
-
/**
|
|
31837
|
-
* Revoked issuance record, including its original revocation time on repeated calls.
|
|
31838
|
-
*/
|
|
31839
|
-
200: {
|
|
31840
|
-
/**
|
|
31841
|
-
* Grant identifier returned by embed token creation.
|
|
31842
|
-
*/
|
|
31843
|
-
id: string;
|
|
31844
|
-
/**
|
|
31845
|
-
* Type tag of the object.
|
|
31846
|
-
*/
|
|
31847
|
-
type: 'embed_token';
|
|
31848
|
-
/**
|
|
31849
|
-
* Service agent identifier.
|
|
31850
|
-
*/
|
|
31851
|
-
agent_id: string;
|
|
31852
|
-
/**
|
|
31853
|
-
* Pinned agent version.
|
|
31854
|
-
*/
|
|
31855
|
-
agent_version: number;
|
|
31856
|
-
/**
|
|
31857
|
-
* Exact host user identifier supplied at issuance.
|
|
31858
|
-
*/
|
|
31859
|
-
external_user_id: string;
|
|
31860
|
-
/**
|
|
31861
|
-
* Issuance time in RFC 3339 format.
|
|
31862
|
-
*/
|
|
31863
|
-
created_at: string;
|
|
31864
|
-
/**
|
|
31865
|
-
* Expiration time in RFC 3339 format.
|
|
31866
|
-
*/
|
|
31867
|
-
expires_at: string;
|
|
31868
|
-
/**
|
|
31869
|
-
* Revocation time in RFC 3339 format, or null while not revoked.
|
|
31870
|
-
*/
|
|
31871
|
-
revoked_at: string | null;
|
|
31872
|
-
/**
|
|
31873
|
-
* Host origin recorded at issuance, or null when absent.
|
|
31874
|
-
*/
|
|
31875
|
-
host_origin: string | null;
|
|
31876
|
-
/**
|
|
31877
|
-
* User or API key that issued the token.
|
|
31878
|
-
*/
|
|
31879
|
-
issued_by: {
|
|
31880
|
-
/**
|
|
31881
|
-
* user identifies a signed-in organization member; api_key identifies the issuing API key.
|
|
31882
|
-
*/
|
|
31883
|
-
type: 'user' | 'api_key';
|
|
31884
|
-
/**
|
|
31885
|
-
* Identifier of the object, as returned by the API; pass it in the path of follow-up calls on the same resource.
|
|
31886
|
-
*/
|
|
31887
|
-
id: string;
|
|
31888
|
-
};
|
|
31889
|
-
};
|
|
31890
|
-
};
|
|
31891
|
-
export type RevokeEmbedTokenResponse = RevokeEmbedTokenResponses[keyof RevokeEmbedTokenResponses];
|
|
31892
30312
|
export type ComputersListData = {
|
|
31893
30313
|
body?: never;
|
|
31894
30314
|
path?: never;
|
|
@@ -37444,228 +35864,70 @@ export type CompactSessionErrors = {
|
|
|
37444
35864
|
*/
|
|
37445
35865
|
503: unknown;
|
|
37446
35866
|
};
|
|
37447
|
-
export type CompactSessionError = CompactSessionErrors[keyof CompactSessionErrors];
|
|
37448
|
-
export type CompactSessionResponses = {
|
|
37449
|
-
/**
|
|
37450
|
-
* Skipped, succeeded or failed compaction
|
|
37451
|
-
*/
|
|
37452
|
-
200: {
|
|
37453
|
-
/**
|
|
37454
|
-
* Always `session_compaction`. Result of a compaction request.
|
|
37455
|
-
*/
|
|
37456
|
-
type: 'session_compaction';
|
|
37457
|
-
/**
|
|
37458
|
-
* Compaction operation id; pass it as operation_id to sessions.compact.retrieve.
|
|
37459
|
-
*/
|
|
37460
|
-
id: string;
|
|
37461
|
-
/**
|
|
37462
|
-
* State of the compaction operation: queued and running are in progress, skipped means nothing needed compaction, succeeded and failed are final.
|
|
37463
|
-
*/
|
|
37464
|
-
status: 'queued' | 'running' | 'skipped' | 'succeeded' | 'failed';
|
|
37465
|
-
/**
|
|
37466
|
-
* Why the compaction was skipped or failed; absent otherwise.
|
|
37467
|
-
*/
|
|
37468
|
-
reason?: string;
|
|
37469
|
-
};
|
|
37470
|
-
/**
|
|
37471
|
-
* Queued or running compaction
|
|
37472
|
-
*/
|
|
37473
|
-
202: {
|
|
37474
|
-
/**
|
|
37475
|
-
* Always `session_compaction`. Result of a compaction request.
|
|
37476
|
-
*/
|
|
37477
|
-
type: 'session_compaction';
|
|
37478
|
-
/**
|
|
37479
|
-
* Compaction operation id; pass it as operation_id to sessions.compact.retrieve.
|
|
37480
|
-
*/
|
|
37481
|
-
id: string;
|
|
37482
|
-
/**
|
|
37483
|
-
* State of the compaction operation: queued and running are in progress, skipped means nothing needed compaction, succeeded and failed are final.
|
|
37484
|
-
*/
|
|
37485
|
-
status: 'queued' | 'running' | 'skipped' | 'succeeded' | 'failed';
|
|
37486
|
-
/**
|
|
37487
|
-
* Why the compaction was skipped or failed; absent otherwise.
|
|
37488
|
-
*/
|
|
37489
|
-
reason?: string;
|
|
37490
|
-
};
|
|
37491
|
-
};
|
|
37492
|
-
export type CompactSessionResponse = CompactSessionResponses[keyof CompactSessionResponses];
|
|
37493
|
-
export type GetSessionCompactionData = {
|
|
37494
|
-
body?: never;
|
|
37495
|
-
path: {
|
|
37496
|
-
/**
|
|
37497
|
-
* Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.
|
|
37498
|
-
*/
|
|
37499
|
-
session_id: string;
|
|
37500
|
-
/**
|
|
37501
|
-
* Compaction operation id returned by sessions.compact in the id field of the session_compaction object.
|
|
37502
|
-
*/
|
|
37503
|
-
operation_id: string;
|
|
37504
|
-
};
|
|
37505
|
-
query?: never;
|
|
37506
|
-
url: '/agent/v1/sessions/{session_id}/compact/{operation_id}';
|
|
37507
|
-
};
|
|
37508
|
-
export type GetSessionCompactionErrors = {
|
|
37509
|
-
/**
|
|
37510
|
-
* Authentication required
|
|
37511
|
-
*/
|
|
37512
|
-
401: unknown;
|
|
37513
|
-
/**
|
|
37514
|
-
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
37515
|
-
*/
|
|
37516
|
-
403: AgentError;
|
|
37517
|
-
/**
|
|
37518
|
-
* Session or compaction operation not found
|
|
37519
|
-
*/
|
|
37520
|
-
404: unknown;
|
|
37521
|
-
/**
|
|
37522
|
-
* Agent service failed
|
|
37523
|
-
*/
|
|
37524
|
-
502: unknown;
|
|
37525
|
-
/**
|
|
37526
|
-
* Agent service unavailable
|
|
37527
|
-
*/
|
|
37528
|
-
503: unknown;
|
|
37529
|
-
};
|
|
37530
|
-
export type GetSessionCompactionError = GetSessionCompactionErrors[keyof GetSessionCompactionErrors];
|
|
37531
|
-
export type GetSessionCompactionResponses = {
|
|
37532
|
-
/**
|
|
37533
|
-
* Compaction operation
|
|
37534
|
-
*/
|
|
37535
|
-
200: {
|
|
37536
|
-
/**
|
|
37537
|
-
* Always `session_compaction`. Result of a compaction request.
|
|
37538
|
-
*/
|
|
37539
|
-
type: 'session_compaction';
|
|
37540
|
-
/**
|
|
37541
|
-
* Compaction operation id; pass it as operation_id to sessions.compact.retrieve.
|
|
37542
|
-
*/
|
|
37543
|
-
id: string;
|
|
37544
|
-
/**
|
|
37545
|
-
* State of the compaction operation: queued and running are in progress, skipped means nothing needed compaction, succeeded and failed are final.
|
|
37546
|
-
*/
|
|
37547
|
-
status: 'queued' | 'running' | 'skipped' | 'succeeded' | 'failed';
|
|
37548
|
-
/**
|
|
37549
|
-
* Why the compaction was skipped or failed; absent otherwise.
|
|
37550
|
-
*/
|
|
37551
|
-
reason?: string;
|
|
37552
|
-
};
|
|
37553
|
-
};
|
|
37554
|
-
export type GetSessionCompactionResponse = GetSessionCompactionResponses[keyof GetSessionCompactionResponses];
|
|
37555
|
-
export type ListSessionCompactionsData = {
|
|
37556
|
-
body?: never;
|
|
37557
|
-
path: {
|
|
37558
|
-
/**
|
|
37559
|
-
* Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.
|
|
37560
|
-
*/
|
|
37561
|
-
session_id: string;
|
|
37562
|
-
};
|
|
37563
|
-
query?: never;
|
|
37564
|
-
url: '/agent/v1/sessions/{session_id}/compactions';
|
|
37565
|
-
};
|
|
37566
|
-
export type ListSessionCompactionsErrors = {
|
|
37567
|
-
/**
|
|
37568
|
-
* Authentication required
|
|
37569
|
-
*/
|
|
37570
|
-
401: unknown;
|
|
37571
|
-
/**
|
|
37572
|
-
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
37573
|
-
*/
|
|
37574
|
-
403: AgentError;
|
|
37575
|
-
/**
|
|
37576
|
-
* Session not found
|
|
37577
|
-
*/
|
|
37578
|
-
404: unknown;
|
|
37579
|
-
/**
|
|
37580
|
-
* Agent service failed
|
|
37581
|
-
*/
|
|
37582
|
-
502: unknown;
|
|
37583
|
-
/**
|
|
37584
|
-
* Agent service unavailable
|
|
37585
|
-
*/
|
|
37586
|
-
503: unknown;
|
|
37587
|
-
};
|
|
37588
|
-
export type ListSessionCompactionsError = ListSessionCompactionsErrors[keyof ListSessionCompactionsErrors];
|
|
37589
|
-
export type ListSessionCompactionsResponses = {
|
|
35867
|
+
export type CompactSessionError = CompactSessionErrors[keyof CompactSessionErrors];
|
|
35868
|
+
export type CompactSessionResponses = {
|
|
37590
35869
|
/**
|
|
37591
|
-
*
|
|
35870
|
+
* Skipped, succeeded or failed compaction
|
|
37592
35871
|
*/
|
|
37593
35872
|
200: {
|
|
37594
35873
|
/**
|
|
37595
|
-
*
|
|
35874
|
+
* Always `session_compaction`. Result of a compaction request.
|
|
37596
35875
|
*/
|
|
37597
|
-
|
|
37598
|
-
|
|
37599
|
-
|
|
37600
|
-
|
|
37601
|
-
|
|
37602
|
-
|
|
37603
|
-
|
|
37604
|
-
|
|
37605
|
-
|
|
37606
|
-
|
|
37607
|
-
|
|
37608
|
-
|
|
37609
|
-
|
|
37610
|
-
|
|
37611
|
-
|
|
37612
|
-
|
|
37613
|
-
|
|
37614
|
-
|
|
37615
|
-
|
|
37616
|
-
|
|
37617
|
-
|
|
37618
|
-
|
|
37619
|
-
|
|
37620
|
-
|
|
37621
|
-
|
|
37622
|
-
|
|
37623
|
-
|
|
37624
|
-
|
|
37625
|
-
|
|
37626
|
-
|
|
37627
|
-
|
|
37628
|
-
|
|
37629
|
-
|
|
37630
|
-
|
|
37631
|
-
* Context tokens after the compaction; null when not measured.
|
|
37632
|
-
*/
|
|
37633
|
-
input_tokens_after: number | null;
|
|
37634
|
-
/**
|
|
37635
|
-
* Summary text that replaced the messages; null when the compaction failed.
|
|
37636
|
-
*/
|
|
37637
|
-
summary: string | null;
|
|
37638
|
-
/**
|
|
37639
|
-
* Failure reason; null when the compaction succeeded.
|
|
37640
|
-
*/
|
|
37641
|
-
error: string | null;
|
|
37642
|
-
/**
|
|
37643
|
-
* RFC 3339 time at which the compaction was recorded.
|
|
37644
|
-
*/
|
|
37645
|
-
created_at: string;
|
|
37646
|
-
}>;
|
|
35876
|
+
type: 'session_compaction';
|
|
35877
|
+
/**
|
|
35878
|
+
* Compaction operation id; pass it as operation_id to sessions.compact.retrieve.
|
|
35879
|
+
*/
|
|
35880
|
+
id: string;
|
|
35881
|
+
/**
|
|
35882
|
+
* State of the compaction operation: queued and running are in progress, skipped means nothing needed compaction, succeeded and failed are final.
|
|
35883
|
+
*/
|
|
35884
|
+
status: 'queued' | 'running' | 'skipped' | 'succeeded' | 'failed';
|
|
35885
|
+
/**
|
|
35886
|
+
* Why the compaction was skipped or failed; absent otherwise.
|
|
35887
|
+
*/
|
|
35888
|
+
reason?: string;
|
|
35889
|
+
};
|
|
35890
|
+
/**
|
|
35891
|
+
* Queued or running compaction
|
|
35892
|
+
*/
|
|
35893
|
+
202: {
|
|
35894
|
+
/**
|
|
35895
|
+
* Always `session_compaction`. Result of a compaction request.
|
|
35896
|
+
*/
|
|
35897
|
+
type: 'session_compaction';
|
|
35898
|
+
/**
|
|
35899
|
+
* Compaction operation id; pass it as operation_id to sessions.compact.retrieve.
|
|
35900
|
+
*/
|
|
35901
|
+
id: string;
|
|
35902
|
+
/**
|
|
35903
|
+
* State of the compaction operation: queued and running are in progress, skipped means nothing needed compaction, succeeded and failed are final.
|
|
35904
|
+
*/
|
|
35905
|
+
status: 'queued' | 'running' | 'skipped' | 'succeeded' | 'failed';
|
|
35906
|
+
/**
|
|
35907
|
+
* Why the compaction was skipped or failed; absent otherwise.
|
|
35908
|
+
*/
|
|
35909
|
+
reason?: string;
|
|
37647
35910
|
};
|
|
37648
35911
|
};
|
|
37649
|
-
export type
|
|
37650
|
-
export type
|
|
35912
|
+
export type CompactSessionResponse = CompactSessionResponses[keyof CompactSessionResponses];
|
|
35913
|
+
export type GetSessionCompactionData = {
|
|
37651
35914
|
body?: never;
|
|
37652
|
-
|
|
35915
|
+
path: {
|
|
35916
|
+
/**
|
|
35917
|
+
* Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.
|
|
35918
|
+
*/
|
|
35919
|
+
session_id: string;
|
|
37653
35920
|
/**
|
|
37654
|
-
*
|
|
35921
|
+
* Compaction operation id returned by sessions.compact in the id field of the session_compaction object.
|
|
37655
35922
|
*/
|
|
37656
|
-
|
|
35923
|
+
operation_id: string;
|
|
37657
35924
|
};
|
|
37658
|
-
path?: never;
|
|
37659
35925
|
query?: never;
|
|
37660
|
-
url: '/agent/v1/
|
|
35926
|
+
url: '/agent/v1/sessions/{session_id}/compact/{operation_id}';
|
|
37661
35927
|
};
|
|
37662
|
-
export type
|
|
37663
|
-
/**
|
|
37664
|
-
* Addressing parameters are not accepted; remove identity_number, agent_id and other query parameters.
|
|
37665
|
-
*/
|
|
37666
|
-
400: unknown;
|
|
35928
|
+
export type GetSessionCompactionErrors = {
|
|
37667
35929
|
/**
|
|
37668
|
-
*
|
|
35930
|
+
* Authentication required
|
|
37669
35931
|
*/
|
|
37670
35932
|
401: unknown;
|
|
37671
35933
|
/**
|
|
@@ -37673,217 +35935,138 @@ export type GetEmbedAppearanceErrors = {
|
|
|
37673
35935
|
*/
|
|
37674
35936
|
403: AgentError;
|
|
37675
35937
|
/**
|
|
37676
|
-
*
|
|
35938
|
+
* Session or compaction operation not found
|
|
37677
35939
|
*/
|
|
37678
35940
|
404: unknown;
|
|
37679
35941
|
/**
|
|
37680
|
-
*
|
|
35942
|
+
* Agent service failed
|
|
35943
|
+
*/
|
|
35944
|
+
502: unknown;
|
|
35945
|
+
/**
|
|
35946
|
+
* Agent service unavailable
|
|
37681
35947
|
*/
|
|
37682
35948
|
503: unknown;
|
|
37683
35949
|
};
|
|
37684
|
-
export type
|
|
37685
|
-
export type
|
|
35950
|
+
export type GetSessionCompactionError = GetSessionCompactionErrors[keyof GetSessionCompactionErrors];
|
|
35951
|
+
export type GetSessionCompactionResponses = {
|
|
37686
35952
|
/**
|
|
37687
|
-
*
|
|
35953
|
+
* Compaction operation
|
|
37688
35954
|
*/
|
|
37689
35955
|
200: {
|
|
37690
35956
|
/**
|
|
37691
|
-
*
|
|
35957
|
+
* Always `session_compaction`. Result of a compaction request.
|
|
37692
35958
|
*/
|
|
37693
|
-
|
|
37694
|
-
/**
|
|
37695
|
-
* Display name; omission keeps the neutral browser-language default.
|
|
37696
|
-
*/
|
|
37697
|
-
name?: string;
|
|
37698
|
-
/**
|
|
37699
|
-
* Optional HTTPS avatar image URL; non-HTTPS images are rejected.
|
|
37700
|
-
*/
|
|
37701
|
-
avatar?: string;
|
|
37702
|
-
};
|
|
35959
|
+
type: 'session_compaction';
|
|
37703
35960
|
/**
|
|
37704
|
-
*
|
|
35961
|
+
* Compaction operation id; pass it as operation_id to sessions.compact.retrieve.
|
|
37705
35962
|
*/
|
|
37706
|
-
|
|
35963
|
+
id: string;
|
|
37707
35964
|
/**
|
|
37708
|
-
*
|
|
35965
|
+
* State of the compaction operation: queued and running are in progress, skipped means nothing needed compaction, succeeded and failed are final.
|
|
37709
35966
|
*/
|
|
37710
|
-
|
|
37711
|
-
/**
|
|
37712
|
-
* Entry control: none hides the launcher, bubble shows a button, mascot shows a character that reacts while the visitor types and the agent thinks and answers. A mascot needs pack.
|
|
37713
|
-
*/
|
|
37714
|
-
type: 'none' | 'bubble' | 'mascot';
|
|
37715
|
-
/**
|
|
37716
|
-
* Mascot images: exactly one of preset or images. Send pack, not image.
|
|
37717
|
-
*/
|
|
37718
|
-
pack?: {
|
|
37719
|
-
/**
|
|
37720
|
-
* Built-in character: mint (mint support girl), cat (cat-eared girl) or bot (small robot).
|
|
37721
|
-
*/
|
|
37722
|
-
preset?: 'mint' | 'cat' | 'bot';
|
|
37723
|
-
/**
|
|
37724
|
-
* One HTTPS image per slot; only idle is required and a missing slot shows idle. Use 2:3 canvases with the feet bottom-centered on a transparent background; PNG or WebP stay still, GIF, WebP and APNG play as they are.
|
|
37725
|
-
*/
|
|
37726
|
-
images?: {
|
|
37727
|
-
/**
|
|
37728
|
-
* Resting state.
|
|
37729
|
-
*/
|
|
37730
|
-
idle: string;
|
|
37731
|
-
/**
|
|
37732
|
-
* Page open and while the greeting bubble shows.
|
|
37733
|
-
*/
|
|
37734
|
-
greet?: string;
|
|
37735
|
-
/**
|
|
37736
|
-
* The visitor is typing in the composer.
|
|
37737
|
-
*/
|
|
37738
|
-
listening?: string;
|
|
37739
|
-
/**
|
|
37740
|
-
* After the visitor sends, before the first reply text.
|
|
37741
|
-
*/
|
|
37742
|
-
thinking?: string;
|
|
37743
|
-
/**
|
|
37744
|
-
* While the reply streams; alternates with talking-2 every 220 ms.
|
|
37745
|
-
*/
|
|
37746
|
-
talking?: string;
|
|
37747
|
-
/**
|
|
37748
|
-
* Second mouth frame of talking, mouth closed; without it talking alternates with idle.
|
|
37749
|
-
*/
|
|
37750
|
-
'talking-2'?: string;
|
|
37751
|
-
/**
|
|
37752
|
-
* The last turn failed or was refused.
|
|
37753
|
-
*/
|
|
37754
|
-
sorry?: string;
|
|
37755
|
-
/**
|
|
37756
|
-
* No interaction for 60 seconds; hover or click wakes the mascot.
|
|
37757
|
-
*/
|
|
37758
|
-
sleep?: string;
|
|
37759
|
-
};
|
|
37760
|
-
};
|
|
37761
|
-
/**
|
|
37762
|
-
* Legacy single mascot image, read as pack.images.idle. When pack is present, pack wins.
|
|
37763
|
-
*/
|
|
37764
|
-
image?: string;
|
|
37765
|
-
/**
|
|
37766
|
-
* float (default) gently floats the mascot, bounces on hover and waves with the greeting; none keeps it still. Reduced-motion settings always win.
|
|
37767
|
-
*/
|
|
37768
|
-
motion?: 'float' | 'none';
|
|
37769
|
-
/**
|
|
37770
|
-
* Launcher corner: bottom-right is the default; bottom-left uses the opposite corner.
|
|
37771
|
-
*/
|
|
37772
|
-
position?: 'bottom-right' | 'bottom-left';
|
|
37773
|
-
/**
|
|
37774
|
-
* Accessible entry button label and bubble text; omission uses the default chat label.
|
|
37775
|
-
*/
|
|
37776
|
-
label?: string;
|
|
37777
|
-
};
|
|
35967
|
+
status: 'queued' | 'running' | 'skipped' | 'succeeded' | 'failed';
|
|
37778
35968
|
/**
|
|
37779
|
-
*
|
|
35969
|
+
* Why the compaction was skipped or failed; absent otherwise.
|
|
37780
35970
|
*/
|
|
37781
|
-
|
|
37782
|
-
|
|
37783
|
-
|
|
37784
|
-
|
|
37785
|
-
|
|
37786
|
-
|
|
37787
|
-
|
|
37788
|
-
*/
|
|
37789
|
-
subtitle?: string;
|
|
37790
|
-
/**
|
|
37791
|
-
* Optional HTTPS image shown in the heading avatar position.
|
|
37792
|
-
*/
|
|
37793
|
-
icon?: string;
|
|
37794
|
-
};
|
|
35971
|
+
reason?: string;
|
|
35972
|
+
};
|
|
35973
|
+
};
|
|
35974
|
+
export type GetSessionCompactionResponse = GetSessionCompactionResponses[keyof GetSessionCompactionResponses];
|
|
35975
|
+
export type ListSessionCompactionsData = {
|
|
35976
|
+
body?: never;
|
|
35977
|
+
path: {
|
|
37795
35978
|
/**
|
|
37796
|
-
*
|
|
35979
|
+
* Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.
|
|
37797
35980
|
*/
|
|
37798
|
-
|
|
35981
|
+
session_id: string;
|
|
35982
|
+
};
|
|
35983
|
+
query?: never;
|
|
35984
|
+
url: '/agent/v1/sessions/{session_id}/compactions';
|
|
35985
|
+
};
|
|
35986
|
+
export type ListSessionCompactionsErrors = {
|
|
35987
|
+
/**
|
|
35988
|
+
* Authentication required
|
|
35989
|
+
*/
|
|
35990
|
+
401: unknown;
|
|
35991
|
+
/**
|
|
35992
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
35993
|
+
*/
|
|
35994
|
+
403: AgentError;
|
|
35995
|
+
/**
|
|
35996
|
+
* Session not found
|
|
35997
|
+
*/
|
|
35998
|
+
404: unknown;
|
|
35999
|
+
/**
|
|
36000
|
+
* Agent service failed
|
|
36001
|
+
*/
|
|
36002
|
+
502: unknown;
|
|
36003
|
+
/**
|
|
36004
|
+
* Agent service unavailable
|
|
36005
|
+
*/
|
|
36006
|
+
503: unknown;
|
|
36007
|
+
};
|
|
36008
|
+
export type ListSessionCompactionsError = ListSessionCompactionsErrors[keyof ListSessionCompactionsErrors];
|
|
36009
|
+
export type ListSessionCompactionsResponses = {
|
|
36010
|
+
/**
|
|
36011
|
+
* Compaction history
|
|
36012
|
+
*/
|
|
36013
|
+
200: {
|
|
36014
|
+
/**
|
|
36015
|
+
* Items of this page, in the order requested by the call.
|
|
36016
|
+
*/
|
|
36017
|
+
data: Array<{
|
|
37799
36018
|
/**
|
|
37800
|
-
*
|
|
36019
|
+
* Always `context_compaction`. Record of one past compaction.
|
|
37801
36020
|
*/
|
|
37802
|
-
|
|
36021
|
+
type: 'context_compaction';
|
|
37803
36022
|
/**
|
|
37804
|
-
*
|
|
36023
|
+
* Compaction record id.
|
|
37805
36024
|
*/
|
|
37806
|
-
|
|
36025
|
+
id: string;
|
|
37807
36026
|
/**
|
|
37808
|
-
*
|
|
36027
|
+
* Id of the agent.thread_context_compacted event emitted for this compaction; null when none.
|
|
37809
36028
|
*/
|
|
37810
|
-
|
|
36029
|
+
event_id: string | null;
|
|
37811
36030
|
/**
|
|
37812
|
-
*
|
|
36031
|
+
* What started the compaction.
|
|
37813
36032
|
*/
|
|
37814
|
-
|
|
36033
|
+
trigger: 'auto' | 'manual' | 'model_downshift';
|
|
37815
36034
|
/**
|
|
37816
|
-
*
|
|
36035
|
+
* Final outcome of the compaction.
|
|
37817
36036
|
*/
|
|
37818
|
-
|
|
36037
|
+
status: 'succeeded' | 'failed';
|
|
37819
36038
|
/**
|
|
37820
|
-
*
|
|
36039
|
+
* Model that wrote the summary.
|
|
37821
36040
|
*/
|
|
37822
|
-
|
|
36041
|
+
model: string;
|
|
37823
36042
|
/**
|
|
37824
|
-
*
|
|
36043
|
+
* Number of messages replaced by the summary.
|
|
37825
36044
|
*/
|
|
37826
|
-
|
|
36045
|
+
compacted_message_count: number;
|
|
37827
36046
|
/**
|
|
37828
|
-
*
|
|
36047
|
+
* Context tokens before the compaction.
|
|
37829
36048
|
*/
|
|
37830
|
-
|
|
37831
|
-
};
|
|
37832
|
-
/**
|
|
37833
|
-
* Reserved Kit locale preference: zh for Chinese, en for English. Kit currently passes this option through without translating all controls.
|
|
37834
|
-
*/
|
|
37835
|
-
locale?: 'zh' | 'en';
|
|
37836
|
-
/**
|
|
37837
|
-
* Content displayed before the first message in a conversation.
|
|
37838
|
-
*/
|
|
37839
|
-
startScreen?: {
|
|
36049
|
+
input_tokens_before: number;
|
|
37840
36050
|
/**
|
|
37841
|
-
*
|
|
36051
|
+
* Context tokens after the compaction; null when not measured.
|
|
37842
36052
|
*/
|
|
37843
|
-
|
|
36053
|
+
input_tokens_after: number | null;
|
|
37844
36054
|
/**
|
|
37845
|
-
*
|
|
36055
|
+
* Summary text that replaced the messages; null when the compaction failed.
|
|
37846
36056
|
*/
|
|
37847
|
-
|
|
37848
|
-
/**
|
|
37849
|
-
* Visible suggested-question button text.
|
|
37850
|
-
*/
|
|
37851
|
-
label: string;
|
|
37852
|
-
/**
|
|
37853
|
-
* User message sent when this suggestion is selected.
|
|
37854
|
-
*/
|
|
37855
|
-
prompt: string;
|
|
37856
|
-
}>;
|
|
37857
|
-
};
|
|
37858
|
-
/**
|
|
37859
|
-
* Message input appearance; transport and attachment settings are excluded.
|
|
37860
|
-
*/
|
|
37861
|
-
composer?: {
|
|
36057
|
+
summary: string | null;
|
|
37862
36058
|
/**
|
|
37863
|
-
*
|
|
36059
|
+
* Failure reason; null when the compaction succeeded.
|
|
37864
36060
|
*/
|
|
37865
|
-
|
|
37866
|
-
};
|
|
37867
|
-
/**
|
|
37868
|
-
* Optional notice displayed beside the conversation composer.
|
|
37869
|
-
*/
|
|
37870
|
-
disclaimer?: string;
|
|
37871
|
-
/**
|
|
37872
|
-
* Optional text below the conversation.
|
|
37873
|
-
*/
|
|
37874
|
-
footer?: string;
|
|
37875
|
-
/**
|
|
37876
|
-
* Availability of the conversation history control.
|
|
37877
|
-
*/
|
|
37878
|
-
history?: {
|
|
36061
|
+
error: string | null;
|
|
37879
36062
|
/**
|
|
37880
|
-
*
|
|
36063
|
+
* RFC 3339 time at which the compaction was recorded.
|
|
37881
36064
|
*/
|
|
37882
|
-
|
|
37883
|
-
}
|
|
36065
|
+
created_at: string;
|
|
36066
|
+
}>;
|
|
37884
36067
|
};
|
|
37885
36068
|
};
|
|
37886
|
-
export type
|
|
36069
|
+
export type ListSessionCompactionsResponse = ListSessionCompactionsResponses[keyof ListSessionCompactionsResponses];
|
|
37887
36070
|
export type CreateAudioSpeechData = {
|
|
37888
36071
|
body: unknown & {
|
|
37889
36072
|
/**
|
|
@@ -46147,7 +44330,7 @@ export type AgentsListResponses = {
|
|
|
46147
44330
|
};
|
|
46148
44331
|
};
|
|
46149
44332
|
/**
|
|
46150
|
-
*
|
|
44333
|
+
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
46151
44334
|
*/
|
|
46152
44335
|
multiagent: null | AgentManaged39;
|
|
46153
44336
|
/**
|
|
@@ -46175,12 +44358,11 @@ export type AgentsListResponses = {
|
|
|
46175
44358
|
*/
|
|
46176
44359
|
updated_at: string;
|
|
46177
44360
|
/**
|
|
46178
|
-
*
|
|
46179
|
-
* modified.
|
|
44361
|
+
* Version of this returned configuration. Default retrieve returns the effective version; an explicit version query or a version-history item returns that saved version.
|
|
46180
44362
|
*/
|
|
46181
44363
|
version: number;
|
|
46182
44364
|
/**
|
|
46183
|
-
*
|
|
44365
|
+
* Agent-level currently effective version used by new sessions and newly issued embed tokens. This same value appears on every history item; it is not that item's version. Saving with apply false leaves it unchanged. Existing sessions and tokens retain their version.
|
|
46184
44366
|
*/
|
|
46185
44367
|
active_version: number;
|
|
46186
44368
|
/**
|
|
@@ -46707,9 +44889,7 @@ export type AgentsCreateData = {
|
|
|
46707
44889
|
*/
|
|
46708
44890
|
metadata?: AgentManaged8Writable;
|
|
46709
44891
|
/**
|
|
46710
|
-
* A
|
|
46711
|
-
* work by spawning session threads, each running an agent drawn from the `agents`
|
|
46712
|
-
* roster.
|
|
44892
|
+
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
46713
44893
|
*/
|
|
46714
44894
|
multiagent?: null | AgentManaged9;
|
|
46715
44895
|
/**
|
|
@@ -47232,7 +45412,7 @@ export type AgentsCreateResponses = {
|
|
|
47232
45412
|
};
|
|
47233
45413
|
};
|
|
47234
45414
|
/**
|
|
47235
|
-
*
|
|
45415
|
+
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
47236
45416
|
*/
|
|
47237
45417
|
multiagent: null | AgentManaged39;
|
|
47238
45418
|
/**
|
|
@@ -47260,12 +45440,11 @@ export type AgentsCreateResponses = {
|
|
|
47260
45440
|
*/
|
|
47261
45441
|
updated_at: string;
|
|
47262
45442
|
/**
|
|
47263
|
-
*
|
|
47264
|
-
* modified.
|
|
45443
|
+
* Version of this returned configuration. Default retrieve returns the effective version; an explicit version query or a version-history item returns that saved version.
|
|
47265
45444
|
*/
|
|
47266
45445
|
version: number;
|
|
47267
45446
|
/**
|
|
47268
|
-
*
|
|
45447
|
+
* Agent-level currently effective version used by new sessions and newly issued embed tokens. This same value appears on every history item; it is not that item's version. Saving with apply false leaves it unchanged. Existing sessions and tokens retain their version.
|
|
47269
45448
|
*/
|
|
47270
45449
|
active_version: number;
|
|
47271
45450
|
/**
|
|
@@ -47741,8 +45920,8 @@ export type AgentsRetrieveData = {
|
|
|
47741
45920
|
};
|
|
47742
45921
|
query?: {
|
|
47743
45922
|
/**
|
|
47744
|
-
* Agent version. Omit for the
|
|
47745
|
-
*
|
|
45923
|
+
* Agent version to read. Omit, or pass active, for the effective version.
|
|
45924
|
+
* Pass an integer of at least 1 to read that saved version.
|
|
47746
45925
|
*/
|
|
47747
45926
|
version?: number;
|
|
47748
45927
|
};
|
|
@@ -47828,7 +46007,7 @@ export type AgentsRetrieveResponses = {
|
|
|
47828
46007
|
};
|
|
47829
46008
|
};
|
|
47830
46009
|
/**
|
|
47831
|
-
*
|
|
46010
|
+
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
47832
46011
|
*/
|
|
47833
46012
|
multiagent: null | AgentManaged39;
|
|
47834
46013
|
/**
|
|
@@ -47856,12 +46035,15 @@ export type AgentsRetrieveResponses = {
|
|
|
47856
46035
|
*/
|
|
47857
46036
|
updated_at: string;
|
|
47858
46037
|
/**
|
|
47859
|
-
*
|
|
47860
|
-
* modified.
|
|
46038
|
+
* Version of this returned configuration. Default retrieve returns the effective version; an explicit version query or a version-history item returns that saved version.
|
|
47861
46039
|
*/
|
|
47862
46040
|
version: number;
|
|
47863
46041
|
/**
|
|
47864
|
-
*
|
|
46042
|
+
* Newest saved version number, including an unapplied save. Returned by default retrieve, update and apply; use it for optimistic concurrency when updating.
|
|
46043
|
+
*/
|
|
46044
|
+
latest_version?: number;
|
|
46045
|
+
/**
|
|
46046
|
+
* Agent-level currently effective version used by new sessions and newly issued embed tokens. This same value appears on every history item; it is not that item's version. Saving with apply false leaves it unchanged. Existing sessions and tokens retain their version.
|
|
47865
46047
|
*/
|
|
47866
46048
|
active_version: number;
|
|
47867
46049
|
/**
|
|
@@ -48380,9 +46562,7 @@ export type AgentsUpdateData = {
|
|
|
48380
46562
|
};
|
|
48381
46563
|
};
|
|
48382
46564
|
/**
|
|
48383
|
-
* A
|
|
48384
|
-
* work by spawning session threads, each running an agent drawn from the `agents`
|
|
48385
|
-
* roster.
|
|
46565
|
+
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
48386
46566
|
*/
|
|
48387
46567
|
multiagent?: null | AgentManaged9;
|
|
48388
46568
|
/**
|
|
@@ -48404,20 +46584,17 @@ export type AgentsUpdateData = {
|
|
|
48404
46584
|
*/
|
|
48405
46585
|
tools?: null | Array<AgentManaged15 | AgentManaged29 | AgentManaged32>;
|
|
48406
46586
|
/**
|
|
48407
|
-
*
|
|
48408
|
-
* Obtain this value from a create or retrieve response. Must be at least 1 if
|
|
48409
|
-
* specified. When supplied, the request fails if it does not match the server's
|
|
48410
|
-
* current version; omit to apply the update unconditionally.
|
|
46587
|
+
* Newest saved version used for optimistic concurrency. Obtain latest_version from the default retrieve or update response, or version from versions.list. A stale value returns 409; omit for an unconditional update.
|
|
48411
46588
|
*/
|
|
48412
46589
|
version?: number;
|
|
48413
46590
|
/**
|
|
48414
|
-
* Defaults to true: apply
|
|
46591
|
+
* Defaults to true: apply a newly saved configuration version. Set false to save without changing active_version. An unchanged configuration is a no-op, including note-only updates; use versions.apply to activate a saved version.
|
|
48415
46592
|
*/
|
|
48416
46593
|
apply?: boolean;
|
|
48417
46594
|
/**
|
|
48418
|
-
* Optional change explanation
|
|
46595
|
+
* Optional change explanation, at most 280 characters. Recorded only when a configuration change creates a new immutable version. A note-only update is a no-op returning 200 and the current effective version. Null is equivalent to omission.
|
|
48419
46596
|
*/
|
|
48420
|
-
version_note?: string;
|
|
46597
|
+
version_note?: string | null;
|
|
48421
46598
|
/**
|
|
48422
46599
|
* Replace the whole bindings list; omission preserves it, and null or [] clears it. Additions apply only to new sessions; once this version is applied, disabling, removing or downgrading a binding revokes it immediately in running sessions on older versions, while apply=false changes no access. Only service agents accept a nonempty list.
|
|
48423
46600
|
*/
|
|
@@ -48934,7 +47111,7 @@ export type AgentsUpdateResponses = {
|
|
|
48934
47111
|
};
|
|
48935
47112
|
};
|
|
48936
47113
|
/**
|
|
48937
|
-
*
|
|
47114
|
+
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
48938
47115
|
*/
|
|
48939
47116
|
multiagent: null | AgentManaged39;
|
|
48940
47117
|
/**
|
|
@@ -48962,12 +47139,15 @@ export type AgentsUpdateResponses = {
|
|
|
48962
47139
|
*/
|
|
48963
47140
|
updated_at: string;
|
|
48964
47141
|
/**
|
|
48965
|
-
*
|
|
48966
|
-
* modified.
|
|
47142
|
+
* Version of this returned configuration. Default retrieve returns the effective version; an explicit version query or a version-history item returns that saved version.
|
|
48967
47143
|
*/
|
|
48968
47144
|
version: number;
|
|
48969
47145
|
/**
|
|
48970
|
-
*
|
|
47146
|
+
* Newest saved version number, including an unapplied save. Returned by default retrieve, update and apply; use it for optimistic concurrency when updating.
|
|
47147
|
+
*/
|
|
47148
|
+
latest_version?: number;
|
|
47149
|
+
/**
|
|
47150
|
+
* Agent-level currently effective version used by new sessions and newly issued embed tokens. This same value appears on every history item; it is not that item's version. Saving with apply false leaves it unchanged. Existing sessions and tokens retain their version.
|
|
48971
47151
|
*/
|
|
48972
47152
|
active_version: number;
|
|
48973
47153
|
/**
|
|
@@ -49520,7 +47700,7 @@ export type AgentsArchiveResponses = {
|
|
|
49520
47700
|
};
|
|
49521
47701
|
};
|
|
49522
47702
|
/**
|
|
49523
|
-
*
|
|
47703
|
+
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
49524
47704
|
*/
|
|
49525
47705
|
multiagent: null | AgentManaged39;
|
|
49526
47706
|
/**
|
|
@@ -49548,12 +47728,11 @@ export type AgentsArchiveResponses = {
|
|
|
49548
47728
|
*/
|
|
49549
47729
|
updated_at: string;
|
|
49550
47730
|
/**
|
|
49551
|
-
*
|
|
49552
|
-
* modified.
|
|
47731
|
+
* Version of this returned configuration. Default retrieve returns the effective version; an explicit version query or a version-history item returns that saved version.
|
|
49553
47732
|
*/
|
|
49554
47733
|
version: number;
|
|
49555
47734
|
/**
|
|
49556
|
-
*
|
|
47735
|
+
* Agent-level currently effective version used by new sessions and newly issued embed tokens. This same value appears on every history item; it is not that item's version. Saving with apply false leaves it unchanged. Existing sessions and tokens retain their version.
|
|
49557
47736
|
*/
|
|
49558
47737
|
active_version: number;
|
|
49559
47738
|
/**
|
|
@@ -50061,7 +48240,7 @@ export type AgentsVersionsListResponses = {
|
|
|
50061
48240
|
*/
|
|
50062
48241
|
200: {
|
|
50063
48242
|
/**
|
|
50064
|
-
*
|
|
48243
|
+
* Saved agent configurations in ascending version number, oldest first. Each own-face item carries the same agent-level active_version.
|
|
50065
48244
|
*/
|
|
50066
48245
|
data: Array<{
|
|
50067
48246
|
/**
|
|
@@ -50120,7 +48299,7 @@ export type AgentsVersionsListResponses = {
|
|
|
50120
48299
|
};
|
|
50121
48300
|
};
|
|
50122
48301
|
/**
|
|
50123
|
-
*
|
|
48302
|
+
* Coordinator roster. A bare string agent id is equivalent to {type: "agent", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: "self"} refers to this agent. Specify a concrete version to pin it explicitly.
|
|
50124
48303
|
*/
|
|
50125
48304
|
multiagent: null | AgentManaged39;
|
|
50126
48305
|
/**
|
|
@@ -50148,12 +48327,11 @@ export type AgentsVersionsListResponses = {
|
|
|
50148
48327
|
*/
|
|
50149
48328
|
updated_at: string;
|
|
50150
48329
|
/**
|
|
50151
|
-
*
|
|
50152
|
-
* modified.
|
|
48330
|
+
* Version of this returned configuration. Default retrieve returns the effective version; an explicit version query or a version-history item returns that saved version.
|
|
50153
48331
|
*/
|
|
50154
48332
|
version: number;
|
|
50155
48333
|
/**
|
|
50156
|
-
*
|
|
48334
|
+
* Agent-level currently effective version used by new sessions and newly issued embed tokens. This same value appears on every history item; it is not that item's version. Saving with apply false leaves it unchanged. Existing sessions and tokens retain their version.
|
|
50157
48335
|
*/
|
|
50158
48336
|
active_version: number;
|
|
50159
48337
|
/**
|