One read of Claude Developer Platformapi-20260923T183720Z
268 pages moved out of 637 read.
Pages moved
268
significant first
Pages read
637
in this capture
Captured
18:37 UTC
Corpus hash
f552f1fbd6ec
corpus-hash
What this read moved
76-100 of 268, page 4 of 11This capture is too large to show at once. Changes 76-100 of 268 are below, significant first; the rest are on the following screens.
api/beta/messages/batches/delete Changed · +5 / -1 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 43 more`
30 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
3131
3232 - `"message-batches-2024-09-24"`
3333
from line 120
120120 - `"mid-conversation-system-clear-at-2026-08-21"`
121121
122122 - `"compact-2026-09-04"`
123
124 - `"inline-tools-2026-09-15"`
125
126 - `"mcp-client-2026-09-15"`
123127
124128- `"anthropic-workspace-id": optional string`
125129
api/beta/messages/batches/list Changed · +5 / -1 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 43 more`
40 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
4141
4242 - `"message-batches-2024-09-24"`
4343
from line 130
130130 - `"mid-conversation-system-clear-at-2026-08-21"`
131131
132132 - `"compact-2026-09-04"`
133
134 - `"inline-tools-2026-09-15"`
135
136 - `"mcp-client-2026-09-15"`
133137
134138- `"anthropic-workspace-id": optional string`
135139
api/beta/messages/batches/results Changed · +2168 / -77 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 27
2727
2828 - `string`
2929
30 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
30 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
3131
3232 - `"message-batches-2024-09-24"`
3333
from line 120
120120 - `"mid-conversation-system-clear-at-2026-08-21"`
121121
122122 - `"compact-2026-09-04"`
123
124 - `"inline-tools-2026-09-15"`
125
126 - `"mcp-client-2026-09-15"`
123127
124128- `"anthropic-workspace-id": optional string`
125129
from line 1058
10541058
10551059 Signature over the summary, to be sent back with the block verbatim
10561060
1061 - `tool_changes: optional array of BetaResponseToolAdditionBlock or BetaResponseToolRemovalBlock or null`
1062
1063 The tool changes of the compacted range: the `tool_addition` and `tool_removal` blocks that take the request's `tools` to the tool set in effect at the end of the range, or `[]` when the range changed no tool. Absent when the server did not compute them. Send the block back unchanged.
1064
1065 - `BetaResponseToolAdditionBlock object`
1066
1067 An entry of a `compaction` block's `tool_changes`: a tool the
1068 compacted range made available, as a reference to a `tools` entry or
1069 MCP toolset, or as the tool definition in effect at the end of the
1070 range, by value. Send it back unchanged.
1071
1072 - `type: "tool_addition"`
1073
1074 default: tool_addition
1075
1076 - `tool: BetaResponseToolChangeToolReference or BetaResponseToolChangeMCPToolReference or BetaResponseToolChangeMCPToolsetReference or BetaToolChangeToolDefinition`
1077
1078 The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value.
1079
1080 - `BetaResponseToolChangeToolReference object`
1081
1082 Reference to a single tool, by the name the model uses to call it, as
1083 a `compaction` block's `tool_changes` entry reports it: a tool
1084 declared in `tools` or defined by an earlier `tool_addition` block.
1085 Send it back unchanged with the block.
1086
1087 - `type: "tool_reference"`
1088
1089 default: tool_reference
1090
1091 - `name: string`
1092
1093 - `BetaResponseToolChangeMCPToolReference object`
1094
1095 Reference to a single MCP tool, by its server and its name on that
1096 server, as a `compaction` block's `tool_changes` entry reports it.
1097 Send it back unchanged with the block.
1098
1099 - `type: "mcp_tool_reference"`
1100
1101 default: mcp_tool_reference
1102
1103 - `name: string`
1104
1105 - `server_name: string`
1106
1107 - `BetaResponseToolChangeMCPToolsetReference object`
1108
1109 Reference to every tool in the named MCP server's toolset, as a
1110 `compaction` block's `tool_changes` entry reports it. Send it back
1111 unchanged with the block.
1112
1113 - `type: "mcp_toolset_reference"`
1114
1115 default: mcp_toolset_reference
1116
1117 - `server_name: string`
1118
1119 - `BetaToolChangeToolDefinition object`
1120
1121 A tool defined by value, as a `compaction` block's `tool_changes` entry
1122 reports it: `definition` is the tool's definition as it was sent, in the
1123 form of a `tools` entry, without `cache_control`. Send it back unchanged
1124 with the block.
1125
1126 - `type: "tool_definition"`
1127
1128 default: tool_definition
1129
1130 - `definition: BetaResponseToolUnion`
1131
1132 - `BetaResponseTool object`
1133
1134 A custom tool definition, as sent.
1135
1136 - `type: optional "custom" or null`
1137
1138 - `input_schema: BetaResponseToolInputSchema`
1139
1140 [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.
1141
1142 This defines the shape of the `input` that your tool accepts and that the model will produce.
1143
1144 - `type: "object"`
1145
1146 - `properties: optional map[unknown] or null`
1147
1148 - `required: optional array of string or null`
1149
1150 - `name: string`
1151
1152 Name of the tool.
1153
1154 This is how the tool will be called by the model and in `tool_use` blocks.
1155
1156 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$
1157
1158 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1159
1160 - `"direct"`
1161
1162 - `"code_execution_20250825"`
1163
1164 - `"code_execution_20260120"`
1165
1166 - `"code_execution_20260521"`
1167
1168 - `defer_loading: optional boolean`
1169
1170 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1171
1172 - `description: optional string`
1173
1174 Description of what this tool does.
1175
1176 Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.
1177
1178 - `eager_input_streaming: optional boolean or null`
1179
1180 Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers.
1181
1182 - `input_examples: optional array of map[unknown]`
1183
1184 - `strict: optional boolean`
1185
1186 When true, guarantees schema validation on tool names and inputs
1187
1188 - `BetaToolBash20241022 object`
1189
1190 - `type: "bash_20241022"`
1191
1192 - `name: "bash"`
1193
1194 Name of the tool.
1195
1196 This is how the tool will be called by the model and in `tool_use` blocks.
1197
1198 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1199
1200 - `"direct"`
1201
1202 - `"code_execution_20250825"`
1203
1204 - `"code_execution_20260120"`
1205
1206 - `"code_execution_20260521"`
1207
1208 - `cache_control: optional BetaCacheControlEphemeral or null`
1209
1210 Create a cache control breakpoint at this content block.
1211
1212 - `type: "ephemeral"`
1213
1214 - `ttl: optional "5m" or "1h"`
1215
1216 The time-to-live for the cache control breakpoint.
1217
1218 This may be one the following values:
1219
1220 - `5m`: 5 minutes
1221 - `1h`: 1 hour
1222
1223 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.
1224
1225 - `"5m"`
1226
1227 - `"1h"`
1228
1229 - `defer_loading: optional boolean`
1230
1231 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1232
1233 - `input_examples: optional array of map[unknown]`
1234
1235 - `strict: optional boolean`
1236
1237 When true, guarantees schema validation on tool names and inputs
1238
1239 - `BetaToolBash20250124 object`
1240
1241 - `type: "bash_20250124"`
1242
1243 - `name: "bash"`
1244
1245 Name of the tool.
1246
1247 This is how the tool will be called by the model and in `tool_use` blocks.
1248
1249 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1250
1251 - `"direct"`
1252
1253 - `"code_execution_20250825"`
1254
1255 - `"code_execution_20260120"`
1256
1257 - `"code_execution_20260521"`
1258
1259 - `cache_control: optional BetaCacheControlEphemeral or null`
1260
1261 Create a cache control breakpoint at this content block.
1262
1263 - `defer_loading: optional boolean`
1264
1265 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1266
1267 - `input_examples: optional array of map[unknown]`
1268
1269 - `strict: optional boolean`
1270
1271 When true, guarantees schema validation on tool names and inputs
1272
1273 - `BetaCodeExecutionTool20250522 object`
1274
1275 - `type: "code_execution_20250522"`
1276
1277 - `name: "code_execution"`
1278
1279 Name of the tool.
1280
1281 This is how the tool will be called by the model and in `tool_use` blocks.
1282
1283 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1284
1285 - `"direct"`
1286
1287 - `"code_execution_20250825"`
1288
1289 - `"code_execution_20260120"`
1290
1291 - `"code_execution_20260521"`
1292
1293 - `cache_control: optional BetaCacheControlEphemeral or null`
1294
1295 Create a cache control breakpoint at this content block.
1296
1297 - `defer_loading: optional boolean`
1298
1299 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1300
1301 - `strict: optional boolean`
1302
1303 When true, guarantees schema validation on tool names and inputs
1304
1305 - `BetaCodeExecutionTool20250825 object`
1306
1307 - `type: "code_execution_20250825"`
1308
1309 - `name: "code_execution"`
1310
1311 Name of the tool.
1312
1313 This is how the tool will be called by the model and in `tool_use` blocks.
1314
1315 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1316
1317 - `"direct"`
1318
1319 - `"code_execution_20250825"`
1320
1321 - `"code_execution_20260120"`
1322
1323 - `"code_execution_20260521"`
1324
1325 - `cache_control: optional BetaCacheControlEphemeral or null`
1326
1327 Create a cache control breakpoint at this content block.
1328
1329 - `defer_loading: optional boolean`
1330
1331 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1332
1333 - `strict: optional boolean`
1334
1335 When true, guarantees schema validation on tool names and inputs
1336
1337 - `BetaCodeExecutionTool20260120 object`
1338
1339 Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
1340
1341 - `type: "code_execution_20260120"`
1342
1343 - `name: "code_execution"`
1344
1345 Name of the tool.
1346
1347 This is how the tool will be called by the model and in `tool_use` blocks.
1348
1349 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1350
1351 - `"direct"`
1352
1353 - `"code_execution_20250825"`
1354
1355 - `"code_execution_20260120"`
1356
1357 - `"code_execution_20260521"`
1358
1359 - `cache_control: optional BetaCacheControlEphemeral or null`
1360
1361 Create a cache control breakpoint at this content block.
1362
1363 - `defer_loading: optional boolean`
1364
1365 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1366
1367 - `strict: optional boolean`
1368
1369 When true, guarantees schema validation on tool names and inputs
1370
1371 - `BetaCodeExecutionTool20260521 object`
1372
1373 Code execution tool with REPL state persistence.
1374
1375 - `type: "code_execution_20260521"`
1376
1377 - `name: "code_execution"`
1378
1379 Name of the tool.
1380
1381 This is how the tool will be called by the model and in `tool_use` blocks.
1382
1383 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1384
1385 - `"direct"`
1386
1387 - `"code_execution_20250825"`
1388
1389 - `"code_execution_20260120"`
1390
1391 - `"code_execution_20260521"`
1392
1393 - `cache_control: optional BetaCacheControlEphemeral or null`
1394
1395 Create a cache control breakpoint at this content block.
1396
1397 - `defer_loading: optional boolean`
1398
1399 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1400
1401 - `strict: optional boolean`
1402
1403 When true, guarantees schema validation on tool names and inputs
1404
1405 - `BetaBrowserToolset20260801 object`
1406
1407 The browser toolset: a single `tools[]` entry (carrying no
1408 `name`) that declares the browser tool family. The model is served
1409 the family's tool with any members disabled via `configs` removed
1410 from its schema.
1411
1412 - `type: "browser_toolset_20260801"`
1413
1414 - `cache_control: optional BetaCacheControlEphemeral or null`
1415
1416 Create a cache control breakpoint at this content block.
1417
1418 - `configs: optional BetaBrowserToolsetConfigs or null`
1419
1420 Per-member configuration for `browser_toolset_20260801`: one
1421 optional field per member tool, keyed by the member name — the same
1422 name the member's `tool_use` blocks carry. Every member is an
1423 accepted key, and a member's defaults apply wherever its key is
1424 absent. Unknown keys are rejected: the field set is this toolset
1425 version's complete member set.
1426
1427 - `type: optional BetaBrowserTypeConfig or null`
1428
1429 `type`'s config overrides.
1430
1431 - `defer_loading: optional boolean or null`
1432
1433 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1434
1435 - `enabled: optional boolean or null`
1436
1437 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.
1438
1439 - `close_tab: optional BetaBrowserCloseTabConfig or null`
1440
1441 `close_tab`'s config overrides.
1442
1443 - `defer_loading: optional boolean or null`
1444
1445 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1446
1447 - `enabled: optional boolean or null`
1448
1449 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.
1450
1451 - `double_click: optional BetaBrowserDoubleClickConfig or null`
1452
1453 `double_click`'s config overrides.
1454
1455 - `defer_loading: optional boolean or null`
1456
1457 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1458
1459 - `enabled: optional boolean or null`
1460
1461 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.
1462
1463 - `file_upload: optional BetaBrowserFileUploadConfig or null`
1464
1465 `file_upload`'s config overrides.
1466
1467 - `defer_loading: optional boolean or null`
1468
1469 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1470
1471 - `enabled: optional boolean or null`
1472
1473 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.
1474
1475 - `find: optional BetaBrowserFindConfig or null`
1476
1477 `find`'s config overrides.
1478
1479 - `defer_loading: optional boolean or null`
1480
1481 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1482
1483 - `enabled: optional boolean or null`
1484
1485 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.
1486
1487 - `form_input: optional BetaBrowserFormInputConfig or null`
1488
1489 `form_input`'s config overrides.
1490
1491 - `defer_loading: optional boolean or null`
1492
1493 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1494
1495 - `enabled: optional boolean or null`
1496
1497 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.
1498
1499 - `get_page_text: optional BetaBrowserGetPageTextConfig or null`
1500
1501 `get_page_text`'s config overrides.
1502
1503 - `defer_loading: optional boolean or null`
1504
1505 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1506
1507 - `enabled: optional boolean or null`
1508
1509 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.
1510
1511 - `hold_key: optional BetaBrowserHoldKeyConfig or null`
1512
1513 `hold_key`'s config overrides.
1514
1515 - `defer_loading: optional boolean or null`
1516
1517 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1518
1519 - `enabled: optional boolean or null`
1520
1521 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.
1522
1523 - `hover: optional BetaBrowserHoverConfig or null`
1524
1525 `hover`'s config overrides.
1526
1527 - `defer_loading: optional boolean or null`
1528
1529 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1530
1531 - `enabled: optional boolean or null`
1532
1533 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.
1534
1535 - `javascript_exec: optional BetaBrowserJavascriptExecConfig or null`
1536
1537 `javascript_exec`'s config overrides.
1538
1539 - `defer_loading: optional boolean or null`
1540
1541 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1542
1543 - `enabled: optional boolean or null`
1544
1545 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.
1546
1547 - `key: optional BetaBrowserKeyConfig or null`
1548
1549 `key`'s config overrides.
1550
1551 - `defer_loading: optional boolean or null`
1552
1553 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1554
1555 - `enabled: optional boolean or null`
1556
1557 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.
1558
1559 - `left_click: optional BetaBrowserLeftClickConfig or null`
1560
1561 `left_click`'s config overrides.
1562
1563 - `defer_loading: optional boolean or null`
1564
1565 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1566
1567 - `enabled: optional boolean or null`
1568
1569 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.
1570
1571 - `left_click_drag: optional BetaBrowserLeftClickDragConfig or null`
1572
1573 `left_click_drag`'s config overrides.
1574
1575 - `defer_loading: optional boolean or null`
1576
1577 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1578
1579 - `enabled: optional boolean or null`
1580
1581 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.
1582
1583 - `left_mouse_down: optional BetaBrowserLeftMouseDownConfig or null`
1584
1585 `left_mouse_down`'s config overrides.
1586
1587 - `defer_loading: optional boolean or null`
1588
1589 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1590
1591 - `enabled: optional boolean or null`
1592
1593 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.
1594
1595 - `left_mouse_up: optional BetaBrowserLeftMouseUpConfig or null`
1596
1597 `left_mouse_up`'s config overrides.
1598
1599 - `defer_loading: optional boolean or null`
1600
1601 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1602
1603 - `enabled: optional boolean or null`
1604
1605 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.
1606
1607 - `list_tabs: optional BetaBrowserListTabsConfig or null`
1608
1609 `list_tabs`'s config overrides.
1610
1611 - `defer_loading: optional boolean or null`
1612
1613 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1614
1615 - `enabled: optional boolean or null`
1616
1617 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.
1618
1619 - `middle_click: optional BetaBrowserMiddleClickConfig or null`
1620
1621 `middle_click`'s config overrides.
1622
1623 - `defer_loading: optional boolean or null`
1624
1625 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1626
1627 - `enabled: optional boolean or null`
1628
1629 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.
1630
1631 - `mouse_move: optional BetaBrowserMouseMoveConfig or null`
1632
1633 `mouse_move`'s config overrides.
1634
1635 - `defer_loading: optional boolean or null`
1636
1637 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1638
1639 - `enabled: optional boolean or null`
1640
1641 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.
1642
1643 - `navigate: optional BetaBrowserNavigateConfig or null`
1644
1645 `navigate`'s config overrides.
1646
1647 - `defer_loading: optional boolean or null`
1648
1649 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1650
1651 - `enabled: optional boolean or null`
1652
1653 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.
1654
1655 - `new_tab: optional BetaBrowserNewTabConfig or null`
1656
1657 `new_tab`'s config overrides.
1658
1659 - `defer_loading: optional boolean or null`
1660
1661 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1662
1663 - `enabled: optional boolean or null`
1664
1665 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.
1666
1667 - `read_console: optional BetaBrowserReadConsoleConfig or null`
1668
1669 `read_console`'s config overrides.
1670
1671 - `defer_loading: optional boolean or null`
1672
1673 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1674
1675 - `enabled: optional boolean or null`
1676
1677 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.
1678
1679 - `read_network: optional BetaBrowserReadNetworkConfig or null`
1680
1681 `read_network`'s config overrides.
1682
1683 - `defer_loading: optional boolean or null`
1684
1685 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1686
1687 - `enabled: optional boolean or null`
1688
1689 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.
1690
1691 - `read_page: optional BetaBrowserReadPageConfig or null`
1692
1693 `read_page`'s config overrides.
1694
1695 - `defer_loading: optional boolean or null`
1696
1697 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1698
1699 - `enabled: optional boolean or null`
1700
1701 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.
1702
1703 - `right_click: optional BetaBrowserRightClickConfig or null`
1704
1705 `right_click`'s config overrides.
1706
1707 - `defer_loading: optional boolean or null`
1708
1709 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1710
1711 - `enabled: optional boolean or null`
1712
1713 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.
1714
1715 - `screenshot: optional BetaBrowserScreenshotConfig or null`
1716
1717 `screenshot`'s config overrides.
1718
1719 - `defer_loading: optional boolean or null`
1720
1721 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1722
1723 - `enabled: optional boolean or null`
1724
1725 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.
1726
1727 - `scroll: optional BetaBrowserScrollConfig or null`
1728
1729 `scroll`'s config overrides.
1730
1731 - `defer_loading: optional boolean or null`
1732
1733 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1734
1735 - `enabled: optional boolean or null`
1736
1737 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.
1738
1739 - `scroll_to: optional BetaBrowserScrollToConfig or null`
1740
1741 `scroll_to`'s config overrides.
1742
1743 - `defer_loading: optional boolean or null`
1744
1745 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1746
1747 - `enabled: optional boolean or null`
1748
1749 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.
1750
1751 - `switch_tab: optional BetaBrowserSwitchTabConfig or null`
1752
1753 `switch_tab`'s config overrides.
1754
1755 - `defer_loading: optional boolean or null`
1756
1757 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1758
1759 - `enabled: optional boolean or null`
1760
1761 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.
1762
1763 - `triple_click: optional BetaBrowserTripleClickConfig or null`
1764
1765 `triple_click`'s config overrides.
1766
1767 - `defer_loading: optional boolean or null`
1768
1769 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1770
1771 - `enabled: optional boolean or null`
1772
1773 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.
1774
1775 - `wait: optional BetaBrowserWaitConfig or null`
1776
1777 `wait`'s config overrides.
1778
1779 - `defer_loading: optional boolean or null`
1780
1781 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1782
1783 - `enabled: optional boolean or null`
1784
1785 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.
1786
1787 - `zoom: optional BetaBrowserZoomConfig or null`
1788
1789 `zoom`'s config overrides.
1790
1791 - `defer_loading: optional boolean or null`
1792
1793 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1794
1795 - `enabled: optional boolean or null`
1796
1797 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.
1798
1799 - `BetaToolComputerUse20241022 object`
1800
1801 - `type: "computer_20241022"`
1802
1803 - `display_height_px: number`
1804
1805 The height of the display in pixels.
1806
1807 minimum: 1
1808
1809 - `display_width_px: number`
1810
1811 The width of the display in pixels.
1812
1813 minimum: 1
1814
1815 - `name: "computer"`
1816
1817 Name of the tool.
1818
1819 This is how the tool will be called by the model and in `tool_use` blocks.
1820
1821 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1822
1823 - `"direct"`
1824
1825 - `"code_execution_20250825"`
1826
1827 - `"code_execution_20260120"`
1828
1829 - `"code_execution_20260521"`
1830
1831 - `cache_control: optional BetaCacheControlEphemeral or null`
1832
1833 Create a cache control breakpoint at this content block.
1834
1835 - `defer_loading: optional boolean`
1836
1837 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1838
1839 - `display_number: optional number or null`
1840
1841 The X11 display number (e.g. 0, 1) for the display.
1842
1843 minimum: 0
1844
1845 - `input_examples: optional array of map[unknown]`
1846
1847 - `strict: optional boolean`
1848
1849 When true, guarantees schema validation on tool names and inputs
1850
1851 - `BetaMemoryTool20250818 object`
1852
1853 - `type: "memory_20250818"`
1854
1855 - `name: "memory"`
1856
1857 Name of the tool.
1858
1859 This is how the tool will be called by the model and in `tool_use` blocks.
1860
1861 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1862
1863 - `"direct"`
1864
1865 - `"code_execution_20250825"`
1866
1867 - `"code_execution_20260120"`
1868
1869 - `"code_execution_20260521"`
1870
1871 - `cache_control: optional BetaCacheControlEphemeral or null`
1872
1873 Create a cache control breakpoint at this content block.
1874
1875 - `defer_loading: optional boolean`
1876
1877 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1878
1879 - `input_examples: optional array of map[unknown]`
1880
1881 - `strict: optional boolean`
1882
1883 When true, guarantees schema validation on tool names and inputs
1884
1885 - `BetaToolComputerUse20250124 object`
1886
1887 - `type: "computer_20250124"`
1888
1889 - `display_height_px: number`
1890
1891 The height of the display in pixels.
1892
1893 minimum: 1
1894
1895 - `display_width_px: number`
1896
1897 The width of the display in pixels.
1898
1899 minimum: 1
1900
1901 - `name: "computer"`
1902
1903 Name of the tool.
1904
1905 This is how the tool will be called by the model and in `tool_use` blocks.
1906
1907 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1908
1909 - `"direct"`
1910
1911 - `"code_execution_20250825"`
1912
1913 - `"code_execution_20260120"`
1914
1915 - `"code_execution_20260521"`
1916
1917 - `cache_control: optional BetaCacheControlEphemeral or null`
1918
1919 Create a cache control breakpoint at this content block.
1920
1921 - `defer_loading: optional boolean`
1922
1923 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1924
1925 - `display_number: optional number or null`
1926
1927 The X11 display number (e.g. 0, 1) for the display.
1928
1929 minimum: 0
1930
1931 - `input_examples: optional array of map[unknown]`
1932
1933 - `strict: optional boolean`
1934
1935 When true, guarantees schema validation on tool names and inputs
1936
1937 - `BetaToolTextEditor20241022 object`
1938
1939 - `type: "text_editor_20241022"`
1940
1941 - `name: "str_replace_editor"`
1942
1943 Name of the tool.
1944
1945 This is how the tool will be called by the model and in `tool_use` blocks.
1946
1947 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1948
1949 - `"direct"`
1950
1951 - `"code_execution_20250825"`
1952
1953 - `"code_execution_20260120"`
1954
1955 - `"code_execution_20260521"`
1956
1957 - `cache_control: optional BetaCacheControlEphemeral or null`
1958
1959 Create a cache control breakpoint at this content block.
1960
1961 - `defer_loading: optional boolean`
1962
1963 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1964
1965 - `input_examples: optional array of map[unknown]`
1966
1967 - `strict: optional boolean`
1968
1969 When true, guarantees schema validation on tool names and inputs
1970
1971 - `BetaToolComputerUse20251124 object`
1972
1973 - `type: "computer_20251124"`
1974
1975 - `display_height_px: number`
1976
1977 The height of the display in pixels.
1978
1979 minimum: 1
1980
1981 - `display_width_px: number`
1982
1983 The width of the display in pixels.
1984
1985 minimum: 1
1986
1987 - `name: "computer"`
1988
1989 Name of the tool.
1990
1991 This is how the tool will be called by the model and in `tool_use` blocks.
1992
1993 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1994
1995 - `"direct"`
1996
1997 - `"code_execution_20250825"`
1998
1999 - `"code_execution_20260120"`
2000
2001 - `"code_execution_20260521"`
2002
2003 - `cache_control: optional BetaCacheControlEphemeral or null`
2004
2005 Create a cache control breakpoint at this content block.
2006
2007 - `defer_loading: optional boolean`
2008
2009 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2010
2011 - `display_number: optional number or null`
2012
2013 The X11 display number (e.g. 0, 1) for the display.
2014
2015 minimum: 0
2016
2017 - `enable_zoom: optional boolean`
2018
2019 Whether to enable an action to take a zoomed-in screenshot of the screen.
2020
2021 - `input_examples: optional array of map[unknown]`
2022
2023 - `strict: optional boolean`
2024
2025 When true, guarantees schema validation on tool names and inputs
2026
2027 - `BetaComputerToolset20260801 object`
2028
2029 The computer toolset: a single `tools[]` entry (carrying no
2030 `name`) that declares the computer tool family. The model is
2031 served the family's tool with any members disabled via `configs`
2032 removed from its schema. Every member is enabled by default, zoom
2033 included. The single-tool options `display_number` and
2034 `enable_zoom` are not fields of a toolset entry — it carries only
2035 `type`, `configs`, and `cache_control`; zoom is controlled
2036 via `configs.zoom.enabled`.
2037
2038 - `type: "computer_toolset_20260801"`
2039
2040 - `cache_control: optional BetaCacheControlEphemeral or null`
2041
2042 Create a cache control breakpoint at this content block.
2043
2044 - `configs: optional BetaComputerToolsetConfigs or null`
2045
2046 Per-member configuration for `computer_toolset_20260801`: one
2047 optional field per member tool, keyed by the member name — the same
2048 name the member's `tool_use` blocks carry. Every member is an
2049 accepted key, and a member's defaults apply wherever its key is
2050 absent. Unknown keys are rejected: the field set is this toolset
2051 version's complete member set.
2052
2053 - `type: optional BetaComputerTypeConfig or null`
2054
2055 `type`'s config overrides.
2056
2057 - `defer_loading: optional boolean or null`
2058
2059 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2060
2061 - `enabled: optional boolean or null`
2062
2063 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.
2064
2065 - `cursor_position: optional BetaComputerCursorPositionConfig or null`
2066
2067 `cursor_position`'s config overrides.
2068
2069 - `defer_loading: optional boolean or null`
2070
2071 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2072
2073 - `enabled: optional boolean or null`
2074
2075 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.
2076
2077 - `double_click: optional BetaComputerDoubleClickConfig or null`
2078
2079 `double_click`'s config overrides.
2080
2081 - `defer_loading: optional boolean or null`
2082
2083 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2084
2085 - `enabled: optional boolean or null`
2086
2087 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.
2088
2089 - `hold_key: optional BetaComputerHoldKeyConfig or null`
2090
2091 `hold_key`'s config overrides.
2092
2093 - `defer_loading: optional boolean or null`
2094
2095 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2096
2097 - `enabled: optional boolean or null`
2098
2099 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.
2100
2101 - `key: optional BetaComputerKeyConfig or null`
2102
2103 `key`'s config overrides.
2104
2105 - `defer_loading: optional boolean or null`
2106
2107 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2108
2109 - `enabled: optional boolean or null`
2110
2111 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.
2112
2113 - `left_click: optional BetaComputerLeftClickConfig or null`
2114
2115 `left_click`'s config overrides.
2116
2117 - `defer_loading: optional boolean or null`
2118
2119 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2120
2121 - `enabled: optional boolean or null`
2122
2123 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.
2124
2125 - `left_click_drag: optional BetaComputerLeftClickDragConfig or null`
2126
2127 `left_click_drag`'s config overrides.
2128
2129 - `defer_loading: optional boolean or null`
2130
2131 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2132
2133 - `enabled: optional boolean or null`
2134
2135 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.
2136
2137 - `left_mouse_down: optional BetaComputerLeftMouseDownConfig or null`
2138
2139 `left_mouse_down`'s config overrides.
2140
2141 - `defer_loading: optional boolean or null`
2142
2143 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2144
2145 - `enabled: optional boolean or null`
2146
2147 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.
2148
2149 - `left_mouse_up: optional BetaComputerLeftMouseUpConfig or null`
2150
2151 `left_mouse_up`'s config overrides.
2152
2153 - `defer_loading: optional boolean or null`
2154
2155 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2156
2157 - `enabled: optional boolean or null`
2158
2159 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.
2160
2161 - `middle_click: optional BetaComputerMiddleClickConfig or null`
2162
2163 `middle_click`'s config overrides.
2164
2165 - `defer_loading: optional boolean or null`
2166
2167 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2168
2169 - `enabled: optional boolean or null`
2170
2171 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.
2172
2173 - `mouse_move: optional BetaComputerMouseMoveConfig or null`
2174
2175 `mouse_move`'s config overrides.
2176
2177 - `defer_loading: optional boolean or null`
2178
2179 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2180
2181 - `enabled: optional boolean or null`
2182
2183 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.
2184
2185 - `right_click: optional BetaComputerRightClickConfig or null`
2186
2187 `right_click`'s config overrides.
2188
2189 - `defer_loading: optional boolean or null`
2190
2191 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2192
2193 - `enabled: optional boolean or null`
2194
2195 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.
2196
2197 - `screenshot: optional BetaComputerScreenshotConfig or null`
2198
2199 `screenshot`'s config overrides.
2200
2201 - `defer_loading: optional boolean or null`
2202
2203 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2204
2205 - `enabled: optional boolean or null`
2206
2207 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.
2208
2209 - `scroll: optional BetaComputerScrollConfig or null`
2210
2211 `scroll`'s config overrides.
2212
2213 - `defer_loading: optional boolean or null`
2214
2215 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2216
2217 - `enabled: optional boolean or null`
2218
2219 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.
2220
2221 - `triple_click: optional BetaComputerTripleClickConfig or null`
2222
2223 `triple_click`'s config overrides.
2224
2225 - `defer_loading: optional boolean or null`
2226
2227 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2228
2229 - `enabled: optional boolean or null`
2230
2231 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.
2232
2233 - `wait: optional BetaComputerWaitConfig or null`
2234
2235 `wait`'s config overrides.
2236
2237 - `defer_loading: optional boolean or null`
2238
2239 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2240
2241 - `enabled: optional boolean or null`
2242
2243 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.
2244
2245 - `zoom: optional BetaComputerZoomConfig or null`
2246
2247 `zoom`'s config overrides.
2248
2249 - `defer_loading: optional boolean or null`
2250
2251 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2252
2253 - `enabled: optional boolean or null`
2254
2255 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.
2256
2257 - `BetaToolTextEditor20250124 object`
2258
2259 - `type: "text_editor_20250124"`
2260
2261 - `name: "str_replace_editor"`
2262
2263 Name of the tool.
2264
2265 This is how the tool will be called by the model and in `tool_use` blocks.
2266
2267 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2268
2269 - `"direct"`
2270
2271 - `"code_execution_20250825"`
2272
2273 - `"code_execution_20260120"`
2274
2275 - `"code_execution_20260521"`
2276
2277 - `cache_control: optional BetaCacheControlEphemeral or null`
2278
2279 Create a cache control breakpoint at this content block.
2280
2281 - `defer_loading: optional boolean`
2282
2283 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2284
2285 - `input_examples: optional array of map[unknown]`
2286
2287 - `strict: optional boolean`
2288
2289 When true, guarantees schema validation on tool names and inputs
2290
2291 - `BetaToolTextEditor20250429 object`
2292
2293 - `type: "text_editor_20250429"`
2294
2295 - `name: "str_replace_based_edit_tool"`
2296
2297 Name of the tool.
2298
2299 This is how the tool will be called by the model and in `tool_use` blocks.
2300
2301 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2302
2303 - `"direct"`
2304
2305 - `"code_execution_20250825"`
2306
2307 - `"code_execution_20260120"`
2308
2309 - `"code_execution_20260521"`
2310
2311 - `cache_control: optional BetaCacheControlEphemeral or null`
2312
2313 Create a cache control breakpoint at this content block.
2314
2315 - `defer_loading: optional boolean`
2316
2317 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2318
2319 - `input_examples: optional array of map[unknown]`
2320
2321 - `strict: optional boolean`
2322
2323 When true, guarantees schema validation on tool names and inputs
2324
2325 - `BetaToolTextEditor20250728 object`
2326
2327 - `type: "text_editor_20250728"`
2328
2329 - `name: "str_replace_based_edit_tool"`
2330
2331 Name of the tool.
2332
2333 This is how the tool will be called by the model and in `tool_use` blocks.
2334
2335 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2336
2337 - `"direct"`
2338
2339 - `"code_execution_20250825"`
2340
2341 - `"code_execution_20260120"`
2342
2343 - `"code_execution_20260521"`
2344
2345 - `cache_control: optional BetaCacheControlEphemeral or null`
2346
2347 Create a cache control breakpoint at this content block.
2348
2349 - `defer_loading: optional boolean`
2350
2351 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2352
2353 - `input_examples: optional array of map[unknown]`
2354
2355 - `max_characters: optional number or null`
2356
2357 Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
2358
2359 minimum: 1
2360
2361 - `strict: optional boolean`
2362
2363 When true, guarantees schema validation on tool names and inputs
2364
2365 - `BetaWebSearchTool20250305 object`
2366
2367 - `type: "web_search_20250305"`
2368
2369 - `name: "web_search"`
2370
2371 Name of the tool.
2372
2373 This is how the tool will be called by the model and in `tool_use` blocks.
2374
2375 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2376
2377 - `"direct"`
2378
2379 - `"code_execution_20250825"`
2380
2381 - `"code_execution_20260120"`
2382
2383 - `"code_execution_20260521"`
2384
2385 - `allowed_domains: optional array of string or null`
2386
2387 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.
2388
2389 - `blocked_domains: optional array of string or null`
2390
2391 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.
2392
2393 - `cache_control: optional BetaCacheControlEphemeral or null`
2394
2395 Create a cache control breakpoint at this content block.
2396
2397 - `defer_loading: optional boolean`
2398
2399 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2400
2401 - `max_uses: optional number or null`
2402
2403 Maximum number of times the tool can be used in the API request.
2404
2405 exclusiveMinimum: 0
2406
2407 - `strict: optional boolean`
2408
2409 When true, guarantees schema validation on tool names and inputs
2410
2411 - `user_location: optional BetaUserLocation or null`
2412
2413 Parameters for the user's location. Used to provide more relevant search results.
2414
2415 - `type: "approximate"`
2416
2417 - `city: optional string or null`
2418
2419 The city of the user.
2420
2421 maxLength: 255, minLength: 1
2422
2423 - `country: optional string or null`
2424
2425 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.
2426
2427 maxLength: 2, minLength: 2
2428
2429 - `region: optional string or null`
2430
2431 The region of the user.
2432
2433 maxLength: 255, minLength: 1
2434
2435 - `timezone: optional string or null`
2436
2437 The [IANA timezone](https://nodatime.org/TimeZones) of the user.
2438
2439 maxLength: 255, minLength: 1
2440
2441 - `BetaWebFetchTool20250910 object`
2442
2443 - `type: "web_fetch_20250910"`
2444
2445 - `name: "web_fetch"`
2446
2447 Name of the tool.
2448
2449 This is how the tool will be called by the model and in `tool_use` blocks.
2450
2451 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2452
2453 - `"direct"`
2454
2455 - `"code_execution_20250825"`
2456
2457 - `"code_execution_20260120"`
2458
2459 - `"code_execution_20260521"`
2460
2461 - `allowed_domains: optional array of string or null`
2462
2463 List of domains to allow fetching from
2464
2465 - `blocked_domains: optional array of string or null`
2466
2467 List of domains to block fetching from
2468
2469 - `cache_control: optional BetaCacheControlEphemeral or null`
2470
2471 Create a cache control breakpoint at this content block.
2472
2473 - `citations: optional BetaCitationsConfigParam or null`
2474
2475 Citations configuration for fetched documents. Citations are disabled by default.
2476
2477 - `enabled: optional boolean`
2478
2479 - `defer_loading: optional boolean`
2480
2481 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2482
2483 - `max_content_tokens: optional number or null`
2484
2485 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
2486
2487 exclusiveMinimum: 0
2488
2489 - `max_uses: optional number or null`
2490
2491 Maximum number of times the tool can be used in the API request.
2492
2493 exclusiveMinimum: 0
2494
2495 - `strict: optional boolean`
2496
2497 When true, guarantees schema validation on tool names and inputs
2498
2499 - `url_sources: optional BetaWebFetchURLSources or null`
2500
2501 Which sources contribute to the set of URLs web fetch may fetch.
2502
2503 Each key is a tagged variant: `user_input` is `all` or `none`; the
2504 two tool filters are `all`, `none`, `only` (only the named tools'
2505 results) or `except` (every result but the named tools'). A named tool
2506 must be declared in this request's `tools[]`.
2507
2508 - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`
2509
2510 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].
2511
2512 - `BetaWebFetchURLSourceAll object`
2513
2514 The `url_sources` variant under which a source contributes in
2515 full: every result of the tool filter's source, or all user input.
2516
2517 - `type: "all"`
2518
2519 - `BetaWebFetchURLSourceNone object`
2520
2521 The `url_sources` variant under which a source contributes nothing:
2522 no result of the tool filter's source, or no user input.
2523
2524 - `type: "none"`
2525
2526 - `BetaWebFetchURLSourceOnly object`
2527
2528 The tool filter variant under which only the named tools' results
2529 contribute.
2530
2531 - `type: "only"`
2532
2533 - `tools: array of BetaWebFetchURLSourceToolReference`
2534
2535 - `type: "tool_reference"`
2536
2537 - `name: string`
2538
2539 - `BetaWebFetchURLSourceExcept object`
2540
2541 The tool filter variant under which every result but the named
2542 tools' contributes.
2543
2544 - `type: "except"`
2545
2546 - `tools: array of BetaWebFetchURLSourceToolReference`
2547
2548 - `type: "tool_reference"`
2549
2550 - `name: string`
2551
2552 - `server_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`
2553
2554 Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute.
2555
2556 - `BetaWebFetchURLSourceAll object`
2557
2558 The `url_sources` variant under which a source contributes in
2559 full: every result of the tool filter's source, or all user input.
2560
2561 - `BetaWebFetchURLSourceNone object`
2562
2563 The `url_sources` variant under which a source contributes nothing:
2564 no result of the tool filter's source, or no user input.
2565
2566 - `BetaWebFetchURLSourceOnly object`
2567
2568 The tool filter variant under which only the named tools' results
2569 contribute.
2570
2571 - `BetaWebFetchURLSourceExcept object`
2572
2573 The tool filter variant under which every result but the named
2574 tools' contributes.
2575
2576 - `user_input: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone`
2577
2578 Whether URLs in user messages are fetchable: "all" or "none".
2579
2580 - `BetaWebFetchURLSourceAll object`
2581
2582 The `url_sources` variant under which a source contributes in
2583 full: every result of the tool filter's source, or all user input.
2584
2585 - `BetaWebFetchURLSourceNone object`
2586
2587 The `url_sources` variant under which a source contributes nothing:
2588 no result of the tool filter's source, or no user input.
2589
2590 - `BetaWebSearchTool20260209 object`
2591
2592 - `type: "web_search_20260209"`
2593
2594 - `name: "web_search"`
2595
2596 Name of the tool.
2597
2598 This is how the tool will be called by the model and in `tool_use` blocks.
2599
2600 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2601
2602 - `"direct"`
2603
2604 - `"code_execution_20250825"`
2605
2606 - `"code_execution_20260120"`
2607
2608 - `"code_execution_20260521"`
2609
2610 - `allowed_domains: optional array of string or null`
2611
2612 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.
2613
2614 - `blocked_domains: optional array of string or null`
2615
2616 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.
2617
2618 - `cache_control: optional BetaCacheControlEphemeral or null`
2619
2620 Create a cache control breakpoint at this content block.
2621
2622 - `defer_loading: optional boolean`
2623
2624 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2625
2626 - `max_uses: optional number or null`
2627
2628 Maximum number of times the tool can be used in the API request.
2629
2630 exclusiveMinimum: 0
2631
2632 - `strict: optional boolean`
2633
2634 When true, guarantees schema validation on tool names and inputs
2635
2636 - `user_location: optional BetaUserLocation or null`
2637
2638 Parameters for the user's location. Used to provide more relevant search results.
2639
2640 - `BetaWebFetchTool20260209 object`
2641
2642 - `type: "web_fetch_20260209"`
2643
2644 - `name: "web_fetch"`
2645
2646 Name of the tool.
2647
2648 This is how the tool will be called by the model and in `tool_use` blocks.
2649
2650 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2651
2652 - `"direct"`
2653
2654 - `"code_execution_20250825"`
2655
2656 - `"code_execution_20260120"`
2657
2658 - `"code_execution_20260521"`
2659
2660 - `allowed_domains: optional array of string or null`
2661
2662 List of domains to allow fetching from
2663
2664 - `blocked_domains: optional array of string or null`
2665
2666 List of domains to block fetching from
2667
2668 - `cache_control: optional BetaCacheControlEphemeral or null`
2669
2670 Create a cache control breakpoint at this content block.
2671
2672 - `citations: optional BetaCitationsConfigParam or null`
2673
2674 Citations configuration for fetched documents. Citations are disabled by default.
2675
2676 - `defer_loading: optional boolean`
2677
2678 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2679
2680 - `max_content_tokens: optional number or null`
2681
2682 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
2683
2684 exclusiveMinimum: 0
2685
2686 - `max_uses: optional number or null`
2687
2688 Maximum number of times the tool can be used in the API request.
2689
2690 exclusiveMinimum: 0
2691
2692 - `strict: optional boolean`
2693
2694 When true, guarantees schema validation on tool names and inputs
2695
2696 - `url_sources: optional BetaWebFetchURLSources or null`
2697
2698 Which sources contribute to the set of URLs web fetch may fetch.
2699
2700 Each key is a tagged variant: `user_input` is `all` or `none`; the
2701 two tool filters are `all`, `none`, `only` (only the named tools'
2702 results) or `except` (every result but the named tools'). A named tool
2703 must be declared in this request's `tools[]`.
2704
2705 - `BetaWebFetchTool20260309 object`
2706
2707 Web fetch tool with use_cache parameter for bypassing cached content.
2708
2709 - `type: "web_fetch_20260309"`
2710
2711 - `name: "web_fetch"`
2712
2713 Name of the tool.
2714
2715 This is how the tool will be called by the model and in `tool_use` blocks.
2716
2717 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2718
2719 - `"direct"`
2720
2721 - `"code_execution_20250825"`
2722
2723 - `"code_execution_20260120"`
2724
2725 - `"code_execution_20260521"`
2726
2727 - `allowed_domains: optional array of string or null`
2728
2729 List of domains to allow fetching from
2730
2731 - `blocked_domains: optional array of string or null`
2732
2733 List of domains to block fetching from
2734
2735 - `cache_control: optional BetaCacheControlEphemeral or null`
2736
2737 Create a cache control breakpoint at this content block.
2738
2739 - `citations: optional BetaCitationsConfigParam or null`
2740
2741 Citations configuration for fetched documents. Citations are disabled by default.
2742
2743 - `defer_loading: optional boolean`
2744
2745 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2746
2747 - `max_content_tokens: optional number or null`
2748
2749 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
2750
2751 exclusiveMinimum: 0
2752
2753 - `max_uses: optional number or null`
2754
2755 Maximum number of times the tool can be used in the API request.
2756
2757 exclusiveMinimum: 0
2758
2759 - `strict: optional boolean`
2760
2761 When true, guarantees schema validation on tool names and inputs
2762
2763 - `url_sources: optional BetaWebFetchURLSources or null`
2764
2765 Which sources contribute to the set of URLs web fetch may fetch.
2766
2767 Each key is a tagged variant: `user_input` is `all` or `none`; the
2768 two tool filters are `all`, `none`, `only` (only the named tools'
2769 results) or `except` (every result but the named tools'). A named tool
2770 must be declared in this request's `tools[]`.
2771
2772 - `use_cache: optional boolean`
2773
2774 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
2775
2776 - `BetaWebSearchTool20260318 object`
2777
2778 - `type: "web_search_20260318"`
2779
2780 - `name: "web_search"`
2781
2782 Name of the tool.
2783
2784 This is how the tool will be called by the model and in `tool_use` blocks.
2785
2786 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2787
2788 - `"direct"`
2789
2790 - `"code_execution_20250825"`
2791
2792 - `"code_execution_20260120"`
2793
2794 - `"code_execution_20260521"`
2795
2796 - `allowed_domains: optional array of string or null`
2797
2798 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.
2799
2800 - `blocked_domains: optional array of string or null`
2801
2802 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.
2803
2804 - `cache_control: optional BetaCacheControlEphemeral or null`
2805
2806 Create a cache control breakpoint at this content block.
2807
2808 - `defer_loading: optional boolean`
2809
2810 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2811
2812 - `max_uses: optional number or null`
2813
2814 Maximum number of times the tool can be used in the API request.
2815
2816 exclusiveMinimum: 0
2817
2818 - `response_inclusion: optional "full" or "excluded"`
2819
2820 How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn.
2821
2822 - `"full"`
2823
2824 - `"excluded"`
2825
2826 - `strict: optional boolean`
2827
2828 When true, guarantees schema validation on tool names and inputs
2829
2830 - `user_location: optional BetaUserLocation or null`
2831
2832 Parameters for the user's location. Used to provide more relevant search results.
2833
2834 - `BetaWebFetchTool20260318 object`
2835
2836 - `type: "web_fetch_20260318"`
2837
2838 - `name: "web_fetch"`
2839
2840 Name of the tool.
2841
2842 This is how the tool will be called by the model and in `tool_use` blocks.
2843
2844 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2845
2846 - `"direct"`
2847
2848 - `"code_execution_20250825"`
2849
2850 - `"code_execution_20260120"`
2851
2852 - `"code_execution_20260521"`
2853
2854 - `allowed_domains: optional array of string or null`
2855
2856 List of domains to allow fetching from
2857
2858 - `blocked_domains: optional array of string or null`
2859
2860 List of domains to block fetching from
2861
2862 - `cache_control: optional BetaCacheControlEphemeral or null`
2863
2864 Create a cache control breakpoint at this content block.
2865
2866 - `citations: optional BetaCitationsConfigParam or null`
2867
2868 Citations configuration for fetched documents. Citations are disabled by default.
2869
2870 - `defer_loading: optional boolean`
2871
2872 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2873
2874 - `max_content_tokens: optional number or null`
2875
2876 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
2877
2878 exclusiveMinimum: 0
2879
2880 - `max_uses: optional number or null`
2881
2882 Maximum number of times the tool can be used in the API request.
2883
2884 exclusiveMinimum: 0
2885
2886 - `response_inclusion: optional "full" or "excluded"`
2887
2888 How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn.
2889
2890 - `"full"`
2891
2892 - `"excluded"`
2893
2894 - `strict: optional boolean`
2895
2896 When true, guarantees schema validation on tool names and inputs
2897
2898 - `url_sources: optional BetaWebFetchURLSources or null`
2899
2900 Which sources contribute to the set of URLs web fetch may fetch.
2901
2902 Each key is a tagged variant: `user_input` is `all` or `none`; the
2903 two tool filters are `all`, `none`, `only` (only the named tools'
2904 results) or `except` (every result but the named tools'). A named tool
2905 must be declared in this request's `tools[]`.
2906
2907 - `use_cache: optional boolean`
2908
2909 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
2910
2911 - `BetaAdvisorTool20260301 object`
2912
2913 - `type: "advisor_20260301"`
2914
2915 - `model: Model`
2916
2917 The model that will complete your prompt.
2918
2919 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
2920
2921 - `"claude-fable-5-1" or "claude-opus-5-5" or "claude-mythos-5-1" or 15 more`
2922
2923 The model that will complete your prompt.
2924
2925 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
2926
2927 - `"claude-fable-5-1"`
2928
2929 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows
2930
2931 - `"claude-opus-5-5"`
2932
2933 Powerful intelligence for coding, knowledge work, and long-running agents
2934
2935 - `"claude-mythos-5-1"`
2936
2937 Our most capable model for cybersecurity and biology research, available through trusted access programs
2938
2939 - `"claude-sonnet-5"`
2940
2941 High-performance model for coding and agents
2942
2943 - `"claude-fable-5"`
2944
2945 Next generation of intelligence for the hardest knowledge work and coding problems
2946
2947 - `"claude-mythos-5"`
2948
2949 Most capable model for cybersecurity and biology research
2950
2951 - `"claude-opus-5"`
2952
2953 Powerful intelligence for long-running agents and coding
2954
2955 - `"claude-opus-4-8"`
2956
2957 Powerful intelligence for long-running agents and coding
2958
2959 - `"claude-opus-4-7"`
2960
2961 Powerful intelligence for long-running agents and coding
2962
2963 - `"claude-mythos-preview"`
2964
2965 New class of intelligence, strongest in coding and cybersecurity
2966
2967 - `"claude-opus-4-6"`
2968
2969 Powerful intelligence for long-running agents and coding
2970
2971 - `"claude-sonnet-4-6"`
2972
2973 Best combination of speed and intelligence
2974
2975 - `"claude-haiku-4-5"`
2976
2977 Fastest model with near-frontier intelligence
2978
2979 - `"claude-haiku-4-5-20251001"`
2980
2981 Fastest model with near-frontier intelligence
2982
2983 - `"claude-opus-4-5"`
2984
2985 Powerful intelligence for long-running agents and coding
2986
2987 - `"claude-opus-4-5-20251101"`
2988
2989 Powerful intelligence for long-running agents and coding
2990
2991 - `"claude-sonnet-4-5"`
2992
2993 High-performance model for agents and coding
2994
2995 - `"claude-sonnet-4-5-20250929"`
2996
2997 High-performance model for agents and coding
2998
2999 - `string`
3000
3001 - `name: "advisor"`
3002
3003 Name of the tool.
3004
3005 This is how the tool will be called by the model and in `tool_use` blocks.
3006
3007 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3008
3009 - `"direct"`
3010
3011 - `"code_execution_20250825"`
3012
3013 - `"code_execution_20260120"`
3014
3015 - `"code_execution_20260521"`
3016
3017 - `cache_control: optional BetaCacheControlEphemeral or null`
3018
3019 Create a cache control breakpoint at this content block.
3020
3021 - `caching: optional BetaCacheControlEphemeral or null`
3022
3023 Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.
3024
3025 - `defer_loading: optional boolean`
3026
3027 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3028
3029 - `max_tokens: optional number or null`
3030
3031 Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.
3032
3033 minimum: 1024
3034
3035 - `max_uses: optional number or null`
3036
3037 Maximum number of times the tool can be used in the API request.
3038
3039 exclusiveMinimum: 0
3040
3041 - `strict: optional boolean`
3042
3043 When true, guarantees schema validation on tool names and inputs
3044
3045 - `BetaToolSearchToolBm25_20251119 object`
3046
3047 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`
3048
3049 - `"tool_search_tool_bm25_20251119"`
3050
3051 - `"tool_search_tool_bm25"`
3052
3053 - `name: "tool_search_tool_bm25"`
3054
3055 Name of the tool.
3056
3057 This is how the tool will be called by the model and in `tool_use` blocks.
3058
3059 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3060
3061 - `"direct"`
3062
3063 - `"code_execution_20250825"`
3064
3065 - `"code_execution_20260120"`
3066
3067 - `"code_execution_20260521"`
3068
3069 - `cache_control: optional BetaCacheControlEphemeral or null`
3070
3071 Create a cache control breakpoint at this content block.
3072
3073 - `defer_loading: optional boolean`
3074
3075 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3076
3077 - `strict: optional boolean`
3078
3079 When true, guarantees schema validation on tool names and inputs
3080
3081 - `BetaToolSearchToolRegex20251119 object`
3082
3083 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`
3084
3085 - `"tool_search_tool_regex_20251119"`
3086
3087 - `"tool_search_tool_regex"`
3088
3089 - `name: "tool_search_tool_regex"`
3090
3091 Name of the tool.
3092
3093 This is how the tool will be called by the model and in `tool_use` blocks.
3094
3095 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3096
3097 - `"direct"`
3098
3099 - `"code_execution_20250825"`
3100
3101 - `"code_execution_20260120"`
3102
3103 - `"code_execution_20260521"`
3104
3105 - `cache_control: optional BetaCacheControlEphemeral or null`
3106
3107 Create a cache control breakpoint at this content block.
3108
3109 - `defer_loading: optional boolean`
3110
3111 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3112
3113 - `strict: optional boolean`
3114
3115 When true, guarantees schema validation on tool names and inputs
3116
3117 - `BetaMCPToolset object`
3118
3119 Configuration for a group of tools from an MCP server.
3120
3121 Allows configuring enabled status and defer_loading for all tools
3122 from an MCP server, with optional per-tool overrides.
3123
3124 - `type: "mcp_toolset"`
3125
3126 - `mcp_server_name: string`
3127
3128 Name of the MCP server to configure tools for
3129
3130 maxLength: 255, minLength: 1
3131
3132 - `cache_control: optional BetaCacheControlEphemeral or null`
3133
3134 Create a cache control breakpoint at this content block.
3135
3136 - `configs: optional map[BetaMCPToolConfig] or null`
3137
3138 Configuration overrides for specific tools, keyed by tool name
3139
3140 - `defer_loading: optional boolean`
3141
3142 - `enabled: optional boolean`
3143
3144 - `default_config: optional BetaMCPToolDefaultConfig`
3145
3146 Default configuration applied to all tools from this server
3147
3148 - `defer_loading: optional boolean`
3149
3150 - `enabled: optional boolean`
3151
3152 - `tools: optional array of BetaMCPToolParam or null`
3153
3154 The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.
3155
3156 - `input_schema: map[unknown]`
3157
3158 The tool's input schema as the MCP server lists it, verbatim.
3159
3160 - `name: string`
3161
3162 The tool's name as the MCP server lists it (not prefixed with the server name).
3163
3164 minLength: 1
3165
3166 - `description: optional string or null`
3167
3168 The tool's description as the MCP server lists it.
3169
3170 - `BetaResponseToolRemovalBlock object`
3171
3172 An entry of a `compaction` block's `tool_changes`: a tool of the
3173 request's `tools` (or an MCP tool or toolset) that the compacted range
3174 withdrew. Send it back unchanged.
3175
3176 - `type: "tool_removal"`
3177
3178 default: tool_removal
3179
3180 - `tool: BetaResponseToolChangeToolReference or BetaResponseToolChangeMCPToolReference or BetaResponseToolChangeMCPToolsetReference`
3181
3182 A reference to the withdrawn `tools` entry, MCP tool or MCP toolset.
3183
3184 - `BetaResponseToolChangeToolReference object`
3185
3186 Reference to a single tool, by the name the model uses to call it, as
3187 a `compaction` block's `tool_changes` entry reports it: a tool
3188 declared in `tools` or defined by an earlier `tool_addition` block.
3189 Send it back unchanged with the block.
3190
3191 - `BetaResponseToolChangeMCPToolReference object`
3192
3193 Reference to a single MCP tool, by its server and its name on that
3194 server, as a `compaction` block's `tool_changes` entry reports it.
3195 Send it back unchanged with the block.
3196
3197 - `BetaResponseToolChangeMCPToolsetReference object`
3198
3199 Reference to every tool in the named MCP server's toolset, as a
3200 `compaction` block's `tool_changes` entry reports it. Send it back
3201 unchanged with the block.
3202
10573203 - `BetaFallbackBlock object`
10583204
10593205 Marks the point in `content` where one model's output gives way to the next.
from line 3228
10823228
10833229 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
10843230
1085 - `"claude-fable-5-1" or "claude-mythos-5-1" or "claude-sonnet-5" or 14 more`
1086
1087 The model that will complete your prompt.
1088
1089 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
1090
1091 - `"claude-fable-5-1"`
1092
1093 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows
1094
1095 - `"claude-mythos-5-1"`
1096
1097 Our most capable model for cybersecurity and biology research, available through trusted access programs
1098
1099 - `"claude-sonnet-5"`
1100
1101 High-performance model for coding and agents
1102
1103 - `"claude-fable-5"`
1104
1105 Next generation of intelligence for the hardest knowledge work and coding problems
1106
1107 - `"claude-mythos-5"`
1108
1109 Most capable model for cybersecurity and biology research
1110
1111 - `"claude-opus-5"`
1112
1113 Powerful intelligence for long-running agents and coding
1114
1115 - `"claude-opus-4-8"`
1116
1117 Powerful intelligence for long-running agents and coding
1118
1119 - `"claude-opus-4-7"`
1120
1121 Powerful intelligence for long-running agents and coding
1122
1123 - `"claude-mythos-preview"`
1124
1125 New class of intelligence, strongest in coding and cybersecurity
1126
1127 - `"claude-opus-4-6"`
1128
1129 Powerful intelligence for long-running agents and coding
1130
1131 - `"claude-sonnet-4-6"`
1132
1133 Best combination of speed and intelligence
1134
1135 - `"claude-haiku-4-5"`
1136
1137 Fastest model with near-frontier intelligence
1138
1139 - `"claude-haiku-4-5-20251001"`
1140
1141 Fastest model with near-frontier intelligence
1142
1143 - `"claude-opus-4-5"`
1144
1145 Powerful intelligence for long-running agents and coding
1146
1147 - `"claude-opus-4-5-20251101"`
1148
1149 Powerful intelligence for long-running agents and coding
1150
1151 - `"claude-sonnet-4-5"`
1152
1153 High-performance model for agents and coding
1154
1155 - `"claude-sonnet-4-5-20250929"`
1156
1157 High-performance model for agents and coding
1158
1159 - `string`
1160
11613231 - `to: BetaFallbackInfo`
11623232
11633233 The fallback model producing the content that follows this block. Its `model` is always the canonical id.
from line 3263
11933263 - `"general_harms"`
11943264
11953265 The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category.
3266
3267 - `BetaMCPToolListingBlock object`
3268
3269 The tool listing the server fetched from an MCP server while producing
3270 this response. Send the assistant message back unchanged, this block
3271 included, so later requests use this listing instead of asking the MCP
3272 server again.
3273
3274 - `type: "mcp_tool_listing"`
3275
3276 default: mcp_tool_listing
3277
3278 - `mcp_server_name: string`
3279
3280 - `tools: array of BetaMCPTool`
3281
3282 - `input_schema: map[unknown]`
3283
3284 - `name: string`
3285
3286 - `description: optional string`
11963287
11973288 - `context_management: BetaContextManagementResponse or null`
11983289
11993290
api/beta/messages/batches/retrieve Changed · +5 / -1 lines
from line 25
2525
2626 - `string`
2727
28 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
28 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
2929
3030 - `"message-batches-2024-09-24"`
3131
from line 118
118118 - `"mid-conversation-system-clear-at-2026-08-21"`
119119
120120 - `"compact-2026-09-04"`
121
122 - `"inline-tools-2026-09-15"`
123
124 - `"mcp-client-2026-09-15"`
121125
122126- `"anthropic-workspace-id": optional string`
123127
api/beta/messages/count_tokens Changed · +2171 / -1991 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 43 more`
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
2525
2626 - `"message-batches-2024-09-24"`
2727
from line 114
114114 - `"mid-conversation-system-clear-at-2026-08-21"`
115115
116116 - `"compact-2026-09-04"`
117
118 - `"inline-tools-2026-09-15"`
119
120 - `"mcp-client-2026-09-15"`
117121
118122- `"anthropic-user-profile-id": optional string`
119123
from line 1285
12811285
12821286 The block's signature as returned, to be sent back verbatim
12831287
1288 - `tool_changes: optional array of BetaRequestToolAdditionBlock or BetaRequestToolRemovalBlock or null`
1289
1290 The tool changes of the compacted range, as the server returned them on this block: the `tool_addition` and `tool_removal` entries that take the request's `tools` to the tool set in effect at the end of the range. Send them back unchanged with the block.
1291
1292 - `BetaRequestToolAdditionBlock object`
1293
1294 Mid-conversation directive to make a tool available.
1295
1296 `tool` is a reference to a tool (or MCP toolset) declared in the
1297 request's `tools`. Under the `inline-tools-2026-09-15` beta it may
1298 instead be a reference to a tool defined earlier in `messages`, or a
1299 `tool_definition` object that carries an inline tool definition in
1300 `definition` (the same object a `tools` entry holds). An `mcp_toolset`
1301 definition also requires the `mcp-client-2026-09-15` beta. The tool is
1302 offered to the model from this point in the conversation onward.
1303
1304 - `type: "tool_addition"`
1305
1306 - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference or BetaToolChangeToolDefinitionParam`
1307
1308 - `BetaToolChangeToolReference object`
1309
1310 Reference to a single tool, by the name the model uses to call it: a
1311 tool declared in `tools` or defined by an earlier `tool_addition`
1312 block. Does not accept the composed `{server}_{name}` form the server
1313 assigns to MCP-resolved tools; use `mcp_tool_reference` or
1314 `mcp_toolset_reference` for those.
1315
1316 - `type: "tool_reference"`
1317
1318 - `name: string`
1319
1320 pattern: ^[a-zA-Z0-9_-]{1,128}$
1321
1322 - `BetaToolChangeMCPToolReference object`
1323
1324 Reference to a single MCP tool by its server and remote name; the
1325 same `server_name`/`name` pair `mcp_tool_use` carries.
1326
1327 - `type: "mcp_tool_reference"`
1328
1329 - `name: string`
1330
1331 - `server_name: string`
1332
1333 - `BetaToolChangeMCPToolsetReference object`
1334
1335 Reference to every tool in the named MCP server's toolset.
1336
1337 - `type: "mcp_toolset_reference"`
1338
1339 - `server_name: string`
1340
1341 - `BetaToolChangeToolDefinitionParam object`
1342
1343 A tool defined by value: `definition` is a `tools` entry (any kind
1344 `tools` accepts, an MCP toolset included). An `mcp_toolset` given here
1345 also requires the `mcp-client-2026-09-15` beta.
1346
1347 - `type: "tool_definition"`
1348
1349 - `definition: BetaToolUnion`
1350
1351 - `BetaTool object`
1352
1353 - `type: optional "custom" or null`
1354
1355 - `input_schema: object`
1356
1357 [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.
1358
1359 This defines the shape of the `input` that your tool accepts and that the model will produce.
1360
1361 - `type: "object"`
1362
1363 - `properties: optional map[unknown] or null`
1364
1365 - `required: optional array of string or null`
1366
1367 - `name: string`
1368
1369 Name of the tool.
1370
1371 This is how the tool will be called by the model and in `tool_use` blocks.
1372
1373 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$
1374
1375 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1376
1377 - `"direct"`
1378
1379 - `"code_execution_20250825"`
1380
1381 - `"code_execution_20260120"`
1382
1383 - `"code_execution_20260521"`
1384
1385 - `cache_control: optional BetaCacheControlEphemeral or null`
1386
1387 Create a cache control breakpoint at this content block.
1388
1389 - `defer_loading: optional boolean`
1390
1391 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1392
1393 - `description: optional string`
1394
1395 Description of what this tool does.
1396
1397 Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.
1398
1399 - `eager_input_streaming: optional boolean or null`
1400
1401 Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers.
1402
1403 - `input_examples: optional array of map[unknown]`
1404
1405 - `strict: optional boolean`
1406
1407 When true, guarantees schema validation on tool names and inputs
1408
1409 - `BetaToolBash20241022 object`
1410
1411 - `type: "bash_20241022"`
1412
1413 - `name: "bash"`
1414
1415 Name of the tool.
1416
1417 This is how the tool will be called by the model and in `tool_use` blocks.
1418
1419 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1420
1421 - `"direct"`
1422
1423 - `"code_execution_20250825"`
1424
1425 - `"code_execution_20260120"`
1426
1427 - `"code_execution_20260521"`
1428
1429 - `cache_control: optional BetaCacheControlEphemeral or null`
1430
1431 Create a cache control breakpoint at this content block.
1432
1433 - `defer_loading: optional boolean`
1434
1435 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1436
1437 - `input_examples: optional array of map[unknown]`
1438
1439 - `strict: optional boolean`
1440
1441 When true, guarantees schema validation on tool names and inputs
1442
1443 - `BetaToolBash20250124 object`
1444
1445 - `type: "bash_20250124"`
1446
1447 - `name: "bash"`
1448
1449 Name of the tool.
1450
1451 This is how the tool will be called by the model and in `tool_use` blocks.
1452
1453 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1454
1455 - `"direct"`
1456
1457 - `"code_execution_20250825"`
1458
1459 - `"code_execution_20260120"`
1460
1461 - `"code_execution_20260521"`
1462
1463 - `cache_control: optional BetaCacheControlEphemeral or null`
1464
1465 Create a cache control breakpoint at this content block.
1466
1467 - `defer_loading: optional boolean`
1468
1469 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1470
1471 - `input_examples: optional array of map[unknown]`
1472
1473 - `strict: optional boolean`
1474
1475 When true, guarantees schema validation on tool names and inputs
1476
1477 - `BetaCodeExecutionTool20250522 object`
1478
1479 - `type: "code_execution_20250522"`
1480
1481 - `name: "code_execution"`
1482
1483 Name of the tool.
1484
1485 This is how the tool will be called by the model and in `tool_use` blocks.
1486
1487 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1488
1489 - `"direct"`
1490
1491 - `"code_execution_20250825"`
1492
1493 - `"code_execution_20260120"`
1494
1495 - `"code_execution_20260521"`
1496
1497 - `cache_control: optional BetaCacheControlEphemeral or null`
1498
1499 Create a cache control breakpoint at this content block.
1500
1501 - `defer_loading: optional boolean`
1502
1503 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1504
1505 - `strict: optional boolean`
1506
1507 When true, guarantees schema validation on tool names and inputs
1508
1509 - `BetaCodeExecutionTool20250825 object`
1510
1511 - `type: "code_execution_20250825"`
1512
1513 - `name: "code_execution"`
1514
1515 Name of the tool.
1516
1517 This is how the tool will be called by the model and in `tool_use` blocks.
1518
1519 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1520
1521 - `"direct"`
1522
1523 - `"code_execution_20250825"`
1524
1525 - `"code_execution_20260120"`
1526
1527 - `"code_execution_20260521"`
1528
1529 - `cache_control: optional BetaCacheControlEphemeral or null`
1530
1531 Create a cache control breakpoint at this content block.
1532
1533 - `defer_loading: optional boolean`
1534
1535 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1536
1537 - `strict: optional boolean`
1538
1539 When true, guarantees schema validation on tool names and inputs
1540
1541 - `BetaCodeExecutionTool20260120 object`
1542
1543 Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
1544
1545 - `type: "code_execution_20260120"`
1546
1547 - `name: "code_execution"`
1548
1549 Name of the tool.
1550
1551 This is how the tool will be called by the model and in `tool_use` blocks.
1552
1553 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1554
1555 - `"direct"`
1556
1557 - `"code_execution_20250825"`
1558
1559 - `"code_execution_20260120"`
1560
1561 - `"code_execution_20260521"`
1562
1563 - `cache_control: optional BetaCacheControlEphemeral or null`
1564
1565 Create a cache control breakpoint at this content block.
1566
1567 - `defer_loading: optional boolean`
1568
1569 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1570
1571 - `strict: optional boolean`
1572
1573 When true, guarantees schema validation on tool names and inputs
1574
1575 - `BetaCodeExecutionTool20260521 object`
1576
1577 Code execution tool with REPL state persistence.
1578
1579 - `type: "code_execution_20260521"`
1580
1581 - `name: "code_execution"`
1582
1583 Name of the tool.
1584
1585 This is how the tool will be called by the model and in `tool_use` blocks.
1586
1587 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1588
1589 - `"direct"`
1590
1591 - `"code_execution_20250825"`
1592
1593 - `"code_execution_20260120"`
1594
1595 - `"code_execution_20260521"`
1596
1597 - `cache_control: optional BetaCacheControlEphemeral or null`
1598
1599 Create a cache control breakpoint at this content block.
1600
1601 - `defer_loading: optional boolean`
1602
1603 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1604
1605 - `strict: optional boolean`
1606
1607 When true, guarantees schema validation on tool names and inputs
1608
1609 - `BetaBrowserToolset20260801 object`
1610
1611 The browser toolset: a single `tools[]` entry (carrying no
1612 `name`) that declares the browser tool family. The model is served
1613 the family's tool with any members disabled via `configs` removed
1614 from its schema.
1615
1616 - `type: "browser_toolset_20260801"`
1617
1618 - `cache_control: optional BetaCacheControlEphemeral or null`
1619
1620 Create a cache control breakpoint at this content block.
1621
1622 - `configs: optional BetaBrowserToolsetConfigs or null`
1623
1624 Per-member configuration for `browser_toolset_20260801`: one
1625 optional field per member tool, keyed by the member name — the same
1626 name the member's `tool_use` blocks carry. Every member is an
1627 accepted key, and a member's defaults apply wherever its key is
1628 absent. Unknown keys are rejected: the field set is this toolset
1629 version's complete member set.
1630
1631 - `type: optional BetaBrowserTypeConfig or null`
1632
1633 `type`'s config overrides.
1634
1635 - `defer_loading: optional boolean or null`
1636
1637 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1638
1639 - `enabled: optional boolean or null`
1640
1641 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.
1642
1643 - `close_tab: optional BetaBrowserCloseTabConfig or null`
1644
1645 `close_tab`'s config overrides.
1646
1647 - `defer_loading: optional boolean or null`
1648
1649 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1650
1651 - `enabled: optional boolean or null`
1652
1653 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.
1654
1655 - `double_click: optional BetaBrowserDoubleClickConfig or null`
1656
1657 `double_click`'s config overrides.
1658
1659 - `defer_loading: optional boolean or null`
1660
1661 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1662
1663 - `enabled: optional boolean or null`
1664
1665 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.
1666
1667 - `file_upload: optional BetaBrowserFileUploadConfig or null`
1668
1669 `file_upload`'s config overrides.
1670
1671 - `defer_loading: optional boolean or null`
1672
1673 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1674
1675 - `enabled: optional boolean or null`
1676
1677 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.
1678
1679 - `find: optional BetaBrowserFindConfig or null`
1680
1681 `find`'s config overrides.
1682
1683 - `defer_loading: optional boolean or null`
1684
1685 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1686
1687 - `enabled: optional boolean or null`
1688
1689 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.
1690
1691 - `form_input: optional BetaBrowserFormInputConfig or null`
1692
1693 `form_input`'s config overrides.
1694
1695 - `defer_loading: optional boolean or null`
1696
1697 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1698
1699 - `enabled: optional boolean or null`
1700
1701 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.
1702
1703 - `get_page_text: optional BetaBrowserGetPageTextConfig or null`
1704
1705 `get_page_text`'s config overrides.
1706
1707 - `defer_loading: optional boolean or null`
1708
1709 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1710
1711 - `enabled: optional boolean or null`
1712
1713 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.
1714
1715 - `hold_key: optional BetaBrowserHoldKeyConfig or null`
1716
1717 `hold_key`'s config overrides.
1718
1719 - `defer_loading: optional boolean or null`
1720
1721 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1722
1723 - `enabled: optional boolean or null`
1724
1725 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.
1726
1727 - `hover: optional BetaBrowserHoverConfig or null`
1728
1729 `hover`'s config overrides.
1730
1731 - `defer_loading: optional boolean or null`
1732
1733 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1734
1735 - `enabled: optional boolean or null`
1736
1737 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.
1738
1739 - `javascript_exec: optional BetaBrowserJavascriptExecConfig or null`
1740
1741 `javascript_exec`'s config overrides.
1742
1743 - `defer_loading: optional boolean or null`
1744
1745 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1746
1747 - `enabled: optional boolean or null`
1748
1749 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.
1750
1751 - `key: optional BetaBrowserKeyConfig or null`
1752
1753 `key`'s config overrides.
1754
1755 - `defer_loading: optional boolean or null`
1756
1757 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1758
1759 - `enabled: optional boolean or null`
1760
1761 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.
1762
1763 - `left_click: optional BetaBrowserLeftClickConfig or null`
1764
1765 `left_click`'s config overrides.
1766
1767 - `defer_loading: optional boolean or null`
1768
1769 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1770
1771 - `enabled: optional boolean or null`
1772
1773 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.
1774
1775 - `left_click_drag: optional BetaBrowserLeftClickDragConfig or null`
1776
1777 `left_click_drag`'s config overrides.
1778
1779 - `defer_loading: optional boolean or null`
1780
1781 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1782
1783 - `enabled: optional boolean or null`
1784
1785 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.
1786
1787 - `left_mouse_down: optional BetaBrowserLeftMouseDownConfig or null`
1788
1789 `left_mouse_down`'s config overrides.
1790
1791 - `defer_loading: optional boolean or null`
1792
1793 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1794
1795 - `enabled: optional boolean or null`
1796
1797 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.
1798
1799 - `left_mouse_up: optional BetaBrowserLeftMouseUpConfig or null`
1800
1801 `left_mouse_up`'s config overrides.
1802
1803 - `defer_loading: optional boolean or null`
1804
1805 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1806
1807 - `enabled: optional boolean or null`
1808
1809 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.
1810
1811 - `list_tabs: optional BetaBrowserListTabsConfig or null`
1812
1813 `list_tabs`'s config overrides.
1814
1815 - `defer_loading: optional boolean or null`
1816
1817 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1818
1819 - `enabled: optional boolean or null`
1820
1821 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.
1822
1823 - `middle_click: optional BetaBrowserMiddleClickConfig or null`
1824
1825 `middle_click`'s config overrides.
1826
1827 - `defer_loading: optional boolean or null`
1828
1829 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1830
1831 - `enabled: optional boolean or null`
1832
1833 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.
1834
1835 - `mouse_move: optional BetaBrowserMouseMoveConfig or null`
1836
1837 `mouse_move`'s config overrides.
1838
1839 - `defer_loading: optional boolean or null`
1840
1841 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1842
1843 - `enabled: optional boolean or null`
1844
1845 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.
1846
1847 - `navigate: optional BetaBrowserNavigateConfig or null`
1848
1849 `navigate`'s config overrides.
1850
1851 - `defer_loading: optional boolean or null`
1852
1853 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1854
1855 - `enabled: optional boolean or null`
1856
1857 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.
1858
1859 - `new_tab: optional BetaBrowserNewTabConfig or null`
1860
1861 `new_tab`'s config overrides.
1862
1863 - `defer_loading: optional boolean or null`
1864
1865 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1866
1867 - `enabled: optional boolean or null`
1868
1869 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.
1870
1871 - `read_console: optional BetaBrowserReadConsoleConfig or null`
1872
1873 `read_console`'s config overrides.
1874
1875 - `defer_loading: optional boolean or null`
1876
1877 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1878
1879 - `enabled: optional boolean or null`
1880
1881 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.
1882
1883 - `read_network: optional BetaBrowserReadNetworkConfig or null`
1884
1885 `read_network`'s config overrides.
1886
1887 - `defer_loading: optional boolean or null`
1888
1889 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1890
1891 - `enabled: optional boolean or null`
1892
1893 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.
1894
1895 - `read_page: optional BetaBrowserReadPageConfig or null`
1896
1897 `read_page`'s config overrides.
1898
1899 - `defer_loading: optional boolean or null`
1900
1901 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1902
1903 - `enabled: optional boolean or null`
1904
1905 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.
1906
1907 - `right_click: optional BetaBrowserRightClickConfig or null`
1908
1909 `right_click`'s config overrides.
1910
1911 - `defer_loading: optional boolean or null`
1912
1913 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1914
1915 - `enabled: optional boolean or null`
1916
1917 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.
1918
1919 - `screenshot: optional BetaBrowserScreenshotConfig or null`
1920
1921 `screenshot`'s config overrides.
1922
1923 - `defer_loading: optional boolean or null`
1924
1925 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1926
1927 - `enabled: optional boolean or null`
1928
1929 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.
1930
1931 - `scroll: optional BetaBrowserScrollConfig or null`
1932
1933 `scroll`'s config overrides.
1934
1935 - `defer_loading: optional boolean or null`
1936
1937 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1938
1939 - `enabled: optional boolean or null`
1940
1941 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.
1942
1943 - `scroll_to: optional BetaBrowserScrollToConfig or null`
1944
1945 `scroll_to`'s config overrides.
1946
1947 - `defer_loading: optional boolean or null`
1948
1949 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1950
1951 - `enabled: optional boolean or null`
1952
1953 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.
1954
1955 - `switch_tab: optional BetaBrowserSwitchTabConfig or null`
1956
1957 `switch_tab`'s config overrides.
1958
1959 - `defer_loading: optional boolean or null`
1960
1961 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1962
1963 - `enabled: optional boolean or null`
1964
1965 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.
1966
1967 - `triple_click: optional BetaBrowserTripleClickConfig or null`
1968
1969 `triple_click`'s config overrides.
1970
1971 - `defer_loading: optional boolean or null`
1972
1973 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1974
1975 - `enabled: optional boolean or null`
1976
1977 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.
1978
1979 - `wait: optional BetaBrowserWaitConfig or null`
1980
1981 `wait`'s config overrides.
1982
1983 - `defer_loading: optional boolean or null`
1984
1985 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1986
1987 - `enabled: optional boolean or null`
1988
1989 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.
1990
1991 - `zoom: optional BetaBrowserZoomConfig or null`
1992
1993 `zoom`'s config overrides.
1994
1995 - `defer_loading: optional boolean or null`
1996
1997 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1998
1999 - `enabled: optional boolean or null`
2000
2001 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.
2002
2003 - `BetaToolComputerUse20241022 object`
2004
2005 - `type: "computer_20241022"`
2006
2007 - `display_height_px: number`
2008
2009 The height of the display in pixels.
2010
2011 minimum: 1
2012
2013 - `display_width_px: number`
2014
2015 The width of the display in pixels.
2016
2017 minimum: 1
2018
2019 - `name: "computer"`
2020
2021 Name of the tool.
2022
2023 This is how the tool will be called by the model and in `tool_use` blocks.
2024
2025 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2026
2027 - `"direct"`
2028
2029 - `"code_execution_20250825"`
2030
2031 - `"code_execution_20260120"`
2032
2033 - `"code_execution_20260521"`
2034
2035 - `cache_control: optional BetaCacheControlEphemeral or null`
2036
2037 Create a cache control breakpoint at this content block.
2038
2039 - `defer_loading: optional boolean`
2040
2041 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2042
2043 - `display_number: optional number or null`
2044
2045 The X11 display number (e.g. 0, 1) for the display.
2046
2047 minimum: 0
2048
2049 - `input_examples: optional array of map[unknown]`
2050
2051 - `strict: optional boolean`
2052
2053 When true, guarantees schema validation on tool names and inputs
2054
2055 - `BetaMemoryTool20250818 object`
2056
2057 - `type: "memory_20250818"`
2058
2059 - `name: "memory"`
2060
2061 Name of the tool.
2062
2063 This is how the tool will be called by the model and in `tool_use` blocks.
2064
2065 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2066
2067 - `"direct"`
2068
2069 - `"code_execution_20250825"`
2070
2071 - `"code_execution_20260120"`
2072
2073 - `"code_execution_20260521"`
2074
2075 - `cache_control: optional BetaCacheControlEphemeral or null`
2076
2077 Create a cache control breakpoint at this content block.
2078
2079 - `defer_loading: optional boolean`
2080
2081 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2082
2083 - `input_examples: optional array of map[unknown]`
2084
2085 - `strict: optional boolean`
2086
2087 When true, guarantees schema validation on tool names and inputs
2088
2089 - `BetaToolComputerUse20250124 object`
2090
2091 - `type: "computer_20250124"`
2092
2093 - `display_height_px: number`
2094
2095 The height of the display in pixels.
2096
2097 minimum: 1
2098
2099 - `display_width_px: number`
2100
2101 The width of the display in pixels.
2102
2103 minimum: 1
2104
2105 - `name: "computer"`
2106
2107 Name of the tool.
2108
2109 This is how the tool will be called by the model and in `tool_use` blocks.
2110
2111 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2112
2113 - `"direct"`
2114
2115 - `"code_execution_20250825"`
2116
2117 - `"code_execution_20260120"`
2118
2119 - `"code_execution_20260521"`
2120
2121 - `cache_control: optional BetaCacheControlEphemeral or null`
2122
2123 Create a cache control breakpoint at this content block.
2124
2125 - `defer_loading: optional boolean`
2126
2127 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2128
2129 - `display_number: optional number or null`
2130
2131 The X11 display number (e.g. 0, 1) for the display.
2132
2133 minimum: 0
2134
2135 - `input_examples: optional array of map[unknown]`
2136
2137 - `strict: optional boolean`
2138
2139 When true, guarantees schema validation on tool names and inputs
2140
2141 - `BetaToolTextEditor20241022 object`
2142
2143 - `type: "text_editor_20241022"`
2144
2145 - `name: "str_replace_editor"`
2146
2147 Name of the tool.
2148
2149 This is how the tool will be called by the model and in `tool_use` blocks.
2150
2151 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2152
2153 - `"direct"`
2154
2155 - `"code_execution_20250825"`
2156
2157 - `"code_execution_20260120"`
2158
2159 - `"code_execution_20260521"`
2160
2161 - `cache_control: optional BetaCacheControlEphemeral or null`
2162
2163 Create a cache control breakpoint at this content block.
2164
2165 - `defer_loading: optional boolean`
2166
2167 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2168
2169 - `input_examples: optional array of map[unknown]`
2170
2171 - `strict: optional boolean`
2172
2173 When true, guarantees schema validation on tool names and inputs
2174
2175 - `BetaToolComputerUse20251124 object`
2176
2177 - `type: "computer_20251124"`
2178
2179 - `display_height_px: number`
2180
2181 The height of the display in pixels.
2182
2183 minimum: 1
2184
2185 - `display_width_px: number`
2186
2187 The width of the display in pixels.
2188
2189 minimum: 1
2190
2191 - `name: "computer"`
2192
2193 Name of the tool.
2194
2195 This is how the tool will be called by the model and in `tool_use` blocks.
2196
2197 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2198
2199 - `"direct"`
2200
2201 - `"code_execution_20250825"`
2202
2203 - `"code_execution_20260120"`
2204
2205 - `"code_execution_20260521"`
2206
2207 - `cache_control: optional BetaCacheControlEphemeral or null`
2208
2209 Create a cache control breakpoint at this content block.
2210
2211 - `defer_loading: optional boolean`
2212
2213 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2214
2215 - `display_number: optional number or null`
2216
2217 The X11 display number (e.g. 0, 1) for the display.
2218
2219 minimum: 0
2220
2221 - `enable_zoom: optional boolean`
2222
2223 Whether to enable an action to take a zoomed-in screenshot of the screen.
2224
2225 - `input_examples: optional array of map[unknown]`
2226
2227 - `strict: optional boolean`
2228
2229 When true, guarantees schema validation on tool names and inputs
2230
2231 - `BetaComputerToolset20260801 object`
2232
2233 The computer toolset: a single `tools[]` entry (carrying no
2234 `name`) that declares the computer tool family. The model is
2235 served the family's tool with any members disabled via `configs`
2236 removed from its schema. Every member is enabled by default, zoom
2237 included. The single-tool options `display_number` and
2238 `enable_zoom` are not fields of a toolset entry — it carries only
2239 `type`, `configs`, and `cache_control`; zoom is controlled
2240 via `configs.zoom.enabled`.
2241
2242 - `type: "computer_toolset_20260801"`
2243
2244 - `cache_control: optional BetaCacheControlEphemeral or null`
2245
2246 Create a cache control breakpoint at this content block.
2247
2248 - `configs: optional BetaComputerToolsetConfigs or null`
2249
2250 Per-member configuration for `computer_toolset_20260801`: one
2251 optional field per member tool, keyed by the member name — the same
2252 name the member's `tool_use` blocks carry. Every member is an
2253 accepted key, and a member's defaults apply wherever its key is
2254 absent. Unknown keys are rejected: the field set is this toolset
2255 version's complete member set.
2256
2257 - `type: optional BetaComputerTypeConfig or null`
2258
2259 `type`'s config overrides.
2260
2261 - `defer_loading: optional boolean or null`
2262
2263 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2264
2265 - `enabled: optional boolean or null`
2266
2267 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.
2268
2269 - `cursor_position: optional BetaComputerCursorPositionConfig or null`
2270
2271 `cursor_position`'s config overrides.
2272
2273 - `defer_loading: optional boolean or null`
2274
2275 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2276
2277 - `enabled: optional boolean or null`
2278
2279 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.
2280
2281 - `double_click: optional BetaComputerDoubleClickConfig or null`
2282
2283 `double_click`'s config overrides.
2284
2285 - `defer_loading: optional boolean or null`
2286
2287 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2288
2289 - `enabled: optional boolean or null`
2290
2291 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.
2292
2293 - `hold_key: optional BetaComputerHoldKeyConfig or null`
2294
2295 `hold_key`'s config overrides.
2296
2297 - `defer_loading: optional boolean or null`
2298
2299 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2300
2301 - `enabled: optional boolean or null`
2302
2303 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.
2304
2305 - `key: optional BetaComputerKeyConfig or null`
2306
2307 `key`'s config overrides.
2308
2309 - `defer_loading: optional boolean or null`
2310
2311 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2312
2313 - `enabled: optional boolean or null`
2314
2315 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.
2316
2317 - `left_click: optional BetaComputerLeftClickConfig or null`
2318
2319 `left_click`'s config overrides.
2320
2321 - `defer_loading: optional boolean or null`
2322
2323 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2324
2325 - `enabled: optional boolean or null`
2326
2327 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.
2328
2329 - `left_click_drag: optional BetaComputerLeftClickDragConfig or null`
2330
2331 `left_click_drag`'s config overrides.
2332
2333 - `defer_loading: optional boolean or null`
2334
2335 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2336
2337 - `enabled: optional boolean or null`
2338
2339 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.
2340
2341 - `left_mouse_down: optional BetaComputerLeftMouseDownConfig or null`
2342
2343 `left_mouse_down`'s config overrides.
2344
2345 - `defer_loading: optional boolean or null`
2346
2347 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2348
2349 - `enabled: optional boolean or null`
2350
2351 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.
2352
2353 - `left_mouse_up: optional BetaComputerLeftMouseUpConfig or null`
2354
2355 `left_mouse_up`'s config overrides.
2356
2357 - `defer_loading: optional boolean or null`
2358
2359 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2360
2361 - `enabled: optional boolean or null`
2362
2363 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.
2364
2365 - `middle_click: optional BetaComputerMiddleClickConfig or null`
2366
2367 `middle_click`'s config overrides.
2368
2369 - `defer_loading: optional boolean or null`
2370
2371 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2372
2373 - `enabled: optional boolean or null`
2374
2375 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.
2376
2377 - `mouse_move: optional BetaComputerMouseMoveConfig or null`
2378
2379 `mouse_move`'s config overrides.
2380
2381 - `defer_loading: optional boolean or null`
2382
2383 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2384
2385 - `enabled: optional boolean or null`
2386
2387 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.
2388
2389 - `right_click: optional BetaComputerRightClickConfig or null`
2390
2391 `right_click`'s config overrides.
2392
2393 - `defer_loading: optional boolean or null`
2394
2395 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2396
2397 - `enabled: optional boolean or null`
2398
2399 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.
2400
2401 - `screenshot: optional BetaComputerScreenshotConfig or null`
2402
2403 `screenshot`'s config overrides.
2404
2405 - `defer_loading: optional boolean or null`
2406
2407 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2408
2409 - `enabled: optional boolean or null`
2410
2411 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.
2412
2413 - `scroll: optional BetaComputerScrollConfig or null`
2414
2415 `scroll`'s config overrides.
2416
2417 - `defer_loading: optional boolean or null`
2418
2419 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2420
2421 - `enabled: optional boolean or null`
2422
2423 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.
2424
2425 - `triple_click: optional BetaComputerTripleClickConfig or null`
2426
2427 `triple_click`'s config overrides.
2428
2429 - `defer_loading: optional boolean or null`
2430
2431 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2432
2433 - `enabled: optional boolean or null`
2434
2435 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.
2436
2437 - `wait: optional BetaComputerWaitConfig or null`
2438
2439 `wait`'s config overrides.
2440
2441 - `defer_loading: optional boolean or null`
2442
2443 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2444
2445 - `enabled: optional boolean or null`
2446
2447 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.
2448
2449 - `zoom: optional BetaComputerZoomConfig or null`
2450
2451 `zoom`'s config overrides.
2452
2453 - `defer_loading: optional boolean or null`
2454
2455 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2456
2457 - `enabled: optional boolean or null`
2458
2459 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.
2460
2461 - `BetaToolTextEditor20250124 object`
2462
2463 - `type: "text_editor_20250124"`
2464
2465 - `name: "str_replace_editor"`
2466
2467 Name of the tool.
2468
2469 This is how the tool will be called by the model and in `tool_use` blocks.
2470
2471 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2472
2473 - `"direct"`
2474
2475 - `"code_execution_20250825"`
2476
2477 - `"code_execution_20260120"`
2478
2479 - `"code_execution_20260521"`
2480
2481 - `cache_control: optional BetaCacheControlEphemeral or null`
2482
2483 Create a cache control breakpoint at this content block.
2484
2485 - `defer_loading: optional boolean`
2486
2487 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2488
2489 - `input_examples: optional array of map[unknown]`
2490
2491 - `strict: optional boolean`
2492
2493 When true, guarantees schema validation on tool names and inputs
2494
2495 - `BetaToolTextEditor20250429 object`
2496
2497 - `type: "text_editor_20250429"`
2498
2499 - `name: "str_replace_based_edit_tool"`
2500
2501 Name of the tool.
2502
2503 This is how the tool will be called by the model and in `tool_use` blocks.
2504
2505 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2506
2507 - `"direct"`
2508
2509 - `"code_execution_20250825"`
2510
2511 - `"code_execution_20260120"`
2512
2513 - `"code_execution_20260521"`
2514
2515 - `cache_control: optional BetaCacheControlEphemeral or null`
2516
2517 Create a cache control breakpoint at this content block.
2518
2519 - `defer_loading: optional boolean`
2520
2521 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2522
2523 - `input_examples: optional array of map[unknown]`
2524
2525 - `strict: optional boolean`
2526
2527 When true, guarantees schema validation on tool names and inputs
2528
2529 - `BetaToolTextEditor20250728 object`
2530
2531 - `type: "text_editor_20250728"`
2532
2533 - `name: "str_replace_based_edit_tool"`
2534
2535 Name of the tool.
2536
2537 This is how the tool will be called by the model and in `tool_use` blocks.
2538
2539 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2540
2541 - `"direct"`
2542
2543 - `"code_execution_20250825"`
2544
2545 - `"code_execution_20260120"`
2546
2547 - `"code_execution_20260521"`
2548
2549 - `cache_control: optional BetaCacheControlEphemeral or null`
2550
2551 Create a cache control breakpoint at this content block.
2552
2553 - `defer_loading: optional boolean`
2554
2555 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2556
2557 - `input_examples: optional array of map[unknown]`
2558
2559 - `max_characters: optional number or null`
2560
2561 Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
2562
2563 minimum: 1
2564
2565 - `strict: optional boolean`
2566
2567 When true, guarantees schema validation on tool names and inputs
2568
2569 - `BetaWebSearchTool20250305 object`
2570
2571 - `type: "web_search_20250305"`
2572
2573 - `name: "web_search"`
2574
2575 Name of the tool.
2576
2577 This is how the tool will be called by the model and in `tool_use` blocks.
2578
2579 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2580
2581 - `"direct"`
2582
2583 - `"code_execution_20250825"`
2584
2585 - `"code_execution_20260120"`
2586
2587 - `"code_execution_20260521"`
2588
2589 - `allowed_domains: optional array of string or null`
2590
2591 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.
2592
2593 - `blocked_domains: optional array of string or null`
2594
2595 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.
2596
2597 - `cache_control: optional BetaCacheControlEphemeral or null`
2598
2599 Create a cache control breakpoint at this content block.
2600
2601 - `defer_loading: optional boolean`
2602
2603 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2604
2605 - `max_uses: optional number or null`
2606
2607 Maximum number of times the tool can be used in the API request.
2608
2609 exclusiveMinimum: 0
2610
2611 - `strict: optional boolean`
2612
2613 When true, guarantees schema validation on tool names and inputs
2614
2615 - `user_location: optional BetaUserLocation or null`
2616
2617 Parameters for the user's location. Used to provide more relevant search results.
2618
2619 - `type: "approximate"`
2620
2621 - `city: optional string or null`
2622
2623 The city of the user.
2624
2625 maxLength: 255, minLength: 1
2626
2627 - `country: optional string or null`
2628
2629 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.
2630
2631 maxLength: 2, minLength: 2
2632
2633 - `region: optional string or null`
2634
2635 The region of the user.
2636
2637 maxLength: 255, minLength: 1
2638
2639 - `timezone: optional string or null`
2640
2641 The [IANA timezone](https://nodatime.org/TimeZones) of the user.
2642
2643 maxLength: 255, minLength: 1
2644
2645 - `BetaWebFetchTool20250910 object`
2646
2647 - `type: "web_fetch_20250910"`
2648
2649 - `name: "web_fetch"`
2650
2651 Name of the tool.
2652
2653 This is how the tool will be called by the model and in `tool_use` blocks.
2654
2655 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2656
2657 - `"direct"`
2658
2659 - `"code_execution_20250825"`
2660
2661 - `"code_execution_20260120"`
2662
2663 - `"code_execution_20260521"`
2664
2665 - `allowed_domains: optional array of string or null`
2666
2667 List of domains to allow fetching from
2668
2669 - `blocked_domains: optional array of string or null`
2670
2671 List of domains to block fetching from
2672
2673 - `cache_control: optional BetaCacheControlEphemeral or null`
2674
2675 Create a cache control breakpoint at this content block.
2676
2677 - `citations: optional BetaCitationsConfigParam or null`
2678
2679 Citations configuration for fetched documents. Citations are disabled by default.
2680
2681 - `defer_loading: optional boolean`
2682
2683 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2684
2685 - `max_content_tokens: optional number or null`
2686
2687 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
2688
2689 exclusiveMinimum: 0
2690
2691 - `max_uses: optional number or null`
2692
2693 Maximum number of times the tool can be used in the API request.
2694
2695 exclusiveMinimum: 0
2696
2697 - `strict: optional boolean`
2698
2699 When true, guarantees schema validation on tool names and inputs
2700
2701 - `url_sources: optional BetaWebFetchURLSources or null`
2702
2703 Which sources contribute to the set of URLs web fetch may fetch.
2704
2705 Each key is a tagged variant: `user_input` is `all` or `none`; the
2706 two tool filters are `all`, `none`, `only` (only the named tools'
2707 results) or `except` (every result but the named tools'). A named tool
2708 must be declared in this request's `tools[]`.
2709
2710 - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`
2711
2712 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].
2713
2714 - `BetaWebFetchURLSourceAll object`
2715
2716 The `url_sources` variant under which a source contributes in
2717 full: every result of the tool filter's source, or all user input.
2718
2719 - `type: "all"`
2720
2721 - `BetaWebFetchURLSourceNone object`
2722
2723 The `url_sources` variant under which a source contributes nothing:
2724 no result of the tool filter's source, or no user input.
2725
2726 - `type: "none"`
2727
2728 - `BetaWebFetchURLSourceOnly object`
2729
2730 The tool filter variant under which only the named tools' results
2731 contribute.
2732
2733 - `type: "only"`
2734
2735 - `tools: array of BetaWebFetchURLSourceToolReference`
2736
2737 - `type: "tool_reference"`
2738
2739 - `name: string`
2740
2741 - `BetaWebFetchURLSourceExcept object`
2742
2743 The tool filter variant under which every result but the named
2744 tools' contributes.
2745
2746 - `type: "except"`
2747
2748 - `tools: array of BetaWebFetchURLSourceToolReference`
2749
2750 - `type: "tool_reference"`
2751
2752 - `name: string`
2753
2754 - `server_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`
2755
2756 Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute.
2757
2758 - `BetaWebFetchURLSourceAll object`
2759
2760 The `url_sources` variant under which a source contributes in
2761 full: every result of the tool filter's source, or all user input.
2762
2763 - `BetaWebFetchURLSourceNone object`
2764
2765 The `url_sources` variant under which a source contributes nothing:
2766 no result of the tool filter's source, or no user input.
2767
2768 - `BetaWebFetchURLSourceOnly object`
2769
2770 The tool filter variant under which only the named tools' results
2771 contribute.
2772
2773 - `BetaWebFetchURLSourceExcept object`
2774
2775 The tool filter variant under which every result but the named
2776 tools' contributes.
2777
2778 - `user_input: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone`
2779
2780 Whether URLs in user messages are fetchable: "all" or "none".
2781
2782 - `BetaWebFetchURLSourceAll object`
2783
2784 The `url_sources` variant under which a source contributes in
2785 full: every result of the tool filter's source, or all user input.
2786
2787 - `BetaWebFetchURLSourceNone object`
2788
2789 The `url_sources` variant under which a source contributes nothing:
2790 no result of the tool filter's source, or no user input.
2791
2792 - `BetaWebSearchTool20260209 object`
2793
2794 - `type: "web_search_20260209"`
2795
2796 - `name: "web_search"`
2797
2798 Name of the tool.
2799
2800 This is how the tool will be called by the model and in `tool_use` blocks.
2801
2802 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2803
2804 - `"direct"`
2805
2806 - `"code_execution_20250825"`
2807
2808 - `"code_execution_20260120"`
2809
2810 - `"code_execution_20260521"`
2811
2812 - `allowed_domains: optional array of string or null`
2813
2814 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.
2815
2816 - `blocked_domains: optional array of string or null`
2817
2818 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.
2819
2820 - `cache_control: optional BetaCacheControlEphemeral or null`
2821
2822 Create a cache control breakpoint at this content block.
2823
2824 - `defer_loading: optional boolean`
2825
2826 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2827
2828 - `max_uses: optional number or null`
2829
2830 Maximum number of times the tool can be used in the API request.
2831
2832 exclusiveMinimum: 0
2833
2834 - `strict: optional boolean`
2835
2836 When true, guarantees schema validation on tool names and inputs
2837
2838 - `user_location: optional BetaUserLocation or null`
2839
2840 Parameters for the user's location. Used to provide more relevant search results.
2841
2842 - `BetaWebFetchTool20260209 object`
2843
2844 - `type: "web_fetch_20260209"`
2845
2846 - `name: "web_fetch"`
2847
2848 Name of the tool.
2849
2850 This is how the tool will be called by the model and in `tool_use` blocks.
2851
2852 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2853
2854 - `"direct"`
2855
2856 - `"code_execution_20250825"`
2857
2858 - `"code_execution_20260120"`
2859
2860 - `"code_execution_20260521"`
2861
2862 - `allowed_domains: optional array of string or null`
2863
2864 List of domains to allow fetching from
2865
2866 - `blocked_domains: optional array of string or null`
2867
2868 List of domains to block fetching from
2869
2870 - `cache_control: optional BetaCacheControlEphemeral or null`
2871
2872 Create a cache control breakpoint at this content block.
2873
2874 - `citations: optional BetaCitationsConfigParam or null`
2875
2876 Citations configuration for fetched documents. Citations are disabled by default.
2877
2878 - `defer_loading: optional boolean`
2879
2880 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2881
2882 - `max_content_tokens: optional number or null`
2883
2884 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
2885
2886 exclusiveMinimum: 0
2887
2888 - `max_uses: optional number or null`
2889
2890 Maximum number of times the tool can be used in the API request.
2891
2892 exclusiveMinimum: 0
2893
2894 - `strict: optional boolean`
2895
2896 When true, guarantees schema validation on tool names and inputs
2897
2898 - `url_sources: optional BetaWebFetchURLSources or null`
2899
2900 Which sources contribute to the set of URLs web fetch may fetch.
2901
2902 Each key is a tagged variant: `user_input` is `all` or `none`; the
2903 two tool filters are `all`, `none`, `only` (only the named tools'
2904 results) or `except` (every result but the named tools'). A named tool
2905 must be declared in this request's `tools[]`.
2906
2907 - `BetaWebFetchTool20260309 object`
2908
2909 Web fetch tool with use_cache parameter for bypassing cached content.
2910
2911 - `type: "web_fetch_20260309"`
2912
2913 - `name: "web_fetch"`
2914
2915 Name of the tool.
2916
2917 This is how the tool will be called by the model and in `tool_use` blocks.
2918
2919 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2920
2921 - `"direct"`
2922
2923 - `"code_execution_20250825"`
2924
2925 - `"code_execution_20260120"`
2926
2927 - `"code_execution_20260521"`
2928
2929 - `allowed_domains: optional array of string or null`
2930
2931 List of domains to allow fetching from
2932
2933 - `blocked_domains: optional array of string or null`
2934
2935 List of domains to block fetching from
2936
2937 - `cache_control: optional BetaCacheControlEphemeral or null`
2938
2939 Create a cache control breakpoint at this content block.
2940
2941 - `citations: optional BetaCitationsConfigParam or null`
2942
2943 Citations configuration for fetched documents. Citations are disabled by default.
2944
2945 - `defer_loading: optional boolean`
2946
2947 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2948
2949 - `max_content_tokens: optional number or null`
2950
2951 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
2952
2953 exclusiveMinimum: 0
2954
2955 - `max_uses: optional number or null`
2956
2957 Maximum number of times the tool can be used in the API request.
2958
2959 exclusiveMinimum: 0
2960
2961 - `strict: optional boolean`
2962
2963 When true, guarantees schema validation on tool names and inputs
2964
2965 - `url_sources: optional BetaWebFetchURLSources or null`
2966
2967 Which sources contribute to the set of URLs web fetch may fetch.
2968
2969 Each key is a tagged variant: `user_input` is `all` or `none`; the
2970 two tool filters are `all`, `none`, `only` (only the named tools'
2971 results) or `except` (every result but the named tools'). A named tool
2972 must be declared in this request's `tools[]`.
2973
2974 - `use_cache: optional boolean`
2975
2976 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
2977
2978 - `BetaWebSearchTool20260318 object`
2979
2980 - `type: "web_search_20260318"`
2981
2982 - `name: "web_search"`
2983
2984 Name of the tool.
2985
2986 This is how the tool will be called by the model and in `tool_use` blocks.
2987
2988 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2989
2990 - `"direct"`
2991
2992 - `"code_execution_20250825"`
2993
2994 - `"code_execution_20260120"`
2995
2996 - `"code_execution_20260521"`
2997
2998 - `allowed_domains: optional array of string or null`
2999
3000 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.
3001
3002 - `blocked_domains: optional array of string or null`
3003
3004 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.
3005
3006 - `cache_control: optional BetaCacheControlEphemeral or null`
3007
3008 Create a cache control breakpoint at this content block.
3009
3010 - `defer_loading: optional boolean`
3011
3012 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3013
3014 - `max_uses: optional number or null`
3015
3016 Maximum number of times the tool can be used in the API request.
3017
3018 exclusiveMinimum: 0
3019
3020 - `response_inclusion: optional "full" or "excluded"`
3021
3022 How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn.
3023
3024 - `"full"`
3025
3026 - `"excluded"`
3027
3028 - `strict: optional boolean`
3029
3030 When true, guarantees schema validation on tool names and inputs
3031
3032 - `user_location: optional BetaUserLocation or null`
3033
3034 Parameters for the user's location. Used to provide more relevant search results.
3035
3036 - `BetaWebFetchTool20260318 object`
3037
3038 - `type: "web_fetch_20260318"`
3039
3040 - `name: "web_fetch"`
3041
3042 Name of the tool.
3043
3044 This is how the tool will be called by the model and in `tool_use` blocks.
3045
3046 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3047
3048 - `"direct"`
3049
3050 - `"code_execution_20250825"`
3051
3052 - `"code_execution_20260120"`
3053
3054 - `"code_execution_20260521"`
3055
3056 - `allowed_domains: optional array of string or null`
3057
3058 List of domains to allow fetching from
3059
3060 - `blocked_domains: optional array of string or null`
3061
3062 List of domains to block fetching from
3063
3064 - `cache_control: optional BetaCacheControlEphemeral or null`
3065
3066 Create a cache control breakpoint at this content block.
3067
3068 - `citations: optional BetaCitationsConfigParam or null`
3069
3070 Citations configuration for fetched documents. Citations are disabled by default.
3071
3072 - `defer_loading: optional boolean`
3073
3074 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3075
3076 - `max_content_tokens: optional number or null`
3077
3078 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
3079
3080 exclusiveMinimum: 0
3081
3082 - `max_uses: optional number or null`
3083
3084 Maximum number of times the tool can be used in the API request.
3085
3086 exclusiveMinimum: 0
3087
3088 - `response_inclusion: optional "full" or "excluded"`
3089
3090 How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn.
3091
3092 - `"full"`
3093
3094 - `"excluded"`
3095
3096 - `strict: optional boolean`
3097
3098 When true, guarantees schema validation on tool names and inputs
3099
3100 - `url_sources: optional BetaWebFetchURLSources or null`
3101
3102 Which sources contribute to the set of URLs web fetch may fetch.
3103
3104 Each key is a tagged variant: `user_input` is `all` or `none`; the
3105 two tool filters are `all`, `none`, `only` (only the named tools'
3106 results) or `except` (every result but the named tools'). A named tool
3107 must be declared in this request's `tools[]`.
3108
3109 - `use_cache: optional boolean`
3110
3111 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
3112
3113 - `BetaAdvisorTool20260301 object`
3114
3115 - `type: "advisor_20260301"`
3116
3117 - `model: Model`
3118
3119 The model that will complete your prompt.
3120
3121 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
3122
3123 - `"claude-fable-5-1" or "claude-opus-5-5" or "claude-mythos-5-1" or 15 more`
3124
3125 The model that will complete your prompt.
3126
3127 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
3128
3129 - `"claude-fable-5-1"`
3130
3131 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows
3132
3133 - `"claude-opus-5-5"`
3134
3135 Powerful intelligence for coding, knowledge work, and long-running agents
3136
3137 - `"claude-mythos-5-1"`
3138
3139 Our most capable model for cybersecurity and biology research, available through trusted access programs
3140
3141 - `"claude-sonnet-5"`
3142
3143 High-performance model for coding and agents
3144
3145 - `"claude-fable-5"`
3146
3147 Next generation of intelligence for the hardest knowledge work and coding problems
3148
3149 - `"claude-mythos-5"`
3150
3151 Most capable model for cybersecurity and biology research
3152
3153 - `"claude-opus-5"`
3154
3155 Powerful intelligence for long-running agents and coding
3156
3157 - `"claude-opus-4-8"`
3158
3159 Powerful intelligence for long-running agents and coding
3160
3161 - `"claude-opus-4-7"`
3162
3163 Powerful intelligence for long-running agents and coding
3164
3165 - `"claude-mythos-preview"`
3166
3167 New class of intelligence, strongest in coding and cybersecurity
3168
3169 - `"claude-opus-4-6"`
3170
3171 Powerful intelligence for long-running agents and coding
3172
3173 - `"claude-sonnet-4-6"`
3174
3175 Best combination of speed and intelligence
3176
3177 - `"claude-haiku-4-5"`
3178
3179 Fastest model with near-frontier intelligence
3180
3181 - `"claude-haiku-4-5-20251001"`
3182
3183 Fastest model with near-frontier intelligence
3184
3185 - `"claude-opus-4-5"`
3186
3187 Powerful intelligence for long-running agents and coding
3188
3189 - `"claude-opus-4-5-20251101"`
3190
3191 Powerful intelligence for long-running agents and coding
3192
3193 - `"claude-sonnet-4-5"`
3194
3195 High-performance model for agents and coding
3196
3197 - `"claude-sonnet-4-5-20250929"`
3198
3199 High-performance model for agents and coding
3200
3201 - `string`
3202
3203 - `name: "advisor"`
3204
3205 Name of the tool.
3206
3207 This is how the tool will be called by the model and in `tool_use` blocks.
3208
3209 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3210
3211 - `"direct"`
3212
3213 - `"code_execution_20250825"`
3214
3215 - `"code_execution_20260120"`
3216
3217 - `"code_execution_20260521"`
3218
3219 - `cache_control: optional BetaCacheControlEphemeral or null`
3220
3221 Create a cache control breakpoint at this content block.
3222
3223 - `caching: optional BetaCacheControlEphemeral or null`
3224
3225 Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.
3226
3227 - `defer_loading: optional boolean`
3228
3229 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3230
3231 - `max_tokens: optional number or null`
3232
3233 Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.
3234
3235 minimum: 1024
3236
3237 - `max_uses: optional number or null`
3238
3239 Maximum number of times the tool can be used in the API request.
3240
3241 exclusiveMinimum: 0
3242
3243 - `strict: optional boolean`
3244
3245 When true, guarantees schema validation on tool names and inputs
3246
3247 - `BetaToolSearchToolBm25_20251119 object`
3248
3249 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`
3250
3251 - `"tool_search_tool_bm25_20251119"`
3252
3253 - `"tool_search_tool_bm25"`
3254
3255 - `name: "tool_search_tool_bm25"`
3256
3257 Name of the tool.
3258
3259 This is how the tool will be called by the model and in `tool_use` blocks.
3260
3261 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3262
3263 - `"direct"`
3264
3265 - `"code_execution_20250825"`
3266
3267 - `"code_execution_20260120"`
3268
3269 - `"code_execution_20260521"`
3270
3271 - `cache_control: optional BetaCacheControlEphemeral or null`
3272
3273 Create a cache control breakpoint at this content block.
3274
3275 - `defer_loading: optional boolean`
3276
3277 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3278
3279 - `strict: optional boolean`
3280
3281 When true, guarantees schema validation on tool names and inputs
3282
3283 - `BetaToolSearchToolRegex20251119 object`
3284
3285 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`
3286
3287 - `"tool_search_tool_regex_20251119"`
3288
3289 - `"tool_search_tool_regex"`
3290
3291 - `name: "tool_search_tool_regex"`
3292
3293 Name of the tool.
3294
3295 This is how the tool will be called by the model and in `tool_use` blocks.
3296
3297 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3298
3299 - `"direct"`
3300
3301 - `"code_execution_20250825"`
3302
3303 - `"code_execution_20260120"`
3304
3305 - `"code_execution_20260521"`
3306
3307 - `cache_control: optional BetaCacheControlEphemeral or null`
3308
3309 Create a cache control breakpoint at this content block.
3310
3311 - `defer_loading: optional boolean`
3312
3313 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3314
3315 - `strict: optional boolean`
3316
3317 When true, guarantees schema validation on tool names and inputs
3318
3319 - `BetaMCPToolset object`
3320
3321 Configuration for a group of tools from an MCP server.
3322
3323 Allows configuring enabled status and defer_loading for all tools
3324 from an MCP server, with optional per-tool overrides.
3325
3326 - `type: "mcp_toolset"`
3327
3328 - `mcp_server_name: string`
3329
3330 Name of the MCP server to configure tools for
3331
3332 maxLength: 255, minLength: 1
3333
3334 - `cache_control: optional BetaCacheControlEphemeral or null`
3335
3336 Create a cache control breakpoint at this content block.
3337
3338 - `configs: optional map[BetaMCPToolConfig] or null`
3339
3340 Configuration overrides for specific tools, keyed by tool name
3341
3342 - `defer_loading: optional boolean`
3343
3344 - `enabled: optional boolean`
3345
3346 - `default_config: optional BetaMCPToolDefaultConfig`
3347
3348 Default configuration applied to all tools from this server
3349
3350 - `defer_loading: optional boolean`
3351
3352 - `enabled: optional boolean`
3353
3354 - `tools: optional array of BetaMCPToolParam or null`
3355
3356 The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.
3357
3358 - `input_schema: map[unknown]`
3359
3360 The tool's input schema as the MCP server lists it, verbatim.
3361
3362 - `name: string`
3363
3364 The tool's name as the MCP server lists it (not prefixed with the server name).
3365
3366 minLength: 1
3367
3368 - `description: optional string or null`
3369
3370 The tool's description as the MCP server lists it.
3371
3372 - `cache_control: optional BetaCacheControlEphemeral or null`
3373
3374 Create a cache control breakpoint at this content block.
3375
3376 - `BetaRequestToolRemovalBlock object`
3377
3378 Mid-conversation directive to withdraw a tool.
3379
3380 `tool` references a tool (or MCP toolset) by name: one declared in the
3381 request's `tools` or defined earlier in `messages`. It is no longer
3382 offered to the model from this point in the conversation onward.
3383
3384 - `type: "tool_removal"`
3385
3386 - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference`
3387
3388 - `BetaToolChangeToolReference object`
3389
3390 Reference to a single tool, by the name the model uses to call it: a
3391 tool declared in `tools` or defined by an earlier `tool_addition`
3392 block. Does not accept the composed `{server}_{name}` form the server
3393 assigns to MCP-resolved tools; use `mcp_tool_reference` or
3394 `mcp_toolset_reference` for those.
3395
3396 - `BetaToolChangeMCPToolReference object`
3397
3398 Reference to a single MCP tool by its server and remote name; the
3399 same `server_name`/`name` pair `mcp_tool_use` carries.
3400
3401 - `BetaToolChangeMCPToolsetReference object`
3402
3403 Reference to every tool in the named MCP server's toolset.
3404
3405 - `cache_control: optional BetaCacheControlEphemeral or null`
3406
3407 Create a cache control breakpoint at this content block.
3408
12843409 - `BetaRequestToolAdditionBlock object`
12853410
1286 Mid-conversation directive to surface a declared tool.
1287
1288 `tool` references a tool (or MCP toolset) by name from the request's
1289 `tools`; it is offered to the model from this point in the
1290 conversation onward.
1291
1292 - `type: "tool_addition"`
1293
1294 - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference`
1295
1296 - `BetaToolChangeToolReference object`
1297
1298 Reference to a single tool the caller declared directly in
1299 `tools[]`. Does not accept the composed `{server}_{name}` form the
1300 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1301 `mcp_toolset_reference` for those.
1302
1303 - `type: "tool_reference"`
1304
1305 - `name: string`
1306
1307 pattern: ^[a-zA-Z0-9_-]{1,128}$
1308
1309 - `BetaToolChangeMCPToolReference object`
1310
1311 Reference to a single MCP tool by its server and remote name; the
1312 same `server_name`/`name` pair `mcp_tool_use` carries.
1313
1314 - `type: "mcp_tool_reference"`
1315
1316 - `name: string`
1317
1318 - `server_name: string`
1319
1320 - `BetaToolChangeMCPToolsetReference object`
1321
1322 Reference to every tool in the named MCP server's toolset.
1323
1324 - `type: "mcp_toolset_reference"`
1325
1326 - `server_name: string`
1327
1328 - `cache_control: optional BetaCacheControlEphemeral or null`
1329
1330 Create a cache control breakpoint at this content block.
3411 Mid-conversation directive to make a tool available.
3412
3413 `tool` is a reference to a tool (or MCP toolset) declared in the
3414 request's `tools`. Under the `inline-tools-2026-09-15` beta it may
3415 instead be a reference to a tool defined earlier in `messages`, or a
3416 `tool_definition` object that carries an inline tool definition in
3417 `definition` (the same object a `tools` entry holds). An `mcp_toolset`
3418 definition also requires the `mcp-client-2026-09-15` beta. The tool is
3419 offered to the model from this point in the conversation onward.
13313420
13323421 - `BetaRequestToolRemovalBlock object`
13333422
13343423 Mid-conversation directive to withdraw a tool.
13353424
1336 `tool` references a tool (or MCP toolset) by name from the request's
1337 `tools`; it is no longer offered to the model from this point in the
1338 conversation onward.
1339
1340 - `type: "tool_removal"`
1341
1342 - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference`
1343
1344 - `BetaToolChangeToolReference object`
1345
1346 Reference to a single tool the caller declared directly in
1347 `tools[]`. Does not accept the composed `{server}_{name}` form the
1348 server assigns to MCP-resolved tools — use `mcp_tool_reference` or
1349 `mcp_toolset_reference` for those.
1350
1351 - `BetaToolChangeMCPToolReference object`
1352
1353 Reference to a single MCP tool by its server and remote name; the
1354 same `server_name`/`name` pair `mcp_tool_use` carries.
1355
1356 - `BetaToolChangeMCPToolsetReference object`
1357
1358 Reference to every tool in the named MCP server's toolset.
1359
1360 - `cache_control: optional BetaCacheControlEphemeral or null`
1361
1362 Create a cache control breakpoint at this content block.
3425 `tool` references a tool (or MCP toolset) by name: one declared in the
3426 request's `tools` or defined earlier in `messages`. It is no longer
3427 offered to the model from this point in the conversation onward.
3428
3429 - `BetaMCPToolListingBlockParam object`
3430
3431 The tool listing an MCP server returned while an earlier response was
3432 produced, as that response carried it. Send the assistant message back
3433 unchanged, this block included, and the server uses this listing for the
3434 matching `mcp_toolset` instead of asking the MCP server again.
3435
3436 - `type: "mcp_tool_listing"`
3437
3438 - `mcp_server_name: string`
3439
3440 The name of the MCP server this listing came from, as `mcp_servers` declares it.
3441
3442 maxLength: 255, minLength: 1
3443
3444 - `tools: array of BetaMCPToolParam`
3445
3446 The server's tools, exactly as the response listed them.
3447
3448 - `input_schema: map[unknown]`
3449
3450 The tool's input schema as the MCP server lists it, verbatim.
3451
3452 - `name: string`
3453
3454 The tool's name as the MCP server lists it (not prefixed with the server name).
3455
3456 minLength: 1
3457
3458 - `description: optional string or null`
3459
3460 The tool's description as the MCP server lists it.
13633461
13643462 - `BetaFallbackBlockParam object`
13653463
from line 3486
13883486 The model that will complete your prompt.
13893487
13903488 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
1391
1392 - `"claude-fable-5-1" or "claude-mythos-5-1" or "claude-sonnet-5" or 14 more`
1393
1394 The model that will complete your prompt.
1395
1396 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
1397
1398 - `"claude-fable-5-1"`
1399
1400 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows
1401
1402 - `"claude-mythos-5-1"`
1403
1404 Our most capable model for cybersecurity and biology research, available through trusted access programs
1405
1406 - `"claude-sonnet-5"`
1407
1408 High-performance model for coding and agents
1409
1410 - `"claude-fable-5"`
1411
1412 Next generation of intelligence for the hardest knowledge work and coding problems
1413
1414 - `"claude-mythos-5"`
1415
1416 Most capable model for cybersecurity and biology research
1417
1418 - `"claude-opus-5"`
1419
1420 Powerful intelligence for long-running agents and coding
1421
1422 - `"claude-opus-4-8"`
1423
1424 Powerful intelligence for long-running agents and coding
1425
1426 - `"claude-opus-4-7"`
1427
1428 Powerful intelligence for long-running agents and coding
1429
1430 - `"claude-mythos-preview"`
1431
1432 New class of intelligence, strongest in coding and cybersecurity
1433
1434 - `"claude-opus-4-6"`
1435
1436 Powerful intelligence for long-running agents and coding
1437
1438 - `"claude-sonnet-4-6"`
1439
1440 Best combination of speed and intelligence
1441
1442 - `"claude-haiku-4-5"`
1443
1444 Fastest model with near-frontier intelligence
1445
1446 - `"claude-haiku-4-5-20251001"`
1447
1448 Fastest model with near-frontier intelligence
1449
1450 - `"claude-opus-4-5"`
1451
1452 Powerful intelligence for long-running agents and coding
1453
1454 - `"claude-opus-4-5-20251101"`
1455
1456 Powerful intelligence for long-running agents and coding
1457
1458 - `"claude-sonnet-4-5"`
1459
1460 High-performance model for agents and coding
1461
1462 - `"claude-sonnet-4-5-20250929"`
1463
1464 High-performance model for agents and coding
1465
1466 - `string`
14673489
14683490 - `to: BetaFallbackInfoParam`
14693491
from line 3958
19363958
19373959 - `BetaTool object`
19383960
1939 - `type: optional "custom" or null`
1940
1941 - `input_schema: object`
1942
1943 [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.
1944
1945 This defines the shape of the `input` that your tool accepts and that the model will produce.
1946
1947 - `type: "object"`
1948
1949 - `properties: optional map[unknown] or null`
1950
1951 - `required: optional array of string or null`
1952
1953 - `name: string`
1954
1955 Name of the tool.
1956
1957 This is how the tool will be called by the model and in `tool_use` blocks.
1958
1959 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$
1960
1961 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
1962
1963 - `"direct"`
1964
1965 - `"code_execution_20250825"`
1966
1967 - `"code_execution_20260120"`
1968
1969 - `"code_execution_20260521"`
1970
1971 - `cache_control: optional BetaCacheControlEphemeral or null`
1972
1973 Create a cache control breakpoint at this content block.
1974
1975 - `defer_loading: optional boolean`
1976
1977 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
1978
1979 - `description: optional string`
1980
1981 Description of what this tool does.
1982
1983 Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.
1984
1985 - `eager_input_streaming: optional boolean or null`
1986
1987 Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers.
1988
1989 - `input_examples: optional array of map[unknown]`
1990
1991 - `strict: optional boolean`
1992
1993 When true, guarantees schema validation on tool names and inputs
1994
19953961 - `BetaToolBash20241022 object`
19963962
1997 - `type: "bash_20241022"`
1998
1999 - `name: "bash"`
2000
2001 Name of the tool.
2002
2003 This is how the tool will be called by the model and in `tool_use` blocks.
2004
2005 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2006
2007 - `"direct"`
2008
2009 - `"code_execution_20250825"`
2010
2011 - `"code_execution_20260120"`
2012
2013 - `"code_execution_20260521"`
2014
2015 - `cache_control: optional BetaCacheControlEphemeral or null`
2016
2017 Create a cache control breakpoint at this content block.
2018
2019 - `defer_loading: optional boolean`
2020
2021 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2022
2023 - `input_examples: optional array of map[unknown]`
2024
2025 - `strict: optional boolean`
2026
2027 When true, guarantees schema validation on tool names and inputs
2028
20293963 - `BetaToolBash20250124 object`
20303964
2031 - `type: "bash_20250124"`
2032
2033 - `name: "bash"`
2034
2035 Name of the tool.
2036
2037 This is how the tool will be called by the model and in `tool_use` blocks.
2038
2039 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2040
2041 - `"direct"`
2042
2043 - `"code_execution_20250825"`
2044
2045 - `"code_execution_20260120"`
2046
2047 - `"code_execution_20260521"`
2048
2049 - `cache_control: optional BetaCacheControlEphemeral or null`
2050
2051 Create a cache control breakpoint at this content block.
2052
2053 - `defer_loading: optional boolean`
2054
2055 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2056
2057 - `input_examples: optional array of map[unknown]`
2058
2059 - `strict: optional boolean`
2060
2061 When true, guarantees schema validation on tool names and inputs
2062
20633965 - `BetaCodeExecutionTool20250522 object`
20643966
2065 - `type: "code_execution_20250522"`
2066
2067 - `name: "code_execution"`
2068
2069 Name of the tool.
2070
2071 This is how the tool will be called by the model and in `tool_use` blocks.
2072
2073 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2074
2075 - `"direct"`
2076
2077 - `"code_execution_20250825"`
2078
2079 - `"code_execution_20260120"`
2080
2081 - `"code_execution_20260521"`
2082
2083 - `cache_control: optional BetaCacheControlEphemeral or null`
2084
2085 Create a cache control breakpoint at this content block.
2086
2087 - `defer_loading: optional boolean`
2088
2089 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2090
2091 - `strict: optional boolean`
2092
2093 When true, guarantees schema validation on tool names and inputs
2094
20953967 - `BetaCodeExecutionTool20250825 object`
20963968
2097 - `type: "code_execution_20250825"`
2098
2099 - `name: "code_execution"`
2100
2101 Name of the tool.
2102
2103 This is how the tool will be called by the model and in `tool_use` blocks.
2104
2105 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2106
2107 - `"direct"`
2108
2109 - `"code_execution_20250825"`
2110
2111 - `"code_execution_20260120"`
2112
2113 - `"code_execution_20260521"`
2114
2115 - `cache_control: optional BetaCacheControlEphemeral or null`
2116
2117 Create a cache control breakpoint at this content block.
2118
2119 - `defer_loading: optional boolean`
2120
2121 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2122
2123 - `strict: optional boolean`
2124
2125 When true, guarantees schema validation on tool names and inputs
2126
21273969 - `BetaCodeExecutionTool20260120 object`
21283970
21293971 Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
21303972
2131 - `type: "code_execution_20260120"`
2132
2133 - `name: "code_execution"`
2134
2135 Name of the tool.
2136
2137 This is how the tool will be called by the model and in `tool_use` blocks.
2138
2139 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2140
2141 - `"direct"`
2142
2143 - `"code_execution_20250825"`
2144
2145 - `"code_execution_20260120"`
2146
2147 - `"code_execution_20260521"`
2148
2149 - `cache_control: optional BetaCacheControlEphemeral or null`
2150
2151 Create a cache control breakpoint at this content block.
2152
2153 - `defer_loading: optional boolean`
2154
2155 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2156
2157 - `strict: optional boolean`
2158
2159 When true, guarantees schema validation on tool names and inputs
2160
21613973 - `BetaCodeExecutionTool20260521 object`
21623974
21633975 Code execution tool with REPL state persistence.
2164
2165 - `type: "code_execution_20260521"`
2166
2167 - `name: "code_execution"`
2168
2169 Name of the tool.
2170
2171 This is how the tool will be called by the model and in `tool_use` blocks.
2172
2173 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2174
2175 - `"direct"`
2176
2177 - `"code_execution_20250825"`
2178
2179 - `"code_execution_20260120"`
2180
2181 - `"code_execution_20260521"`
2182
2183 - `cache_control: optional BetaCacheControlEphemeral or null`
2184
2185 Create a cache control breakpoint at this content block.
2186
2187 - `defer_loading: optional boolean`
2188
2189 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2190
2191 - `strict: optional boolean`
2192
2193 When true, guarantees schema validation on tool names and inputs
21943976
21953977 - `BetaBrowserToolset20260801 object`
21963978
from line 3981
21993981 the family's tool with any members disabled via `configs` removed
22003982 from its schema.
22013983
2202 - `type: "browser_toolset_20260801"`
2203
2204 - `cache_control: optional BetaCacheControlEphemeral or null`
2205
2206 Create a cache control breakpoint at this content block.
2207
2208 - `configs: optional BetaBrowserToolsetConfigs or null`
2209
2210 Per-member configuration for `browser_toolset_20260801`: one
2211 optional field per member tool, keyed by the member name — the same
2212 name the member's `tool_use` blocks carry. Every member is an
2213 accepted key, and a member's defaults apply wherever its key is
2214 absent. Unknown keys are rejected: the field set is this toolset
2215 version's complete member set.
2216
2217 - `type: optional BetaBrowserTypeConfig or null`
2218
2219 `type`'s config overrides.
2220
2221 - `defer_loading: optional boolean or null`
2222
2223 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2224
2225 - `enabled: optional boolean or null`
2226
2227 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.
2228
2229 - `close_tab: optional BetaBrowserCloseTabConfig or null`
2230
2231 `close_tab`'s config overrides.
2232
2233 - `defer_loading: optional boolean or null`
2234
2235 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2236
2237 - `enabled: optional boolean or null`
2238
2239 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.
2240
2241 - `double_click: optional BetaBrowserDoubleClickConfig or null`
2242
2243 `double_click`'s config overrides.
2244
2245 - `defer_loading: optional boolean or null`
2246
2247 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2248
2249 - `enabled: optional boolean or null`
2250
2251 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.
2252
2253 - `file_upload: optional BetaBrowserFileUploadConfig or null`
2254
2255 `file_upload`'s config overrides.
2256
2257 - `defer_loading: optional boolean or null`
2258
2259 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2260
2261 - `enabled: optional boolean or null`
2262
2263 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.
2264
2265 - `find: optional BetaBrowserFindConfig or null`
2266
2267 `find`'s config overrides.
2268
2269 - `defer_loading: optional boolean or null`
2270
2271 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2272
2273 - `enabled: optional boolean or null`
2274
2275 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.
2276
2277 - `form_input: optional BetaBrowserFormInputConfig or null`
2278
2279 `form_input`'s config overrides.
2280
2281 - `defer_loading: optional boolean or null`
2282
2283 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2284
2285 - `enabled: optional boolean or null`
2286
2287 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.
2288
2289 - `get_page_text: optional BetaBrowserGetPageTextConfig or null`
2290
2291 `get_page_text`'s config overrides.
2292
2293 - `defer_loading: optional boolean or null`
2294
2295 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2296
2297 - `enabled: optional boolean or null`
2298
2299 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.
2300
2301 - `hold_key: optional BetaBrowserHoldKeyConfig or null`
2302
2303 `hold_key`'s config overrides.
2304
2305 - `defer_loading: optional boolean or null`
2306
2307 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2308
2309 - `enabled: optional boolean or null`
2310
2311 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.
2312
2313 - `hover: optional BetaBrowserHoverConfig or null`
2314
2315 `hover`'s config overrides.
2316
2317 - `defer_loading: optional boolean or null`
2318
2319 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2320
2321 - `enabled: optional boolean or null`
2322
2323 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.
2324
2325 - `javascript_exec: optional BetaBrowserJavascriptExecConfig or null`
2326
2327 `javascript_exec`'s config overrides.
2328
2329 - `defer_loading: optional boolean or null`
2330
2331 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2332
2333 - `enabled: optional boolean or null`
2334
2335 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.
2336
2337 - `key: optional BetaBrowserKeyConfig or null`
2338
2339 `key`'s config overrides.
2340
2341 - `defer_loading: optional boolean or null`
2342
2343 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2344
2345 - `enabled: optional boolean or null`
2346
2347 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.
2348
2349 - `left_click: optional BetaBrowserLeftClickConfig or null`
2350
2351 `left_click`'s config overrides.
2352
2353 - `defer_loading: optional boolean or null`
2354
2355 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2356
2357 - `enabled: optional boolean or null`
2358
2359 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.
2360
2361 - `left_click_drag: optional BetaBrowserLeftClickDragConfig or null`
2362
2363 `left_click_drag`'s config overrides.
2364
2365 - `defer_loading: optional boolean or null`
2366
2367 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2368
2369 - `enabled: optional boolean or null`
2370
2371 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.
2372
2373 - `left_mouse_down: optional BetaBrowserLeftMouseDownConfig or null`
2374
2375 `left_mouse_down`'s config overrides.
2376
2377 - `defer_loading: optional boolean or null`
2378
2379 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2380
2381 - `enabled: optional boolean or null`
2382
2383 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.
2384
2385 - `left_mouse_up: optional BetaBrowserLeftMouseUpConfig or null`
2386
2387 `left_mouse_up`'s config overrides.
2388
2389 - `defer_loading: optional boolean or null`
2390
2391 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2392
2393 - `enabled: optional boolean or null`
2394
2395 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.
2396
2397 - `list_tabs: optional BetaBrowserListTabsConfig or null`
2398
2399 `list_tabs`'s config overrides.
2400
2401 - `defer_loading: optional boolean or null`
2402
2403 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2404
2405 - `enabled: optional boolean or null`
2406
2407 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.
2408
2409 - `middle_click: optional BetaBrowserMiddleClickConfig or null`
2410
2411 `middle_click`'s config overrides.
2412
2413 - `defer_loading: optional boolean or null`
2414
2415 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2416
2417 - `enabled: optional boolean or null`
2418
2419 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.
2420
2421 - `mouse_move: optional BetaBrowserMouseMoveConfig or null`
2422
2423 `mouse_move`'s config overrides.
2424
2425 - `defer_loading: optional boolean or null`
2426
2427 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2428
2429 - `enabled: optional boolean or null`
2430
2431 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.
2432
2433 - `navigate: optional BetaBrowserNavigateConfig or null`
2434
2435 `navigate`'s config overrides.
2436
2437 - `defer_loading: optional boolean or null`
2438
2439 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2440
2441 - `enabled: optional boolean or null`
2442
2443 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.
2444
2445 - `new_tab: optional BetaBrowserNewTabConfig or null`
2446
2447 `new_tab`'s config overrides.
2448
2449 - `defer_loading: optional boolean or null`
2450
2451 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2452
2453 - `enabled: optional boolean or null`
2454
2455 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.
2456
2457 - `read_console: optional BetaBrowserReadConsoleConfig or null`
2458
2459 `read_console`'s config overrides.
2460
2461 - `defer_loading: optional boolean or null`
2462
2463 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2464
2465 - `enabled: optional boolean or null`
2466
2467 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.
2468
2469 - `read_network: optional BetaBrowserReadNetworkConfig or null`
2470
2471 `read_network`'s config overrides.
2472
2473 - `defer_loading: optional boolean or null`
2474
2475 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2476
2477 - `enabled: optional boolean or null`
2478
2479 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.
2480
2481 - `read_page: optional BetaBrowserReadPageConfig or null`
2482
2483 `read_page`'s config overrides.
2484
2485 - `defer_loading: optional boolean or null`
2486
2487 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2488
2489 - `enabled: optional boolean or null`
2490
2491 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.
2492
2493 - `right_click: optional BetaBrowserRightClickConfig or null`
2494
2495 `right_click`'s config overrides.
2496
2497 - `defer_loading: optional boolean or null`
2498
2499 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2500
2501 - `enabled: optional boolean or null`
2502
2503 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.
2504
2505 - `screenshot: optional BetaBrowserScreenshotConfig or null`
2506
2507 `screenshot`'s config overrides.
2508
2509 - `defer_loading: optional boolean or null`
2510
2511 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2512
2513 - `enabled: optional boolean or null`
2514
2515 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.
2516
2517 - `scroll: optional BetaBrowserScrollConfig or null`
2518
2519 `scroll`'s config overrides.
2520
2521 - `defer_loading: optional boolean or null`
2522
2523 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2524
2525 - `enabled: optional boolean or null`
2526
2527 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.
2528
2529 - `scroll_to: optional BetaBrowserScrollToConfig or null`
2530
2531 `scroll_to`'s config overrides.
2532
2533 - `defer_loading: optional boolean or null`
2534
2535 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2536
2537 - `enabled: optional boolean or null`
2538
2539 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.
2540
2541 - `switch_tab: optional BetaBrowserSwitchTabConfig or null`
2542
2543 `switch_tab`'s config overrides.
2544
2545 - `defer_loading: optional boolean or null`
2546
2547 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2548
2549 - `enabled: optional boolean or null`
2550
2551 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.
2552
2553 - `triple_click: optional BetaBrowserTripleClickConfig or null`
2554
2555 `triple_click`'s config overrides.
2556
2557 - `defer_loading: optional boolean or null`
2558
2559 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2560
2561 - `enabled: optional boolean or null`
2562
2563 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.
2564
2565 - `wait: optional BetaBrowserWaitConfig or null`
2566
2567 `wait`'s config overrides.
2568
2569 - `defer_loading: optional boolean or null`
2570
2571 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2572
2573 - `enabled: optional boolean or null`
2574
2575 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.
2576
2577 - `zoom: optional BetaBrowserZoomConfig or null`
2578
2579 `zoom`'s config overrides.
2580
2581 - `defer_loading: optional boolean or null`
2582
2583 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2584
2585 - `enabled: optional boolean or null`
2586
2587 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.
2588
25893984 - `BetaToolComputerUse20241022 object`
25903985
2591 - `type: "computer_20241022"`
2592
2593 - `display_height_px: number`
2594
2595 The height of the display in pixels.
2596
2597 minimum: 1
2598
2599 - `display_width_px: number`
2600
2601 The width of the display in pixels.
2602
2603 minimum: 1
2604
2605 - `name: "computer"`
2606
2607 Name of the tool.
2608
2609 This is how the tool will be called by the model and in `tool_use` blocks.
2610
2611 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2612
2613 - `"direct"`
2614
2615 - `"code_execution_20250825"`
2616
2617 - `"code_execution_20260120"`
2618
2619 - `"code_execution_20260521"`
2620
2621 - `cache_control: optional BetaCacheControlEphemeral or null`
2622
2623 Create a cache control breakpoint at this content block.
2624
2625 - `defer_loading: optional boolean`
2626
2627 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2628
2629 - `display_number: optional number or null`
2630
2631 The X11 display number (e.g. 0, 1) for the display.
2632
2633 minimum: 0
2634
2635 - `input_examples: optional array of map[unknown]`
2636
2637 - `strict: optional boolean`
2638
2639 When true, guarantees schema validation on tool names and inputs
2640
26413986 - `BetaMemoryTool20250818 object`
26423987
2643 - `type: "memory_20250818"`
2644
2645 - `name: "memory"`
2646
2647 Name of the tool.
2648
2649 This is how the tool will be called by the model and in `tool_use` blocks.
2650
2651 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2652
2653 - `"direct"`
2654
2655 - `"code_execution_20250825"`
2656
2657 - `"code_execution_20260120"`
2658
2659 - `"code_execution_20260521"`
2660
2661 - `cache_control: optional BetaCacheControlEphemeral or null`
2662
2663 Create a cache control breakpoint at this content block.
2664
2665 - `defer_loading: optional boolean`
2666
2667 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2668
2669 - `input_examples: optional array of map[unknown]`
2670
2671 - `strict: optional boolean`
2672
2673 When true, guarantees schema validation on tool names and inputs
2674
26753988 - `BetaToolComputerUse20250124 object`
26763989
2677 - `type: "computer_20250124"`
2678
2679 - `display_height_px: number`
2680
2681 The height of the display in pixels.
2682
2683 minimum: 1
2684
2685 - `display_width_px: number`
2686
2687 The width of the display in pixels.
2688
2689 minimum: 1
2690
2691 - `name: "computer"`
2692
2693 Name of the tool.
2694
2695 This is how the tool will be called by the model and in `tool_use` blocks.
2696
2697 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2698
2699 - `"direct"`
2700
2701 - `"code_execution_20250825"`
2702
2703 - `"code_execution_20260120"`
2704
2705 - `"code_execution_20260521"`
2706
2707 - `cache_control: optional BetaCacheControlEphemeral or null`
2708
2709 Create a cache control breakpoint at this content block.
2710
2711 - `defer_loading: optional boolean`
2712
2713 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2714
2715 - `display_number: optional number or null`
2716
2717 The X11 display number (e.g. 0, 1) for the display.
2718
2719 minimum: 0
2720
2721 - `input_examples: optional array of map[unknown]`
2722
2723 - `strict: optional boolean`
2724
2725 When true, guarantees schema validation on tool names and inputs
2726
27273990 - `BetaToolTextEditor20241022 object`
27283991
2729 - `type: "text_editor_20241022"`
2730
2731 - `name: "str_replace_editor"`
2732
2733 Name of the tool.
2734
2735 This is how the tool will be called by the model and in `tool_use` blocks.
2736
2737 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2738
2739 - `"direct"`
2740
2741 - `"code_execution_20250825"`
2742
2743 - `"code_execution_20260120"`
2744
2745 - `"code_execution_20260521"`
2746
2747 - `cache_control: optional BetaCacheControlEphemeral or null`
2748
2749 Create a cache control breakpoint at this content block.
2750
2751 - `defer_loading: optional boolean`
2752
2753 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2754
2755 - `input_examples: optional array of map[unknown]`
2756
2757 - `strict: optional boolean`
2758
2759 When true, guarantees schema validation on tool names and inputs
2760
27613992 - `BetaToolComputerUse20251124 object`
2762
2763 - `type: "computer_20251124"`
2764
2765 - `display_height_px: number`
2766
2767 The height of the display in pixels.
2768
2769 minimum: 1
2770
2771 - `display_width_px: number`
2772
2773 The width of the display in pixels.
2774
2775 minimum: 1
2776
2777 - `name: "computer"`
2778
2779 Name of the tool.
2780
2781 This is how the tool will be called by the model and in `tool_use` blocks.
2782
2783 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
2784
2785 - `"direct"`
2786
2787 - `"code_execution_20250825"`
2788
2789 - `"code_execution_20260120"`
2790
2791 - `"code_execution_20260521"`
2792
2793 - `cache_control: optional BetaCacheControlEphemeral or null`
2794
2795 Create a cache control breakpoint at this content block.
2796
2797 - `defer_loading: optional boolean`
2798
2799 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
2800
2801 - `display_number: optional number or null`
2802
2803 The X11 display number (e.g. 0, 1) for the display.
2804
2805 minimum: 0
2806
2807 - `enable_zoom: optional boolean`
2808
2809 Whether to enable an action to take a zoomed-in screenshot of the screen.
2810
2811 - `input_examples: optional array of map[unknown]`
2812
2813 - `strict: optional boolean`
2814
2815 When true, guarantees schema validation on tool names and inputs
28163993
28173994 - `BetaComputerToolset20260801 object`
28183995
from line 4002
28254002 `type`, `configs`, and `cache_control`; zoom is controlled
28264003 via `configs.zoom.enabled`.
28274004
2828 - `type: "computer_toolset_20260801"`
2829
2830 - `cache_control: optional BetaCacheControlEphemeral or null`
2831
2832 Create a cache control breakpoint at this content block.
2833
2834 - `configs: optional BetaComputerToolsetConfigs or null`
2835
2836 Per-member configuration for `computer_toolset_20260801`: one
2837 optional field per member tool, keyed by the member name — the same
2838 name the member's `tool_use` blocks carry. Every member is an
2839 accepted key, and a member's defaults apply wherever its key is
2840 absent. Unknown keys are rejected: the field set is this toolset
2841 version's complete member set.
2842
2843 - `type: optional BetaComputerTypeConfig or null`
2844
2845 `type`'s config overrides.
2846
2847 - `defer_loading: optional boolean or null`
2848
2849 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2850
2851 - `enabled: optional boolean or null`
2852
2853 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.
2854
2855 - `cursor_position: optional BetaComputerCursorPositionConfig or null`
2856
2857 `cursor_position`'s config overrides.
2858
2859 - `defer_loading: optional boolean or null`
2860
2861 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2862
2863 - `enabled: optional boolean or null`
2864
2865 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.
2866
2867 - `double_click: optional BetaComputerDoubleClickConfig or null`
2868
2869 `double_click`'s config overrides.
2870
2871 - `defer_loading: optional boolean or null`
2872
2873 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2874
2875 - `enabled: optional boolean or null`
2876
2877 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.
2878
2879 - `hold_key: optional BetaComputerHoldKeyConfig or null`
2880
2881 `hold_key`'s config overrides.
2882
2883 - `defer_loading: optional boolean or null`
2884
2885 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2886
2887 - `enabled: optional boolean or null`
2888
2889 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.
2890
2891 - `key: optional BetaComputerKeyConfig or null`
2892
2893 `key`'s config overrides.
2894
2895 - `defer_loading: optional boolean or null`
2896
2897 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2898
2899 - `enabled: optional boolean or null`
2900
2901 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.
2902
2903 - `left_click: optional BetaComputerLeftClickConfig or null`
2904
2905 `left_click`'s config overrides.
2906
2907 - `defer_loading: optional boolean or null`
2908
2909 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2910
2911 - `enabled: optional boolean or null`
2912
2913 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.
2914
2915 - `left_click_drag: optional BetaComputerLeftClickDragConfig or null`
2916
2917 `left_click_drag`'s config overrides.
2918
2919 - `defer_loading: optional boolean or null`
2920
2921 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2922
2923 - `enabled: optional boolean or null`
2924
2925 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.
2926
2927 - `left_mouse_down: optional BetaComputerLeftMouseDownConfig or null`
2928
2929 `left_mouse_down`'s config overrides.
2930
2931 - `defer_loading: optional boolean or null`
2932
2933 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2934
2935 - `enabled: optional boolean or null`
2936
2937 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.
2938
2939 - `left_mouse_up: optional BetaComputerLeftMouseUpConfig or null`
2940
2941 `left_mouse_up`'s config overrides.
2942
2943 - `defer_loading: optional boolean or null`
2944
2945 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2946
2947 - `enabled: optional boolean or null`
2948
2949 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.
2950
2951 - `middle_click: optional BetaComputerMiddleClickConfig or null`
2952
2953 `middle_click`'s config overrides.
2954
2955 - `defer_loading: optional boolean or null`
2956
2957 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2958
2959 - `enabled: optional boolean or null`
2960
2961 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.
2962
2963 - `mouse_move: optional BetaComputerMouseMoveConfig or null`
2964
2965 `mouse_move`'s config overrides.
2966
2967 - `defer_loading: optional boolean or null`
2968
2969 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2970
2971 - `enabled: optional boolean or null`
2972
2973 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.
2974
2975 - `right_click: optional BetaComputerRightClickConfig or null`
2976
2977 `right_click`'s config overrides.
2978
2979 - `defer_loading: optional boolean or null`
2980
2981 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2982
2983 - `enabled: optional boolean or null`
2984
2985 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.
2986
2987 - `screenshot: optional BetaComputerScreenshotConfig or null`
2988
2989 `screenshot`'s config overrides.
2990
2991 - `defer_loading: optional boolean or null`
2992
2993 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2994
2995 - `enabled: optional boolean or null`
2996
2997 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.
2998
2999 - `scroll: optional BetaComputerScrollConfig or null`
3000
3001 `scroll`'s config overrides.
3002
3003 - `defer_loading: optional boolean or null`
3004
3005 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3006
3007 - `enabled: optional boolean or null`
3008
3009 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.
3010
3011 - `triple_click: optional BetaComputerTripleClickConfig or null`
3012
3013 `triple_click`'s config overrides.
3014
3015 - `defer_loading: optional boolean or null`
3016
3017 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3018
3019 - `enabled: optional boolean or null`
3020
3021 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.
3022
3023 - `wait: optional BetaComputerWaitConfig or null`
3024
3025 `wait`'s config overrides.
3026
3027 - `defer_loading: optional boolean or null`
3028
3029 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3030
3031 - `enabled: optional boolean or null`
3032
3033 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.
3034
3035 - `zoom: optional BetaComputerZoomConfig or null`
3036
3037 `zoom`'s config overrides.
3038
3039 - `defer_loading: optional boolean or null`
3040
3041 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
3042
3043 - `enabled: optional boolean or null`
3044
3045 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.
3046
30474005 - `BetaToolTextEditor20250124 object`
30484006
3049 - `type: "text_editor_20250124"`
3050
3051 - `name: "str_replace_editor"`
3052
3053 Name of the tool.
3054
3055 This is how the tool will be called by the model and in `tool_use` blocks.
3056
3057 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3058
3059 - `"direct"`
3060
3061 - `"code_execution_20250825"`
3062
3063 - `"code_execution_20260120"`
3064
3065 - `"code_execution_20260521"`
3066
3067 - `cache_control: optional BetaCacheControlEphemeral or null`
3068
3069 Create a cache control breakpoint at this content block.
3070
3071 - `defer_loading: optional boolean`
3072
3073 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3074
3075 - `input_examples: optional array of map[unknown]`
3076
3077 - `strict: optional boolean`
3078
3079 When true, guarantees schema validation on tool names and inputs
3080
30814007 - `BetaToolTextEditor20250429 object`
30824008
3083 - `type: "text_editor_20250429"`
3084
3085 - `name: "str_replace_based_edit_tool"`
3086
3087 Name of the tool.
3088
3089 This is how the tool will be called by the model and in `tool_use` blocks.
3090
3091 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3092
3093 - `"direct"`
3094
3095 - `"code_execution_20250825"`
3096
3097 - `"code_execution_20260120"`
3098
3099 - `"code_execution_20260521"`
3100
3101 - `cache_control: optional BetaCacheControlEphemeral or null`
3102
3103 Create a cache control breakpoint at this content block.
3104
3105 - `defer_loading: optional boolean`
3106
3107 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3108
3109 - `input_examples: optional array of map[unknown]`
3110
3111 - `strict: optional boolean`
3112
3113 When true, guarantees schema validation on tool names and inputs
3114
31154009 - `BetaToolTextEditor20250728 object`
31164010
3117 - `type: "text_editor_20250728"`
3118
3119 - `name: "str_replace_based_edit_tool"`
3120
3121 Name of the tool.
3122
3123 This is how the tool will be called by the model and in `tool_use` blocks.
3124
3125 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3126
3127 - `"direct"`
3128
3129 - `"code_execution_20250825"`
3130
3131 - `"code_execution_20260120"`
3132
3133 - `"code_execution_20260521"`
3134
3135 - `cache_control: optional BetaCacheControlEphemeral or null`
3136
3137 Create a cache control breakpoint at this content block.
3138
3139 - `defer_loading: optional boolean`
3140
3141 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3142
3143 - `input_examples: optional array of map[unknown]`
3144
3145 - `max_characters: optional number or null`
3146
3147 Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
3148
3149 minimum: 1
3150
3151 - `strict: optional boolean`
3152
3153 When true, guarantees schema validation on tool names and inputs
3154
31554011 - `BetaWebSearchTool20250305 object`
31564012
3157 - `type: "web_search_20250305"`
3158
3159 - `name: "web_search"`
3160
3161 Name of the tool.
3162
3163 This is how the tool will be called by the model and in `tool_use` blocks.
3164
3165 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3166
3167 - `"direct"`
3168
3169 - `"code_execution_20250825"`
3170
3171 - `"code_execution_20260120"`
3172
3173 - `"code_execution_20260521"`
3174
3175 - `allowed_domains: optional array of string or null`
3176
3177 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.
3178
3179 - `blocked_domains: optional array of string or null`
3180
3181 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.
3182
3183 - `cache_control: optional BetaCacheControlEphemeral or null`
3184
3185 Create a cache control breakpoint at this content block.
3186
3187 - `defer_loading: optional boolean`
3188
3189 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3190
3191 - `max_uses: optional number or null`
3192
3193 Maximum number of times the tool can be used in the API request.
3194
3195 exclusiveMinimum: 0
3196
3197 - `strict: optional boolean`
3198
3199 When true, guarantees schema validation on tool names and inputs
3200
3201 - `user_location: optional BetaUserLocation or null`
3202
3203 Parameters for the user's location. Used to provide more relevant search results.
3204
3205 - `type: "approximate"`
3206
3207 - `city: optional string or null`
3208
3209 The city of the user.
3210
3211 maxLength: 255, minLength: 1
3212
3213 - `country: optional string or null`
3214
3215 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.
3216
3217 maxLength: 2, minLength: 2
3218
3219 - `region: optional string or null`
3220
3221 The region of the user.
3222
3223 maxLength: 255, minLength: 1
3224
3225 - `timezone: optional string or null`
3226
3227 The [IANA timezone](https://nodatime.org/TimeZones) of the user.
3228
3229 maxLength: 255, minLength: 1
3230
32314013 - `BetaWebFetchTool20250910 object`
32324014
3233 - `type: "web_fetch_20250910"`
3234
3235 - `name: "web_fetch"`
3236
3237 Name of the tool.
3238
3239 This is how the tool will be called by the model and in `tool_use` blocks.
3240
3241 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3242
3243 - `"direct"`
3244
3245 - `"code_execution_20250825"`
3246
3247 - `"code_execution_20260120"`
3248
3249 - `"code_execution_20260521"`
3250
3251 - `allowed_domains: optional array of string or null`
3252
3253 List of domains to allow fetching from
3254
3255 - `blocked_domains: optional array of string or null`
3256
3257 List of domains to block fetching from
3258
3259 - `cache_control: optional BetaCacheControlEphemeral or null`
3260
3261 Create a cache control breakpoint at this content block.
3262
3263 - `citations: optional BetaCitationsConfigParam or null`
3264
3265 Citations configuration for fetched documents. Citations are disabled by default.
3266
3267 - `defer_loading: optional boolean`
3268
3269 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3270
3271 - `max_content_tokens: optional number or null`
3272
3273 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
3274
3275 exclusiveMinimum: 0
3276
3277 - `max_uses: optional number or null`
3278
3279 Maximum number of times the tool can be used in the API request.
3280
3281 exclusiveMinimum: 0
3282
3283 - `strict: optional boolean`
3284
3285 When true, guarantees schema validation on tool names and inputs
3286
3287 - `url_sources: optional BetaWebFetchURLSources or null`
3288
3289 Which sources contribute to the set of URLs web fetch may fetch.
3290
3291 Each key is a tagged variant: `user_input` is `all` or `none`; the
3292 two tool filters are `all`, `none`, `only` (only the named tools'
3293 results) or `except` (every result but the named tools'). A named tool
3294 must be declared in this request's `tools[]`.
3295
3296 - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`
3297
3298 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].
3299
3300 - `BetaWebFetchURLSourceAll object`
3301
3302 The `url_sources` variant under which a source contributes in
3303 full: every result of the tool filter's source, or all user input.
3304
3305 - `type: "all"`
3306
3307 - `BetaWebFetchURLSourceNone object`
3308
3309 The `url_sources` variant under which a source contributes nothing:
3310 no result of the tool filter's source, or no user input.
3311
3312 - `type: "none"`
3313
3314 - `BetaWebFetchURLSourceOnly object`
3315
3316 The tool filter variant under which only the named tools' results
3317 contribute.
3318
3319 - `type: "only"`
3320
3321 - `tools: array of BetaWebFetchURLSourceToolReference`
3322
3323 - `type: "tool_reference"`
3324
3325 - `name: string`
3326
3327 - `BetaWebFetchURLSourceExcept object`
3328
3329 The tool filter variant under which every result but the named
3330 tools' contributes.
3331
3332 - `type: "except"`
3333
3334 - `tools: array of BetaWebFetchURLSourceToolReference`
3335
3336 - `type: "tool_reference"`
3337
3338 - `name: string`
3339
3340 - `server_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`
3341
3342 Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute.
3343
3344 - `BetaWebFetchURLSourceAll object`
3345
3346 The `url_sources` variant under which a source contributes in
3347 full: every result of the tool filter's source, or all user input.
3348
3349 - `BetaWebFetchURLSourceNone object`
3350
3351 The `url_sources` variant under which a source contributes nothing:
3352 no result of the tool filter's source, or no user input.
3353
3354 - `BetaWebFetchURLSourceOnly object`
3355
3356 The tool filter variant under which only the named tools' results
3357 contribute.
3358
3359 - `BetaWebFetchURLSourceExcept object`
3360
3361 The tool filter variant under which every result but the named
3362 tools' contributes.
3363
3364 - `user_input: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone`
3365
3366 Whether URLs in user messages are fetchable: "all" or "none".
3367
3368 - `BetaWebFetchURLSourceAll object`
3369
3370 The `url_sources` variant under which a source contributes in
3371 full: every result of the tool filter's source, or all user input.
3372
3373 - `BetaWebFetchURLSourceNone object`
3374
3375 The `url_sources` variant under which a source contributes nothing:
3376 no result of the tool filter's source, or no user input.
3377
33784015 - `BetaWebSearchTool20260209 object`
33794016
3380 - `type: "web_search_20260209"`
3381
3382 - `name: "web_search"`
3383
3384 Name of the tool.
3385
3386 This is how the tool will be called by the model and in `tool_use` blocks.
3387
3388 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3389
3390 - `"direct"`
3391
3392 - `"code_execution_20250825"`
3393
3394 - `"code_execution_20260120"`
3395
3396 - `"code_execution_20260521"`
3397
3398 - `allowed_domains: optional array of string or null`
3399
3400 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.
3401
3402 - `blocked_domains: optional array of string or null`
3403
3404 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.
3405
3406 - `cache_control: optional BetaCacheControlEphemeral or null`
3407
3408 Create a cache control breakpoint at this content block.
3409
3410 - `defer_loading: optional boolean`
3411
3412 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3413
3414 - `max_uses: optional number or null`
3415
3416 Maximum number of times the tool can be used in the API request.
3417
3418 exclusiveMinimum: 0
3419
3420 - `strict: optional boolean`
3421
3422 When true, guarantees schema validation on tool names and inputs
3423
3424 - `user_location: optional BetaUserLocation or null`
3425
3426 Parameters for the user's location. Used to provide more relevant search results.
3427
34284017 - `BetaWebFetchTool20260209 object`
34294018
3430 - `type: "web_fetch_20260209"`
3431
3432 - `name: "web_fetch"`
3433
3434 Name of the tool.
3435
3436 This is how the tool will be called by the model and in `tool_use` blocks.
3437
3438 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3439
3440 - `"direct"`
3441
3442 - `"code_execution_20250825"`
3443
3444 - `"code_execution_20260120"`
3445
3446 - `"code_execution_20260521"`
3447
3448 - `allowed_domains: optional array of string or null`
3449
3450 List of domains to allow fetching from
3451
3452 - `blocked_domains: optional array of string or null`
3453
3454 List of domains to block fetching from
3455
3456 - `cache_control: optional BetaCacheControlEphemeral or null`
3457
3458 Create a cache control breakpoint at this content block.
3459
3460 - `citations: optional BetaCitationsConfigParam or null`
3461
3462 Citations configuration for fetched documents. Citations are disabled by default.
3463
3464 - `defer_loading: optional boolean`
3465
3466 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3467
3468 - `max_content_tokens: optional number or null`
3469
3470 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
3471
3472 exclusiveMinimum: 0
3473
3474 - `max_uses: optional number or null`
3475
3476 Maximum number of times the tool can be used in the API request.
3477
3478 exclusiveMinimum: 0
3479
3480 - `strict: optional boolean`
3481
3482 When true, guarantees schema validation on tool names and inputs
3483
3484 - `url_sources: optional BetaWebFetchURLSources or null`
3485
3486 Which sources contribute to the set of URLs web fetch may fetch.
3487
3488 Each key is a tagged variant: `user_input` is `all` or `none`; the
3489 two tool filters are `all`, `none`, `only` (only the named tools'
3490 results) or `except` (every result but the named tools'). A named tool
3491 must be declared in this request's `tools[]`.
3492
34934019 - `BetaWebFetchTool20260309 object`
34944020
34954021 Web fetch tool with use_cache parameter for bypassing cached content.
34964022
3497 - `type: "web_fetch_20260309"`
3498
3499 - `name: "web_fetch"`
3500
3501 Name of the tool.
3502
3503 This is how the tool will be called by the model and in `tool_use` blocks.
3504
3505 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3506
3507 - `"direct"`
3508
3509 - `"code_execution_20250825"`
3510
3511 - `"code_execution_20260120"`
3512
3513 - `"code_execution_20260521"`
3514
3515 - `allowed_domains: optional array of string or null`
3516
3517 List of domains to allow fetching from
3518
3519 - `blocked_domains: optional array of string or null`
3520
3521 List of domains to block fetching from
3522
3523 - `cache_control: optional BetaCacheControlEphemeral or null`
3524
3525 Create a cache control breakpoint at this content block.
3526
3527 - `citations: optional BetaCitationsConfigParam or null`
3528
3529 Citations configuration for fetched documents. Citations are disabled by default.
3530
3531 - `defer_loading: optional boolean`
3532
3533 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3534
3535 - `max_content_tokens: optional number or null`
3536
3537 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
3538
3539 exclusiveMinimum: 0
3540
3541 - `max_uses: optional number or null`
3542
3543 Maximum number of times the tool can be used in the API request.
3544
3545 exclusiveMinimum: 0
3546
3547 - `strict: optional boolean`
3548
3549 When true, guarantees schema validation on tool names and inputs
3550
3551 - `url_sources: optional BetaWebFetchURLSources or null`
3552
3553 Which sources contribute to the set of URLs web fetch may fetch.
3554
3555 Each key is a tagged variant: `user_input` is `all` or `none`; the
3556 two tool filters are `all`, `none`, `only` (only the named tools'
3557 results) or `except` (every result but the named tools'). A named tool
3558 must be declared in this request's `tools[]`.
3559
3560 - `use_cache: optional boolean`
3561
3562 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
3563
35644023 - `BetaWebSearchTool20260318 object`
35654024
3566 - `type: "web_search_20260318"`
3567
3568 - `name: "web_search"`
3569
3570 Name of the tool.
3571
3572 This is how the tool will be called by the model and in `tool_use` blocks.
3573
3574 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3575
3576 - `"direct"`
3577
3578 - `"code_execution_20250825"`
3579
3580 - `"code_execution_20260120"`
3581
3582 - `"code_execution_20260521"`
3583
3584 - `allowed_domains: optional array of string or null`
3585
3586 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.
3587
3588 - `blocked_domains: optional array of string or null`
3589
3590 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.
3591
3592 - `cache_control: optional BetaCacheControlEphemeral or null`
3593
3594 Create a cache control breakpoint at this content block.
3595
3596 - `defer_loading: optional boolean`
3597
3598 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3599
3600 - `max_uses: optional number or null`
3601
3602 Maximum number of times the tool can be used in the API request.
3603
3604 exclusiveMinimum: 0
3605
3606 - `response_inclusion: optional "full" or "excluded"`
3607
3608 How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn.
3609
3610 - `"full"`
3611
3612 - `"excluded"`
3613
3614 - `strict: optional boolean`
3615
3616 When true, guarantees schema validation on tool names and inputs
3617
3618 - `user_location: optional BetaUserLocation or null`
3619
3620 Parameters for the user's location. Used to provide more relevant search results.
3621
36224025 - `BetaWebFetchTool20260318 object`
36234026
3624 - `type: "web_fetch_20260318"`
3625
3626 - `name: "web_fetch"`
3627
3628 Name of the tool.
3629
3630 This is how the tool will be called by the model and in `tool_use` blocks.
3631
3632 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3633
3634 - `"direct"`
3635
3636 - `"code_execution_20250825"`
3637
3638 - `"code_execution_20260120"`
3639
3640 - `"code_execution_20260521"`
3641
3642 - `allowed_domains: optional array of string or null`
3643
3644 List of domains to allow fetching from
3645
3646 - `blocked_domains: optional array of string or null`
3647
3648 List of domains to block fetching from
3649
3650 - `cache_control: optional BetaCacheControlEphemeral or null`
3651
3652 Create a cache control breakpoint at this content block.
3653
3654 - `citations: optional BetaCitationsConfigParam or null`
3655
3656 Citations configuration for fetched documents. Citations are disabled by default.
3657
3658 - `defer_loading: optional boolean`
3659
3660 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3661
3662 - `max_content_tokens: optional number or null`
3663
3664 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
3665
3666 exclusiveMinimum: 0
3667
3668 - `max_uses: optional number or null`
3669
3670 Maximum number of times the tool can be used in the API request.
3671
3672 exclusiveMinimum: 0
3673
3674 - `response_inclusion: optional "full" or "excluded"`
3675
3676 How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn.
3677
3678 - `"full"`
3679
3680 - `"excluded"`
3681
3682 - `strict: optional boolean`
3683
3684 When true, guarantees schema validation on tool names and inputs
3685
3686 - `url_sources: optional BetaWebFetchURLSources or null`
3687
3688 Which sources contribute to the set of URLs web fetch may fetch.
3689
3690 Each key is a tagged variant: `user_input` is `all` or `none`; the
3691 two tool filters are `all`, `none`, `only` (only the named tools'
3692 results) or `except` (every result but the named tools'). A named tool
3693 must be declared in this request's `tools[]`.
3694
3695 - `use_cache: optional boolean`
3696
3697 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
3698
36994027 - `BetaAdvisorTool20260301 object`
37004028
3701 - `type: "advisor_20260301"`
3702
3703 - `model: Model`
3704
3705 The model that will complete your prompt.
3706
3707 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
3708
3709 - `name: "advisor"`
3710
3711 Name of the tool.
3712
3713 This is how the tool will be called by the model and in `tool_use` blocks.
3714
3715 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3716
3717 - `"direct"`
3718
3719 - `"code_execution_20250825"`
3720
3721 - `"code_execution_20260120"`
3722
3723 - `"code_execution_20260521"`
3724
3725 - `cache_control: optional BetaCacheControlEphemeral or null`
3726
3727 Create a cache control breakpoint at this content block.
3728
3729 - `caching: optional BetaCacheControlEphemeral or null`
3730
3731 Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.
3732
3733 - `defer_loading: optional boolean`
3734
3735 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3736
3737 - `max_tokens: optional number or null`
3738
3739 Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.
3740
3741 minimum: 1024
3742
3743 - `max_uses: optional number or null`
3744
3745 Maximum number of times the tool can be used in the API request.
3746
3747 exclusiveMinimum: 0
3748
3749 - `strict: optional boolean`
3750
3751 When true, guarantees schema validation on tool names and inputs
3752
37534029 - `BetaToolSearchToolBm25_20251119 object`
37544030
3755 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`
3756
3757 - `"tool_search_tool_bm25_20251119"`
3758
3759 - `"tool_search_tool_bm25"`
3760
3761 - `name: "tool_search_tool_bm25"`
3762
3763 Name of the tool.
3764
3765 This is how the tool will be called by the model and in `tool_use` blocks.
3766
3767 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3768
3769 - `"direct"`
3770
3771 - `"code_execution_20250825"`
3772
3773 - `"code_execution_20260120"`
3774
3775 - `"code_execution_20260521"`
3776
3777 - `cache_control: optional BetaCacheControlEphemeral or null`
3778
3779 Create a cache control breakpoint at this content block.
3780
3781 - `defer_loading: optional boolean`
3782
3783 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3784
3785 - `strict: optional boolean`
3786
3787 When true, guarantees schema validation on tool names and inputs
3788
37894031 - `BetaToolSearchToolRegex20251119 object`
3790
3791 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`
3792
3793 - `"tool_search_tool_regex_20251119"`
3794
3795 - `"tool_search_tool_regex"`
3796
3797 - `name: "tool_search_tool_regex"`
3798
3799 Name of the tool.
3800
3801 This is how the tool will be called by the model and in `tool_use` blocks.
3802
3803 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
3804
3805 - `"direct"`
3806
3807 - `"code_execution_20250825"`
3808
3809 - `"code_execution_20260120"`
3810
3811 - `"code_execution_20260521"`
3812
3813 - `cache_control: optional BetaCacheControlEphemeral or null`
3814
3815 Create a cache control breakpoint at this content block.
3816
3817 - `defer_loading: optional boolean`
3818
3819 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
3820
3821 - `strict: optional boolean`
3822
3823 When true, guarantees schema validation on tool names and inputs
38244032
38254033 - `BetaMCPToolset object`
38264034
from line 4036
38284036
38294037 Allows configuring enabled status and defer_loading for all tools
38304038 from an MCP server, with optional per-tool overrides.
3831
3832 - `type: "mcp_toolset"`
3833
3834 - `mcp_server_name: string`
3835
3836 Name of the MCP server to configure tools for
3837
3838 maxLength: 255, minLength: 1
3839
3840 - `cache_control: optional BetaCacheControlEphemeral or null`
3841
3842 Create a cache control breakpoint at this content block.
3843
3844 - `configs: optional map[BetaMCPToolConfig] or null`
3845
3846 Configuration overrides for specific tools, keyed by tool name
3847
3848 - `defer_loading: optional boolean`
3849
3850 - `enabled: optional boolean`
3851
3852 - `default_config: optional BetaMCPToolDefaultConfig`
3853
3854 Default configuration applied to all tools from this server
3855
3856 - `defer_loading: optional boolean`
3857
3858 - `enabled: optional boolean`
38594039
38604040- `output_format: optional BetaJSONOutputFormat or null`
38614041
38624042
api/beta/messages/create Changed · +4342 / -2068 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.
Nothing in the body moved in this read. What changed is above.
api/beta/models Changed · +10 / -2 lines
from line 39
3939
4040 - `string`
4141
42 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
42 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
4343
4444 - `"message-batches-2024-09-24"`
4545
from line 133
133133
134134 - `"compact-2026-09-04"`
135135
136 - `"inline-tools-2026-09-15"`
137
138 - `"mcp-client-2026-09-15"`
139
136140- `"anthropic-workspace-id": optional string`
137141
138142 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
from line 427
423427
424428 - `string`
425429
426 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
430 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
427431
428432 - `"message-batches-2024-09-24"`
429433
from line 520
516520 - `"mid-conversation-system-clear-at-2026-08-21"`
517521
518522 - `"compact-2026-09-04"`
523
524 - `"inline-tools-2026-09-15"`
525
526 - `"mcp-client-2026-09-15"`
519527
520528- `"anthropic-workspace-id": optional string`
521529
api/beta/models/list Changed · +5 / -1 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 43 more`
40 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
4141
4242 - `"message-batches-2024-09-24"`
4343
from line 130
130130 - `"mid-conversation-system-clear-at-2026-08-21"`
131131
132132 - `"compact-2026-09-04"`
133
134 - `"inline-tools-2026-09-15"`
135
136 - `"mcp-client-2026-09-15"`
133137
134138- `"anthropic-workspace-id": optional string`
135139
api/beta/models/retrieve Changed · +5 / -1 lines
from line 25
2525
2626 - `string`
2727
28 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
28 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
2929
3030 - `"message-batches-2024-09-24"`
3131
from line 118
118118 - `"mid-conversation-system-clear-at-2026-08-21"`
119119
120120 - `"compact-2026-09-04"`
121
122 - `"inline-tools-2026-09-15"`
123
124 - `"mcp-client-2026-09-15"`
121125
122126- `"anthropic-workspace-id": optional string`
123127
api/beta/organization Changed · +190 / -38 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.
from line 1544
15441544
15451545 - `string`
15461546
1547 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
1547 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
15481548
15491549 - `"message-batches-2024-09-24"`
15501550
from line 1638
16381638
16391639 - `"compact-2026-09-04"`
16401640
1641 - `"inline-tools-2026-09-15"`
1642
1643 - `"mcp-client-2026-09-15"`
1644
16411645#### Body parameters
16421646
16431647- `issuer_url: string`
from line 1938
19341938
19351939 - `string`
19361940
1937 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
1941 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
19381942
19391943 - `"message-batches-2024-09-24"`
19401944
from line 2032
20282032
20292033 - `"compact-2026-09-04"`
20302034
2035 - `"inline-tools-2026-09-15"`
2036
2037 - `"mcp-client-2026-09-15"`
2038
20312039#### Returns
20322040
20332041- `data: array of BetaFederationIssuer`
from line 2243
22352243
22362244 - `string`
22372245
2238 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
2246 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
22392247
22402248 - `"message-batches-2024-09-24"`
22412249
from line 2337
23292337
23302338 - `"compact-2026-09-04"`
23312339
2340 - `"inline-tools-2026-09-15"`
2341
2342 - `"mcp-client-2026-09-15"`
2343
23322344#### Returns
23332345
23342346- `BetaFederationIssuer object`
from line 2551
25392551
25402552 - `string`
25412553
2542 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
2554 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
25432555
25442556 - `"message-batches-2024-09-24"`
25452557
from line 2645
26332645
26342646 - `"compact-2026-09-04"`
26352647
2648 - `"inline-tools-2026-09-15"`
2649
2650 - `"mcp-client-2026-09-15"`
2651
26362652#### Body parameters
26372653
26382654- `check_jti: optional boolean or null`
from line 2937
29212937
29222938 - `string`
29232939
2924 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
2940 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
29252941
29262942 - `"message-batches-2024-09-24"`
29272943
from line 3031
30153031
30163032 - `"compact-2026-09-04"`
30173033
3034 - `"inline-tools-2026-09-15"`
3035
3036 - `"mcp-client-2026-09-15"`
3037
30183038#### Returns
30193039
30203040- `BetaFederationIssuer object`
from line 3249
32293249
32303250 - `string`
32313251
3232 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
3252 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
32333253
32343254 - `"message-batches-2024-09-24"`
32353255
from line 3343
33233343
33243344 - `"compact-2026-09-04"`
33253345
3346 - `"inline-tools-2026-09-15"`
3347
3348 - `"mcp-client-2026-09-15"`
3349
33263350#### Body parameters
33273351
33283352- `issuer_id: string`
from line 3664
36403664
36413665 - `string`
36423666
3643 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
3667 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
36443668
36453669 - `"message-batches-2024-09-24"`
36463670
from line 3758
37343758
37353759 - `"compact-2026-09-04"`
37363760
3761 - `"inline-tools-2026-09-15"`
3762
3763 - `"mcp-client-2026-09-15"`
3764
37373765#### Returns
37383766
37393767- `data: array of BetaFederationRule`
from line 3965
39373965
39383966 - `string`
39393967
3940 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
3968 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
39413969
39423970 - `"message-batches-2024-09-24"`
39433971
from line 4059
40314059
40324060 - `"compact-2026-09-04"`
40334061
4062 - `"inline-tools-2026-09-15"`
4063
4064 - `"mcp-client-2026-09-15"`
4065
40344066#### Returns
40354067
40364068- `BetaFederationRule object`
from line 4284
42524284
42534285 - `string`
42544286
4255 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
4287 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
42564288
42574289 - `"message-batches-2024-09-24"`
42584290
from line 4378
43464378
43474379 - `"compact-2026-09-04"`
43484380
4381 - `"inline-tools-2026-09-15"`
4382
4383 - `"mcp-client-2026-09-15"`
4384
43494385#### Body parameters
43504386
43514387- `applies_to_all_workspaces: optional boolean or null`
from line 4679
46434679
46444680 - `string`
46454681
4646 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
4682 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
46474683
46484684 - `"message-batches-2024-09-24"`
46494685
from line 4773
47374773
47384774 - `"compact-2026-09-04"`
47394775
4776 - `"inline-tools-2026-09-15"`
4777
4778 - `"mcp-client-2026-09-15"`
4779
47404780#### Returns
47414781
47424782- `BetaFederationRule object`
from line 4994
49544994
49554995 - `string`
49564996
4957 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
4997 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
49584998
49594999 - `"message-batches-2024-09-24"`
49605000
from line 5088
50485088
50495089 - `"compact-2026-09-04"`
50505090
5091 - `"inline-tools-2026-09-15"`
5092
5093 - `"mcp-client-2026-09-15"`
5094
50515095#### Body parameters
50525096
50535097- `workspace_id: string`
from line 5193
51495193
51505194 - `string`
51515195
5152 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
5196 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
51535197
51545198 - `"message-batches-2024-09-24"`
51555199
from line 5287
52435287
52445288 - `"compact-2026-09-04"`
52455289
5290 - `"inline-tools-2026-09-15"`
5291
5292 - `"mcp-client-2026-09-15"`
5293
52465294#### Returns
52475295
52485296- `data: array of BetaFederationRuleWorkspace`
from line 5382
53345382
53355383 - `string`
53365384
5337 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
5385 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
53385386
53395387 - `"message-batches-2024-09-24"`
53405388
from line 5476
54285476
54295477 - `"compact-2026-09-04"`
54305478
5479 - `"inline-tools-2026-09-15"`
5480
5481 - `"mcp-client-2026-09-15"`
5482
54315483#### Returns
54325484
54335485- `type: "federation_rule_workspace_deleted"`
from line 6011
59596011
59606012 - `string`
59616013
5962 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
6014 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
59636015
59646016 - `"message-batches-2024-09-24"`
59656017
from line 6105
60536105
60546106 - `"compact-2026-09-04"`
60556107
6108 - `"inline-tools-2026-09-15"`
6109
6110 - `"mcp-client-2026-09-15"`
6111
60566112#### Body parameters
60576113
60586114- `name: string`
from line 6262
62066262
62076263 - `string`
62086264
6209 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
6265 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
62106266
62116267 - `"message-batches-2024-09-24"`
62126268
from line 6356
63006356
63016357 - `"compact-2026-09-04"`
63026358
6359 - `"inline-tools-2026-09-15"`
6360
6361 - `"mcp-client-2026-09-15"`
6362
63036363#### Returns
63046364
63056365- `data: array of BetaServiceAccount`
from line 6475
64156475
64166476 - `string`
64176477
6418 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
6478 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
64196479
64206480 - `"message-batches-2024-09-24"`
64216481
from line 6569
65096569
65106570 - `"compact-2026-09-04"`
65116571
6572 - `"inline-tools-2026-09-15"`
6573
6574 - `"mcp-client-2026-09-15"`
6575
65126576#### Returns
65136577
65146578- `BetaServiceAccount object`
from line 6689
66256689
66266690 - `string`
66276691
6628 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
6692 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
66296693
66306694 - `"message-batches-2024-09-24"`
66316695
from line 6783
67196783
67206784 - `"compact-2026-09-04"`
67216785
6786 - `"inline-tools-2026-09-15"`
6787
6788 - `"mcp-client-2026-09-15"`
6789
67226790#### Body parameters
67236791
67246792- `description: optional string or null`
from line 6921
68536921
68546922 - `string`
68556923
6856 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
6924 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
68576925
68586926 - `"message-batches-2024-09-24"`
68596927
from line 7015
69477015
69487016 - `"compact-2026-09-04"`
69497017
7018 - `"inline-tools-2026-09-15"`
7019
7020 - `"mcp-client-2026-09-15"`
7021
69507022#### Returns
69517023
69527024- `BetaServiceAccount object`
from line 7140
70687140
70697141 - `string`
70707142
7071 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
7143 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
70727144
70737145 - `"message-batches-2024-09-24"`
70747146
from line 7234
71627234
71637235 - `"compact-2026-09-04"`
71647236
7237 - `"inline-tools-2026-09-15"`
7238
7239 - `"mcp-client-2026-09-15"`
7240
71657241#### Body parameters
71667242
71677243- `workspace_id: string`
from line 7368
72927368
72937369 - `string`
72947370
7295 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
7371 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
72967372
72977373 - `"message-batches-2024-09-24"`
72987374
from line 7462
73867462
73877463 - `"compact-2026-09-04"`
73887464
7465 - `"inline-tools-2026-09-15"`
7466
7467 - `"mcp-client-2026-09-15"`
7468
73897469#### Returns
73907470
73917471- `data: array of BetaServiceAccountWorkspaceMember`
from line 7568
74887568
74897569 - `string`
74907570
7491 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
7571 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
74927572
74937573 - `"message-batches-2024-09-24"`
74947574
from line 7662
75827662
75837663 - `"compact-2026-09-04"`
75847664
7665 - `"inline-tools-2026-09-15"`
7666
7667 - `"mcp-client-2026-09-15"`
7668
75857669#### Returns
75867670
75877671- `type: "service_account_workspace_member_deleted"`
from line 8258
81748258
81758259 - `string`
81768260
8177 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
8261 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
81788262
81798263 - `"message-batches-2024-09-24"`
81808264
from line 8352
82688352
82698353 - `"compact-2026-09-04"`
82708354
8355 - `"inline-tools-2026-09-15"`
8356
8357 - `"mcp-client-2026-09-15"`
8358
82718359#### Body parameters
82728360
82738361- `name: string`
from line 9715
96279715
96289716 - `string`
96299717
9630 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
9718 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
96319719
96329720 - `"message-batches-2024-09-24"`
96339721
from line 9809
97219809
97229810 - `"compact-2026-09-04"`
97239811
9812 - `"inline-tools-2026-09-15"`
9813
9814 - `"mcp-client-2026-09-15"`
9815
97249816#### Returns
97259817
97269818- `data: array of BetaServiceAccountWorkspaceMember`
from line 9912
98209912
98219913 - `string`
98229914
9823 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
9915 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
98249916
98259917 - `"message-batches-2024-09-24"`
98269918
from line 10006
991410006
991510007 - `"compact-2026-09-04"`
991610008
10009 - `"inline-tools-2026-09-15"`
10010
10011 - `"mcp-client-2026-09-15"`
10012
991710013#### Body parameters
991810014
991910015- `service_account_id: string`
from line 10125
1002910125
1003010126 - `string`
1003110127
10032 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
10128 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
1003310129
1003410130 - `"message-batches-2024-09-24"`
1003510131
from line 10219
1012310219
1012410220 - `"compact-2026-09-04"`
1012510221
10222 - `"inline-tools-2026-09-15"`
10223
10224 - `"mcp-client-2026-09-15"`
10225
1012610226#### Returns
1012710227
1012810228- `BetaServiceAccountWorkspaceMember object`
from line 10315
1021510315
1021610316 - `string`
1021710317
10218 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
10318 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
1021910319
1022010320 - `"message-batches-2024-09-24"`
1022110321
from line 10409
1030910409
1031010410 - `"compact-2026-09-04"`
1031110411
10412 - `"inline-tools-2026-09-15"`
10413
10414 - `"mcp-client-2026-09-15"`
10415
1031210416#### Body parameters
1031310417
1031410418- `workspace_role: BetaNoBillingWorkspaceRole`
from line 10522
1041810522
1041910523 - `string`
1042010524
10421 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
10525 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
1042210526
1042310527 - `"message-batches-2024-09-24"`
1042410528
from line 10562
1045810562
1045910563 - `"skills-2025-10-02"`
1046010564
10461 - `"fast-mode-2026-02-01"`
10462
10463 - `"output-300k-2026-03-24"`
10464
10465 - `"user-profiles-2026-03-24"`
10466
10467 - `"user-profiles-2026-08-18"`
10468
10469 - `"user-profiles-2026-09-04"`
10470
10471 - `"advisor-tool-2026-03-01"`
10472
10473 - `"managed-agents-2026-04-01"`
10474
10475 - `"cache-diagnosis-2026-04-07"`
10476
10477 - `"dreaming-2026-04-21"`
10478
10479 - `"thinking-token-count-2026-05-13"`
10480
10481 - `"server-side-fallback-2026-06-01"`
10482
10483 - `"server-side-fallback-2026-07-01"`
10484
10485 - `"fallback-credit-2026-06-01"`
10486
10487 - `"fallback-credit-2026-07-01"`
10488
10489 - `"agent-memory-2026-07-22"`
10490
10491 - `"mid-conversation-tool-changes-2026-07-01"`
10492
10493 - `"compact-2026-01-12"`
10494
10495 - `"computer-use-2025-11-24"`
10496
10497 - `"mcp-tunnels-2026-06-22"`
10498
10499 - `"structured-outputs-2025-11-13"`
10500
10501 - `"task-budgets-2026-03-13"`
10502
10503 - `"thinking-display-updates-2026-08-18"`
10504
10505 - `"ce-user-management-2026-07-13"`
10506
10507 - `"mid-conversation-output-config-2026-07-01"`
10508
10509 - `"thinking-binding-controls-2026-08-01"`
10510
10511 - `"mid-conversation-system-clear-at-2026-08-21"`
10512
10513 - `"compact-2026-09-04"`
10514
10515#### Returns
10516
10517- `type: "service_account_workspace_member_deleted"`
10518
10519 default: service_account_workspace_member_deleted
10520
10521- `service_account_id: string`
10522
10523 Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
10524
10525- `workspace_id: string`
10526
10527 Tagged workspace ID (`wrkspc_...`) named in the delete request.
10528
10529#### Example
10530
10531```bash
10532curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \
10533 -X DELETE \
10534 -H 'anthropic-version: 2023-06-01' \
10535 -H "X-Api-Key: $ANTHROPIC_API_KEY"
10536```
10537
10538##### Response (200)
10539
10540```json
10541{
10542 "service_account_id": "service_account_id",
10543
10565 - `
api/beta/organization/cost_report Changed · +5 / -1 lines
from line 58
5858
5959 - `string`
6060
61 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
61 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
6262
6363 - `"message-batches-2024-09-24"`
6464
from line 151
151151 - `"mid-conversation-system-clear-at-2026-08-21"`
152152
153153 - `"compact-2026-09-04"`
154
155 - `"inline-tools-2026-09-15"`
156
157 - `"mcp-client-2026-09-15"`
154158
155159### Returns
156160
api/beta/organization/cost_report/retrieve Changed · +5 / -1 lines
from line 56
5656
5757 - `string`
5858
59 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
59 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
6060
6161 - `"message-batches-2024-09-24"`
6262
from line 149
149149 - `"mid-conversation-system-clear-at-2026-08-21"`
150150
151151 - `"compact-2026-09-04"`
152
153 - `"inline-tools-2026-09-15"`
154
155 - `"mcp-client-2026-09-15"`
152156
153157## Returns
154158
api/beta/organization/federation Changed · +65 / -13 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 43 more`
36 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
3737
3838 - `"message-batches-2024-09-24"`
3939
from line 127
127127
128128 - `"compact-2026-09-04"`
129129
130 - `"inline-tools-2026-09-15"`
131
132 - `"mcp-client-2026-09-15"`
133
130134#### Body parameters
131135
132136- `issuer_url: string`
from line 427
423427
424428 - `string`
425429
426 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
430 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
427431
428432 - `"message-batches-2024-09-24"`
429433
from line 521
517521
518522 - `"compact-2026-09-04"`
519523
524 - `"inline-tools-2026-09-15"`
525
526 - `"mcp-client-2026-09-15"`
527
520528#### Returns
521529
522530- `data: array of BetaFederationIssuer`
from line 732
724732
725733 - `string`
726734
727 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
735 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
728736
729737 - `"message-batches-2024-09-24"`
730738
from line 826
818826
819827 - `"compact-2026-09-04"`
820828
829 - `"inline-tools-2026-09-15"`
830
831 - `"mcp-client-2026-09-15"`
832
821833#### Returns
822834
823835- `BetaFederationIssuer object`
from line 1040
10281040
10291041 - `string`
10301042
1031 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
1043 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
10321044
10331045 - `"message-batches-2024-09-24"`
10341046
from line 1134
11221134
11231135 - `"compact-2026-09-04"`
11241136
1137 - `"inline-tools-2026-09-15"`
1138
1139 - `"mcp-client-2026-09-15"`
1140
11251141#### Body parameters
11261142
11271143- `check_jti: optional boolean or null`
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 43 more`
1429 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
14141430
14151431 - `"message-batches-2024-09-24"`
14161432
from line 1520
15041520
15051521 - `"compact-2026-09-04"`
15061522
1523 - `"inline-tools-2026-09-15"`
1524
1525 - `"mcp-client-2026-09-15"`
1526
15071527#### Returns
15081528
15091529- `BetaFederationIssuer object`
from line 1738
17181738
17191739 - `string`
17201740
1721 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
1741 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
17221742
17231743 - `"message-batches-2024-09-24"`
17241744
from line 1832
18121832
18131833 - `"compact-2026-09-04"`
18141834
1835 - `"inline-tools-2026-09-15"`
1836
1837 - `"mcp-client-2026-09-15"`
1838
18151839#### Body parameters
18161840
18171841- `issuer_id: string`
from line 2153
21292153
21302154 - `string`
21312155
2132 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
2156 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
21332157
21342158 - `"message-batches-2024-09-24"`
21352159
from line 2247
22232247
22242248 - `"compact-2026-09-04"`
22252249
2250 - `"inline-tools-2026-09-15"`
2251
2252 - `"mcp-client-2026-09-15"`
2253
22262254#### Returns
22272255
22282256- `data: array of BetaFederationRule`
from line 2454
24262454
24272455 - `string`
24282456
2429 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
2457 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
24302458
24312459 - `"message-batches-2024-09-24"`
24322460
from line 2548
25202548
25212549 - `"compact-2026-09-04"`
25222550
2551 - `"inline-tools-2026-09-15"`
2552
2553 - `"mcp-client-2026-09-15"`
2554
25232555#### Returns
25242556
25252557- `BetaFederationRule object`
from line 2773
27412773
27422774 - `string`
27432775
2744 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
2776 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
27452777
27462778 - `"message-batches-2024-09-24"`
27472779
from line 2867
28352867
28362868 - `"compact-2026-09-04"`
28372869
2870 - `"inline-tools-2026-09-15"`
2871
2872 - `"mcp-client-2026-09-15"`
2873
28382874#### Body parameters
28392875
28402876- `applies_to_all_workspaces: optional boolean or null`
from line 3168
31323168
31333169 - `string`
31343170
3135 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
3171 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
31363172
31373173 - `"message-batches-2024-09-24"`
31383174
from line 3262
32263262
32273263 - `"compact-2026-09-04"`
32283264
3265 - `"inline-tools-2026-09-15"`
3266
3267 - `"mcp-client-2026-09-15"`
3268
32293269#### Returns
32303270
32313271- `BetaFederationRule object`
from line 3483
34433483
34443484 - `string`
34453485
3446 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
3486 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
34473487
34483488 - `"message-batches-2024-09-24"`
34493489
from line 3577
35373577
35383578 - `"compact-2026-09-04"`
35393579
3580 - `"inline-tools-2026-09-15"`
3581
3582 - `"mcp-client-2026-09-15"`
3583
35403584#### Body parameters
35413585
35423586- `workspace_id: string`
from line 3682
36383682
36393683 - `string`
36403684
3641 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
3685 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
36423686
36433687 - `"message-batches-2024-09-24"`
36443688
from line 3776
37323776
37333777 - `"compact-2026-09-04"`
37343778
3779 - `"inline-tools-2026-09-15"`
3780
3781 - `"mcp-client-2026-09-15"`
3782
37353783#### Returns
37363784
37373785- `data: array of BetaFederationRuleWorkspace`
from line 3871
38233871
38243872 - `string`
38253873
3826 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
3874 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
38273875
38283876 - `"message-batches-2024-09-24"`
38293877
from line 3964
39163964 - `"mid-conversation-system-clear-at-2026-08-21"`
39173965
39183966 - `"compact-2026-09-04"`
3967
3968 - `"inline-tools-2026-09-15"`
3969
3970 - `"mcp-client-2026-09-15"`
39193971
39203972#### Returns
39213973
api/beta/organization/federation/issuers Changed · +25 / -5 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 43 more`
34 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
3535
3636 - `"message-batches-2024-09-24"`
3737
from line 125
125125
126126 - `"compact-2026-09-04"`
127127
128 - `"inline-tools-2026-09-15"`
129
130 - `"mcp-client-2026-09-15"`
131
128132### Body parameters
129133
130134- `issuer_url: string`
from line 425
421425
422426 - `string`
423427
424 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
428 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
425429
426430 - `"message-batches-2024-09-24"`
427431
from line 519
515519
516520 - `"compact-2026-09-04"`
517521
522 - `"inline-tools-2026-09-15"`
523
524 - `"mcp-client-2026-09-15"`
525
518526### Returns
519527
520528- `data: array of BetaFederationIssuer`
from line 730
722730
723731 - `string`
724732
725 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
733 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
726734
727735 - `"message-batches-2024-09-24"`
728736
from line 824
816824
817825 - `"compact-2026-09-04"`
818826
827 - `"inline-tools-2026-09-15"`
828
829 - `"mcp-client-2026-09-15"`
830
819831### Returns
820832
821833- `BetaFederationIssuer object`
from line 1038
10261038
10271039 - `string`
10281040
1029 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
1041 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
10301042
10311043 - `"message-batches-2024-09-24"`
10321044
from line 1132
11201132
11211133 - `"compact-2026-09-04"`
11221134
1135 - `"inline-tools-2026-09-15"`
1136
1137 - `"mcp-client-2026-09-15"`
1138
11231139### Body parameters
11241140
11251141- `check_jti: optional boolean or null`
from line 1424
14081424
14091425 - `string`
14101426
1411 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
1427 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
14121428
14131429 - `"message-batches-2024-09-24"`
14141430
from line 1517
15011517 - `"mid-conversation-system-clear-at-2026-08-21"`
15021518
15031519 - `"compact-2026-09-04"`
1520
1521 - `"inline-tools-2026-09-15"`
1522
1523 - `"mcp-client-2026-09-15"`
15041524
15051525### Returns
15061526
api/beta/organization/federation/issuers/archive Changed · +5 / -1 lines
from line 30
3030
3131 - `string`
3232
33 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
33 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
3434
3535 - `"message-batches-2024-09-24"`
3636
from line 123
123123 - `"mid-conversation-system-clear-at-2026-08-21"`
124124
125125 - `"compact-2026-09-04"`
126
127 - `"inline-tools-2026-09-15"`
128
129 - `"mcp-client-2026-09-15"`
126130
127131## Returns
128132
api/beta/organization/federation/issuers/create Changed · +5 / -1 lines
from line 29
2929
3030 - `string`
3131
32 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
32 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
3333
3434 - `"message-batches-2024-09-24"`
3535
from line 122
122122 - `"mid-conversation-system-clear-at-2026-08-21"`
123123
124124 - `"compact-2026-09-04"`
125
126 - `"inline-tools-2026-09-15"`
127
128 - `"mcp-client-2026-09-15"`
125129
126130## Body parameters
127131
api/beta/organization/federation/issuers/list Changed · +5 / -1 lines
from line 39
3939
4040 - `string`
4141
42 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
42 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
4343
4444 - `"message-batches-2024-09-24"`
4545
from line 132
132132 - `"mid-conversation-system-clear-at-2026-08-21"`
133133
134134 - `"compact-2026-09-04"`
135
136 - `"inline-tools-2026-09-15"`
137
138 - `"mcp-client-2026-09-15"`
135139
136140## Returns
137141
api/beta/organization/federation/issuers/retrieve Changed · +5 / -1 lines
from line 25
2525
2626 - `string`
2727
28 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
28 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
2929
3030 - `"message-batches-2024-09-24"`
3131
from line 118
118118 - `"mid-conversation-system-clear-at-2026-08-21"`
119119
120120 - `"compact-2026-09-04"`
121
122 - `"inline-tools-2026-09-15"`
123
124 - `"mcp-client-2026-09-15"`
121125
122126## Returns
123127
api/beta/organization/federation/issuers/update Changed · +5 / -1 lines
from line 32
3232
3333 - `string`
3434
35 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
35 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
3636
3737 - `"message-batches-2024-09-24"`
3838
from line 125
125125 - `"mid-conversation-system-clear-at-2026-08-21"`
126126
127127 - `"compact-2026-09-04"`
128
129 - `"inline-tools-2026-09-15"`
130
131 - `"mcp-client-2026-09-15"`
128132
129133## Body parameters
130134
api/beta/organization/federation/rules Changed · +40 / -8 lines
from line 35
3535
3636 - `string`
3737
38 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
38 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
3939
4040 - `"message-batches-2024-09-24"`
4141
from line 129
129129
130130 - `"compact-2026-09-04"`
131131
132 - `"inline-tools-2026-09-15"`
133
134 - `"mcp-client-2026-09-15"`
135
132136### Body parameters
133137
134138- `issuer_id: string`
from line 450
446450
447451 - `string`
448452
449 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
453 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
450454
451455 - `"message-batches-2024-09-24"`
452456
from line 544
540544
541545 - `"compact-2026-09-04"`
542546
547 - `"inline-tools-2026-09-15"`
548
549 - `"mcp-client-2026-09-15"`
550
543551### Returns
544552
545553- `data: array of BetaFederationRule`
from line 751
743751
744752 - `string`
745753
746 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
754 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
747755
748756 - `"message-batches-2024-09-24"`
749757
from line 845
837845
838846 - `"compact-2026-09-04"`
839847
848 - `"inline-tools-2026-09-15"`
849
850 - `"mcp-client-2026-09-15"`
851
840852### Returns
841853
842854- `BetaFederationRule object`
from line 1070
10581070
10591071 - `string`
10601072
1061 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
1073 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
10621074
10631075 - `"message-batches-2024-09-24"`
10641076
from line 1164
11521164
11531165 - `"compact-2026-09-04"`
11541166
1167 - `"inline-tools-2026-09-15"`
1168
1169 - `"mcp-client-2026-09-15"`
1170
11551171### Body parameters
11561172
11571173- `applies_to_all_workspaces: optional boolean or null`
from line 1465
14491465
14501466 - `string`
14511467
1452 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
1468 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
14531469
14541470 - `"message-batches-2024-09-24"`
14551471
from line 1559
15431559
15441560 - `"compact-2026-09-04"`
15451561
1562 - `"inline-tools-2026-09-15"`
1563
1564 - `"mcp-client-2026-09-15"`
1565
15461566### Returns
15471567
15481568- `BetaFederationRule object`
from line 1993
19731993
19741994 - `string`
19751995
1976 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
1996 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
19771997
19781998 - `"message-batches-2024-09-24"`
19791999
from line 2087
20672087
20682088 - `"compact-2026-09-04"`
20692089
2090 - `"inline-tools-2026-09-15"`
2091
2092 - `"mcp-client-2026-09-15"`
2093
20702094#### Body parameters
20712095
20722096- `workspace_id: string`
from line 2192
21682192
21692193 - `string`
21702194
2171 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
2195 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
21722196
21732197 - `"message-batches-2024-09-24"`
21742198
from line 2286
22622286
22632287 - `"compact-2026-09-04"`
22642288
2289 - `"inline-tools-2026-09-15"`
2290
2291 - `"mcp-client-2026-09-15"`
2292
22652293#### Returns
22662294
22672295- `data: array of BetaFederationRuleWorkspace`
from line 2381
23532381
23542382 - `string`
23552383
2356 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
2384 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
23572385
23582386 - `"message-batches-2024-09-24"`
23592387
from line 2474
24462474 - `"mid-conversation-system-clear-at-2026-08-21"`
24472475
24482476 - `"compact-2026-09-04"`
2477
2478 - `"inline-tools-2026-09-15"`
2479
2480 - `"mcp-client-2026-09-15"`
24492481
24502482#### Returns
24512483
api/beta/organization/federation/rules/archive Changed · +5 / -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 43 more`
36 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
3737
3838 - `"message-batches-2024-09-24"`
3939
from line 126
126126 - `"mid-conversation-system-clear-at-2026-08-21"`
127127
128128 - `"compact-2026-09-04"`
129
130 - `"inline-tools-2026-09-15"`
131
132 - `"mcp-client-2026-09-15"`
129133
130134## Returns
131135
api/beta/organization/federation/rules/create Changed · +5 / -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 43 more`
36 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
3737
3838 - `"message-batches-2024-09-24"`
3939
from line 126
126126 - `"mid-conversation-system-clear-at-2026-08-21"`
127127
128128 - `"compact-2026-09-04"`
129
130 - `"inline-tools-2026-09-15"`
131
132 - `"mcp-client-2026-09-15"`
129133
130134## Body parameters
131135
api/beta/organization/federation/rules/list Changed · +5 / -1 lines
from line 44
4444
4545 - `string`
4646
47 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
47 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
4848
4949 - `"message-batches-2024-09-24"`
5050
from line 137
137137 - `"mid-conversation-system-clear-at-2026-08-21"`
138138
139139 - `"compact-2026-09-04"`
140
141 - `"inline-tools-2026-09-15"`
142
143 - `"mcp-client-2026-09-15"`
140144
141145## Returns
142146
api/beta/organization/federation/rules/retrieve Changed · +5 / -1 lines
from line 25
2525
2626 - `string`
2727
28 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
28 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
2929
3030 - `"message-batches-2024-09-24"`
3131
from line 118
118118 - `"mid-conversation-system-clear-at-2026-08-21"`
119119
120120 - `"compact-2026-09-04"`
121
122 - `"inline-tools-2026-09-15"`
123
124 - `"mcp-client-2026-09-15"`
121125
122126## Returns
123127
api/beta/organization/federation/rules/update Changed · +5 / -1 lines
from line 41
4141
4242 - `string`
4343
44 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`
44 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more`
4545
4646 - `"message-batches-2024-09-24"`
4747
from line 134
134134 - `"mid-conversation-system-clear-at-2026-08-21"`
135135
136136 - `"compact-2026-09-04"`
137
138 - `"inline-tools-2026-09-15"`
139
140 - `"mcp-client-2026-09-15"`
137141
138142## Body parameters
139143