One read of Claude Developer Platformapi-20260820T170710Z
229 pages moved out of 583 read.
Pages moved
229
significant first
Pages read
583
in this capture
Captured
17:07 UTC
Corpus hash
9cf0330dc487
corpus-hash
What this read moved
26-50 of 229, page 2 of 10This capture is too large to show at once. Changes 26-50 of 229 are below, significant first; the rest are on the following screens.
api/beta/dreams/create Changed · +57 / -8 lines
from line 17
1717
1818 - `string`
1919
20 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
20 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
2121
2222 - `"message-batches-2024-09-24"`
2323
from line 63
6363
6464 - `"user-profiles-2026-03-24"`
6565
66 - `"user-profiles-2026-08-18"`
67
6668 - `"advisor-tool-2026-03-01"`
6769
6870 - `"managed-agents-2026-04-01"`
from line 93
9193
9294 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
9395
94 An input memory store the dream reads from. The dream never mutates this store.
96 An input memory store the dream reads from. The dream never mutates this store unless it is also the destination: with output_behavior {type: "update_existing"} the job consolidates this store in place.
9597
9698 - `memory_store_id: string`
9799
from line 123
121123
122124 - `id: string`
123125
124 Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
126 Model identifier, e.g. "claude-opus-5". 1-256 characters.
125127
126128 - `speed: optional "standard" or "fast" or null`
127129
from line 135
133135
134136- `instructions: optional string or null`
135137
138- `output_behavior: optional BetaOutputBehavior`
139
140 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
141
142 - `BetaOutputBehaviorCreateNew object { type }`
143
144 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
145
146 - `type: "create_new"`
147
148 - `"create_new"`
149
150 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
151
152 The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place.
153
154 - `memory_store_id: string`
155
156 - `type: "update_existing"`
157
158 - `"update_existing"`
159
136160### Returns
137161
138- `BetaDream object { id, archived_at, created_at, 10 more }`
162- `BetaDream object { id, archived_at, created_at, 11 more }`
139163
140 An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into a new output memory store. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.
164 An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into an output memory store — a new store by default, or an existing store chosen via output_behavior. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.
141165
142166 - `id: string`
143167
from line 189
165189
166190 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
167191
168 An input memory store the dream reads from. The dream never mutates this store.
192 An input memory store the dream reads from. The dream never mutates this store unless it is also the destination: with output_behavior {type: "update_existing"} the job consolidates this store in place.
169193
170194 - `memory_store_id: string`
171195
from line 215
191215
192216 - `id: string`
193217
194 Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
218 Model identifier, e.g. "claude-opus-5". 1-256 characters.
195219
196220 - `speed: optional "standard" or "fast"`
197221
from line 225
201225
202226 - `"fast"`
203227
228 - `output_behavior: BetaOutputBehavior`
229
230 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
231
232 - `BetaOutputBehaviorCreateNew object { type }`
233
234 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
235
236 - `type: "create_new"`
237
238 - `"create_new"`
239
240 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
241
242 The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place.
243
244 - `memory_store_id: string`
245
246 - `type: "update_existing"`
247
248 - `"update_existing"`
249
204250 - `outputs: array of BetaDreamOutput`
205251
206252 - `memory_store_id: string`
from line 336
290336 "model": {
291337 "id": "x",
292338 "speed": "standard"
339 },
340 "output_behavior": {
341 "type": "create_new"
293342 },
294343 "outputs": [
295344 {
api/beta/dreams/list Changed · +30 / -3 lines
from line 53
5353
5454 - `string`
5555
56 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
56 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
5757
5858 - `"message-batches-2024-09-24"`
5959
from line 99
9999
100100 - `"user-profiles-2026-03-24"`
101101
102 - `"user-profiles-2026-08-18"`
103
102104 - `"advisor-tool-2026-03-01"`
103105
104106 - `"managed-agents-2026-04-01"`
from line 153
151153
152154 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
153155
154 An input memory store the dream reads from. The dream never mutates this store.
156 An input memory store the dream reads from. The dream never mutates this store unless it is also the destination: with output_behavior {type: "update_existing"} the job consolidates this store in place.
155157
156158 - `memory_store_id: string`
157159
from line 179
177179
178180 - `id: string`
179181
180 Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
182 Model identifier, e.g. "claude-opus-5". 1-256 characters.
181183
182184 - `speed: optional "standard" or "fast"`
183185
from line 189
187189
188190 - `"fast"`
189191
192 - `output_behavior: BetaOutputBehavior`
193
194 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
195
196 - `BetaOutputBehaviorCreateNew object { type }`
197
198 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
199
200 - `type: "create_new"`
201
202 - `"create_new"`
203
204 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
205
206 The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place.
207
208 - `memory_store_id: string`
209
210 - `type: "update_existing"`
211
212 - `"update_existing"`
213
190214 - `outputs: array of BetaDreamOutput`
191215
192216 - `memory_store_id: string`
from line 294
270294 "model": {
271295 "id": "x",
272296 "speed": "standard"
297 },
298 "output_behavior": {
299 "type": "create_new"
273300 },
274301 "outputs": [
275302 {
api/beta/dreams/retrieve Changed · +33 / -6 lines
from line 21
2121
2222 - `string`
2323
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
2525
2626 - `"message-batches-2024-09-24"`
2727
from line 67
6767
6868 - `"user-profiles-2026-03-24"`
6969
70 - `"user-profiles-2026-08-18"`
71
7072 - `"advisor-tool-2026-03-01"`
7173
7274 - `"managed-agents-2026-04-01"`
from line 93
9193
9294### Returns
9395
94- `BetaDream object { id, archived_at, created_at, 10 more }`
96- `BetaDream object { id, archived_at, created_at, 11 more }`
9597
96 An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into a new output memory store. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.
98 An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into an output memory store — a new store by default, or an existing store chosen via output_behavior. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.
9799
98100 - `id: string`
99101
from line 123
121123
122124 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
123125
124 An input memory store the dream reads from. The dream never mutates this store.
126 An input memory store the dream reads from. The dream never mutates this store unless it is also the destination: with output_behavior {type: "update_existing"} the job consolidates this store in place.
125127
126128 - `memory_store_id: string`
127129
from line 149
147149
148150 - `id: string`
149151
150 Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
152 Model identifier, e.g. "claude-opus-5". 1-256 characters.
151153
152154 - `speed: optional "standard" or "fast"`
153155
from line 159
157159
158160 - `"fast"`
159161
162 - `output_behavior: BetaOutputBehavior`
163
164 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
165
166 - `BetaOutputBehaviorCreateNew object { type }`
167
168 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
169
170 - `type: "create_new"`
171
172 - `"create_new"`
173
174 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
175
176 The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place.
177
178 - `memory_store_id: string`
179
180 - `type: "update_existing"`
181
182 - `"update_existing"`
183
160184 - `outputs: array of BetaDreamOutput`
161185
162186 - `memory_store_id: string`
from line 260
236260 "model": {
237261 "id": "x",
238262 "speed": "standard"
263 },
264 "output_behavior": {
265 "type": "create_new"
239266 },
240267 "outputs": [
241268 {
api/beta/environments Changed · +61 / -33 lines
from line 19
1919
2020 - `string`
2121
22 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
22 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
2323
2424 - `"message-batches-2024-09-24"`
2525
from line 65
6565
6666 - `"user-profiles-2026-03-24"`
6767
68 - `"user-profiles-2026-08-18"`
69
6870 - `"advisor-tool-2026-03-01"`
6971
7072 - `"managed-agents-2026-04-01"`
from line 325
323325
324326 RFC 3339 timestamp when environment was created
325327
326 - `description: string`
328 - `description: string or null`
327329
328 User-provided description for the environment
330 User-provided description for the environment; null when unset
329331
330332 - `metadata: map[string]`
331333
from line 462
460462
461463 - `string`
462464
463 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
465 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
464466
465467 - `"message-batches-2024-09-24"`
466468
from line 508
506508
507509 - `"user-profiles-2026-03-24"`
508510
511 - `"user-profiles-2026-08-18"`
512
509513 - `"advisor-tool-2026-03-01"`
510514
511515 - `"managed-agents-2026-04-01"`
from line 644
640644
641645 RFC 3339 timestamp when environment was created
642646
643 - `description: string`
647 - `description: string or null`
644648
645 User-provided description for the environment
649 User-provided description for the environment; null when unset
646650
647651 - `metadata: map[string]`
648652
from line 759
755759
756760 - `string`
757761
758 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
762 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
759763
760764 - `"message-batches-2024-09-24"`
761765
from line 805
801805
802806 - `"user-profiles-2026-03-24"`
803807
808 - `"user-profiles-2026-08-18"`
809
804810 - `"advisor-tool-2026-03-01"`
805811
806812 - `"managed-agents-2026-04-01"`
from line 941
935941
936942 RFC 3339 timestamp when environment was created
937943
938 - `description: string`
944 - `description: string or null`
939945
940 User-provided description for the environment
946 User-provided description for the environment; null when unset
941947
942948 - `metadata: map[string]`
943949
from line 1047
10411047
10421048 - `string`
10431049
1044 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
1050 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
10451051
10461052 - `"message-batches-2024-09-24"`
10471053
from line 1093
10871093
10881094 - `"user-profiles-2026-03-24"`
10891095
1096 - `"user-profiles-2026-08-18"`
1097
10901098 - `"advisor-tool-2026-03-01"`
10911099
10921100 - `"managed-agents-2026-04-01"`
from line 1223
12151223
12161224- `description: optional string or null`
12171225
1218 Updated description of the environment
1226 Updated description of the environment. Omit to preserve; null clears to null; an empty string is stored as an empty string.
12191227
12201228- `metadata: optional map[string]`
12211229
from line 1353
13451353
13461354 RFC 3339 timestamp when environment was created
13471355
1348 - `description: string`
1356 - `description: string or null`
13491357
1350 User-provided description for the environment
1358 User-provided description for the environment; null when unset
13511359
13521360 - `metadata: map[string]`
13531361
from line 1463
14551463
14561464 - `string`
14571465
1458 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
1466 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
14591467
14601468 - `"message-batches-2024-09-24"`
14611469
from line 1509
15011509
15021510 - `"user-profiles-2026-03-24"`
15031511
1512 - `"user-profiles-2026-08-18"`
1513
15041514 - `"advisor-tool-2026-03-01"`
15051515
15061516 - `"managed-agents-2026-04-01"`
from line 1586
15761586
15771587 - `string`
15781588
1579 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
1589 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
15801590
15811591 - `"message-batches-2024-09-24"`
15821592
from line 1632
16221632
16231633 - `"user-profiles-2026-03-24"`
16241634
1635 - `"user-profiles-2026-08-18"`
1636
16251637 - `"advisor-tool-2026-03-01"`
16261638
16271639 - `"managed-agents-2026-04-01"`
from line 1768
17561768
17571769 RFC 3339 timestamp when environment was created
17581770
1759 - `description: string`
1771 - `description: string or null`
17601772
1761 User-provided description for the environment
1773 User-provided description for the environment; null when unset
17621774
17631775 - `metadata: map[string]`
17641776
from line 2143
21312143
21322144 RFC 3339 timestamp when environment was created
21332145
2134 - `description: string`
2146 - `description: string or null`
21352147
2136 User-provided description for the environment
2148 User-provided description for the environment; null when unset
21372149
21382150 - `metadata: map[string]`
21392151
from line 2374
23622374
23632375 - `string`
23642376
2365 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
2377 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
23662378
23672379 - `"message-batches-2024-09-24"`
23682380
from line 2420
24082420
24092421 - `"user-profiles-2026-03-24"`
24102422
2423 - `"user-profiles-2026-08-18"`
2424
24112425 - `"advisor-tool-2026-03-01"`
24122426
24132427 - `"managed-agents-2026-04-01"`
from line 2592
25782592
25792593 - `string`
25802594
2581 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
2595 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
25822596
25832597 - `"message-batches-2024-09-24"`
25842598
from line 2638
26242638
26252639 - `"user-profiles-2026-03-24"`
26262640
2641 - `"user-profiles-2026-08-18"`
2642
26272643 - `"advisor-tool-2026-03-01"`
26282644
26292645 - `"managed-agents-2026-04-01"`
from line 2806
27902806
27912807 - `string`
27922808
2793 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
2809 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
27942810
27952811 - `"message-batches-2024-09-24"`
27962812
from line 2852
28362852
28372853 - `"user-profiles-2026-03-24"`
28382854
2855 - `"user-profiles-2026-08-18"`
2856
28392857 - `"advisor-tool-2026-03-01"`
28402858
28412859 - `"managed-agents-2026-04-01"`
from line 3027
30093027
30103028 - `string`
30113029
3012 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
3030 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
30133031
30143032 - `"message-batches-2024-09-24"`
30153033
from line 3073
30553073
30563074 - `"user-profiles-2026-03-24"`
30573075
3076 - `"user-profiles-2026-08-18"`
3077
30583078 - `"advisor-tool-2026-03-01"`
30593079
30603080 - `"managed-agents-2026-04-01"`
from line 3179
31593179
31603180 - `string`
31613181
3162 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
3182 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
31633183
31643184 - `"message-batches-2024-09-24"`
31653185
from line 3225
32053225
32063226 - `"user-profiles-2026-03-24"`
32073227
3228 - `"user-profiles-2026-08-18"`
3229
32083230 - `"advisor-tool-2026-03-01"`
32093231
32103232 - `"managed-agents-2026-04-01"`
from line 3405
33833405
33843406 - `string`
33853407
3386 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
3408 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
33873409
33883410 - `"message-batches-2024-09-24"`
33893411
from line 3451
34293451
34303452 - `"user-profiles-2026-03-24"`
34313453
3454 - `"user-profiles-2026-08-18"`
3455
34323456 - `"advisor-tool-2026-03-01"`
34333457
34343458 - `"managed-agents-2026-04-01"`
from line 3624
36003624
36013625 - `string`
36023626
3603 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
3627 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
36043628
36053629 - `"message-batches-2024-09-24"`
36063630
from line 3670
36463670
36473671 - `"user-profiles-2026-03-24"`
36483672
3673 - `"user-profiles-2026-08-18"`
3674
36493675 - `"advisor-tool-2026-03-01"`
36503676
36513677 - `"managed-agents-2026-04-01"`
from line 3842
38163842
38173843 - `string`
38183844
3819 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
3845 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
38203846
38213847 - `"message-batches-2024-09-24"`
38223848
from line 3887
38613887 - `"output-300k-2026-03-24"`
38623888
38633889 - `"user-profiles-2026-03-24"`
3890
3891 - `"user-profiles-2026-08-18"`
38643892
38653893 - `"advisor-tool-2026-03-01"`
38663894
api/beta/environments/archive Changed · +6 / -4 lines
from line 21
2121
2222 - `string`
2323
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
2525
2626 - `"message-batches-2024-09-24"`
2727
from line 67
6767
6868 - `"user-profiles-2026-03-24"`
6969
70 - `"user-profiles-2026-08-18"`
71
7072 - `"advisor-tool-2026-03-01"`
7173
7274 - `"managed-agents-2026-04-01"`
from line 203
201203
202204 RFC 3339 timestamp when environment was created
203205
204 - `description: string`
206 - `description: string or null`
205207
206 User-provided description for the environment
208 User-provided description for the environment; null when unset
207209
208210 - `metadata: map[string]`
209211
api/beta/environments/create Changed · +6 / -4 lines
from line 17
1717
1818 - `string`
1919
20 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
20 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
2121
2222 - `"message-batches-2024-09-24"`
2323
from line 63
6363
6464 - `"user-profiles-2026-03-24"`
6565
66 - `"user-profiles-2026-08-18"`
67
6668 - `"advisor-tool-2026-03-01"`
6769
6870 - `"managed-agents-2026-04-01"`
from line 323
321323
322324 RFC 3339 timestamp when environment was created
323325
324 - `description: string`
326 - `description: string or null`
325327
326 User-provided description for the environment
328 User-provided description for the environment; null when unset
327329
328330 - `metadata: map[string]`
329331
api/beta/environments/list Changed · +6 / -4 lines
from line 31
3131
3232 - `string`
3333
34 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
34 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
3535
3636 - `"message-batches-2024-09-24"`
3737
from line 77
7777
7878 - `"user-profiles-2026-03-24"`
7979
80 - `"user-profiles-2026-08-18"`
81
8082 - `"advisor-tool-2026-03-01"`
8183
8284 - `"managed-agents-2026-04-01"`
from line 213
211213
212214 RFC 3339 timestamp when environment was created
213215
214 - `description: string`
216 - `description: string or null`
215217
216 User-provided description for the environment
218 User-provided description for the environment; null when unset
217219
218220 - `metadata: map[string]`
219221
api/beta/environments/retrieve Changed · +6 / -4 lines
from line 21
2121
2222 - `string`
2323
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
2525
2626 - `"message-batches-2024-09-24"`
2727
from line 67
6767
6868 - `"user-profiles-2026-03-24"`
6969
70 - `"user-profiles-2026-08-18"`
71
7072 - `"advisor-tool-2026-03-01"`
7173
7274 - `"managed-agents-2026-04-01"`
from line 203
201203
202204 RFC 3339 timestamp when environment was created
203205
204 - `description: string`
206 - `description: string or null`
205207
206 User-provided description for the environment
208 User-provided description for the environment; null when unset
207209
208210 - `metadata: map[string]`
209211
api/beta/environments/update Changed · +7 / -5 lines
from line 21
2121
2222 - `string`
2323
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
2525
2626 - `"message-batches-2024-09-24"`
2727
from line 67
6767
6868 - `"user-profiles-2026-03-24"`
6969
70 - `"user-profiles-2026-08-18"`
71
7072 - `"advisor-tool-2026-03-01"`
7173
7274 - `"managed-agents-2026-04-01"`
from line 197
195197
196198- `description: optional string or null`
197199
198 Updated description of the environment
200 Updated description of the environment. Omit to preserve; null clears to null; an empty string is stored as an empty string.
199201
200202- `metadata: optional map[string]`
201203
from line 327
325327
326328 RFC 3339 timestamp when environment was created
327329
328 - `description: string`
330 - `description: string or null`
329331
330 User-provided description for the environment
332 User-provided description for the environment; null when unset
331333
332334 - `metadata: map[string]`
333335
api/beta/environments/work Changed · +24 / -8 lines
from line 27
2727
2828 - `string`
2929
30 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
30 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
3131
3232 - `"message-batches-2024-09-24"`
3333
from line 73
7373
7474 - `"user-profiles-2026-03-24"`
7575
76 - `"user-profiles-2026-08-18"`
77
7678 - `"advisor-tool-2026-03-01"`
7779
7880 - `"managed-agents-2026-04-01"`
from line 245
243245
244246 - `string`
245247
246 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
248 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
247249
248250 - `"message-batches-2024-09-24"`
249251
from line 291
289291
290292 - `"user-profiles-2026-03-24"`
291293
294 - `"user-profiles-2026-08-18"`
295
292296 - `"advisor-tool-2026-03-01"`
293297
294298 - `"managed-agents-2026-04-01"`
from line 459
455459
456460 - `string`
457461
458 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
462 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
459463
460464 - `"message-batches-2024-09-24"`
461465
from line 505
501505
502506 - `"user-profiles-2026-03-24"`
503507
508 - `"user-profiles-2026-08-18"`
509
504510 - `"advisor-tool-2026-03-01"`
505511
506512 - `"managed-agents-2026-04-01"`
from line 680
674680
675681 - `string`
676682
677 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
683 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
678684
679685 - `"message-batches-2024-09-24"`
680686
from line 726
720726
721727 - `"user-profiles-2026-03-24"`
722728
729 - `"user-profiles-2026-08-18"`
730
723731 - `"advisor-tool-2026-03-01"`
724732
725733 - `"managed-agents-2026-04-01"`
from line 832
824832
825833 - `string`
826834
827 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
835 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
828836
829837 - `"message-batches-2024-09-24"`
830838
from line 878
870878
871879 - `"user-profiles-2026-03-24"`
872880
881 - `"user-profiles-2026-08-18"`
882
873883 - `"advisor-tool-2026-03-01"`
874884
875885 - `"managed-agents-2026-04-01"`
from line 1058
10481058
10491059 - `string`
10501060
1051 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
1061 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
10521062
10531063 - `"message-batches-2024-09-24"`
10541064
from line 1104
10941104
10951105 - `"user-profiles-2026-03-24"`
10961106
1107 - `"user-profiles-2026-08-18"`
1108
10971109 - `"advisor-tool-2026-03-01"`
10981110
10991111 - `"managed-agents-2026-04-01"`
from line 1277
12651277
12661278 - `string`
12671279
1268 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
1280 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
12691281
12701282 - `"message-batches-2024-09-24"`
12711283
from line 1323
13111323
13121324 - `"user-profiles-2026-03-24"`
13131325
1326 - `"user-profiles-2026-08-18"`
1327
13141328 - `"advisor-tool-2026-03-01"`
13151329
13161330 - `"managed-agents-2026-04-01"`
from line 1495
14811495
14821496 - `string`
14831497
1484 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
1498 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
14851499
14861500 - `"message-batches-2024-09-24"`
14871501
from line 1540
15261540 - `"output-300k-2026-03-24"`
15271541
15281542 - `"user-profiles-2026-03-24"`
1543
1544 - `"user-profiles-2026-08-18"`
15291545
15301546 - `"advisor-tool-2026-03-01"`
15311547
api/beta/files Changed · +87 / -77 lines
### Beta Deleted File ### Beta File Metadata ### Deleted File ### File Metadata
from line 19
1919
2020 - `string`
2121
22 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
22 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
2323
2424 - `"message-batches-2024-09-24"`
2525
from line 65
6565
6666 - `"user-profiles-2026-03-24"`
6767
68 - `"user-profiles-2026-08-18"`
69
6870 - `"advisor-tool-2026-03-01"`
6971
7072 - `"managed-agents-2026-04-01"`
from line 91
8991
9092### Returns
9193
92- `FileMetadata object { id, created_at, filename, 5 more }`
94- `BetaFileMetadata object { id, created_at, filename, 5 more }`
9395
9496 - `id: string`
9597
from line 204
202204
203205 - `string`
204206
205 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
207 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
206208
207209 - `"message-batches-2024-09-24"`
208210
from line 250
248250
249251 - `"user-profiles-2026-03-24"`
250252
253 - `"user-profiles-2026-08-18"`
254
251255 - `"advisor-tool-2026-03-01"`
252256
253257 - `"managed-agents-2026-04-01"`
from line 276
272276
273277### Returns
274278
275- `data: array of FileMetadata`
279- `data: array of BetaFileMetadata`
276280
277281 List of file metadata objects.
278282
from line 394
390394
391395 - `string`
392396
393 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
397 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
394398
395399 - `"message-batches-2024-09-24"`
396400
from line 440
436440
437441 - `"user-profiles-2026-03-24"`
438442
443 - `"user-profiles-2026-08-18"`
444
439445 - `"advisor-tool-2026-03-01"`
440446
441447 - `"managed-agents-2026-04-01"`
from line 493
487493
488494 - `string`
489495
490 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
496 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
491497
492498 - `"message-batches-2024-09-24"`
493499
from line 539
533539
534540 - `"user-profiles-2026-03-24"`
535541
542 - `"user-profiles-2026-08-18"`
543
536544 - `"advisor-tool-2026-03-01"`
537545
538546 - `"managed-agents-2026-04-01"`
from line 565
557565
558566### Returns
559567
560- `FileMetadata object { id, created_at, filename, 5 more }`
568- `BetaFileMetadata object { id, created_at, filename, 5 more }`
561569
562570 - `id: string`
563571
from line 662
654662
655663 - `string`
656664
657 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
665 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
658666
659667 - `"message-batches-2024-09-24"`
660668
from line 708
700708
701709 - `"user-profiles-2026-03-24"`
702710
711 - `"user-profiles-2026-08-18"`
712
703713 - `"advisor-tool-2026-03-01"`
704714
705715 - `"managed-agents-2026-04-01"`
from line 734
724734
725735### Returns
726736
727- `DeletedFile object { id, type }`
737- `BetaDeletedFile object { id, type }`
728738
729739 - `id: string`
730740
from line 769
759769
760770## Domain Types
761771
762### Beta File Scope
772### Beta Deleted File
763773
764- `BetaFileScope object { id, type }`
774- `BetaDeletedFile object { id, type }`
765775
766776 - `id: string`
767777
768 The ID of the scoping resource (e.g., the session ID).
769
770 - `type: "session"`
771
772 The type of scope (e.g., `"session"`).
773
774 - `"session"`
775
776### Deleted File
777
778- `DeletedFile object { id, type }`
779
780 - `id: string`
781
782778 ID of the deleted file.
783779
784780 - `type: optional "file_deleted"`
from line 785
789785
790786 - `"file_deleted"`
791787
792### File Metadata
788### Beta File Metadata
793789
794- `FileMetadata object { id, created_at, filename, 5 more }`
790- `BetaFileMetadata object { id, created_at, filename, 5 more }`
795791
796792 - `id: string`
797793
from line 836
840836 The type of scope (e.g., `"session"`).
841837
842838 - `"session"`
839
840### Beta File Scope
841
842- `BetaFileScope object { id, type }`
843
844 - `id: string`
845
846 The ID of the scoping resource (e.g., the session ID).
847
848 - `type: "session"`
849
850 The type of scope (e.g., `"session"`).
851
852 - `"session"`
843853
api/beta/files/delete Changed · +4 / -2 lines
from line 23
2323
2424 - `string`
2525
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
2727
2828 - `"message-batches-2024-09-24"`
2929
from line 69
6969
7070 - `"user-profiles-2026-03-24"`
7171
72 - `"user-profiles-2026-08-18"`
73
7274 - `"advisor-tool-2026-03-01"`
7375
7476 - `"managed-agents-2026-04-01"`
from line 95
9395
9496### Returns
9597
96- `DeletedFile object { id, type }`
98- `BetaDeletedFile object { id, type }`
9799
98100 - `id: string`
99101
api/beta/files/list Changed · +4 / -2 lines
from line 37
3737
3838 - `string`
3939
40 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
40 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
4141
4242 - `"message-batches-2024-09-24"`
4343
from line 83
8383
8484 - `"user-profiles-2026-03-24"`
8585
86 - `"user-profiles-2026-08-18"`
87
8688 - `"advisor-tool-2026-03-01"`
8789
8890 - `"managed-agents-2026-04-01"`
from line 109
107109
108110### Returns
109111
110- `data: array of FileMetadata`
112- `data: array of BetaFileMetadata`
111113
112114 List of file metadata objects.
113115
api/beta/files/retrieve_metadata Changed · +4 / -2 lines
from line 23
2323
2424 - `string`
2525
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
2727
2828 - `"message-batches-2024-09-24"`
2929
from line 69
6969
7070 - `"user-profiles-2026-03-24"`
7171
72 - `"user-profiles-2026-08-18"`
73
7274 - `"advisor-tool-2026-03-01"`
7375
7476 - `"managed-agents-2026-04-01"`
from line 95
9395
9496### Returns
9597
96- `FileMetadata object { id, created_at, filename, 5 more }`
98- `BetaFileMetadata object { id, created_at, filename, 5 more }`
9799
98100 - `id: string`
99101
api/beta/files/upload Changed · +4 / -2 lines
from line 17
1717
1818 - `string`
1919
20 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
20 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
2121
2222 - `"message-batches-2024-09-24"`
2323
from line 63
6363
6464 - `"user-profiles-2026-03-24"`
6565
66 - `"user-profiles-2026-08-18"`
67
6668 - `"advisor-tool-2026-03-01"`
6769
6870 - `"managed-agents-2026-04-01"`
from line 89
8789
8890### Returns
8991
90- `FileMetadata object { id, created_at, filename, 5 more }`
92- `BetaFileMetadata object { id, created_at, filename, 5 more }`
9193
9294 - `id: string`
9395
api/beta/memory_stores Changed · +121 / -15 lines
### Beta Managed Agents Service Account Actor
from line 19
1919
2020 - `string`
2121
22 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
22 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
2323
2424 - `"message-batches-2024-09-24"`
2525
from line 65
6565
6666 - `"user-profiles-2026-03-24"`
6767
68 - `"user-profiles-2026-08-18"`
69
6870 - `"advisor-tool-2026-03-01"`
6971
7072 - `"managed-agents-2026-04-01"`
from line 207
205207
206208 - `string`
207209
208 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
210 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
209211
210212 - `"message-batches-2024-09-24"`
211213
from line 253
251253
252254 - `"user-profiles-2026-03-24"`
253255
256 - `"user-profiles-2026-08-18"`
257
254258 - `"advisor-tool-2026-03-01"`
255259
256260 - `"managed-agents-2026-04-01"`
from line 368
364368
365369 - `string`
366370
367 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
371 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
368372
369373 - `"message-batches-2024-09-24"`
370374
from line 414
410414
411415 - `"user-profiles-2026-03-24"`
412416
417 - `"user-profiles-2026-08-18"`
418
413419 - `"advisor-tool-2026-03-01"`
414420
415421 - `"managed-agents-2026-04-01"`
from line 520
514520
515521 - `string`
516522
517 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
523 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
518524
519525 - `"message-batches-2024-09-24"`
520526
from line 566
560566
561567 - `"user-profiles-2026-03-24"`
562568
569 - `"user-profiles-2026-08-18"`
570
563571 - `"advisor-tool-2026-03-01"`
564572
565573 - `"managed-agents-2026-04-01"`
from line 688
680688
681689 - `string`
682690
683 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
691 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
684692
685693 - `"message-batches-2024-09-24"`
686694
from line 734
726734
727735 - `"user-profiles-2026-03-24"`
728736
737 - `"user-profiles-2026-08-18"`
738
729739 - `"advisor-tool-2026-03-01"`
730740
731741 - `"managed-agents-2026-04-01"`
from line 809
799809
800810 - `string`
801811
802 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
812 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
803813
804814 - `"message-batches-2024-09-24"`
805815
from line 855
845855
846856 - `"user-profiles-2026-03-24"`
847857
858 - `"user-profiles-2026-08-18"`
859
848860 - `"advisor-tool-2026-03-01"`
849861
850862 - `"managed-agents-2026-04-01"`
from line 1028
10161028
10171029 - `string`
10181030
1019 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
1031 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
10201032
10211033 - `"message-batches-2024-09-24"`
10221034
from line 1074
10621074
10631075 - `"user-profiles-2026-03-24"`
10641076
1077 - `"user-profiles-2026-08-18"`
1078
10651079 - `"advisor-tool-2026-03-01"`
10661080
10671081 - `"managed-agents-2026-04-01"`
from line 1229
12151229
12161230 - `string`
12171231
1218 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
1232 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
12191233
12201234 - `"message-batches-2024-09-24"`
12211235
from line 1275
12611275
12621276 - `"user-profiles-2026-03-24"`
12631277
1278 - `"user-profiles-2026-08-18"`
1279
12641280 - `"advisor-tool-2026-03-01"`
12651281
12661282 - `"managed-agents-2026-04-01"`
from line 1426
14101426
14111427 - `string`
14121428
1413 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
1429 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
14141430
14151431 - `"message-batches-2024-09-24"`
14161432
from line 1472
14561472
14571473 - `"user-profiles-2026-03-24"`
14581474
1475 - `"user-profiles-2026-08-18"`
1476
14591477 - `"advisor-tool-2026-03-01"`
14601478
14611479 - `"managed-agents-2026-04-01"`
from line 1598
15801598
15811599 - `string`
15821600
1583 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
1601 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
15841602
15851603 - `"message-batches-2024-09-24"`
15861604
from line 1644
16261644
16271645 - `"user-profiles-2026-03-24"`
16281646
1647 - `"user-profiles-2026-08-18"`
1648
16291649 - `"advisor-tool-2026-03-01"`
16301650
16311651 - `"managed-agents-2026-04-01"`
from line 1790
17701790
17711791 - `string`
17721792
1773 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
1793 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
17741794
17751795 - `"message-batches-2024-09-24"`
17761796
from line 1836
18161836
18171837 - `"user-profiles-2026-03-24"`
18181838
1839 - `"user-profiles-2026-08-18"`
1840
18191841 - `"advisor-tool-2026-03-01"`
18201842
18211843 - `"managed-agents-2026-04-01"`
from line 2255
22332255
22342256 Query parameter for page
22352257
2258- `service_account_id: optional string`
2259
2260 Query parameter for service_account_id
2261
22362262- `session_id: optional string`
22372263
22382264 Query parameter for session_id
from line 2279
22532279
22542280 - `string`
22552281
2256 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
2282 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
22572283
22582284 - `"message-batches-2024-09-24"`
22592285
from line 2325
22992325
23002326 - `"user-profiles-2026-03-24"`
23012327
2328 - `"user-profiles-2026-08-18"`
2329
23022330 - `"advisor-tool-2026-03-01"`
23032331
23042332 - `"managed-agents-2026-04-01"`
from line 2437
24092437
24102438 ID of the user who performed the write (a `user_...` value).
24112439
2440 - `BetaManagedAgentsServiceAccountActor object { service_account_id, type }`
2441
2442 Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation.
2443
2444 - `service_account_id: string`
2445
2446 ID of the service account that performed the write (a `svac_...` value).
2447
2448 - `type: "service_account_actor"`
2449
2450 - `"service_account_actor"`
2451
24122452 - `path: optional string or null`
24132453
24142454 The memory's path at the time of this write. `null` if and only if `redacted_at` is set.
from line 2535
24952535
24962536 - `string`
24972537
2498 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
2538 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
24992539
25002540 - `"message-batches-2024-09-24"`
25012541
from line 2581
25412581
25422582 - `"user-profiles-2026-03-24"`
25432583
2584 - `"user-profiles-2026-08-18"`
2585
25442586 - `"advisor-tool-2026-03-01"`
25452587
25462588 - `"managed-agents-2026-04-01"`
from line 2693
26512693
26522694 ID of the user who performed the write (a `user_...` value).
26532695
2696 - `BetaManagedAgentsServiceAccountActor object { service_account_id, type }`
2697
2698 Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation.
2699
2700 - `service_account_id: string`
2701
2702 ID of the service account that performed the write (a `svac_...` value).
2703
2704 - `type: "service_account_actor"`
2705
2706 - `"service_account_actor"`
2707
26542708 - `path: optional string or null`
26552709
26562710 The memory's path at the time of this write. `null` if and only if `redacted_at` is set.
from line 2772
27182772
27192773 - `string`
27202774
2721 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
2775 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
27222776
27232777 - `"message-batches-2024-09-24"`
27242778
from line 2818
27642818
27652819 - `"user-profiles-2026-03-24"`
27662820
2821 - `"user-profiles-2026-08-18"`
2822
27672823 - `"advisor-tool-2026-03-01"`
27682824
27692825 - `"managed-agents-2026-04-01"`
from line 2930
28742930
28752931 ID of the user who performed the write (a `user_...` value).
28762932
2933 - `BetaManagedAgentsServiceAccountActor object { service_account_id, type }`
2934
2935 Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation.
2936
2937 - `service_account_id: string`
2938
2939 ID of the service account that performed the write (a `svac_...` value).
2940
2941 - `type: "service_account_actor"`
2942
2943 - `"service_account_actor"`
2944
28772945 - `path: optional string or null`
28782946
28792947 The memory's path at the time of this write. `null` if and only if `redacted_at` is set.
from line 2994
29262994
29272995### Beta Managed Agents Actor
29282996
2929- `BetaManagedAgentsActor = BetaManagedAgentsSessionActor or BetaManagedAgentsAPIActor or BetaManagedAgentsUserActor`
2997- `BetaManagedAgentsActor = BetaManagedAgentsSessionActor or BetaManagedAgentsAPIActor or BetaManagedAgentsUserActor or BetaManagedAgentsServiceAccountActor`
29302998
29312999 Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve).
29323000
from line 3034
29663034
29673035 ID of the user who performed the write (a `user_...` value).
29683036
3037 - `BetaManagedAgentsServiceAccountActor object { service_account_id, type }`
3038
3039 Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation.
3040
3041 - `service_account_id: string`
3042
3043 ID of the service account that performed the write (a `svac_...` value).
3044
3045 - `type: "service_account_actor"`
3046
3047 - `"service_account_actor"`
3048
29693049### Beta Managed Agents API Actor
29703050
29713051- `BetaManagedAgentsAPIActor object { api_key_id, type }`
from line 3148
30683148
30693149 ID of the user who performed the write (a `user_...` value).
30703150
3151 - `BetaManagedAgentsServiceAccountActor object { service_account_id, type }`
3152
3153 Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation.
3154
3155 - `service_account_id: string`
3156
3157 ID of the service account that performed the write (a `svac_...` value).
3158
3159 - `type: "service_account_actor"`
3160
3161 - `"service_account_actor"`
3162
30713163 - `path: optional string or null`
30723164
30733165 The memory's path at the time of this write. `null` if and only if `redacted_at` is set.
from line 3183
30913183 - `"modified"`
30923184
30933185 - `"deleted"`
3186
3187### Beta Managed Agents Service Account Actor
3188
3189- `BetaManagedAgentsServiceAccountActor object { service_account_id, type }`
3190
3191 Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation.
3192
3193 - `service_account_id: string`
3194
3195 ID of the service account that performed the write (a `svac_...` value).
3196
3197 - `type: "service_account_actor"`
3198
3199 - `"service_account_actor"`
30943200
30953201### Beta Managed Agents Session Actor
30963202
api/beta/memory_stores/memories Changed · +15 / -5 lines
from line 33
3333
3434 - `string`
3535
36 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
36 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
3737
3838 - `"message-batches-2024-09-24"`
3939
from line 79
7979
8080 - `"user-profiles-2026-03-24"`
8181
82 - `"user-profiles-2026-08-18"`
83
8284 - `"advisor-tool-2026-03-01"`
8385
8486 - `"managed-agents-2026-04-01"`
from line 234
232234
233235 - `string`
234236
235 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
237 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
236238
237239 - `"message-batches-2024-09-24"`
238240
from line 280
278280
279281 - `"user-profiles-2026-03-24"`
280282
283 - `"user-profiles-2026-08-18"`
284
281285 - `"advisor-tool-2026-03-01"`
282286
283287 - `"managed-agents-2026-04-01"`
from line 431
427431
428432 - `string`
429433
430 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
434 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
431435
432436 - `"message-batches-2024-09-24"`
433437
from line 477
473477
474478 - `"user-profiles-2026-03-24"`
475479
480 - `"user-profiles-2026-08-18"`
481
476482 - `"advisor-tool-2026-03-01"`
477483
478484 - `"managed-agents-2026-04-01"`
from line 603
597603
598604 - `string`
599605
600 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
606 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
601607
602608 - `"message-batches-2024-09-24"`
603609
from line 649
643649
644650 - `"user-profiles-2026-03-24"`
645651
652 - `"user-profiles-2026-08-18"`
653
646654 - `"advisor-tool-2026-03-01"`
647655
648656 - `"managed-agents-2026-04-01"`
from line 795
787795
788796 - `string`
789797
790 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
798 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
791799
792800 - `"message-batches-2024-09-24"`
793801
from line 840
832840 - `"output-300k-2026-03-24"`
833841
834842 - `"user-profiles-2026-03-24"`
843
844 - `"user-profiles-2026-08-18"`
835845
836846 - `"advisor-tool-2026-03-01"`
837847
api/beta/memory_stores/memory_versions Changed · +88 / -4 lines
### Beta Managed Agents Service Account Actor
from line 51
5151
5252 Query parameter for page
5353
54- `service_account_id: optional string`
55
56 Query parameter for service_account_id
57
5458- `session_id: optional string`
5559
5660 Query parameter for session_id
from line 75
7175
7276 - `string`
7377
74 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
78 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
7579
7680 - `"message-batches-2024-09-24"`
7781
from line 121
117121
118122 - `"user-profiles-2026-03-24"`
119123
124 - `"user-profiles-2026-08-18"`
125
120126 - `"advisor-tool-2026-03-01"`
121127
122128 - `"managed-agents-2026-04-01"`
from line 233
227233
228234 ID of the user who performed the write (a `user_...` value).
229235
236 - `BetaManagedAgentsServiceAccountActor object { service_account_id, type }`
237
238 Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation.
239
240 - `service_account_id: string`
241
242 ID of the service account that performed the write (a `svac_...` value).
243
244 - `type: "service_account_actor"`
245
246 - `"service_account_actor"`
247
230248 - `path: optional string or null`
231249
232250 The memory's path at the time of this write. `null` if and only if `redacted_at` is set.
from line 331
313331
314332 - `string`
315333
316 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
334 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
317335
318336 - `"message-batches-2024-09-24"`
319337
from line 377
359377
360378 - `"user-profiles-2026-03-24"`
361379
380 - `"user-profiles-2026-08-18"`
381
362382 - `"advisor-tool-2026-03-01"`
363383
364384 - `"managed-agents-2026-04-01"`
from line 489
469489
470490 ID of the user who performed the write (a `user_...` value).
471491
492 - `BetaManagedAgentsServiceAccountActor object { service_account_id, type }`
493
494 Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation.
495
496 - `service_account_id: string`
497
498 ID of the service account that performed the write (a `svac_...` value).
499
500 - `type: "service_account_actor"`
501
502 - `"service_account_actor"`
503
472504 - `path: optional string or null`
473505
474506 The memory's path at the time of this write. `null` if and only if `redacted_at` is set.
from line 568
536568
537569 - `string`
538570
539 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
571 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
540572
541573 - `"message-batches-2024-09-24"`
542574
from line 614
582614
583615 - `"user-profiles-2026-03-24"`
584616
617 - `"user-profiles-2026-08-18"`
618
585619 - `"advisor-tool-2026-03-01"`
586620
587621 - `"managed-agents-2026-04-01"`
from line 726
692726
693727 ID of the user who performed the write (a `user_...` value).
694728
729 - `BetaManagedAgentsServiceAccountActor object { service_account_id, type }`
730
731 Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation.
732
733 - `service_account_id: string`
734
735 ID of the service account that performed the write (a `svac_...` value).
736
737 - `type: "service_account_actor"`
738
739 - `"service_account_actor"`
740
695741 - `path: optional string or null`
696742
697743 The memory's path at the time of this write. `null` if and only if `redacted_at` is set.
from line 790
744790
745791### Beta Managed Agents Actor
746792
747- `BetaManagedAgentsActor = BetaManagedAgentsSessionActor or BetaManagedAgentsAPIActor or BetaManagedAgentsUserActor`
793- `BetaManagedAgentsActor = BetaManagedAgentsSessionActor or BetaManagedAgentsAPIActor or BetaManagedAgentsUserActor or BetaManagedAgentsServiceAccountActor`
748794
749795 Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve).
750796
from line 830
784830
785831 ID of the user who performed the write (a `user_...` value).
786832
833 - `BetaManagedAgentsServiceAccountActor object { service_account_id, type }`
834
835 Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation.
836
837 - `service_account_id: string`
838
839 ID of the service account that performed the write (a `svac_...` value).
840
841 - `type: "service_account_actor"`
842
843 - `"service_account_actor"`
844
787845### Beta Managed Agents API Actor
788846
789847- `BetaManagedAgentsAPIActor object { api_key_id, type }`
from line 944
886944
887945 ID of the user who performed the write (a `user_...` value).
888946
947 - `BetaManagedAgentsServiceAccountActor object { service_account_id, type }`
948
949 Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation.
950
951 - `service_account_id: string`
952
953 ID of the service account that performed the write (a `svac_...` value).
954
955 - `type: "service_account_actor"`
956
957 - `"service_account_actor"`
958
889959 - `path: optional string or null`
890960
891961 The memory's path at the time of this write. `null` if and only if `redacted_at` is set.
from line 979
909979 - `"modified"`
910980
911981 - `"deleted"`
982
983### Beta Managed Agents Service Account Actor
984
985- `BetaManagedAgentsServiceAccountActor object { service_account_id, type }`
986
987 Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation.
988
989 - `service_account_id: string`
990
991 ID of the service account that performed the write (a `svac_...` value).
992
993 - `type: "service_account_actor"`
994
995 - `"service_account_actor"`
912996
913997### Beta Managed Agents Session Actor
914998
api/beta/memory_stores/memory_versions/list Changed · +19 / -1 lines
from line 49
4949
5050 Query parameter for page
5151
52- `service_account_id: optional string`
53
54 Query parameter for service_account_id
55
5256- `session_id: optional string`
5357
5458 Query parameter for session_id
from line 73
6973
7074 - `string`
7175
72 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
76 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
7377
7478 - `"message-batches-2024-09-24"`
7579
from line 119
115119
116120 - `"user-profiles-2026-03-24"`
117121
122 - `"user-profiles-2026-08-18"`
123
118124 - `"advisor-tool-2026-03-01"`
119125
120126 - `"managed-agents-2026-04-01"`
from line 230
224230 - `user_id: string`
225231
226232 ID of the user who performed the write (a `user_...` value).
233
234 - `BetaManagedAgentsServiceAccountActor object { service_account_id, type }`
235
236 Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation.
237
238 - `service_account_id: string`
239
240 ID of the service account that performed the write (a `svac_...` value).
241
242 - `type: "service_account_actor"`
243
244 - `"service_account_actor"`
227245
228246 - `path: optional string or null`
229247
api/beta/memory_stores/memory_versions/redact Changed · +15 / -1 lines
from line 23
2323
2424 - `string`
2525
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
2727
2828 - `"message-batches-2024-09-24"`
2929
from line 69
6969
7070 - `"user-profiles-2026-03-24"`
7171
72 - `"user-profiles-2026-08-18"`
73
7274 - `"advisor-tool-2026-03-01"`
7375
7476 - `"managed-agents-2026-04-01"`
from line 180
178180 - `user_id: string`
179181
180182 ID of the user who performed the write (a `user_...` value).
183
184 - `BetaManagedAgentsServiceAccountActor object { service_account_id, type }`
185
186 Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation.
187
188 - `service_account_id: string`
189
190 ID of the service account that performed the write (a `svac_...` value).
191
192 - `type: "service_account_actor"`
193
194 - `"service_account_actor"`
181195
182196 - `path: optional string or null`
183197
api/beta/memory_stores/memory_versions/retrieve Changed · +15 / -1 lines
from line 33
3333
3434 - `string`
3535
36 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
36 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
3737
3838 - `"message-batches-2024-09-24"`
3939
from line 79
7979
8080 - `"user-profiles-2026-03-24"`
8181
82 - `"user-profiles-2026-08-18"`
83
8284 - `"advisor-tool-2026-03-01"`
8385
8486 - `"managed-agents-2026-04-01"`
from line 190
188190 - `user_id: string`
189191
190192 ID of the user who performed the write (a `user_...` value).
193
194 - `BetaManagedAgentsServiceAccountActor object { service_account_id, type }`
195
196 Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation.
197
198 - `service_account_id: string`
199
200 ID of the service account that performed the write (a `svac_...` value).
201
202 - `type: "service_account_actor"`
203
204 - `"service_account_actor"`
191205
192206 - `path: optional string or null`
193207
api/beta/messages Changed · +6396 / -926 lines
### Beta Browser Close Tab Config ### Beta Browser Double Click Config ### Beta Browser File Upload Config ### Beta Browser Find Config ### Beta Browser Form Input Config ### Beta Browser Get Page Text Config ### Beta Browser Hold Key Config ### Beta Browser Hover Config ### Beta Browser Javascript Exec Config ### Beta Browser Key Config ### Beta Browser Left Click Config ### Beta Browser Left Click Drag Config ### Beta Browser Left Mouse Down Config ### Beta Browser Left Mouse Up Config ### Beta Browser List Tabs Config ### Beta Browser Middle Click Config ### Beta Browser Mouse Move Config ### Beta Browser Navigate Config ### Beta Browser New Tab Config ### Beta Browser Read Console Config ### Beta Browser Read Network Config ### Beta Browser Read Page Config ### Beta Browser Right Click Config ### Beta Browser Screenshot Config ### Beta Browser Scroll Config ### Beta Browser Scroll To Config ### Beta Browser State Block Param ### Beta Browser State Change ### Beta Browser State Change Download Completed ### Beta Browser State Change Download Failed ### Beta Browser State Change Download Started ### Beta Browser State Change Tab Opened ### Beta Browser State Tab Entry ### Beta Browser Switch Tab Config ### Beta Browser Toolset 20260801 ### Beta Browser Toolset Configs ### Beta Browser Triple Click Config ### Beta Browser Type Config ### Beta Browser Wait Config ### Beta Browser Zoom Config ### Beta Computer Cursor Position Config ### Beta Computer Double Click Config ### Beta Computer Hold Key Config ### Beta Computer Key Config ### Beta Computer Left Click Config ### Beta Computer Left Click Drag Config ### Beta Computer Left Mouse Down Config ### Beta Computer Left Mouse Up Config ### Beta Computer Middle Click Config ### Beta Computer Mouse Move Config ### Beta Computer Right Click Config ### Beta Computer Screenshot Config ### Beta Computer Scroll Config ### Beta Computer Toolset 20260801 ### Beta Computer Toolset Configs ### Beta Computer Triple Click Config ### Beta Computer Type Config ### Beta Computer Wait Config ### Beta Computer Zoom Config ### Beta Image Transformations Param ### Beta Mid Conversation System Block Param
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
Nothing in the body moved in this read. What changed is above.
api/beta/messages/batches Changed · +919 / -137 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
The two sides of this change are more than 400 edits apart, too far apart to line up, so this is the differ's own diff of it and the words inside a line are not marked.
from line 23
2323
2424 - `string`
2525
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
2727
2828 - `"message-batches-2024-09-24"`
2929
from line 68
6868 - `"output-300k-2026-03-24"`
6969
7070 - `"user-profiles-2026-03-24"`
71
72 - `"user-profiles-2026-08-18"`
7173
7274 - `"advisor-tool-2026-03-01"`
7375
from line 319
317319
318320 - `"search_result_location"`
319321
320 - `BetaImageBlockParam object { source, type, cache_control }`
322 - `BetaImageBlockParam object { source, type, cache_control, transformations }`
321323
322324 - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource`
323325
from line 365
363365
364366 Create a cache control breakpoint at this content block.
365367
368 - `transformations: optional BetaImageTransformationsParam or null`
369
370 Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field.
371
372 - `oversized_image: optional "downsize" or "error"`
373
374 What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down.
375
376 - `"downsize"`
377
378 - `"error"`
379
366380 - `BetaRequestDocumentBlock object { source, type, cache_control, 3 more }`
367381
368382 - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more`
from line 415
401415
402416 - `BetaTextBlockParam object { text, type, cache_control, citations }`
403417
404 - `BetaImageBlockParam object { source, type, cache_control }`
418 - `BetaImageBlockParam object { source, type, cache_control, transformations }`
405419
406420 - `type: "content"`
407421
from line 507
493507
494508 - `"redacted_thinking"`
495509
496 - `BetaToolUseBlockParam object { id, input, name, 3 more }`
510 - `BetaToolUseBlockParam object { id, input, name, 4 more }`
497511
498512 - `id: string`
499513
from line 553
539553
540554 - `"code_execution_20260120"`
541555
542 - `BetaToolResultBlockParam object { tool_use_id, type, cache_control, 2 more }`
556 - `toolset_name: optional string or null`
557
558 For a toolset member tool_use, the toolset family this member belongs to.
559
560 - `BetaToolResultBlockParam object { tool_use_id, type, cache_control, 3 more }`
543561
544562 - `tool_use_id: string`
545563
from line 569
551569
552570 Create a cache control breakpoint at this content block.
553571
554 - `content: optional string or array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 2 more`
572 - `content: optional string or array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 3 more`
555573
556574 - `string`
557575
558 - `array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 2 more`
576 - `array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 3 more`
559577
560578 - `BetaTextBlockParam object { text, type, cache_control, citations }`
561579
562 - `BetaImageBlockParam object { source, type, cache_control }`
580 - `BetaImageBlockParam object { source, type, cache_control, transformations }`
563581
564582 - `BetaSearchResultBlockParam object { content, source, title, 3 more }`
565583
from line 597
579597
580598 Create a cache control breakpoint at this content block.
581599
600 - `BetaBrowserStateBlockParam object { tabs, type, cache_control, state_changes }`
601
602 The caller's browser state after a browser toolset member call —
603 the full inventory of open tabs, which tab is active, and any side
604 effects (tabs opened, download state changes) the call produced.
605
606 At most one per `tool_result`, only on a non-error result answering a
607 browser toolset member `tool_use`. The server renders the
608 model-visible text from it; the model never sees the raw fields.
609
610 - `tabs: array of BetaBrowserStateTabEntry`
611
612 All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`.
613
614 - `tab_id: string`
615
616 The caller-assigned identifier for this tab, unique within the inventory.
617
618 - `title: string`
619
620 The title of the page the tab is showing. May be empty.
621
622 - `url: string`
623
624 The URL of the page the tab is showing. May be empty.
625
626 - `active: optional boolean`
627
628 Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.
629
630 - `type: "browser_state"`
631
632 - `"browser_state"`
633
634 - `cache_control: optional BetaCacheControlEphemeral or null`
635
636 Create a cache control breakpoint at this content block.
637
638 - `state_changes: optional array of BetaBrowserStateChange or null`
639
640 Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list.
641
642 - `BetaBrowserStateChangeTabOpened object { tab_id, type }`
643
644 A tab this call's execution opened that remains open at its end —
645 the creation delta of the `tabs` inventory, not an event log.
646
647 Carries only the `tab_id`; the tab's `title` and `url` live on its
648 `tabs` entry, which must include the same `tab_id`. A tab opened
649 during a failed call gets no deferred `tab_opened`; it simply appears
650 in the next result's `tabs` inventory.
651
652 - `tab_id: string`
653
654 The `tab_id` of the opened tab, present in `tabs`.
655
656 - `type: "tab_opened"`
657
658 - `"tab_opened"`
659
660 - `BetaBrowserStateChangeDownloadStarted object { download_id, type, url }`
661
662 A file download that started during this call.
663
664 - `download_id: string`
665
666 The caller-assigned identifier for this download, stable across the state changes reporting it.
667
668 - `type: "download_started"`
669
670 - `"download_started"`
671
672 - `url: string`
673
674 The final post-redirect URL the download was served from.
675
676 - `BetaBrowserStateChangeDownloadCompleted object { download_id, type, url, 2 more }`
677
678 A file download that finished during this call, reported with the
679 same `download_id` as its `download_started` — or without a prior
680 `download_started`, when the download finished during the call that
681 started it (at most one state change per `download_id` per result).
682
683 - `download_id: string`
684
685 The caller-assigned identifier for this download, stable across the state changes reporting it.
686
687 - `type: "download_completed"`
688
689 - `"download_completed"`
690
691 - `url: string`
692
693 The final post-redirect URL the download was served from.
694
695 - `path: optional string or null`
696
697 Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path.
698
699 - `size_bytes: optional number or null`
700
701 The completed download's size.
702
703 - `BetaBrowserStateChangeDownloadFailed object { download_id, type, url, error }`
704
705 A file download that failed — or was cancelled — during this call.
706
707 - `download_id: string`
708
709 The caller-assigned identifier for this download, stable across the state changes reporting it.
710
711 - `type: "download_failed"`
712
713 - `"download_failed"`
714
715 - `url: string`
716
717 The final post-redirect URL the download was served from.
718
719 - `error: optional string or null`
720
721 The failure or cancellation detail, when known.
722
582723 - `is_error: optional boolean`
724
725 - `toolset_name: optional string or null`
726
727 For a toolset member tool_result, the toolset family of the paired tool_use.
583728
584729 - `BetaServerToolUseBlockParam object { id, input, name, 3 more }`
585730
from line 1304
11591304 - `encrypted_content: optional string or null`
11601305
11611306 Opaque metadata from prior compaction, to be round-tripped verbatim
1162
1163 - `BetaMidConversationSystemBlockParam object { content, type, cache_control }`
1164
1165 System instructions that appear mid-conversation.
1166
1167 Use this block to provide or update system-level instructions at a specific
1168 point in the conversation, rather than only via the top-level `system` parameter.
1169
1170 - `content: array of BetaTextBlockParam or BetaRequestToolAdditionBlock or BetaRequestToolRemovalBlock`
1171
1172 System instruction text blocks.
1173
1174 - `BetaTextBlockParam object { text, type, cache_control, citations }`
1175
1176 - `BetaRequestToolAdditionBlock object { tool, type, cache_control }`
1177
1178 Mid-conversation directive to surface a declared tool.
1179
1180 `tool` references a tool (or MCP toolset) by name from the request's
1181 `tools`; it is offered to the model from this point in the
1182 conversation onward.
1183
1184 - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference`
1185
1186 Reference to a single tool the caller declared directly in
1187 `tools[]`. Does not accept the composed `{server}_{name}` form the
1188 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1189 `mcp_toolset_reference` for those.
1190
1191 - `BetaToolChangeToolReference object { name, type }`
1192
1193 Reference to a single tool the caller declared directly in
1194 `tools[]`. Does not accept the composed `{server}_{name}` form the
1195 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1196 `mcp_toolset_reference` for those.
1197
1198 - `name: string`
1199
1200 - `type: "tool_reference"`
1201
1202 - `"tool_reference"`
1203
1204 - `BetaToolChangeMCPToolReference object { name, server_name, type }`
1205
1206 Reference to a single MCP tool by its server and remote name — the
1207 same `server_name`/`name` pair `mcp_tool_use` carries.
1208
1209 - `name: string`
1210
1211 - `server_name: string`
1212
1213 - `type: "mcp_tool_reference"`
1214
1215 - `"mcp_tool_reference"`
1216
1217 - `BetaToolChangeMCPToolsetReference object { server_name, type }`
1218
1219 Reference to every tool in the named MCP server's toolset.
1220
1221 - `server_name: string`
1222
1223 - `type: "mcp_toolset_reference"`
1224
1225 - `"mcp_toolset_reference"`
1226
1227 - `type: "tool_addition"`
1228
1229 - `"tool_addition"`
1230
1231 - `cache_control: optional BetaCacheControlEphemeral or null`
1232
1233 Create a cache control breakpoint at this content block.
1234
1235 - `BetaRequestToolRemovalBlock object { tool, type, cache_control }`
1236
1237 Mid-conversation directive to withdraw a tool.
1238
1239 `tool` references a tool (or MCP toolset) by name from the request's
1240 `tools`; it is no longer offered to the model from this point in the
1241 conversation onward.
1242
1243 - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference`
1244
1245 Reference to a single tool the caller declared directly in
1246 `tools[]`. Does not accept the composed `{server}_{name}` form the
1247 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1248 `mcp_toolset_reference` for those.
1249
1250 - `BetaToolChangeToolReference object { name, type }`
1251
1252 Reference to a single tool the caller declared directly in
1253 `tools[]`. Does not accept the composed `{server}_{name}` form the
1254 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1255 `mcp_toolset_reference` for those.
1256
1257 - `BetaToolChangeMCPToolReference object { name, server_name, type }`
1258
1259 Reference to a single MCP tool by its server and remote name — the
1260 same `server_name`/`name` pair `mcp_tool_use` carries.
1261
1262 - `BetaToolChangeMCPToolsetReference object { server_name, type }`
1263
1264 Reference to every tool in the named MCP server's toolset.
1265
1266 - `type: "tool_removal"`
1267
1268 - `"tool_removal"`
1269
1270 - `cache_control: optional BetaCacheControlEphemeral or null`
1271
1272 Create a cache control breakpoint at this content block.
1273
1274 - `type: "mid_conv_system"`
1275
1276 - `"mid_conv_system"`
1277
1278 - `cache_control: optional BetaCacheControlEphemeral or null`
1279
1280 Create a cache control breakpoint at this content block.
12811307
12821308 - `BetaRequestToolAdditionBlock object { tool, type, cache_control }`
12831309
from line 1313
12871313 `tools`; it is offered to the model from this point in the
12881314 conversation onward.
12891315
1316 - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference`
1317
1318 Reference to a single tool the caller declared directly in
1319 `tools[]`. Does not accept the composed `{server}_{name}` form the
1320 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1321 `mcp_toolset_reference` for those.
1322
1323 - `BetaToolChangeToolReference object { name, type }`
1324
1325 Reference to a single tool the caller declared directly in
1326 `tools[]`. Does not accept the composed `{server}_{name}` form the
1327 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1328 `mcp_toolset_reference` for those.
1329
1330 - `name: string`
1331
1332 - `type: "tool_reference"`
1333
1334 - `"tool_reference"`
1335
1336 - `BetaToolChangeMCPToolReference object { name, server_name, type }`
1337
1338 Reference to a single MCP tool by its server and remote name — the
1339 same `server_name`/`name` pair `mcp_tool_use` carries.
1340
1341 - `name: string`
1342
1343 - `server_name: string`
1344
1345 - `type: "mcp_tool_reference"`
1346
1347 - `"mcp_tool_reference"`
1348
1349 - `BetaToolChangeMCPToolsetReference object { server_name, type }`
1350
1351 Reference to every tool in the named MCP server's toolset.
1352
1353 - `server_name: string`
1354
1355 - `type: "mcp_toolset_reference"`
1356
1357 - `"mcp_toolset_reference"`
1358
1359 - `type: "tool_addition"`
1360
1361 - `"tool_addition"`
1362
1363 - `cache_control: optional BetaCacheControlEphemeral or null`
1364
1365 Create a cache control breakpoint at this content block.
1366
12901367 - `BetaRequestToolRemovalBlock object { tool, type, cache_control }`
12911368
12921369 Mid-conversation directive to withdraw a tool.
from line 1371
12941371 `tool` references a tool (or MCP toolset) by name from the request's
12951372 `tools`; it is no longer offered to the model from this point in the
12961373 conversation onward.
1374
1375 - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference`
1376
1377 Reference to a single tool the caller declared directly in
1378 `tools[]`. Does not accept the composed `{server}_{name}` form the
1379 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1380 `mcp_toolset_reference` for those.
1381
1382 - `BetaToolChangeToolReference object { name, type }`
1383
1384 Reference to a single tool the caller declared directly in
1385 `tools[]`. Does not accept the composed `{server}_{name}` form the
1386 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1387 `mcp_toolset_reference` for those.
1388
1389 - `BetaToolChangeMCPToolReference object { name, server_name, type }`
1390
1391 Reference to a single MCP tool by its server and remote name — the
1392 same `server_name`/`name` pair `mcp_tool_use` carries.
1393
1394 - `BetaToolChangeMCPToolsetReference object { server_name, type }`
1395
1396 Reference to every tool in the named MCP server's toolset.
1397
1398 - `type: "tool_removal"`
1399
1400 - `"tool_removal"`
1401
1402 - `cache_control: optional BetaCacheControlEphemeral or null`
1403
1404 Create a cache control breakpoint at this content block.
12971405
12981406 - `BetaFallbackBlockParam object { from, to, type, trigger }`
12991407
from line 2373
22652373
22662374 When true, guarantees schema validation on tool names and inputs
22672375
2376 - `BetaBrowserToolset20260801 object { type, allowed_callers, cache_control, configs }`
2377
2378 The browser toolset: a single `tools[]` entry (carrying no
2379 `name`) that declares the browser tool family. The model is served
2380 the family's tool with any members disabled via `configs` removed
2381 from its schema.
2382
2383 - `type: "browser_toolset_20260801"`
2384
2385 - `"browser_toolset_20260801"`
2386
2387 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2388
2389 - `"direct"`
2390
2391 - `"code_execution_20250825"`
2392
2393 - `"code_execution_20260120"`
2394
2395 - `"code_execution_20260521"`
2396
2397 - `cache_control: optional BetaCacheControlEphemeral or null`
2398
2399 Create a cache control breakpoint at this content block.
2400
2401 - `configs: optional BetaBrowserToolsetConfigs or null`
2402
2403 Per-member configuration for `browser_toolset_20260801`: one
2404 optional field per member tool, keyed by the member name — the same
2405 name the member's `tool_use` blocks carry. Every member is an
2406 accepted key, and a member's defaults apply wherever its key is
2407 absent. Unknown keys are rejected: the field set is this toolset
2408 version's complete member set.
2409
2410 - `close_tab: optional BetaBrowserCloseTabConfig or null`
2411
2412 `close_tab`'s config overrides.
2413
2414 - `defer_loading: optional boolean or null`
2415
2416 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2417
2418 - `enabled: optional boolean or null`
2419
2420 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2421
2422 - `double_click: optional BetaBrowserDoubleClickConfig or null`
2423
2424 `double_click`'s config overrides.
2425
2426 - `defer_loading: optional boolean or null`
2427
2428 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2429
2430 - `enabled: optional boolean or null`
2431
2432 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2433
2434 - `file_upload: optional BetaBrowserFileUploadConfig or null`
2435
2436 `file_upload`'s config overrides.
2437
2438 - `defer_loading: optional boolean or null`
2439
2440 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2441
2442 - `enabled: optional boolean or null`
2443
2444 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2445
2446 - `find: optional BetaBrowserFindConfig or null`
2447
2448 `find`'s config overrides.
2449
2450 - `defer_loading: optional boolean or null`
2451
2452 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2453
2454 - `enabled: optional boolean or null`
2455
2456 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2457
2458 - `form_input: optional BetaBrowserFormInputConfig or null`
2459
2460 `form_input`'s config overrides.
2461
2462 - `defer_loading: optional boolean or null`
2463
2464 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2465
2466 - `enabled: optional boolean or null`
2467
2468 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2469
2470 - `get_page_text: optional BetaBrowserGetPageTextConfig or null`
2471
2472 `get_page_text`'s config overrides.
2473
2474 - `defer_loading: optional boolean or null`
2475
2476 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2477
2478 - `enabled: optional boolean or null`
2479
2480 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2481
2482 - `hold_key: optional BetaBrowserHoldKeyConfig or null`
2483
2484 `hold_key`'s config overrides.
2485
2486 - `defer_loading: optional boolean or null`
2487
2488 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2489
2490 - `enabled: optional boolean or null`
2491
2492 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2493
2494 - `hover: optional BetaBrowserHoverConfig or null`
2495
2496 `hover`'s config overrides.
2497
2498 - `defer_loading: optional boolean or null`
2499
2500 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2501
2502 - `enabled: optional boolean or null`
2503
2504 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2505
2506 - `javascript_exec: optional BetaBrowserJavascriptExecConfig or null`
2507
2508 `javascript_exec`'s config overrides.
2509
2510 - `defer_loading: optional boolean or null`
2511
2512 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2513
2514 - `enabled: optional boolean or null`
2515
2516 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2517
2518 - `key: optional BetaBrowserKeyConfig or null`
2519
2520 `key`'s config overrides.
2521
2522 - `defer_loading: optional boolean or null`
2523
2524 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2525
2526 - `enabled: optional boolean or null`
2527
2528 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2529
2530 - `left_click: optional BetaBrowserLeftClickConfig or null`
2531
2532 `left_click`'s config overrides.
2533
2534 - `defer_loading: optional boolean or null`
2535
2536 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2537
2538 - `enabled: optional boolean or null`
2539
2540 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2541
2542 - `left_click_drag: optional BetaBrowserLeftClickDragConfig or null`
2543
2544 `left_click_drag`'s config overrides.
2545
2546 - `defer_loading: optional boolean or null`
2547
2548 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2549
2550 - `enabled: optional boolean or null`
2551
2552 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2553
2554 - `left_mouse_down: optional BetaBrowserLeftMouseDownConfig or null`
2555
2556 `left_mouse_down`'s config overrides.
2557
2558 - `defer_loading: optional boolean or null`
2559
2560 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2561
2562 - `enabled: optional boolean or null`
2563
2564 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2565
2566 - `left_mouse_up: optional BetaBrowserLeftMouseUpConfig or null`
2567
2568 `left_mouse_up`'s config overrides.
2569
2570 - `defer_loading: optional boolean or null`
2571
2572 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2573
2574 - `enabled: optional boolean or null`
2575
2576 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2577
2578 - `list_tabs: optional BetaBrowserListTabsConfig or null`
2579
2580 `list_tabs`'s config overrides.
2581
2582 - `defer_loading: optional boolean or null`
2583
2584 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2585
2586 - `enabled: optional boolean or null`
2587
2588 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2589
2590 - `middle_click: optional BetaBrowserMiddleClickConfig or null`
2591
2592 `middle_click`'s config overrides.
2593
2594 - `defer_loading: optional boolean or null`
2595
2596 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2597
2598 - `enabled: optional boolean or null`
2599
2600 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2601
2602 - `mouse_move: optional BetaBrowserMouseMoveConfig or null`
2603
2604 `mouse_move`'s config overrides.
2605
2606 - `defer_loading: optional boolean or null`
2607
2608 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2609
2610 - `enabled: optional boolean or null`
2611
2612 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2613
2614 - `navigate: optional BetaBrowserNavigateConfig or null`
2615
2616 `navigate`'s config overrides.
2617
2618 - `defer_loading: optional boolean or null`
2619
2620 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2621
2622 - `enabled: optional boolean or null`
2623
2624 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2625
2626 - `new_tab: optional BetaBrowserNewTabConfig or null`
2627
2628 `new_tab`'s config overrides.
2629
2630 - `defer_loading: optional boolean or null`
2631
2632 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2633
2634 - `enabled: optional boolean or null`
2635
2636 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2637
2638 - `read_console: optional BetaBrowserReadConsoleConfig or null`
2639
2640 `read_console`'s config overrides.
2641
2642 - `defer_loading: optional boolean or null`
2643
2644 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2645
2646 - `enabled: optional boolean or null`
2647
2648 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2649
2650 - `read_network: optional BetaBrowserReadNetworkConfig or null`
2651
2652 `read_network`'s config overrides.
2653
2654 - `defer_loading: optional boolean or null`
2655
2656 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2657
2658 - `enabled: optional boolean or null`
2659
2660 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2661
2662 - `read_page: optional BetaBrowserReadPageConfig or null`
2663
2664 `read_page`'s config overrides.
2665
2666 - `defer_loading: optional boolean or null`
2667
2668 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2669
2670 - `enabled: optional boolean or null`
2671
2672 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2673
2674 - `right_click: optional BetaBrowserRightClickConfig or null`
2675
2676 `right_click`'s config overrides.
2677
2678 - `defer_loading: optional boolean or null`
2679
2680 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2681
2682 - `enabled: optional boolean or null`
2683
2684 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2685
2686 - `screenshot: optional BetaBrowserScreenshotConfig or null`
2687
2688 `screenshot`'s config overrides.
2689
2690 - `defer_loading: optional boolean or null`
2691
2692 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2693
2694 - `enabled: optional boolean or null`
2695
2696 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2697
2698 - `scroll: optional BetaBrowserScrollConfig or null`
2699
2700 `scroll`'s config overrides.
2701
2702 - `defer_loading: optional boolean or null`
2703
2704 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2705
2706 - `enabled: optional boolean or null`
2707
2708 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2709
2710 - `scroll_to: optional BetaBrowserScrollToConfig or null`
2711
2712 `scroll_to`'s config overrides.
2713
2714 - `defer_loading: optional boolean or null`
2715
2716 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2717
2718 - `enabled: optional boolean or null`
2719
2720 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2721
2722 - `switch_tab: optional BetaBrowserSwitchTabConfig or null`
2723
2724 `switch_tab`'s config overrides.
2725
2726 - `defer_loading: optional boolean or null`
2727
2728 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2729
2730 - `enabled: optional boolean or null`
2731
2732 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2733
2734 - `triple_click: optional BetaBrowserTripleClickConfig or null`
2735
2736 `triple_click`'s config overrides.
2737
2738 - `defer_loading: optional boolean or null`
2739
2740 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2741
2742 - `enabled: optional boolean or null`
2743
2744 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2745
2746 - `type: optional BetaBrowserTypeConfig or null`
2747
2748 `type`'s config overrides.
2749
2750 - `defer_loading: optional boolean or null`
2751
2752 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2753
2754 - `enabled: optional boolean or null`
2755
2756 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2757
2758 - `wait: optional BetaBrowserWaitConfig or null`
2759
2760 `wait`'s config overrides.
2761
2762 - `defer_loading: optional boolean or null`
2763
2764 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2765
2766 - `enabled: optional boolean or null`
2767
2768 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2769
2770 - `zoom: optional BetaBrowserZoomConfig or null`
2771
2772 `zoom`'s config overrides.
2773
2774 - `defer_loading: optional boolean or null`
2775
2776 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2777
2778 - `enabled: optional boolean or null`
2779
2780 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2781
22682782 - `BetaToolComputerUse20241022 object { display_height_px, display_width_px, name, 7 more }`
22692783
22702784 - `display_height_px: number`
from line 3008
24943008 - `strict: optional boolean`
24953009
24963010 When true, guarantees schema validation on tool names and inputs
3011
3012 - `BetaComputerToolset20260801 object { type, allowed_callers, cache_control, configs }`
3013
3014 The computer toolset: a single `tools[]` entry (carrying no
3015 `name`) that declares the computer tool family. The model is
3016 served the family's tool with any members disabled via `configs`
3017 removed from its schema. Every member is enabled by default, zoom
3018 included. The single-tool options `display_number` and
3019 `enable_zoom` are not fields of a toolset entry — it carries only
3020 `type`, `configs`, and `cache_control`; zoom is controlled
3021 via `configs.zoom.enabled`.
3022
3023 - `type: "computer_toolset_20260801"`
3024
3025 - `"computer_toolset_20260801"`
3026
3027 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3028
3029 - `"direct"`
3030
3031 - `"code_execution_20250825"`
3032
3033 - `"code_execution_20260120"`
3034
3035 - `"code_execution_20260521"`
3036
3037 - `cache_control: optional BetaCacheControlEphemeral or null`
3038
3039 Create a cache control breakpoint at this content block.
3040
3041 - `configs: optional BetaComputerToolsetConfigs or null`
3042
3043 Per-member configuration for `computer_toolset_20260801`: one
3044 optional field per member tool, keyed by the member name — the same
3045 name the member's `tool_use` blocks carry. Every member is an
3046 accepted key, and a member's defaults apply wherever its key is
3047 absent. Unknown keys are rejected: the field set is this toolset
3048 version's complete member set.
3049
3050 - `cursor_position: optional BetaComputerCursorPositionConfig or null`
3051
3052 `cursor_position`'s config overrides.
3053
3054 - `defer_loading: optional boolean or null`
3055
3056 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3057
3058 - `enabled: optional boolean or null`
3059
3060 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3061
3062 - `double_click: optional BetaComputerDoubleClickConfig or null`
3063
3064 `double_click`'s config overrides.
3065
3066 - `defer_loading: optional boolean or null`
3067
3068 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3069
3070 - `enabled: optional boolean or null`
3071
3072 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3073
3074 - `hold_key: optional BetaComputerHoldKeyConfig or null`
3075
3076 `hold_key`'s config overrides.
3077
3078 - `defer_loading: optional boolean or null`
3079
3080 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3081
3082 - `enabled: optional boolean or null`
3083
3084 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3085
3086 - `key: optional BetaComputerKeyConfig or null`
3087
3088 `key`'s config overrides.
3089
3090 - `defer_loading: optional boolean or null`
3091
3092 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3093
3094 - `enabled: optional boolean or null`
3095
3096 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3097
3098 - `left_click: optional BetaComputerLeftClickConfig or null`
3099
3100 `left_click`'s config overrides.
3101
3102 - `defer_loading: optional boolean or null`
3103
3104 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3105
3106 - `enabled: optional boolean or null`
3107
3108 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3109
3110 - `left_click_drag: optional BetaComputerLeftClickDragConfig or null`
3111
3112 `left_click_drag`'s config overrides.
3113
3114 - `defer_loading: optional boolean or null`
3115
3116 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3117
3118 - `enabled: optional boolean or null`
3119
3120 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3121
3122 - `left_mouse_down: optional BetaComputerLeftMouseDownConfig or null`
3123
3124 `left_mouse_down`'s config overrides.
3125
3126 - `defer_loading: optional boolean or null`
3127
3128 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3129
3130 - `enabled: optional boolean or null`
3131
3132 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3133
3134 - `left_mouse_up: optional BetaComputerLeftMouseUpConfig or null`
3135
3136 `left_mouse_up`'s config overrides.
3137
3138 - `defer_loading: optional boolean or null`
3139
3140 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3141
3142 - `enabled: optional boolean or null`
3143
3144 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3145
3146 - `middle_click: optional BetaComputerMiddleClickConfig or null`
3147
3148 `middle_click`'s config overrides.
3149
3150 - `defer_loading: optional boolean or null`
3151
3152 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3153
3154 - `enabled: optional boolean or null`
3155
3156 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3157
3158 - `mouse_move: optional BetaComputerMouseMoveConfig or null`
3159
3160 `mouse_move`'s config overrides.
3161
3162 - `defer_loading: optional boolean or null`
3163
3164 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3165
3166 - `enabled: optional boolean or null`
3167
3168 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3169
3170 - `right_click: optional BetaComputerRightClickConfig or null`
3171
3172 `right_click`'s config overrides.
3173
3174 - `defer_loading: optional boolean or null`
3175
3176 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3177
3178 - `enabled: optional boolean or null`
3179
3180 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3181
3182 - `screenshot: optional BetaComputerScreenshotConfig or null`
3183
3184 `screenshot`'s config overrides.
3185
3186 - `defer_loading: optional boolean or null`
3187
3188 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3189
3190 - `enabled: optional boolean or null`
3191
3192 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3193
3194 - `scroll: optional BetaComputerScrollConfig or null`
3195
3196 `scroll`'s config overrides.
3197
3198 - `defer_loading: optional boolean or null`
3199
3200 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3201
3202 - `enabled: optional boolean or null`
3203
3204 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3205
3206 - `triple_click: optional BetaComputerTripleClickConfig or null`
3207
3208 `triple_click`'s config overrides.
3209
3210 - `defer_loading: optional boolean or null`
3211
3212 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3213
3214 - `enabled: optional boolean or null`
3215
3216 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3217
3218 - `type: optional BetaComputerTypeConfig or null`
3219
3220 `type`'s config overrides.
3221
3222 - `defer_loading: optional boolean or null`
3223
3224 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3225
3226 - `enabled: optional boolean or null`
3227
3228 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3229
3230 - `wait: optional BetaComputerWaitConfig or null`
3231
3232 `wait`'s config overrides.
3233
3234 - `defer_loading: optional boolean or null`
3235
3236 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3237
3238 - `enabled: optional boolean or null`
3239
3240 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3241
3242 - `zoom: optional BetaComputerZoomConfig or null`
3243
3244 `zoom`'s config overrides.
3245
3246 - `defer_loading: optional boolean or null`
3247
3248 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3249
3250 - `enabled: optional boolean or null`
3251
3252 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
24973253
24983254 - `BetaToolTextEditor20250124 object { name, type, allowed_callers, 4 more }`
24993255
from line 4086
33304086 "role": "user"
33314087 }
33324088 ],
3333 "model": "claude-opus-4-6"
4089 "model": "claude-opus-5"
33344090 }
33354091 }
33364092 ]
from line 4138
33824138
33834139 - `string`
33844140
3385 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
4141 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
33864142
33874143 - `"message-batches-2024-09-24"`
33884144
from line 4183
34274183 - `"output-300k-2026-03-24"`
34284184
34294185 - `"user-profiles-2026-03-24"`
4186
4187 - `"user-profiles-2026-08-18"`
34304188
34314189 - `"advisor-tool-2026-03-01"`
34324190
from line 4362
36044362
36054363 - `string`
36064364
3607 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
4365 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
36084366
36094367 - `"message-batches-2024-09-24"`
36104368
from line 4407
36494407 - `"output-300k-2026-03-24"`
36504408
36514409 - `"user-profiles-2026-03-24"`
4410
4411 - `"user-profiles-2026-08-18"`
36524412
36534413 - `"advisor-tool-2026-03-01"`
36544414
from line 4597
38374597
38384598 - `string`
38394599
3840 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
4600 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
38414601
38424602 - `"message-batches-2024-09-24"`
38434603
from line 4642
38824642 - `"output-300k-2026-03-24"`
38834643
38844644 - `"user-profiles-2026-03-24"`
4645
4646 - `"user-profiles-2026-08-18"`
38854647
38864648 - `"advisor-tool-2026-03-01"`
38874649
from line 4814
40524814
40534815 - `string`
40544816
4055 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
4817 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
40564818
40574819 - `"message-batches-2024-09-24"`
40584820
from line 4859
40974859 - `"output-300k-2026-03-24"`
40984860
40994861 - `"user-profiles-2026-03-24"`
4862
4863 - `"user-profiles-2026-08-18"`
41004864
41014865 - `"advisor-tool-2026-03-01"`
41024866
from line 4943
41794943
41804944 - `string`
41814945
4182 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
4946 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
41834947
41844948 - `"message-batches-2024-09-24"`
41854949
from line 4988
42244988 - `"output-300k-2026-03-24"`
42254989
42264990 - `"user-profiles-2026-03-24"`
4991
4992 - `"user-profiles-2026-08-18"`
42274993
42284994 - `"advisor-tool-2026-03-01"`
42294995
from line 5258
44925258
44935259 - `"redacted_thinking"`
44945260
4495 - `BetaToolUseBlock object { id, input, name, 2 more }`
5261 - `BetaToolUseBlock object { id, input, name, 3 more }`
44965262
44975263 - `id: string`
44985264
from line 5299
45335299 - `type: "code_execution_20260120"`
45345300
45355301 - `"code_execution_20260120"`
5302
5303 - `toolset_name: optional string or null`
5304
5305 For a toolset member tool_use, the toolset family.
45365306
45375307 - `BetaServerToolUseBlock object { id, input, name, 2 more }`
45385308
from line 7149
63797149
63807150 - `"redacted_thinking"`
63817151
6382 - `BetaToolUseBlock object { id, input, name, 2 more }`
7152 - `BetaToolUseBlock object { id, input, name, 3 more }`
63837153
63847154 - `id: string`
63857155
from line 7190
64207190 - `type: "code_execution_20260120"`
64217191
64227192 - `"code_execution_20260120"`
7193
7194 - `toolset_name: optional string or null`
7195
7196 For a toolset member tool_use, the toolset family.
64237197
64247198 - `BetaServerToolUseBlock object { id, input, name, 2 more }`
64257199
from line 8839
80658839
80668840 - `"redacted_thinking"`
80678841
8068 - `BetaToolUseBlock object { id, input, name, 2 more }`
8842 - `BetaToolUseBlock object { id, input, name, 3 more }`
80698843
80708844 - `id: string`
80718845
from line 8880
81068880 - `type: "code_execution_20260120"`
81078881
81088882 - `"code_execution_20260120"`
8883
8884 - `toolset_name: optional string or null`
8885
8886 For a toolset member tool_use, the toolset family.
81098887
81108888 - `BetaServerToolUseBlock object { id, input, name, 2 more }`
81118889
from line 10491
971310491
971410492 - `"redacted_thinking"`
971510493
9716 - `BetaToolUseBlock object { id, input, name, 2 more }`
10494 - `BetaToolUseBlock object { id, input, name, 3 more }`
971710495
971810496 - `id: string`
971910497
from line 10532
975410532 - `type: "code_execution_20260120"`
975510533
975610534 - `"code_execution_20260120"`
10535
10536 - `toolset_name: optional string or null`
10537
10538 For a toolset member tool_use, the toolset family.
975710539
975810540 - `BetaServerToolUseBlock object { id, input, name, 2 more }`
975910541
976010542
api/beta/messages/batches/create Changed · +884 / -128 lines
The two sides of this change are more than 400 edits apart, too far apart to line up, so this is the differ's own diff of it and the words inside a line are not marked.
from line 21
2121
2222 - `string`
2323
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
2525
2626 - `"message-batches-2024-09-24"`
2727
from line 66
6666 - `"output-300k-2026-03-24"`
6767
6868 - `"user-profiles-2026-03-24"`
69
70 - `"user-profiles-2026-08-18"`
6971
7072 - `"advisor-tool-2026-03-01"`
7173
from line 317
315317
316318 - `"search_result_location"`
317319
318 - `BetaImageBlockParam object { source, type, cache_control }`
320 - `BetaImageBlockParam object { source, type, cache_control, transformations }`
319321
320322 - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource`
321323
from line 363
361363
362364 Create a cache control breakpoint at this content block.
363365
366 - `transformations: optional BetaImageTransformationsParam or null`
367
368 Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field.
369
370 - `oversized_image: optional "downsize" or "error"`
371
372 What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down.
373
374 - `"downsize"`
375
376 - `"error"`
377
364378 - `BetaRequestDocumentBlock object { source, type, cache_control, 3 more }`
365379
366380 - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more`
from line 413
399413
400414 - `BetaTextBlockParam object { text, type, cache_control, citations }`
401415
402 - `BetaImageBlockParam object { source, type, cache_control }`
416 - `BetaImageBlockParam object { source, type, cache_control, transformations }`
403417
404418 - `type: "content"`
405419
from line 505
491505
492506 - `"redacted_thinking"`
493507
494 - `BetaToolUseBlockParam object { id, input, name, 3 more }`
508 - `BetaToolUseBlockParam object { id, input, name, 4 more }`
495509
496510 - `id: string`
497511
from line 551
537551
538552 - `"code_execution_20260120"`
539553
540 - `BetaToolResultBlockParam object { tool_use_id, type, cache_control, 2 more }`
554 - `toolset_name: optional string or null`
555
556 For a toolset member tool_use, the toolset family this member belongs to.
557
558 - `BetaToolResultBlockParam object { tool_use_id, type, cache_control, 3 more }`
541559
542560 - `tool_use_id: string`
543561
from line 567
549567
550568 Create a cache control breakpoint at this content block.
551569
552 - `content: optional string or array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 2 more`
570 - `content: optional string or array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 3 more`
553571
554572 - `string`
555573
556 - `array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 2 more`
574 - `array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 3 more`
557575
558576 - `BetaTextBlockParam object { text, type, cache_control, citations }`
559577
560 - `BetaImageBlockParam object { source, type, cache_control }`
578 - `BetaImageBlockParam object { source, type, cache_control, transformations }`
561579
562580 - `BetaSearchResultBlockParam object { content, source, title, 3 more }`
563581
from line 595
577595
578596 Create a cache control breakpoint at this content block.
579597
598 - `BetaBrowserStateBlockParam object { tabs, type, cache_control, state_changes }`
599
600 The caller's browser state after a browser toolset member call —
601 the full inventory of open tabs, which tab is active, and any side
602 effects (tabs opened, download state changes) the call produced.
603
604 At most one per `tool_result`, only on a non-error result answering a
605 browser toolset member `tool_use`. The server renders the
606 model-visible text from it; the model never sees the raw fields.
607
608 - `tabs: array of BetaBrowserStateTabEntry`
609
610 All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`.
611
612 - `tab_id: string`
613
614 The caller-assigned identifier for this tab, unique within the inventory.
615
616 - `title: string`
617
618 The title of the page the tab is showing. May be empty.
619
620 - `url: string`
621
622 The URL of the page the tab is showing. May be empty.
623
624 - `active: optional boolean`
625
626 Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.
627
628 - `type: "browser_state"`
629
630 - `"browser_state"`
631
632 - `cache_control: optional BetaCacheControlEphemeral or null`
633
634 Create a cache control breakpoint at this content block.
635
636 - `state_changes: optional array of BetaBrowserStateChange or null`
637
638 Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list.
639
640 - `BetaBrowserStateChangeTabOpened object { tab_id, type }`
641
642 A tab this call's execution opened that remains open at its end —
643 the creation delta of the `tabs` inventory, not an event log.
644
645 Carries only the `tab_id`; the tab's `title` and `url` live on its
646 `tabs` entry, which must include the same `tab_id`. A tab opened
647 during a failed call gets no deferred `tab_opened`; it simply appears
648 in the next result's `tabs` inventory.
649
650 - `tab_id: string`
651
652 The `tab_id` of the opened tab, present in `tabs`.
653
654 - `type: "tab_opened"`
655
656 - `"tab_opened"`
657
658 - `BetaBrowserStateChangeDownloadStarted object { download_id, type, url }`
659
660 A file download that started during this call.
661
662 - `download_id: string`
663
664 The caller-assigned identifier for this download, stable across the state changes reporting it.
665
666 - `type: "download_started"`
667
668 - `"download_started"`
669
670 - `url: string`
671
672 The final post-redirect URL the download was served from.
673
674 - `BetaBrowserStateChangeDownloadCompleted object { download_id, type, url, 2 more }`
675
676 A file download that finished during this call, reported with the
677 same `download_id` as its `download_started` — or without a prior
678 `download_started`, when the download finished during the call that
679 started it (at most one state change per `download_id` per result).
680
681 - `download_id: string`
682
683 The caller-assigned identifier for this download, stable across the state changes reporting it.
684
685 - `type: "download_completed"`
686
687 - `"download_completed"`
688
689 - `url: string`
690
691 The final post-redirect URL the download was served from.
692
693 - `path: optional string or null`
694
695 Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path.
696
697 - `size_bytes: optional number or null`
698
699 The completed download's size.
700
701 - `BetaBrowserStateChangeDownloadFailed object { download_id, type, url, error }`
702
703 A file download that failed — or was cancelled — during this call.
704
705 - `download_id: string`
706
707 The caller-assigned identifier for this download, stable across the state changes reporting it.
708
709 - `type: "download_failed"`
710
711 - `"download_failed"`
712
713 - `url: string`
714
715 The final post-redirect URL the download was served from.
716
717 - `error: optional string or null`
718
719 The failure or cancellation detail, when known.
720
580721 - `is_error: optional boolean`
722
723 - `toolset_name: optional string or null`
724
725 For a toolset member tool_result, the toolset family of the paired tool_use.
581726
582727 - `BetaServerToolUseBlockParam object { id, input, name, 3 more }`
583728
from line 1302
11571302 - `encrypted_content: optional string or null`
11581303
11591304 Opaque metadata from prior compaction, to be round-tripped verbatim
1160
1161 - `BetaMidConversationSystemBlockParam object { content, type, cache_control }`
1162
1163 System instructions that appear mid-conversation.
1164
1165 Use this block to provide or update system-level instructions at a specific
1166 point in the conversation, rather than only via the top-level `system` parameter.
1167
1168 - `content: array of BetaTextBlockParam or BetaRequestToolAdditionBlock or BetaRequestToolRemovalBlock`
1169
1170 System instruction text blocks.
1171
1172 - `BetaTextBlockParam object { text, type, cache_control, citations }`
1173
1174 - `BetaRequestToolAdditionBlock object { tool, type, cache_control }`
1175
1176 Mid-conversation directive to surface a declared tool.
1177
1178 `tool` references a tool (or MCP toolset) by name from the request's
1179 `tools`; it is offered to the model from this point in the
1180 conversation onward.
1181
1182 - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference`
1183
1184 Reference to a single tool the caller declared directly in
1185 `tools[]`. Does not accept the composed `{server}_{name}` form the
1186 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1187 `mcp_toolset_reference` for those.
1188
1189 - `BetaToolChangeToolReference object { name, type }`
1190
1191 Reference to a single tool the caller declared directly in
1192 `tools[]`. Does not accept the composed `{server}_{name}` form the
1193 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1194 `mcp_toolset_reference` for those.
1195
1196 - `name: string`
1197
1198 - `type: "tool_reference"`
1199
1200 - `"tool_reference"`
1201
1202 - `BetaToolChangeMCPToolReference object { name, server_name, type }`
1203
1204 Reference to a single MCP tool by its server and remote name — the
1205 same `server_name`/`name` pair `mcp_tool_use` carries.
1206
1207 - `name: string`
1208
1209 - `server_name: string`
1210
1211 - `type: "mcp_tool_reference"`
1212
1213 - `"mcp_tool_reference"`
1214
1215 - `BetaToolChangeMCPToolsetReference object { server_name, type }`
1216
1217 Reference to every tool in the named MCP server's toolset.
1218
1219 - `server_name: string`
1220
1221 - `type: "mcp_toolset_reference"`
1222
1223 - `"mcp_toolset_reference"`
1224
1225 - `type: "tool_addition"`
1226
1227 - `"tool_addition"`
1228
1229 - `cache_control: optional BetaCacheControlEphemeral or null`
1230
1231 Create a cache control breakpoint at this content block.
1232
1233 - `BetaRequestToolRemovalBlock object { tool, type, cache_control }`
1234
1235 Mid-conversation directive to withdraw a tool.
1236
1237 `tool` references a tool (or MCP toolset) by name from the request's
1238 `tools`; it is no longer offered to the model from this point in the
1239 conversation onward.
1240
1241 - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference`
1242
1243 Reference to a single tool the caller declared directly in
1244 `tools[]`. Does not accept the composed `{server}_{name}` form the
1245 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1246 `mcp_toolset_reference` for those.
1247
1248 - `BetaToolChangeToolReference object { name, type }`
1249
1250 Reference to a single tool the caller declared directly in
1251 `tools[]`. Does not accept the composed `{server}_{name}` form the
1252 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1253 `mcp_toolset_reference` for those.
1254
1255 - `BetaToolChangeMCPToolReference object { name, server_name, type }`
1256
1257 Reference to a single MCP tool by its server and remote name — the
1258 same `server_name`/`name` pair `mcp_tool_use` carries.
1259
1260 - `BetaToolChangeMCPToolsetReference object { server_name, type }`
1261
1262 Reference to every tool in the named MCP server's toolset.
1263
1264 - `type: "tool_removal"`
1265
1266 - `"tool_removal"`
1267
1268 - `cache_control: optional BetaCacheControlEphemeral or null`
1269
1270 Create a cache control breakpoint at this content block.
1271
1272 - `type: "mid_conv_system"`
1273
1274 - `"mid_conv_system"`
1275
1276 - `cache_control: optional BetaCacheControlEphemeral or null`
1277
1278 Create a cache control breakpoint at this content block.
12791305
12801306 - `BetaRequestToolAdditionBlock object { tool, type, cache_control }`
12811307
from line 1311
12851311 `tools`; it is offered to the model from this point in the
12861312 conversation onward.
12871313
1314 - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference`
1315
1316 Reference to a single tool the caller declared directly in
1317 `tools[]`. Does not accept the composed `{server}_{name}` form the
1318 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1319 `mcp_toolset_reference` for those.
1320
1321 - `BetaToolChangeToolReference object { name, type }`
1322
1323 Reference to a single tool the caller declared directly in
1324 `tools[]`. Does not accept the composed `{server}_{name}` form the
1325 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1326 `mcp_toolset_reference` for those.
1327
1328 - `name: string`
1329
1330 - `type: "tool_reference"`
1331
1332 - `"tool_reference"`
1333
1334 - `BetaToolChangeMCPToolReference object { name, server_name, type }`
1335
1336 Reference to a single MCP tool by its server and remote name — the
1337 same `server_name`/`name` pair `mcp_tool_use` carries.
1338
1339 - `name: string`
1340
1341 - `server_name: string`
1342
1343 - `type: "mcp_tool_reference"`
1344
1345 - `"mcp_tool_reference"`
1346
1347 - `BetaToolChangeMCPToolsetReference object { server_name, type }`
1348
1349 Reference to every tool in the named MCP server's toolset.
1350
1351 - `server_name: string`
1352
1353 - `type: "mcp_toolset_reference"`
1354
1355 - `"mcp_toolset_reference"`
1356
1357 - `type: "tool_addition"`
1358
1359 - `"tool_addition"`
1360
1361 - `cache_control: optional BetaCacheControlEphemeral or null`
1362
1363 Create a cache control breakpoint at this content block.
1364
12881365 - `BetaRequestToolRemovalBlock object { tool, type, cache_control }`
12891366
12901367 Mid-conversation directive to withdraw a tool.
from line 1369
12921369 `tool` references a tool (or MCP toolset) by name from the request's
12931370 `tools`; it is no longer offered to the model from this point in the
12941371 conversation onward.
1372
1373 - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference`
1374
1375 Reference to a single tool the caller declared directly in
1376 `tools[]`. Does not accept the composed `{server}_{name}` form the
1377 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1378 `mcp_toolset_reference` for those.
1379
1380 - `BetaToolChangeToolReference object { name, type }`
1381
1382 Reference to a single tool the caller declared directly in
1383 `tools[]`. Does not accept the composed `{server}_{name}` form the
1384 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1385 `mcp_toolset_reference` for those.
1386
1387 - `BetaToolChangeMCPToolReference object { name, server_name, type }`
1388
1389 Reference to a single MCP tool by its server and remote name — the
1390 same `server_name`/`name` pair `mcp_tool_use` carries.
1391
1392 - `BetaToolChangeMCPToolsetReference object { server_name, type }`
1393
1394 Reference to every tool in the named MCP server's toolset.
1395
1396 - `type: "tool_removal"`
1397
1398 - `"tool_removal"`
1399
1400 - `cache_control: optional BetaCacheControlEphemeral or null`
1401
1402 Create a cache control breakpoint at this content block.
12951403
12961404 - `BetaFallbackBlockParam object { from, to, type, trigger }`
12971405
from line 2371
22632371
22642372 When true, guarantees schema validation on tool names and inputs
22652373
2374 - `BetaBrowserToolset20260801 object { type, allowed_callers, cache_control, configs }`
2375
2376 The browser toolset: a single `tools[]` entry (carrying no
2377 `name`) that declares the browser tool family. The model is served
2378 the family's tool with any members disabled via `configs` removed
2379 from its schema.
2380
2381 - `type: "browser_toolset_20260801"`
2382
2383 - `"browser_toolset_20260801"`
2384
2385 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2386
2387 - `"direct"`
2388
2389 - `"code_execution_20250825"`
2390
2391 - `"code_execution_20260120"`
2392
2393 - `"code_execution_20260521"`
2394
2395 - `cache_control: optional BetaCacheControlEphemeral or null`
2396
2397 Create a cache control breakpoint at this content block.
2398
2399 - `configs: optional BetaBrowserToolsetConfigs or null`
2400
2401 Per-member configuration for `browser_toolset_20260801`: one
2402 optional field per member tool, keyed by the member name — the same
2403 name the member's `tool_use` blocks carry. Every member is an
2404 accepted key, and a member's defaults apply wherever its key is
2405 absent. Unknown keys are rejected: the field set is this toolset
2406 version's complete member set.
2407
2408 - `close_tab: optional BetaBrowserCloseTabConfig or null`
2409
2410 `close_tab`'s config overrides.
2411
2412 - `defer_loading: optional boolean or null`
2413
2414 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2415
2416 - `enabled: optional boolean or null`
2417
2418 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2419
2420 - `double_click: optional BetaBrowserDoubleClickConfig or null`
2421
2422 `double_click`'s config overrides.
2423
2424 - `defer_loading: optional boolean or null`
2425
2426 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2427
2428 - `enabled: optional boolean or null`
2429
2430 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2431
2432 - `file_upload: optional BetaBrowserFileUploadConfig or null`
2433
2434 `file_upload`'s config overrides.
2435
2436 - `defer_loading: optional boolean or null`
2437
2438 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2439
2440 - `enabled: optional boolean or null`
2441
2442 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2443
2444 - `find: optional BetaBrowserFindConfig or null`
2445
2446 `find`'s config overrides.
2447
2448 - `defer_loading: optional boolean or null`
2449
2450 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2451
2452 - `enabled: optional boolean or null`
2453
2454 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2455
2456 - `form_input: optional BetaBrowserFormInputConfig or null`
2457
2458 `form_input`'s config overrides.
2459
2460 - `defer_loading: optional boolean or null`
2461
2462 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2463
2464 - `enabled: optional boolean or null`
2465
2466 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2467
2468 - `get_page_text: optional BetaBrowserGetPageTextConfig or null`
2469
2470 `get_page_text`'s config overrides.
2471
2472 - `defer_loading: optional boolean or null`
2473
2474 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2475
2476 - `enabled: optional boolean or null`
2477
2478 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2479
2480 - `hold_key: optional BetaBrowserHoldKeyConfig or null`
2481
2482 `hold_key`'s config overrides.
2483
2484 - `defer_loading: optional boolean or null`
2485
2486 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2487
2488 - `enabled: optional boolean or null`
2489
2490 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2491
2492 - `hover: optional BetaBrowserHoverConfig or null`
2493
2494 `hover`'s config overrides.
2495
2496 - `defer_loading: optional boolean or null`
2497
2498 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2499
2500 - `enabled: optional boolean or null`
2501
2502 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2503
2504 - `javascript_exec: optional BetaBrowserJavascriptExecConfig or null`
2505
2506 `javascript_exec`'s config overrides.
2507
2508 - `defer_loading: optional boolean or null`
2509
2510 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2511
2512 - `enabled: optional boolean or null`
2513
2514 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2515
2516 - `key: optional BetaBrowserKeyConfig or null`
2517
2518 `key`'s config overrides.
2519
2520 - `defer_loading: optional boolean or null`
2521
2522 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2523
2524 - `enabled: optional boolean or null`
2525
2526 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2527
2528 - `left_click: optional BetaBrowserLeftClickConfig or null`
2529
2530 `left_click`'s config overrides.
2531
2532 - `defer_loading: optional boolean or null`
2533
2534 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2535
2536 - `enabled: optional boolean or null`
2537
2538 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2539
2540 - `left_click_drag: optional BetaBrowserLeftClickDragConfig or null`
2541
2542 `left_click_drag`'s config overrides.
2543
2544 - `defer_loading: optional boolean or null`
2545
2546 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2547
2548 - `enabled: optional boolean or null`
2549
2550 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2551
2552 - `left_mouse_down: optional BetaBrowserLeftMouseDownConfig or null`
2553
2554 `left_mouse_down`'s config overrides.
2555
2556 - `defer_loading: optional boolean or null`
2557
2558 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2559
2560 - `enabled: optional boolean or null`
2561
2562 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2563
2564 - `left_mouse_up: optional BetaBrowserLeftMouseUpConfig or null`
2565
2566 `left_mouse_up`'s config overrides.
2567
2568 - `defer_loading: optional boolean or null`
2569
2570 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2571
2572 - `enabled: optional boolean or null`
2573
2574 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2575
2576 - `list_tabs: optional BetaBrowserListTabsConfig or null`
2577
2578 `list_tabs`'s config overrides.
2579
2580 - `defer_loading: optional boolean or null`
2581
2582 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2583
2584 - `enabled: optional boolean or null`
2585
2586 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2587
2588 - `middle_click: optional BetaBrowserMiddleClickConfig or null`
2589
2590 `middle_click`'s config overrides.
2591
2592 - `defer_loading: optional boolean or null`
2593
2594 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2595
2596 - `enabled: optional boolean or null`
2597
2598 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2599
2600 - `mouse_move: optional BetaBrowserMouseMoveConfig or null`
2601
2602 `mouse_move`'s config overrides.
2603
2604 - `defer_loading: optional boolean or null`
2605
2606 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2607
2608 - `enabled: optional boolean or null`
2609
2610 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2611
2612 - `navigate: optional BetaBrowserNavigateConfig or null`
2613
2614 `navigate`'s config overrides.
2615
2616 - `defer_loading: optional boolean or null`
2617
2618 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2619
2620 - `enabled: optional boolean or null`
2621
2622 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2623
2624 - `new_tab: optional BetaBrowserNewTabConfig or null`
2625
2626 `new_tab`'s config overrides.
2627
2628 - `defer_loading: optional boolean or null`
2629
2630 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2631
2632 - `enabled: optional boolean or null`
2633
2634 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2635
2636 - `read_console: optional BetaBrowserReadConsoleConfig or null`
2637
2638 `read_console`'s config overrides.
2639
2640 - `defer_loading: optional boolean or null`
2641
2642 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2643
2644 - `enabled: optional boolean or null`
2645
2646 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2647
2648 - `read_network: optional BetaBrowserReadNetworkConfig or null`
2649
2650 `read_network`'s config overrides.
2651
2652 - `defer_loading: optional boolean or null`
2653
2654 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2655
2656 - `enabled: optional boolean or null`
2657
2658 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2659
2660 - `read_page: optional BetaBrowserReadPageConfig or null`
2661
2662 `read_page`'s config overrides.
2663
2664 - `defer_loading: optional boolean or null`
2665
2666 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2667
2668 - `enabled: optional boolean or null`
2669
2670 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2671
2672 - `right_click: optional BetaBrowserRightClickConfig or null`
2673
2674 `right_click`'s config overrides.
2675
2676 - `defer_loading: optional boolean or null`
2677
2678 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2679
2680 - `enabled: optional boolean or null`
2681
2682 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2683
2684 - `screenshot: optional BetaBrowserScreenshotConfig or null`
2685
2686 `screenshot`'s config overrides.
2687
2688 - `defer_loading: optional boolean or null`
2689
2690 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2691
2692 - `enabled: optional boolean or null`
2693
2694 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2695
2696 - `scroll: optional BetaBrowserScrollConfig or null`
2697
2698 `scroll`'s config overrides.
2699
2700 - `defer_loading: optional boolean or null`
2701
2702 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2703
2704 - `enabled: optional boolean or null`
2705
2706 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2707
2708 - `scroll_to: optional BetaBrowserScrollToConfig or null`
2709
2710 `scroll_to`'s config overrides.
2711
2712 - `defer_loading: optional boolean or null`
2713
2714 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2715
2716 - `enabled: optional boolean or null`
2717
2718 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2719
2720 - `switch_tab: optional BetaBrowserSwitchTabConfig or null`
2721
2722 `switch_tab`'s config overrides.
2723
2724 - `defer_loading: optional boolean or null`
2725
2726 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2727
2728 - `enabled: optional boolean or null`
2729
2730 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2731
2732 - `triple_click: optional BetaBrowserTripleClickConfig or null`
2733
2734 `triple_click`'s config overrides.
2735
2736 - `defer_loading: optional boolean or null`
2737
2738 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2739
2740 - `enabled: optional boolean or null`
2741
2742 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2743
2744 - `type: optional BetaBrowserTypeConfig or null`
2745
2746 `type`'s config overrides.
2747
2748 - `defer_loading: optional boolean or null`
2749
2750 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2751
2752 - `enabled: optional boolean or null`
2753
2754 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2755
2756 - `wait: optional BetaBrowserWaitConfig or null`
2757
2758 `wait`'s config overrides.
2759
2760 - `defer_loading: optional boolean or null`
2761
2762 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2763
2764 - `enabled: optional boolean or null`
2765
2766 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2767
2768 - `zoom: optional BetaBrowserZoomConfig or null`
2769
2770 `zoom`'s config overrides.
2771
2772 - `defer_loading: optional boolean or null`
2773
2774 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2775
2776 - `enabled: optional boolean or null`
2777
2778 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2779
22662780 - `BetaToolComputerUse20241022 object { display_height_px, display_width_px, name, 7 more }`
22672781
22682782 - `display_height_px: number`
from line 3006
24923006 - `strict: optional boolean`
24933007
24943008 When true, guarantees schema validation on tool names and inputs
3009
3010 - `BetaComputerToolset20260801 object { type, allowed_callers, cache_control, configs }`
3011
3012 The computer toolset: a single `tools[]` entry (carrying no
3013 `name`) that declares the computer tool family. The model is
3014 served the family's tool with any members disabled via `configs`
3015 removed from its schema. Every member is enabled by default, zoom
3016 included. The single-tool options `display_number` and
3017 `enable_zoom` are not fields of a toolset entry — it carries only
3018 `type`, `configs`, and `cache_control`; zoom is controlled
3019 via `configs.zoom.enabled`.
3020
3021 - `type: "computer_toolset_20260801"`
3022
3023 - `"computer_toolset_20260801"`
3024
3025 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3026
3027 - `"direct"`
3028
3029 - `"code_execution_20250825"`
3030
3031 - `"code_execution_20260120"`
3032
3033 - `"code_execution_20260521"`
3034
3035 - `cache_control: optional BetaCacheControlEphemeral or null`
3036
3037 Create a cache control breakpoint at this content block.
3038
3039 - `configs: optional BetaComputerToolsetConfigs or null`
3040
3041 Per-member configuration for `computer_toolset_20260801`: one
3042 optional field per member tool, keyed by the member name — the same
3043 name the member's `tool_use` blocks carry. Every member is an
3044 accepted key, and a member's defaults apply wherever its key is
3045 absent. Unknown keys are rejected: the field set is this toolset
3046 version's complete member set.
3047
3048 - `cursor_position: optional BetaComputerCursorPositionConfig or null`
3049
3050 `cursor_position`'s config overrides.
3051
3052 - `defer_loading: optional boolean or null`
3053
3054 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3055
3056 - `enabled: optional boolean or null`
3057
3058 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3059
3060 - `double_click: optional BetaComputerDoubleClickConfig or null`
3061
3062 `double_click`'s config overrides.
3063
3064 - `defer_loading: optional boolean or null`
3065
3066 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3067
3068 - `enabled: optional boolean or null`
3069
3070 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3071
3072 - `hold_key: optional BetaComputerHoldKeyConfig or null`
3073
3074 `hold_key`'s config overrides.
3075
3076 - `defer_loading: optional boolean or null`
3077
3078 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3079
3080 - `enabled: optional boolean or null`
3081
3082 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3083
3084 - `key: optional BetaComputerKeyConfig or null`
3085
3086 `key`'s config overrides.
3087
3088 - `defer_loading: optional boolean or null`
3089
3090 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3091
3092 - `enabled: optional boolean or null`
3093
3094 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3095
3096 - `left_click: optional BetaComputerLeftClickConfig or null`
3097
3098 `left_click`'s config overrides.
3099
3100 - `defer_loading: optional boolean or null`
3101
3102 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3103
3104 - `enabled: optional boolean or null`
3105
3106 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3107
3108 - `left_click_drag: optional BetaComputerLeftClickDragConfig or null`
3109
3110 `left_click_drag`'s config overrides.
3111
3112 - `defer_loading: optional boolean or null`
3113
3114 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3115
3116 - `enabled: optional boolean or null`
3117
3118 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3119
3120 - `left_mouse_down: optional BetaComputerLeftMouseDownConfig or null`
3121
3122 `left_mouse_down`'s config overrides.
3123
3124 - `defer_loading: optional boolean or null`
3125
3126 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3127
3128 - `enabled: optional boolean or null`
3129
3130 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3131
3132 - `left_mouse_up: optional BetaComputerLeftMouseUpConfig or null`
3133
3134 `left_mouse_up`'s config overrides.
3135
3136 - `defer_loading: optional boolean or null`
3137
3138 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3139
3140 - `enabled: optional boolean or null`
3141
3142 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3143
3144 - `middle_click: optional BetaComputerMiddleClickConfig or null`
3145
3146 `middle_click`'s config overrides.
3147
3148 - `defer_loading: optional boolean or null`
3149
3150 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3151
3152 - `enabled: optional boolean or null`
3153
3154 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3155
3156 - `mouse_move: optional BetaComputerMouseMoveConfig or null`
3157
3158 `mouse_move`'s config overrides.
3159
3160 - `defer_loading: optional boolean or null`
3161
3162 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3163
3164 - `enabled: optional boolean or null`
3165
3166 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3167
3168 - `right_click: optional BetaComputerRightClickConfig or null`
3169
3170 `right_click`'s config overrides.
3171
3172 - `defer_loading: optional boolean or null`
3173
3174 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3175
3176 - `enabled: optional boolean or null`
3177
3178 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3179
3180 - `screenshot: optional BetaComputerScreenshotConfig or null`
3181
3182 `screenshot`'s config overrides.
3183
3184 - `defer_loading: optional boolean or null`
3185
3186 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3187
3188 - `enabled: optional boolean or null`
3189
3190 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3191
3192 - `scroll: optional BetaComputerScrollConfig or null`
3193
3194 `scroll`'s config overrides.
3195
3196 - `defer_loading: optional boolean or null`
3197
3198 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3199
3200 - `enabled: optional boolean or null`
3201
3202 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3203
3204 - `triple_click: optional BetaComputerTripleClickConfig or null`
3205
3206 `triple_click`'s config overrides.
3207
3208 - `defer_loading: optional boolean or null`
3209
3210 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3211
3212 - `enabled: optional boolean or null`
3213
3214 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3215
3216 - `type: optional BetaComputerTypeConfig or null`
3217
3218 `type`'s config overrides.
3219
3220 - `defer_loading: optional boolean or null`
3221
3222 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3223
3224 - `enabled: optional boolean or null`
3225
3226 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3227
3228 - `wait: optional BetaComputerWaitConfig or null`
3229
3230 `wait`'s config overrides.
3231
3232 - `defer_loading: optional boolean or null`
3233
3234 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3235
3236 - `enabled: optional boolean or null`
3237
3238 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
3239
3240 - `zoom: optional BetaComputerZoomConfig or null`
3241
3242 `zoom`'s config overrides.
3243
3244 - `defer_loading: optional boolean or null`
3245
3246 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3247
3248 - `enabled: optional boolean or null`
3249
3250 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
24953251
24963252 - `BetaToolTextEditor20250124 object { name, type, allowed_callers, 4 more }`
24973253
from line 4084
33284084 "role": "user"
33294085 }
33304086 ],
3331 "model": "claude-opus-4-6"
4087 "model": "claude-opus-5"
33324088 }
33334089 }
33344090 ]
33354091
api/beta/messages/batches/results Changed · +8 / -2 lines
from line 27
2727
2828 - `string`
2929
30 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
30 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
3131
3232 - `"message-batches-2024-09-24"`
3333
from line 73
7373
7474 - `"user-profiles-2026-03-24"`
7575
76 - `"user-profiles-2026-08-18"`
77
7678 - `"advisor-tool-2026-03-01"`
7779
7880 - `"managed-agents-2026-04-01"`
from line 342
340342
341343 - `"redacted_thinking"`
342344
343 - `BetaToolUseBlock object { id, input, name, 2 more }`
345 - `BetaToolUseBlock object { id, input, name, 3 more }`
344346
345347 - `id: string`
346348
from line 383
381383 - `type: "code_execution_20260120"`
382384
383385 - `"code_execution_20260120"`
386
387 - `toolset_name: optional string or null`
388
389 For a toolset member tool_use, the toolset family.
384390
385391 - `BetaServerToolUseBlock object { id, input, name, 2 more }`
386392