Home Docs Claude Developer Platform 23 Sep 2026

One change · api

Create a Message Batch changedapi/beta/messages/batches/create

Nearest release: v2.1.281, published an hour before this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.

Recorded here 23 Sep 2026 18:37 UTC

Lines+2,171added

Lines−1,991removed

From line 21 where the diff opens

First seen 14 Aug 2026 this site's first read of the page

Recorded edits13to this page, all time

The whole hunk

from line 21, old and new numbered

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 1317

13131317

13141318 The block's signature as returned, to be sent back verbatim

13151319

1320 - `tool_changes: optional array of BetaRequestToolAdditionBlock or BetaRequestToolRemovalBlock or null`

1321

1322 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.

1323

1324 - `BetaRequestToolAdditionBlock object`

1325

1326 Mid-conversation directive to make a tool available.

1327

1328 `tool` is a reference to a tool (or MCP toolset) declared in the

1329 request's `tools`. Under the `inline-tools-2026-09-15` beta it may

1330 instead be a reference to a tool defined earlier in `messages`, or a

1331 `tool_definition` object that carries an inline tool definition in

1332 `definition` (the same object a `tools` entry holds). An `mcp_toolset`

1333 definition also requires the `mcp-client-2026-09-15` beta. The tool is

1334 offered to the model from this point in the conversation onward.

1335

1336 - `type: "tool_addition"`

1337

1338 - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference or BetaToolChangeToolDefinitionParam`

1339

1340 - `BetaToolChangeToolReference object`

1341

1342 Reference to a single tool, by the name the model uses to call it: a

1343 tool declared in `tools` or defined by an earlier `tool_addition`

1344 block. Does not accept the composed `{server}_{name}` form the server

1345 assigns to MCP-resolved tools; use `mcp_tool_reference` or

1346 `mcp_toolset_reference` for those.

1347

1348 - `type: "tool_reference"`

1349

1350 - `name: string`

1351

1352 pattern: ^[a-zA-Z0-9_-]{1,128}$

1353

1354 - `BetaToolChangeMCPToolReference object`

1355

1356 Reference to a single MCP tool by its server and remote name; the

1357 same `server_name`/`name` pair `mcp_tool_use` carries.

1358

1359 - `type: "mcp_tool_reference"`

1360

1361 - `name: string`

1362

1363 - `server_name: string`

1364

1365 - `BetaToolChangeMCPToolsetReference object`

1366

1367 Reference to every tool in the named MCP server's toolset.

1368

1369 - `type: "mcp_toolset_reference"`

1370

1371 - `server_name: string`

1372

1373 - `BetaToolChangeToolDefinitionParam object`

1374

1375 A tool defined by value: `definition` is a `tools` entry (any kind

1376 `tools` accepts, an MCP toolset included). An `mcp_toolset` given here

1377 also requires the `mcp-client-2026-09-15` beta.

1378

1379 - `type: "tool_definition"`

1380

1381 - `definition: BetaToolUnion`

1382

1383 - `BetaTool object`

1384

1385 - `type: optional "custom" or null`

1386

1387 - `input_schema: object`

1388

1389 [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.

1390

1391 This defines the shape of the `input` that your tool accepts and that the model will produce.

1392

1393 - `type: "object"`

1394

1395 - `properties: optional map[unknown] or null`

1396

1397 - `required: optional array of string or null`

1398

1399 - `name: string`

1400

1401 Name of the tool.

1402

1403 This is how the tool will be called by the model and in `tool_use` blocks.

1404

1405 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$

1406

1407 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

1408

1409 - `"direct"`

1410

1411 - `"code_execution_20250825"`

1412

1413 - `"code_execution_20260120"`

1414

1415 - `"code_execution_20260521"`

1416

1417 - `cache_control: optional BetaCacheControlEphemeral or null`

1418

1419 Create a cache control breakpoint at this content block.

1420

1421 - `defer_loading: optional boolean`

1422

1423 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

1424

1425 - `description: optional string`

1426

1427 Description of what this tool does.

1428

1429 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.

1430

1431 - `eager_input_streaming: optional boolean or null`

1432

1433 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.

1434

1435 - `input_examples: optional array of map[unknown]`

1436

1437 - `strict: optional boolean`

1438

1439 When true, guarantees schema validation on tool names and inputs

1440

1441 - `BetaToolBash20241022 object`

1442

1443 - `type: "bash_20241022"`

1444

1445 - `name: "bash"`

1446

1447 Name of the tool.

1448

1449 This is how the tool will be called by the model and in `tool_use` blocks.

1450

1451 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

1452

1453 - `"direct"`

1454

1455 - `"code_execution_20250825"`

1456

1457 - `"code_execution_20260120"`

1458

1459 - `"code_execution_20260521"`

1460

1461 - `cache_control: optional BetaCacheControlEphemeral or null`

1462

1463 Create a cache control breakpoint at this content block.

1464

1465 - `defer_loading: optional boolean`

1466

1467 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

1468

1469 - `input_examples: optional array of map[unknown]`

1470

1471 - `strict: optional boolean`

1472

1473 When true, guarantees schema validation on tool names and inputs

1474

1475 - `BetaToolBash20250124 object`

1476

1477 - `type: "bash_20250124"`

1478

1479 - `name: "bash"`

1480

1481 Name of the tool.

1482

1483 This is how the tool will be called by the model and in `tool_use` blocks.

1484

1485 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

1486

1487 - `"direct"`

1488

1489 - `"code_execution_20250825"`

1490

1491 - `"code_execution_20260120"`

1492

1493 - `"code_execution_20260521"`

1494

1495 - `cache_control: optional BetaCacheControlEphemeral or null`

1496

1497 Create a cache control breakpoint at this content block.

1498

1499 - `defer_loading: optional boolean`

1500

1501 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

1502

1503 - `input_examples: optional array of map[unknown]`

1504

1505 - `strict: optional boolean`

1506

1507 When true, guarantees schema validation on tool names and inputs

1508

1509 - `BetaCodeExecutionTool20250522 object`

1510

1511 - `type: "code_execution_20250522"`

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 - `BetaCodeExecutionTool20250825 object`

1542

1543 - `type: "code_execution_20250825"`

1544

1545 - `name: "code_execution"`

1546

1547 Name of the tool.

1548

1549 This is how the tool will be called by the model and in `tool_use` blocks.

1550

1551 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

1552

1553 - `"direct"`

1554

1555 - `"code_execution_20250825"`

1556

1557 - `"code_execution_20260120"`

1558

1559 - `"code_execution_20260521"`

1560

1561 - `cache_control: optional BetaCacheControlEphemeral or null`

1562

1563 Create a cache control breakpoint at this content block.

1564

1565 - `defer_loading: optional boolean`

1566

1567 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

1568

1569 - `strict: optional boolean`

1570

1571 When true, guarantees schema validation on tool names and inputs

1572

1573 - `BetaCodeExecutionTool20260120 object`

1574

1575 Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).

1576

1577 - `type: "code_execution_20260120"`

1578

1579 - `name: "code_execution"`

1580

1581 Name of the tool.

1582

1583 This is how the tool will be called by the model and in `tool_use` blocks.

1584

1585 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

1586

1587 - `"direct"`

1588

1589 - `"code_execution_20250825"`

1590

1591 - `"code_execution_20260120"`

1592

1593 - `"code_execution_20260521"`

1594

1595 - `cache_control: optional BetaCacheControlEphemeral or null`

1596

1597 Create a cache control breakpoint at this content block.

1598

1599 - `defer_loading: optional boolean`

1600

1601 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

1602

1603 - `strict: optional boolean`

1604

1605 When true, guarantees schema validation on tool names and inputs

1606

1607 - `BetaCodeExecutionTool20260521 object`

1608

1609 Code execution tool with REPL state persistence.

1610

1611 - `type: "code_execution_20260521"`

1612

1613 - `name: "code_execution"`

1614

1615 Name of the tool.

1616

1617 This is how the tool will be called by the model and in `tool_use` blocks.

1618

1619 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

1620

1621 - `"direct"`

1622

1623 - `"code_execution_20250825"`

1624

1625 - `"code_execution_20260120"`

1626

1627 - `"code_execution_20260521"`

1628

1629 - `cache_control: optional BetaCacheControlEphemeral or null`

1630

1631 Create a cache control breakpoint at this content block.

1632

1633 - `defer_loading: optional boolean`

1634

1635 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

1636

1637 - `strict: optional boolean`

1638

1639 When true, guarantees schema validation on tool names and inputs

1640

1641 - `BetaBrowserToolset20260801 object`

1642

1643 The browser toolset: a single `tools[]` entry (carrying no

1644 `name`) that declares the browser tool family. The model is served

1645 the family's tool with any members disabled via `configs` removed

1646 from its schema.

1647

1648 - `type: "browser_toolset_20260801"`

1649

1650 - `cache_control: optional BetaCacheControlEphemeral or null`

1651

1652 Create a cache control breakpoint at this content block.

1653

1654 - `configs: optional BetaBrowserToolsetConfigs or null`

1655

1656 Per-member configuration for `browser_toolset_20260801`: one

1657 optional field per member tool, keyed by the member name — the same

1658 name the member's `tool_use` blocks carry. Every member is an

1659 accepted key, and a member's defaults apply wherever its key is

1660 absent. Unknown keys are rejected: the field set is this toolset

1661 version's complete member set.

1662

1663 - `type: optional BetaBrowserTypeConfig or null`

1664

1665 `type`'s config overrides.

1666

1667 - `defer_loading: optional boolean or null`

1668

1669 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1670

1671 - `enabled: optional boolean or null`

1672

1673 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.

1674

1675 - `close_tab: optional BetaBrowserCloseTabConfig or null`

1676

1677 `close_tab`'s config overrides.

1678

1679 - `defer_loading: optional boolean or null`

1680

1681 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1682

1683 - `enabled: optional boolean or null`

1684

1685 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.

1686

1687 - `double_click: optional BetaBrowserDoubleClickConfig or null`

1688

1689 `double_click`'s config overrides.

1690

1691 - `defer_loading: optional boolean or null`

1692

1693 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1694

1695 - `enabled: optional boolean or null`

1696

1697 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.

1698

1699 - `file_upload: optional BetaBrowserFileUploadConfig or null`

1700

1701 `file_upload`'s config overrides.

1702

1703 - `defer_loading: optional boolean or null`

1704

1705 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1706

1707 - `enabled: optional boolean or null`

1708

1709 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.

1710

1711 - `find: optional BetaBrowserFindConfig or null`

1712

1713 `find`'s config overrides.

1714

1715 - `defer_loading: optional boolean or null`

1716

1717 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1718

1719 - `enabled: optional boolean or null`

1720

1721 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.

1722

1723 - `form_input: optional BetaBrowserFormInputConfig or null`

1724

1725 `form_input`'s config overrides.

1726

1727 - `defer_loading: optional boolean or null`

1728

1729 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1730

1731 - `enabled: optional boolean or null`

1732

1733 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.

1734

1735 - `get_page_text: optional BetaBrowserGetPageTextConfig or null`

1736

1737 `get_page_text`'s config overrides.

1738

1739 - `defer_loading: optional boolean or null`

1740

1741 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1742

1743 - `enabled: optional boolean or null`

1744

1745 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.

1746

1747 - `hold_key: optional BetaBrowserHoldKeyConfig or null`

1748

1749 `hold_key`'s config overrides.

1750

1751 - `defer_loading: optional boolean or null`

1752

1753 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1754

1755 - `enabled: optional boolean or null`

1756

1757 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.

1758

1759 - `hover: optional BetaBrowserHoverConfig or null`

1760

1761 `hover`'s config overrides.

1762

1763 - `defer_loading: optional boolean or null`

1764

1765 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1766

1767 - `enabled: optional boolean or null`

1768

1769 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.

1770

1771 - `javascript_exec: optional BetaBrowserJavascriptExecConfig or null`

1772

1773 `javascript_exec`'s config overrides.

1774

1775 - `defer_loading: optional boolean or null`

1776

1777 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1778

1779 - `enabled: optional boolean or null`

1780

1781 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.

1782

1783 - `key: optional BetaBrowserKeyConfig or null`

1784

1785 `key`'s config overrides.

1786

1787 - `defer_loading: optional boolean or null`

1788

1789 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1790

1791 - `enabled: optional boolean or null`

1792

1793 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.

1794

1795 - `left_click: optional BetaBrowserLeftClickConfig or null`

1796

1797 `left_click`'s config overrides.

1798

1799 - `defer_loading: optional boolean or null`

1800

1801 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1802

1803 - `enabled: optional boolean or null`

1804

1805 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.

1806

1807 - `left_click_drag: optional BetaBrowserLeftClickDragConfig or null`

1808

1809 `left_click_drag`'s config overrides.

1810

1811 - `defer_loading: optional boolean or null`

1812

1813 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1814

1815 - `enabled: optional boolean or null`

1816

1817 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.

1818

1819 - `left_mouse_down: optional BetaBrowserLeftMouseDownConfig or null`

1820

1821 `left_mouse_down`'s config overrides.

1822

1823 - `defer_loading: optional boolean or null`

1824

1825 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1826

1827 - `enabled: optional boolean or null`

1828

1829 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.

1830

1831 - `left_mouse_up: optional BetaBrowserLeftMouseUpConfig or null`

1832

1833 `left_mouse_up`'s config overrides.

1834

1835 - `defer_loading: optional boolean or null`

1836

1837 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1838

1839 - `enabled: optional boolean or null`

1840

1841 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.

1842

1843 - `list_tabs: optional BetaBrowserListTabsConfig or null`

1844

1845 `list_tabs`'s config overrides.

1846

1847 - `defer_loading: optional boolean or null`

1848

1849 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1850

1851 - `enabled: optional boolean or null`

1852

1853 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.

1854

1855 - `middle_click: optional BetaBrowserMiddleClickConfig or null`

1856

1857 `middle_click`'s config overrides.

1858

1859 - `defer_loading: optional boolean or null`

1860

1861 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1862

1863 - `enabled: optional boolean or null`

1864

1865 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.

1866

1867 - `mouse_move: optional BetaBrowserMouseMoveConfig or null`

1868

1869 `mouse_move`'s config overrides.

1870

1871 - `defer_loading: optional boolean or null`

1872

1873 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1874

1875 - `enabled: optional boolean or null`

1876

1877 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.

1878

1879 - `navigate: optional BetaBrowserNavigateConfig or null`

1880

1881 `navigate`'s config overrides.

1882

1883 - `defer_loading: optional boolean or null`

1884

1885 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1886

1887 - `enabled: optional boolean or null`

1888

1889 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.

1890

1891 - `new_tab: optional BetaBrowserNewTabConfig or null`

1892

1893 `new_tab`'s config overrides.

1894

1895 - `defer_loading: optional boolean or null`

1896

1897 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1898

1899 - `enabled: optional boolean or null`

1900

1901 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.

1902

1903 - `read_console: optional BetaBrowserReadConsoleConfig or null`

1904

1905 `read_console`'s config overrides.

1906

1907 - `defer_loading: optional boolean or null`

1908

1909 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1910

1911 - `enabled: optional boolean or null`

1912

1913 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.

1914

1915 - `read_network: optional BetaBrowserReadNetworkConfig or null`

1916

1917 `read_network`'s config overrides.

1918

1919 - `defer_loading: optional boolean or null`

1920

1921 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1922

1923 - `enabled: optional boolean or null`

1924

1925 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.

1926

1927 - `read_page: optional BetaBrowserReadPageConfig or null`

1928

1929 `read_page`'s config overrides.

1930

1931 - `defer_loading: optional boolean or null`

1932

1933 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1934

1935 - `enabled: optional boolean or null`

1936

1937 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.

1938

1939 - `right_click: optional BetaBrowserRightClickConfig or null`

1940

1941 `right_click`'s config overrides.

1942

1943 - `defer_loading: optional boolean or null`

1944

1945 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1946

1947 - `enabled: optional boolean or null`

1948

1949 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.

1950

1951 - `screenshot: optional BetaBrowserScreenshotConfig or null`

1952

1953 `screenshot`'s config overrides.

1954

1955 - `defer_loading: optional boolean or null`

1956

1957 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1958

1959 - `enabled: optional boolean or null`

1960

1961 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.

1962

1963 - `scroll: optional BetaBrowserScrollConfig or null`

1964

1965 `scroll`'s config overrides.

1966

1967 - `defer_loading: optional boolean or null`

1968

1969 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1970

1971 - `enabled: optional boolean or null`

1972

1973 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.

1974

1975 - `scroll_to: optional BetaBrowserScrollToConfig or null`

1976

1977 `scroll_to`'s config overrides.

1978

1979 - `defer_loading: optional boolean or null`

1980

1981 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1982

1983 - `enabled: optional boolean or null`

1984

1985 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.

1986

1987 - `switch_tab: optional BetaBrowserSwitchTabConfig or null`

1988

1989 `switch_tab`'s config overrides.

1990

1991 - `defer_loading: optional boolean or null`

1992

1993 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

1994

1995 - `enabled: optional boolean or null`

1996

1997 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.

1998

1999 - `triple_click: optional BetaBrowserTripleClickConfig or null`

2000

2001 `triple_click`'s config overrides.

2002

2003 - `defer_loading: optional boolean or null`

2004

2005 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2006

2007 - `enabled: optional boolean or null`

2008

2009 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.

2010

2011 - `wait: optional BetaBrowserWaitConfig or null`

2012

2013 `wait`'s config overrides.

2014

2015 - `defer_loading: optional boolean or null`

2016

2017 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2018

2019 - `enabled: optional boolean or null`

2020

2021 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.

2022

2023 - `zoom: optional BetaBrowserZoomConfig or null`

2024

2025 `zoom`'s config overrides.

2026

2027 - `defer_loading: optional boolean or null`

2028

2029 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2030

2031 - `enabled: optional boolean or null`

2032

2033 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.

2034

2035 - `BetaToolComputerUse20241022 object`

2036

2037 - `type: "computer_20241022"`

2038

2039 - `display_height_px: number`

2040

2041 The height of the display in pixels.

2042

2043 minimum: 1

2044

2045 - `display_width_px: number`

2046

2047 The width of the display in pixels.

2048

2049 minimum: 1

2050

2051 - `name: "computer"`

2052

2053 Name of the tool.

2054

2055 This is how the tool will be called by the model and in `tool_use` blocks.

2056

2057 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2058

2059 - `"direct"`

2060

2061 - `"code_execution_20250825"`

2062

2063 - `"code_execution_20260120"`

2064

2065 - `"code_execution_20260521"`

2066

2067 - `cache_control: optional BetaCacheControlEphemeral or null`

2068

2069 Create a cache control breakpoint at this content block.

2070

2071 - `defer_loading: optional boolean`

2072

2073 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2074

2075 - `display_number: optional number or null`

2076

2077 The X11 display number (e.g. 0, 1) for the display.

2078

2079 minimum: 0

2080

2081 - `input_examples: optional array of map[unknown]`

2082

2083 - `strict: optional boolean`

2084

2085 When true, guarantees schema validation on tool names and inputs

2086

2087 - `BetaMemoryTool20250818 object`

2088

2089 - `type: "memory_20250818"`

2090

2091 - `name: "memory"`

2092

2093 Name of the tool.

2094

2095 This is how the tool will be called by the model and in `tool_use` blocks.

2096

2097 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2098

2099 - `"direct"`

2100

2101 - `"code_execution_20250825"`

2102

2103 - `"code_execution_20260120"`

2104

2105 - `"code_execution_20260521"`

2106

2107 - `cache_control: optional BetaCacheControlEphemeral or null`

2108

2109 Create a cache control breakpoint at this content block.

2110

2111 - `defer_loading: optional boolean`

2112

2113 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2114

2115 - `input_examples: optional array of map[unknown]`

2116

2117 - `strict: optional boolean`

2118

2119 When true, guarantees schema validation on tool names and inputs

2120

2121 - `BetaToolComputerUse20250124 object`

2122

2123 - `type: "computer_20250124"`

2124

2125 - `display_height_px: number`

2126

2127 The height of the display in pixels.

2128

2129 minimum: 1

2130

2131 - `display_width_px: number`

2132

2133 The width of the display in pixels.

2134

2135 minimum: 1

2136

2137 - `name: "computer"`

2138

2139 Name of the tool.

2140

2141 This is how the tool will be called by the model and in `tool_use` blocks.

2142

2143 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2144

2145 - `"direct"`

2146

2147 - `"code_execution_20250825"`

2148

2149 - `"code_execution_20260120"`

2150

2151 - `"code_execution_20260521"`

2152

2153 - `cache_control: optional BetaCacheControlEphemeral or null`

2154

2155 Create a cache control breakpoint at this content block.

2156

2157 - `defer_loading: optional boolean`

2158

2159 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2160

2161 - `display_number: optional number or null`

2162

2163 The X11 display number (e.g. 0, 1) for the display.

2164

2165 minimum: 0

2166

2167 - `input_examples: optional array of map[unknown]`

2168

2169 - `strict: optional boolean`

2170

2171 When true, guarantees schema validation on tool names and inputs

2172

2173 - `BetaToolTextEditor20241022 object`

2174

2175 - `type: "text_editor_20241022"`

2176

2177 - `name: "str_replace_editor"`

2178

2179 Name of the tool.

2180

2181 This is how the tool will be called by the model and in `tool_use` blocks.

2182

2183 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2184

2185 - `"direct"`

2186

2187 - `"code_execution_20250825"`

2188

2189 - `"code_execution_20260120"`

2190

2191 - `"code_execution_20260521"`

2192

2193 - `cache_control: optional BetaCacheControlEphemeral or null`

2194

2195 Create a cache control breakpoint at this content block.

2196

2197 - `defer_loading: optional boolean`

2198

2199 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2200

2201 - `input_examples: optional array of map[unknown]`

2202

2203 - `strict: optional boolean`

2204

2205 When true, guarantees schema validation on tool names and inputs

2206

2207 - `BetaToolComputerUse20251124 object`

2208

2209 - `type: "computer_20251124"`

2210

2211 - `display_height_px: number`

2212

2213 The height of the display in pixels.

2214

2215 minimum: 1

2216

2217 - `display_width_px: number`

2218

2219 The width of the display in pixels.

2220

2221 minimum: 1

2222

2223 - `name: "computer"`

2224

2225 Name of the tool.

2226

2227 This is how the tool will be called by the model and in `tool_use` blocks.

2228

2229 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2230

2231 - `"direct"`

2232

2233 - `"code_execution_20250825"`

2234

2235 - `"code_execution_20260120"`

2236

2237 - `"code_execution_20260521"`

2238

2239 - `cache_control: optional BetaCacheControlEphemeral or null`

2240

2241 Create a cache control breakpoint at this content block.

2242

2243 - `defer_loading: optional boolean`

2244

2245 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2246

2247 - `display_number: optional number or null`

2248

2249 The X11 display number (e.g. 0, 1) for the display.

2250

2251 minimum: 0

2252

2253 - `enable_zoom: optional boolean`

2254

2255 Whether to enable an action to take a zoomed-in screenshot of the screen.

2256

2257 - `input_examples: optional array of map[unknown]`

2258

2259 - `strict: optional boolean`

2260

2261 When true, guarantees schema validation on tool names and inputs

2262

2263 - `BetaComputerToolset20260801 object`

2264

2265 The computer toolset: a single `tools[]` entry (carrying no

2266 `name`) that declares the computer tool family. The model is

2267 served the family's tool with any members disabled via `configs`

2268 removed from its schema. Every member is enabled by default, zoom

2269 included. The single-tool options `display_number` and

2270 `enable_zoom` are not fields of a toolset entry — it carries only

2271 `type`, `configs`, and `cache_control`; zoom is controlled

2272 via `configs.zoom.enabled`.

2273

2274 - `type: "computer_toolset_20260801"`

2275

2276 - `cache_control: optional BetaCacheControlEphemeral or null`

2277

2278 Create a cache control breakpoint at this content block.

2279

2280 - `configs: optional BetaComputerToolsetConfigs or null`

2281

2282 Per-member configuration for `computer_toolset_20260801`: one

2283 optional field per member tool, keyed by the member name — the same

2284 name the member's `tool_use` blocks carry. Every member is an

2285 accepted key, and a member's defaults apply wherever its key is

2286 absent. Unknown keys are rejected: the field set is this toolset

2287 version's complete member set.

2288

2289 - `type: optional BetaComputerTypeConfig or null`

2290

2291 `type`'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 - `cursor_position: optional BetaComputerCursorPositionConfig or null`

2302

2303 `cursor_position`'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 - `double_click: optional BetaComputerDoubleClickConfig or null`

2314

2315 `double_click`'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 - `hold_key: optional BetaComputerHoldKeyConfig or null`

2326

2327 `hold_key`'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 BetaComputerKeyConfig 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 BetaComputerLeftClickConfig 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 BetaComputerLeftClickDragConfig 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 BetaComputerLeftMouseDownConfig 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 BetaComputerLeftMouseUpConfig 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 - `middle_click: optional BetaComputerMiddleClickConfig or null`

2398

2399 `middle_click`'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 - `mouse_move: optional BetaComputerMouseMoveConfig or null`

2410

2411 `mouse_move`'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 - `right_click: optional BetaComputerRightClickConfig or null`

2422

2423 `right_click`'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 - `screenshot: optional BetaComputerScreenshotConfig or null`

2434

2435 `screenshot`'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 - `scroll: optional BetaComputerScrollConfig or null`

2446

2447 `scroll`'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 - `triple_click: optional BetaComputerTripleClickConfig or null`

2458

2459 `triple_click`'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 - `wait: optional BetaComputerWaitConfig or null`

2470

2471 `wait`'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 - `zoom: optional BetaComputerZoomConfig or null`

2482

2483 `zoom`'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 - `BetaToolTextEditor20250124 object`

2494

2495 - `type: "text_editor_20250124"`

2496

2497 - `name: "str_replace_editor"`

2498

2499 Name of the tool.

2500

2501 This is how the tool will be called by the model and in `tool_use` blocks.

2502

2503 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2504

2505 - `"direct"`

2506

2507 - `"code_execution_20250825"`

2508

2509 - `"code_execution_20260120"`

2510

2511 - `"code_execution_20260521"`

2512

2513 - `cache_control: optional BetaCacheControlEphemeral or null`

2514

2515 Create a cache control breakpoint at this content block.

2516

2517 - `defer_loading: optional boolean`

2518

2519 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2520

2521 - `input_examples: optional array of map[unknown]`

2522

2523 - `strict: optional boolean`

2524

2525 When true, guarantees schema validation on tool names and inputs

2526

2527 - `BetaToolTextEditor20250429 object`

2528

2529 - `type: "text_editor_20250429"`

2530

2531 - `name: "str_replace_based_edit_tool"`

2532

2533 Name of the tool.

2534

2535 This is how the tool will be called by the model and in `tool_use` blocks.

2536

2537 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2538

2539 - `"direct"`

2540

2541 - `"code_execution_20250825"`

2542

2543 - `"code_execution_20260120"`

2544

2545 - `"code_execution_20260521"`

2546

2547 - `cache_control: optional BetaCacheControlEphemeral or null`

2548

2549 Create a cache control breakpoint at this content block.

2550

2551 - `defer_loading: optional boolean`

2552

2553 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2554

2555 - `input_examples: optional array of map[unknown]`

2556

2557 - `strict: optional boolean`

2558

2559 When true, guarantees schema validation on tool names and inputs

2560

2561 - `BetaToolTextEditor20250728 object`

2562

2563 - `type: "text_editor_20250728"`

2564

2565 - `name: "str_replace_based_edit_tool"`

2566

2567 Name of the tool.

2568

2569 This is how the tool will be called by the model and in `tool_use` blocks.

2570

2571 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2572

2573 - `"direct"`

2574

2575 - `"code_execution_20250825"`

2576

2577 - `"code_execution_20260120"`

2578

2579 - `"code_execution_20260521"`

2580

2581 - `cache_control: optional BetaCacheControlEphemeral or null`

2582

2583 Create a cache control breakpoint at this content block.

2584

2585 - `defer_loading: optional boolean`

2586

2587 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2588

2589 - `input_examples: optional array of map[unknown]`

2590

2591 - `max_characters: optional number or null`

2592

2593 Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

2594

2595 minimum: 1

2596

2597 - `strict: optional boolean`

2598

2599 When true, guarantees schema validation on tool names and inputs

2600

2601 - `BetaWebSearchTool20250305 object`

2602

2603 - `type: "web_search_20250305"`

2604

2605 - `name: "web_search"`

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 - `allowed_domains: optional array of string or null`

2622

2623 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

2624

2625 - `blocked_domains: optional array of string or null`

2626

2627 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

2628

2629 - `cache_control: optional BetaCacheControlEphemeral or null`

2630

2631 Create a cache control breakpoint at this content block.

2632

2633 - `defer_loading: optional boolean`

2634

2635 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2636

2637 - `max_uses: optional number or null`

2638

2639 Maximum number of times the tool can be used in the API request.

2640

2641 exclusiveMinimum: 0

2642

2643 - `strict: optional boolean`

2644

2645 When true, guarantees schema validation on tool names and inputs

2646

2647 - `user_location: optional BetaUserLocation or null`

2648

2649 Parameters for the user's location. Used to provide more relevant search results.

2650

2651 - `type: "approximate"`

2652

2653 - `city: optional string or null`

2654

2655 The city of the user.

2656

2657 maxLength: 255, minLength: 1

2658

2659 - `country: optional string or null`

2660

2661 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.

2662

2663 maxLength: 2, minLength: 2

2664

2665 - `region: optional string or null`

2666

2667 The region of the user.

2668

2669 maxLength: 255, minLength: 1

2670

2671 - `timezone: optional string or null`

2672

2673 The [IANA timezone](https://nodatime.org/TimeZones) of the user.

2674

2675 maxLength: 255, minLength: 1

2676

2677 - `BetaWebFetchTool20250910 object`

2678

2679 - `type: "web_fetch_20250910"`

2680

2681 - `name: "web_fetch"`

2682

2683 Name of the tool.

2684

2685 This is how the tool will be called by the model and in `tool_use` blocks.

2686

2687 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2688

2689 - `"direct"`

2690

2691 - `"code_execution_20250825"`

2692

2693 - `"code_execution_20260120"`

2694

2695 - `"code_execution_20260521"`

2696

2697 - `allowed_domains: optional array of string or null`

2698

2699 List of domains to allow fetching from

2700

2701 - `blocked_domains: optional array of string or null`

2702

2703 List of domains to block fetching from

2704

2705 - `cache_control: optional BetaCacheControlEphemeral or null`

2706

2707 Create a cache control breakpoint at this content block.

2708

2709 - `citations: optional BetaCitationsConfigParam or null`

2710

2711 Citations configuration for fetched documents. Citations are disabled by default.

2712

2713 - `defer_loading: optional boolean`

2714

2715 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2716

2717 - `max_content_tokens: optional number or null`

2718

2719 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.

2720

2721 exclusiveMinimum: 0

2722

2723 - `max_uses: optional number or null`

2724

2725 Maximum number of times the tool can be used in the API request.

2726

2727 exclusiveMinimum: 0

2728

2729 - `strict: optional boolean`

2730

2731 When true, guarantees schema validation on tool names and inputs

2732

2733 - `url_sources: optional BetaWebFetchURLSources or null`

2734

2735 Which sources contribute to the set of URLs web fetch may fetch.

2736

2737 Each key is a tagged variant: `user_input` is `all` or `none`; the

2738 two tool filters are `all`, `none`, `only` (only the named tools'

2739 results) or `except` (every result but the named tools'). A named tool

2740 must be declared in this request's `tools[]`.

2741

2742 - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`

2743

2744 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

2745

2746 - `BetaWebFetchURLSourceAll object`

2747

2748 The `url_sources` variant under which a source contributes in

2749 full: every result of the tool filter's source, or all user input.

2750

2751 - `type: "all"`

2752

2753 - `BetaWebFetchURLSourceNone object`

2754

2755 The `url_sources` variant under which a source contributes nothing:

2756 no result of the tool filter's source, or no user input.

2757

2758 - `type: "none"`

2759

2760 - `BetaWebFetchURLSourceOnly object`

2761

2762 The tool filter variant under which only the named tools' results

2763 contribute.

2764

2765 - `type: "only"`

2766

2767 - `tools: array of BetaWebFetchURLSourceToolReference`

2768

2769 - `type: "tool_reference"`

2770

2771 - `name: string`

2772

2773 - `BetaWebFetchURLSourceExcept object`

2774

2775 The tool filter variant under which every result but the named

2776 tools' contributes.

2777

2778 - `type: "except"`

2779

2780 - `tools: array of BetaWebFetchURLSourceToolReference`

2781

2782 - `type: "tool_reference"`

2783

2784 - `name: string`

2785

2786 - `server_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`

2787

2788 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.

2789

2790 - `BetaWebFetchURLSourceAll object`

2791

2792 The `url_sources` variant under which a source contributes in

2793 full: every result of the tool filter's source, or all user input.

2794

2795 - `BetaWebFetchURLSourceNone object`

2796

2797 The `url_sources` variant under which a source contributes nothing:

2798 no result of the tool filter's source, or no user input.

2799

2800 - `BetaWebFetchURLSourceOnly object`

2801

2802 The tool filter variant under which only the named tools' results

2803 contribute.

2804

2805 - `BetaWebFetchURLSourceExcept object`

2806

2807 The tool filter variant under which every result but the named

2808 tools' contributes.

2809

2810 - `user_input: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone`

2811

2812 Whether URLs in user messages are fetchable: "all" or "none".

2813

2814 - `BetaWebFetchURLSourceAll object`

2815

2816 The `url_sources` variant under which a source contributes in

2817 full: every result of the tool filter's source, or all user input.

2818

2819 - `BetaWebFetchURLSourceNone object`

2820

2821 The `url_sources` variant under which a source contributes nothing:

2822 no result of the tool filter's source, or no user input.

2823

2824 - `BetaWebSearchTool20260209 object`

2825

2826 - `type: "web_search_20260209"`

2827

2828 - `name: "web_search"`

2829

2830 Name of the tool.

2831

2832 This is how the tool will be called by the model and in `tool_use` blocks.

2833

2834 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2835

2836 - `"direct"`

2837

2838 - `"code_execution_20250825"`

2839

2840 - `"code_execution_20260120"`

2841

2842 - `"code_execution_20260521"`

2843

2844 - `allowed_domains: optional array of string or null`

2845

2846 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

2847

2848 - `blocked_domains: optional array of string or null`

2849

2850 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

2851

2852 - `cache_control: optional BetaCacheControlEphemeral or null`

2853

2854 Create a cache control breakpoint at this content block.

2855

2856 - `defer_loading: optional boolean`

2857

2858 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2859

2860 - `max_uses: optional number or null`

2861

2862 Maximum number of times the tool can be used in the API request.

2863

2864 exclusiveMinimum: 0

2865

2866 - `strict: optional boolean`

2867

2868 When true, guarantees schema validation on tool names and inputs

2869

2870 - `user_location: optional BetaUserLocation or null`

2871

2872 Parameters for the user's location. Used to provide more relevant search results.

2873

2874 - `BetaWebFetchTool20260209 object`

2875

2876 - `type: "web_fetch_20260209"`

2877

2878 - `name: "web_fetch"`

2879

2880 Name of the tool.

2881

2882 This is how the tool will be called by the model and in `tool_use` blocks.

2883

2884 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2885

2886 - `"direct"`

2887

2888 - `"code_execution_20250825"`

2889

2890 - `"code_execution_20260120"`

2891

2892 - `"code_execution_20260521"`

2893

2894 - `allowed_domains: optional array of string or null`

2895

2896 List of domains to allow fetching from

2897

2898 - `blocked_domains: optional array of string or null`

2899

2900 List of domains to block fetching from

2901

2902 - `cache_control: optional BetaCacheControlEphemeral or null`

2903

2904 Create a cache control breakpoint at this content block.

2905

2906 - `citations: optional BetaCitationsConfigParam or null`

2907

2908 Citations configuration for fetched documents. Citations are disabled by default.

2909

2910 - `defer_loading: optional boolean`

2911

2912 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2913

2914 - `max_content_tokens: optional number or null`

2915

2916 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.

2917

2918 exclusiveMinimum: 0

2919

2920 - `max_uses: optional number or null`

2921

2922 Maximum number of times the tool can be used in the API request.

2923

2924 exclusiveMinimum: 0

2925

2926 - `strict: optional boolean`

2927

2928 When true, guarantees schema validation on tool names and inputs

2929

2930 - `url_sources: optional BetaWebFetchURLSources or null`

2931

2932 Which sources contribute to the set of URLs web fetch may fetch.

2933

2934 Each key is a tagged variant: `user_input` is `all` or `none`; the

2935 two tool filters are `all`, `none`, `only` (only the named tools'

2936 results) or `except` (every result but the named tools'). A named tool

2937 must be declared in this request's `tools[]`.

2938

2939 - `BetaWebFetchTool20260309 object`

2940

2941 Web fetch tool with use_cache parameter for bypassing cached content.

2942

2943 - `type: "web_fetch_20260309"`

2944

2945 - `name: "web_fetch"`

2946

2947 Name of the tool.

2948

2949 This is how the tool will be called by the model and in `tool_use` blocks.

2950

2951 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2952

2953 - `"direct"`

2954

2955 - `"code_execution_20250825"`

2956

2957 - `"code_execution_20260120"`

2958

2959 - `"code_execution_20260521"`

2960

2961 - `allowed_domains: optional array of string or null`

2962

2963 List of domains to allow fetching from

2964

2965 - `blocked_domains: optional array of string or null`

2966

2967 List of domains to block fetching from

2968

2969 - `cache_control: optional BetaCacheControlEphemeral or null`

2970

2971 Create a cache control breakpoint at this content block.

2972

2973 - `citations: optional BetaCitationsConfigParam or null`

2974

2975 Citations configuration for fetched documents. Citations are disabled by default.

2976

2977 - `defer_loading: optional boolean`

2978

2979 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2980

2981 - `max_content_tokens: optional number or null`

2982

2983 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.

2984

2985 exclusiveMinimum: 0

2986

2987 - `max_uses: optional number or null`

2988

2989 Maximum number of times the tool can be used in the API request.

2990

2991 exclusiveMinimum: 0

2992

2993 - `strict: optional boolean`

2994

2995 When true, guarantees schema validation on tool names and inputs

2996

2997 - `url_sources: optional BetaWebFetchURLSources or null`

2998

2999 Which sources contribute to the set of URLs web fetch may fetch.

3000

3001 Each key is a tagged variant: `user_input` is `all` or `none`; the

3002 two tool filters are `all`, `none`, `only` (only the named tools'

3003 results) or `except` (every result but the named tools'). A named tool

3004 must be declared in this request's `tools[]`.

3005

3006 - `use_cache: optional boolean`

3007

3008 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.

3009

3010 - `BetaWebSearchTool20260318 object`

3011

3012 - `type: "web_search_20260318"`

3013

3014 - `name: "web_search"`

3015

3016 Name of the tool.

3017

3018 This is how the tool will be called by the model and in `tool_use` blocks.

3019

3020 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

3021

3022 - `"direct"`

3023

3024 - `"code_execution_20250825"`

3025

3026 - `"code_execution_20260120"`

3027

3028 - `"code_execution_20260521"`

3029

3030 - `allowed_domains: optional array of string or null`

3031

3032 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

3033

3034 - `blocked_domains: optional array of string or null`

3035

3036 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

3037

3038 - `cache_control: optional BetaCacheControlEphemeral or null`

3039

3040 Create a cache control breakpoint at this content block.

3041

3042 - `defer_loading: optional boolean`

3043

3044 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3045

3046 - `max_uses: optional number or null`

3047

3048 Maximum number of times the tool can be used in the API request.

3049

3050 exclusiveMinimum: 0

3051

3052 - `response_inclusion: optional "full" or "excluded"`

3053

3054 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.

3055

3056 - `"full"`

3057

3058 - `"excluded"`

3059

3060 - `strict: optional boolean`

3061

3062 When true, guarantees schema validation on tool names and inputs

3063

3064 - `user_location: optional BetaUserLocation or null`

3065

3066 Parameters for the user's location. Used to provide more relevant search results.

3067

3068 - `BetaWebFetchTool20260318 object`

3069

3070 - `type: "web_fetch_20260318"`

3071

3072 - `name: "web_fetch"`

3073

3074 Name of the tool.

3075

3076 This is how the tool will be called by the model and in `tool_use` blocks.

3077

3078 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

3079

3080 - `"direct"`

3081

3082 - `"code_execution_20250825"`

3083

3084 - `"code_execution_20260120"`

3085

3086 - `"code_execution_20260521"`

3087

3088 - `allowed_domains: optional array of string or null`

3089

3090 List of domains to allow fetching from

3091

3092 - `blocked_domains: optional array of string or null`

3093

3094 List of domains to block fetching from

3095

3096 - `cache_control: optional BetaCacheControlEphemeral or null`

3097

3098 Create a cache control breakpoint at this content block.

3099

3100 - `citations: optional BetaCitationsConfigParam or null`

3101

3102 Citations configuration for fetched documents. Citations are disabled by default.

3103

3104 - `defer_loading: optional boolean`

3105

3106 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3107

3108 - `max_content_tokens: optional number or null`

3109

3110 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.

3111

3112 exclusiveMinimum: 0

3113

3114 - `max_uses: optional number or null`

3115

3116 Maximum number of times the tool can be used in the API request.

3117

3118 exclusiveMinimum: 0

3119

3120 - `response_inclusion: optional "full" or "excluded"`

3121

3122 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.

3123

3124 - `"full"`

3125

3126 - `"excluded"`

3127

3128 - `strict: optional boolean`

3129

3130 When true, guarantees schema validation on tool names and inputs

3131

3132 - `url_sources: optional BetaWebFetchURLSources or null`

3133

3134 Which sources contribute to the set of URLs web fetch may fetch.

3135

3136 Each key is a tagged variant: `user_input` is `all` or `none`; the

3137 two tool filters are `all`, `none`, `only` (only the named tools'

3138 results) or `except` (every result but the named tools'). A named tool

3139 must be declared in this request's `tools[]`.

3140

3141 - `use_cache: optional boolean`

3142

3143 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.

3144

3145 - `BetaAdvisorTool20260301 object`

3146

3147 - `type: "advisor_20260301"`

3148

3149 - `model: Model`

3150

3151 The model that will complete your prompt.

3152

3153 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

3154

3155 - `"claude-fable-5-1" or "claude-opus-5-5" or "claude-mythos-5-1" or 15 more`

3156

3157 The model that will complete your prompt.

3158

3159 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

3160

3161 - `"claude-fable-5-1"`

3162

3163 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows

3164

3165 - `"claude-opus-5-5"`

3166

3167 Powerful intelligence for coding, knowledge work, and long-running agents

3168

3169 - `"claude-mythos-5-1"`

3170

3171 Our most capable model for cybersecurity and biology research, available through trusted access programs

3172

3173 - `"claude-sonnet-5"`

3174

3175 High-performance model for coding and agents

3176

3177 - `"claude-fable-5"`

3178

3179 Next generation of intelligence for the hardest knowledge work and coding problems

3180

3181 - `"claude-mythos-5"`

3182

3183 Most capable model for cybersecurity and biology research

3184

3185 - `"claude-opus-5"`

3186

3187 Powerful intelligence for long-running agents and coding

3188

3189 - `"claude-opus-4-8"`

3190

3191 Powerful intelligence for long-running agents and coding

3192

3193 - `"claude-opus-4-7"`

3194

3195 Powerful intelligence for long-running agents and coding

3196

3197 - `"claude-mythos-preview"`

3198

3199 New class of intelligence, strongest in coding and cybersecurity

3200

3201 - `"claude-opus-4-6"`

3202

3203 Powerful intelligence for long-running agents and coding

3204

3205 - `"claude-sonnet-4-6"`

3206

3207 Best combination of speed and intelligence

3208

3209 - `"claude-haiku-4-5"`

3210

3211 Fastest model with near-frontier intelligence

3212

3213 - `"claude-haiku-4-5-20251001"`

3214

3215 Fastest model with near-frontier intelligence

3216

3217 - `"claude-opus-4-5"`

3218

3219 Powerful intelligence for long-running agents and coding

3220

3221 - `"claude-opus-4-5-20251101"`

3222

3223 Powerful intelligence for long-running agents and coding

3224

3225 - `"claude-sonnet-4-5"`

3226

3227 High-performance model for agents and coding

3228

3229 - `"claude-sonnet-4-5-20250929"`

3230

3231 High-performance model for agents and coding

3232

3233 - `string`

3234

3235 - `name: "advisor"`

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 - `cache_control: optional BetaCacheControlEphemeral or null`

3252

3253 Create a cache control breakpoint at this content block.

3254

3255 - `caching: optional BetaCacheControlEphemeral or null`

3256

3257 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.

3258

3259 - `defer_loading: optional boolean`

3260

3261 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3262

3263 - `max_tokens: optional number or null`

3264

3265 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.

3266

3267 minimum: 1024

3268

3269 - `max_uses: optional number or null`

3270

3271 Maximum number of times the tool can be used in the API request.

3272

3273 exclusiveMinimum: 0

3274

3275 - `strict: optional boolean`

3276

3277 When true, guarantees schema validation on tool names and inputs

3278

3279 - `BetaToolSearchToolBm25_20251119 object`

3280

3281 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`

3282

3283 - `"tool_search_tool_bm25_20251119"`

3284

3285 - `"tool_search_tool_bm25"`

3286

3287 - `name: "tool_search_tool_bm25"`

3288

3289 Name of the tool.

3290

3291 This is how the tool will be called by the model and in `tool_use` blocks.

3292

3293 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

3294

3295 - `"direct"`

3296

3297 - `"code_execution_20250825"`

3298

3299 - `"code_execution_20260120"`

3300

3301 - `"code_execution_20260521"`

3302

3303 - `cache_control: optional BetaCacheControlEphemeral or null`

3304

3305 Create a cache control breakpoint at this content block.

3306

3307 - `defer_loading: optional boolean`

3308

3309 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3310

3311 - `strict: optional boolean`

3312

3313 When true, guarantees schema validation on tool names and inputs

3314

3315 - `BetaToolSearchToolRegex20251119 object`

3316

3317 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`

3318

3319 - `"tool_search_tool_regex_20251119"`

3320

3321 - `"tool_search_tool_regex"`

3322

3323 - `name: "tool_search_tool_regex"`

3324

3325 Name of the tool.

3326

3327 This is how the tool will be called by the model and in `tool_use` blocks.

3328

3329 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

3330

3331 - `"direct"`

3332

3333 - `"code_execution_20250825"`

3334

3335 - `"code_execution_20260120"`

3336

3337 - `"code_execution_20260521"`

3338

3339 - `cache_control: optional BetaCacheControlEphemeral or null`

3340

3341 Create a cache control breakpoint at this content block.

3342

3343 - `defer_loading: optional boolean`

3344

3345 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3346

3347 - `strict: optional boolean`

3348

3349 When true, guarantees schema validation on tool names and inputs

3350

3351 - `BetaMCPToolset object`

3352

3353 Configuration for a group of tools from an MCP server.

3354

3355 Allows configuring enabled status and defer_loading for all tools

3356 from an MCP server, with optional per-tool overrides.

3357

3358 - `type: "mcp_toolset"`

3359

3360 - `mcp_server_name: string`

3361

3362 Name of the MCP server to configure tools for

3363

3364 maxLength: 255, minLength: 1

3365

3366 - `cache_control: optional BetaCacheControlEphemeral or null`

3367

3368 Create a cache control breakpoint at this content block.

3369

3370 - `configs: optional map[BetaMCPToolConfig] or null`

3371

3372 Configuration overrides for specific tools, keyed by tool name

3373

3374 - `defer_loading: optional boolean`

3375

3376 - `enabled: optional boolean`

3377

3378 - `default_config: optional BetaMCPToolDefaultConfig`

3379

3380 Default configuration applied to all tools from this server

3381

3382 - `defer_loading: optional boolean`

3383

3384 - `enabled: optional boolean`

3385

3386 - `tools: optional array of BetaMCPToolParam or null`

3387

3388 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.

3389

3390 - `input_schema: map[unknown]`

3391

3392 The tool's input schema as the MCP server lists it, verbatim.

3393

3394 - `name: string`

3395

3396 The tool's name as the MCP server lists it (not prefixed with the server name).

3397

3398 minLength: 1

3399

3400 - `description: optional string or null`

3401

3402 The tool's description as the MCP server lists it.

3403

3404 - `cache_control: optional BetaCacheControlEphemeral or null`

3405

3406 Create a cache control breakpoint at this content block.

3407

3408 - `BetaRequestToolRemovalBlock object`

3409

3410 Mid-conversation directive to withdraw a tool.

3411

3412 `tool` references a tool (or MCP toolset) by name: one declared in the

3413 request's `tools` or defined earlier in `messages`. It is no longer

3414 offered to the model from this point in the conversation onward.

3415

3416 - `type: "tool_removal"`

3417

3418 - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference`

3419

3420 - `BetaToolChangeToolReference object`

3421

3422 Reference to a single tool, by the name the model uses to call it: a

3423 tool declared in `tools` or defined by an earlier `tool_addition`

3424 block. Does not accept the composed `{server}_{name}` form the server

3425 assigns to MCP-resolved tools; use `mcp_tool_reference` or

3426 `mcp_toolset_reference` for those.

3427

3428 - `BetaToolChangeMCPToolReference object`

3429

3430 Reference to a single MCP tool by its server and remote name; the

3431 same `server_name`/`name` pair `mcp_tool_use` carries.

3432

3433 - `BetaToolChangeMCPToolsetReference object`

3434

3435 Reference to every tool in the named MCP server's toolset.

3436

3437 - `cache_control: optional BetaCacheControlEphemeral or null`

3438

3439 Create a cache control breakpoint at this content block.

3440

13163441 - `BetaRequestToolAdditionBlock object`

13173442

1318 Mid-conversation directive to surface a declared tool.

1319

1320 `tool` references a tool (or MCP toolset) by name from the request's

1321 `tools`; it is offered to the model from this point in the

1322 conversation onward.

1323

1324 - `type: "tool_addition"`

1325

1326 - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference`

1327

1328 - `BetaToolChangeToolReference object`

1329

1330 Reference to a single tool the caller declared directly in

1331 `tools[]`. Does not accept the composed `{server}_{name}` form the

1332 server assigns to MCP-resolved tools — use `mcp_tool_reference` or

1333 `mcp_toolset_reference` for those.

1334

1335 - `type: "tool_reference"`

1336

1337 - `name: string`

1338

1339 pattern: ^[a-zA-Z0-9_-]{1,128}$

1340

1341 - `BetaToolChangeMCPToolReference object`

1342

1343 Reference to a single MCP tool by its server and remote name; the

1344 same `server_name`/`name` pair `mcp_tool_use` carries.

1345

1346 - `type: "mcp_tool_reference"`

1347

1348 - `name: string`

1349

1350 - `server_name: string`

1351

1352 - `BetaToolChangeMCPToolsetReference object`

1353

1354 Reference to every tool in the named MCP server's toolset.

1355

1356 - `type: "mcp_toolset_reference"`

1357

1358 - `server_name: string`

1359

1360 - `cache_control: optional BetaCacheControlEphemeral or null`

1361

1362 Create a cache control breakpoint at this content block.

3443 Mid-conversation directive to make a tool available.

3444

3445 `tool` is a reference to a tool (or MCP toolset) declared in the

3446 request's `tools`. Under the `inline-tools-2026-09-15` beta it may

3447 instead be a reference to a tool defined earlier in `messages`, or a

3448 `tool_definition` object that carries an inline tool definition in

3449 `definition` (the same object a `tools` entry holds). An `mcp_toolset`

3450 definition also requires the `mcp-client-2026-09-15` beta. The tool is

3451 offered to the model from this point in the conversation onward.

13633452

13643453 - `BetaRequestToolRemovalBlock object`

13653454

13663455 Mid-conversation directive to withdraw a tool.

13673456

1368 `tool` references a tool (or MCP toolset) by name from the request's

1369 `tools`; it is no longer offered to the model from this point in the

1370 conversation onward.

1371

1372 - `type: "tool_removal"`

1373

1374 - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference`

1375

1376 - `BetaToolChangeToolReference object`

1377

1378 Reference to a single tool the caller declared directly in

1379 `tools[]`. Does not accept the composed `{server}_{name}` form the

1380 server assigns to MCP-resolved tools — use `mcp_tool_reference` or

1381 `mcp_toolset_reference` for those.

1382

1383 - `BetaToolChangeMCPToolReference object`

1384

1385 Reference to a single MCP tool by its server and remote name; the

1386 same `server_name`/`name` pair `mcp_tool_use` carries.

1387

1388 - `BetaToolChangeMCPToolsetReference object`

1389

1390 Reference to every tool in the named MCP server's toolset.

1391

1392 - `cache_control: optional BetaCacheControlEphemeral or null`

1393

1394 Create a cache control breakpoint at this content block.

3457 `tool` references a tool (or MCP toolset) by name: one declared in the

3458 request's `tools` or defined earlier in `messages`. It is no longer

3459 offered to the model from this point in the conversation onward.

3460

3461 - `BetaMCPToolListingBlockParam object`

3462

3463 The tool listing an MCP server returned while an earlier response was

3464 produced, as that response carried it. Send the assistant message back

3465 unchanged, this block included, and the server uses this listing for the

3466 matching `mcp_toolset` instead of asking the MCP server again.

3467

3468 - `type: "mcp_tool_listing"`

3469

3470 - `mcp_server_name: string`

3471

3472 The name of the MCP server this listing came from, as `mcp_servers` declares it.

3473

3474 maxLength: 255, minLength: 1

3475

3476 - `tools: array of BetaMCPToolParam`

3477

3478 The server's tools, exactly as the response listed them.

3479

3480 - `input_schema: map[unknown]`

3481

3482 The tool's input schema as the MCP server lists it, verbatim.

3483

3484 - `name: string`

3485

3486 The tool's name as the MCP server lists it (not prefixed with the server name).

3487

3488 minLength: 1

3489

3490 - `description: optional string or null`

3491

3492 The tool's description as the MCP server lists it.

13953493

13963494 - `BetaFallbackBlockParam object`

13973495

from line 3518

14203518 The model that will complete your prompt.

14213519

14223520 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

1423

1424 - `"claude-fable-5-1" or "claude-mythos-5-1" or "claude-sonnet-5" or 14 more`

1425

1426 The model that will complete your prompt.

1427

1428 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

1429

1430 - `"claude-fable-5-1"`

1431

1432 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows

1433

1434 - `"claude-mythos-5-1"`

1435

1436 Our most capable model for cybersecurity and biology research, available through trusted access programs

1437

1438 - `"claude-sonnet-5"`

1439

1440 High-performance model for coding and agents

1441

1442 - `"claude-fable-5"`

1443

1444 Next generation of intelligence for the hardest knowledge work and coding problems

1445

1446 - `"claude-mythos-5"`

1447

1448 Most capable model for cybersecurity and biology research

1449

1450 - `"claude-opus-5"`

1451

1452 Powerful intelligence for long-running agents and coding

1453

1454 - `"claude-opus-4-8"`

1455

1456 Powerful intelligence for long-running agents and coding

1457

1458 - `"claude-opus-4-7"`

1459

1460 Powerful intelligence for long-running agents and coding

1461

1462 - `"claude-mythos-preview"`

1463

1464 New class of intelligence, strongest in coding and cybersecurity

1465

1466 - `"claude-opus-4-6"`

1467

1468 Powerful intelligence for long-running agents and coding

1469

1470 - `"claude-sonnet-4-6"`

1471

1472 Best combination of speed and intelligence

1473

1474 - `"claude-haiku-4-5"`

1475

1476 Fastest model with near-frontier intelligence

1477

1478 - `"claude-haiku-4-5-20251001"`

1479

1480 Fastest model with near-frontier intelligence

1481

1482 - `"claude-opus-4-5"`

1483

1484 Powerful intelligence for long-running agents and coding

1485

1486 - `"claude-opus-4-5-20251101"`

1487

1488 Powerful intelligence for long-running agents and coding

1489

1490 - `"claude-sonnet-4-5"`

1491

1492 High-performance model for agents and coding

1493

1494 - `"claude-sonnet-4-5-20250929"`

1495

1496 High-performance model for agents and coding

1497

1498 - `string`

14993521

15003522 - `to: BetaFallbackInfoParam`

15013523

from line 4164

21424164

21434165 - `BetaTool object`

21444166

2145 - `type: optional "custom" or null`

2146

2147 - `input_schema: object`

2148

2149 [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.

2150

2151 This defines the shape of the `input` that your tool accepts and that the model will produce.

2152

2153 - `type: "object"`

2154

2155 - `properties: optional map[unknown] or null`

2156

2157 - `required: optional array of string or null`

2158

2159 - `name: string`

2160

2161 Name of the tool.

2162

2163 This is how the tool will be called by the model and in `tool_use` blocks.

2164

2165 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$

2166

2167 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2168

2169 - `"direct"`

2170

2171 - `"code_execution_20250825"`

2172

2173 - `"code_execution_20260120"`

2174

2175 - `"code_execution_20260521"`

2176

2177 - `cache_control: optional BetaCacheControlEphemeral or null`

2178

2179 Create a cache control breakpoint at this content block.

2180

2181 - `defer_loading: optional boolean`

2182

2183 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2184

2185 - `description: optional string`

2186

2187 Description of what this tool does.

2188

2189 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.

2190

2191 - `eager_input_streaming: optional boolean or null`

2192

2193 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.

2194

2195 - `input_examples: optional array of map[unknown]`

2196

2197 - `strict: optional boolean`

2198

2199 When true, guarantees schema validation on tool names and inputs

2200

22014167 - `BetaToolBash20241022 object`

22024168

2203 - `type: "bash_20241022"`

2204

2205 - `name: "bash"`

2206

2207 Name of the tool.

2208

2209 This is how the tool will be called by the model and in `tool_use` blocks.

2210

2211 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2212

2213 - `"direct"`

2214

2215 - `"code_execution_20250825"`

2216

2217 - `"code_execution_20260120"`

2218

2219 - `"code_execution_20260521"`

2220

2221 - `cache_control: optional BetaCacheControlEphemeral or null`

2222

2223 Create a cache control breakpoint at this content block.

2224

2225 - `defer_loading: optional boolean`

2226

2227 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2228

2229 - `input_examples: optional array of map[unknown]`

2230

2231 - `strict: optional boolean`

2232

2233 When true, guarantees schema validation on tool names and inputs

2234

22354169 - `BetaToolBash20250124 object`

22364170

2237 - `type: "bash_20250124"`

2238

2239 - `name: "bash"`

2240

2241 Name of the tool.

2242

2243 This is how the tool will be called by the model and in `tool_use` blocks.

2244

2245 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2246

2247 - `"direct"`

2248

2249 - `"code_execution_20250825"`

2250

2251 - `"code_execution_20260120"`

2252

2253 - `"code_execution_20260521"`

2254

2255 - `cache_control: optional BetaCacheControlEphemeral or null`

2256

2257 Create a cache control breakpoint at this content block.

2258

2259 - `defer_loading: optional boolean`

2260

2261 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2262

2263 - `input_examples: optional array of map[unknown]`

2264

2265 - `strict: optional boolean`

2266

2267 When true, guarantees schema validation on tool names and inputs

2268

22694171 - `BetaCodeExecutionTool20250522 object`

22704172

2271 - `type: "code_execution_20250522"`

2272

2273 - `name: "code_execution"`

2274

2275 Name of the tool.

2276

2277 This is how the tool will be called by the model and in `tool_use` blocks.

2278

2279 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2280

2281 - `"direct"`

2282

2283 - `"code_execution_20250825"`

2284

2285 - `"code_execution_20260120"`

2286

2287 - `"code_execution_20260521"`

2288

2289 - `cache_control: optional BetaCacheControlEphemeral or null`

2290

2291 Create a cache control breakpoint at this content block.

2292

2293 - `defer_loading: optional boolean`

2294

2295 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2296

2297 - `strict: optional boolean`

2298

2299 When true, guarantees schema validation on tool names and inputs

2300

23014173 - `BetaCodeExecutionTool20250825 object`

23024174

2303 - `type: "code_execution_20250825"`

2304

2305 - `name: "code_execution"`

2306

2307 Name of the tool.

2308

2309 This is how the tool will be called by the model and in `tool_use` blocks.

2310

2311 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2312

2313 - `"direct"`

2314

2315 - `"code_execution_20250825"`

2316

2317 - `"code_execution_20260120"`

2318

2319 - `"code_execution_20260521"`

2320

2321 - `cache_control: optional BetaCacheControlEphemeral or null`

2322

2323 Create a cache control breakpoint at this content block.

2324

2325 - `defer_loading: optional boolean`

2326

2327 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2328

2329 - `strict: optional boolean`

2330

2331 When true, guarantees schema validation on tool names and inputs

2332

23334175 - `BetaCodeExecutionTool20260120 object`

23344176

23354177 Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).

23364178

2337 - `type: "code_execution_20260120"`

2338

2339 - `name: "code_execution"`

2340

2341 Name of the tool.

2342

2343 This is how the tool will be called by the model and in `tool_use` blocks.

2344

2345 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2346

2347 - `"direct"`

2348

2349 - `"code_execution_20250825"`

2350

2351 - `"code_execution_20260120"`

2352

2353 - `"code_execution_20260521"`

2354

2355 - `cache_control: optional BetaCacheControlEphemeral or null`

2356

2357 Create a cache control breakpoint at this content block.

2358

2359 - `defer_loading: optional boolean`

2360

2361 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2362

2363 - `strict: optional boolean`

2364

2365 When true, guarantees schema validation on tool names and inputs

2366

23674179 - `BetaCodeExecutionTool20260521 object`

23684180

23694181 Code execution tool with REPL state persistence.

2370

2371 - `type: "code_execution_20260521"`

2372

2373 - `name: "code_execution"`

2374

2375 Name of the tool.

2376

2377 This is how the tool will be called by the model and in `tool_use` blocks.

2378

2379 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2380

2381 - `"direct"`

2382

2383 - `"code_execution_20250825"`

2384

2385 - `"code_execution_20260120"`

2386

2387 - `"code_execution_20260521"`

2388

2389 - `cache_control: optional BetaCacheControlEphemeral or null`

2390

2391 Create a cache control breakpoint at this content block.

2392

2393 - `defer_loading: optional boolean`

2394

2395 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2396

2397 - `strict: optional boolean`

2398

2399 When true, guarantees schema validation on tool names and inputs

24004182

24014183 - `BetaBrowserToolset20260801 object`

24024184

from line 4187

24054187 the family's tool with any members disabled via `configs` removed

24064188 from its schema.

24074189

2408 - `type: "browser_toolset_20260801"`

2409

2410 - `cache_control: optional BetaCacheControlEphemeral or null`

2411

2412 Create a cache control breakpoint at this content block.

2413

2414 - `configs: optional BetaBrowserToolsetConfigs or null`

2415

2416 Per-member configuration for `browser_toolset_20260801`: one

2417 optional field per member tool, keyed by the member name — the same

2418 name the member's `tool_use` blocks carry. Every member is an

2419 accepted key, and a member's defaults apply wherever its key is

2420 absent. Unknown keys are rejected: the field set is this toolset

2421 version's complete member set.

2422

2423 - `type: optional BetaBrowserTypeConfig or null`

2424

2425 `type`'s config overrides.

2426

2427 - `defer_loading: optional boolean or null`

2428

2429 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2430

2431 - `enabled: optional boolean or null`

2432

2433 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.

2434

2435 - `close_tab: optional BetaBrowserCloseTabConfig or null`

2436

2437 `close_tab`'s config overrides.

2438

2439 - `defer_loading: optional boolean or null`

2440

2441 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2442

2443 - `enabled: optional boolean or null`

2444

2445 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.

2446

2447 - `double_click: optional BetaBrowserDoubleClickConfig or null`

2448

2449 `double_click`'s config overrides.

2450

2451 - `defer_loading: optional boolean or null`

2452

2453 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2454

2455 - `enabled: optional boolean or null`

2456

2457 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.

2458

2459 - `file_upload: optional BetaBrowserFileUploadConfig or null`

2460

2461 `file_upload`'s config overrides.

2462

2463 - `defer_loading: optional boolean or null`

2464

2465 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2466

2467 - `enabled: optional boolean or null`

2468

2469 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.

2470

2471 - `find: optional BetaBrowserFindConfig or null`

2472

2473 `find`'s config overrides.

2474

2475 - `defer_loading: optional boolean or null`

2476

2477 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2478

2479 - `enabled: optional boolean or null`

2480

2481 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.

2482

2483 - `form_input: optional BetaBrowserFormInputConfig or null`

2484

2485 `form_input`'s config overrides.

2486

2487 - `defer_loading: optional boolean or null`

2488

2489 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2490

2491 - `enabled: optional boolean or null`

2492

2493 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.

2494

2495 - `get_page_text: optional BetaBrowserGetPageTextConfig or null`

2496

2497 `get_page_text`'s config overrides.

2498

2499 - `defer_loading: optional boolean or null`

2500

2501 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2502

2503 - `enabled: optional boolean or null`

2504

2505 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.

2506

2507 - `hold_key: optional BetaBrowserHoldKeyConfig or null`

2508

2509 `hold_key`'s config overrides.

2510

2511 - `defer_loading: optional boolean or null`

2512

2513 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2514

2515 - `enabled: optional boolean or null`

2516

2517 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.

2518

2519 - `hover: optional BetaBrowserHoverConfig or null`

2520

2521 `hover`'s config overrides.

2522

2523 - `defer_loading: optional boolean or null`

2524

2525 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2526

2527 - `enabled: optional boolean or null`

2528

2529 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.

2530

2531 - `javascript_exec: optional BetaBrowserJavascriptExecConfig or null`

2532

2533 `javascript_exec`'s config overrides.

2534

2535 - `defer_loading: optional boolean or null`

2536

2537 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2538

2539 - `enabled: optional boolean or null`

2540

2541 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.

2542

2543 - `key: optional BetaBrowserKeyConfig or null`

2544

2545 `key`'s config overrides.

2546

2547 - `defer_loading: optional boolean or null`

2548

2549 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2550

2551 - `enabled: optional boolean or null`

2552

2553 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.

2554

2555 - `left_click: optional BetaBrowserLeftClickConfig or null`

2556

2557 `left_click`'s config overrides.

2558

2559 - `defer_loading: optional boolean or null`

2560

2561 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2562

2563 - `enabled: optional boolean or null`

2564

2565 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.

2566

2567 - `left_click_drag: optional BetaBrowserLeftClickDragConfig or null`

2568

2569 `left_click_drag`'s config overrides.

2570

2571 - `defer_loading: optional boolean or null`

2572

2573 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2574

2575 - `enabled: optional boolean or null`

2576

2577 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.

2578

2579 - `left_mouse_down: optional BetaBrowserLeftMouseDownConfig or null`

2580

2581 `left_mouse_down`'s config overrides.

2582

2583 - `defer_loading: optional boolean or null`

2584

2585 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2586

2587 - `enabled: optional boolean or null`

2588

2589 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.

2590

2591 - `left_mouse_up: optional BetaBrowserLeftMouseUpConfig or null`

2592

2593 `left_mouse_up`'s config overrides.

2594

2595 - `defer_loading: optional boolean or null`

2596

2597 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2598

2599 - `enabled: optional boolean or null`

2600

2601 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.

2602

2603 - `list_tabs: optional BetaBrowserListTabsConfig or null`

2604

2605 `list_tabs`'s config overrides.

2606

2607 - `defer_loading: optional boolean or null`

2608

2609 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2610

2611 - `enabled: optional boolean or null`

2612

2613 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.

2614

2615 - `middle_click: optional BetaBrowserMiddleClickConfig or null`

2616

2617 `middle_click`'s config overrides.

2618

2619 - `defer_loading: optional boolean or null`

2620

2621 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2622

2623 - `enabled: optional boolean or null`

2624

2625 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.

2626

2627 - `mouse_move: optional BetaBrowserMouseMoveConfig or null`

2628

2629 `mouse_move`'s config overrides.

2630

2631 - `defer_loading: optional boolean or null`

2632

2633 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2634

2635 - `enabled: optional boolean or null`

2636

2637 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.

2638

2639 - `navigate: optional BetaBrowserNavigateConfig or null`

2640

2641 `navigate`'s config overrides.

2642

2643 - `defer_loading: optional boolean or null`

2644

2645 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2646

2647 - `enabled: optional boolean or null`

2648

2649 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.

2650

2651 - `new_tab: optional BetaBrowserNewTabConfig or null`

2652

2653 `new_tab`'s config overrides.

2654

2655 - `defer_loading: optional boolean or null`

2656

2657 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2658

2659 - `enabled: optional boolean or null`

2660

2661 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.

2662

2663 - `read_console: optional BetaBrowserReadConsoleConfig or null`

2664

2665 `read_console`'s config overrides.

2666

2667 - `defer_loading: optional boolean or null`

2668

2669 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2670

2671 - `enabled: optional boolean or null`

2672

2673 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.

2674

2675 - `read_network: optional BetaBrowserReadNetworkConfig or null`

2676

2677 `read_network`'s config overrides.

2678

2679 - `defer_loading: optional boolean or null`

2680

2681 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2682

2683 - `enabled: optional boolean or null`

2684

2685 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.

2686

2687 - `read_page: optional BetaBrowserReadPageConfig or null`

2688

2689 `read_page`'s config overrides.

2690

2691 - `defer_loading: optional boolean or null`

2692

2693 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2694

2695 - `enabled: optional boolean or null`

2696

2697 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.

2698

2699 - `right_click: optional BetaBrowserRightClickConfig or null`

2700

2701 `right_click`'s config overrides.

2702

2703 - `defer_loading: optional boolean or null`

2704

2705 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2706

2707 - `enabled: optional boolean or null`

2708

2709 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.

2710

2711 - `screenshot: optional BetaBrowserScreenshotConfig or null`

2712

2713 `screenshot`'s config overrides.

2714

2715 - `defer_loading: optional boolean or null`

2716

2717 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2718

2719 - `enabled: optional boolean or null`

2720

2721 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.

2722

2723 - `scroll: optional BetaBrowserScrollConfig or null`

2724

2725 `scroll`'s config overrides.

2726

2727 - `defer_loading: optional boolean or null`

2728

2729 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2730

2731 - `enabled: optional boolean or null`

2732

2733 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.

2734

2735 - `scroll_to: optional BetaBrowserScrollToConfig or null`

2736

2737 `scroll_to`'s config overrides.

2738

2739 - `defer_loading: optional boolean or null`

2740

2741 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2742

2743 - `enabled: optional boolean or null`

2744

2745 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.

2746

2747 - `switch_tab: optional BetaBrowserSwitchTabConfig or null`

2748

2749 `switch_tab`'s config overrides.

2750

2751 - `defer_loading: optional boolean or null`

2752

2753 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2754

2755 - `enabled: optional boolean or null`

2756

2757 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.

2758

2759 - `triple_click: optional BetaBrowserTripleClickConfig or null`

2760

2761 `triple_click`'s config overrides.

2762

2763 - `defer_loading: optional boolean or null`

2764

2765 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2766

2767 - `enabled: optional boolean or null`

2768

2769 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.

2770

2771 - `wait: optional BetaBrowserWaitConfig or null`

2772

2773 `wait`'s config overrides.

2774

2775 - `defer_loading: optional boolean or null`

2776

2777 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2778

2779 - `enabled: optional boolean or null`

2780

2781 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.

2782

2783 - `zoom: optional BetaBrowserZoomConfig or null`

2784

2785 `zoom`'s config overrides.

2786

2787 - `defer_loading: optional boolean or null`

2788

2789 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

2790

2791 - `enabled: optional boolean or null`

2792

2793 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.

2794

27954190 - `BetaToolComputerUse20241022 object`

27964191

2797 - `type: "computer_20241022"`

2798

2799 - `display_height_px: number`

2800

2801 The height of the display in pixels.

2802

2803 minimum: 1

2804

2805 - `display_width_px: number`

2806

2807 The width of the display in pixels.

2808

2809 minimum: 1

2810

2811 - `name: "computer"`

2812

2813 Name of the tool.

2814

2815 This is how the tool will be called by the model and in `tool_use` blocks.

2816

2817 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2818

2819 - `"direct"`

2820

2821 - `"code_execution_20250825"`

2822

2823 - `"code_execution_20260120"`

2824

2825 - `"code_execution_20260521"`

2826

2827 - `cache_control: optional BetaCacheControlEphemeral or null`

2828

2829 Create a cache control breakpoint at this content block.

2830

2831 - `defer_loading: optional boolean`

2832

2833 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2834

2835 - `display_number: optional number or null`

2836

2837 The X11 display number (e.g. 0, 1) for the display.

2838

2839 minimum: 0

2840

2841 - `input_examples: optional array of map[unknown]`

2842

2843 - `strict: optional boolean`

2844

2845 When true, guarantees schema validation on tool names and inputs

2846

28474192 - `BetaMemoryTool20250818 object`

28484193

2849 - `type: "memory_20250818"`

2850

2851 - `name: "memory"`

2852

2853 Name of the tool.

2854

2855 This is how the tool will be called by the model and in `tool_use` blocks.

2856

2857 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2858

2859 - `"direct"`

2860

2861 - `"code_execution_20250825"`

2862

2863 - `"code_execution_20260120"`

2864

2865 - `"code_execution_20260521"`

2866

2867 - `cache_control: optional BetaCacheControlEphemeral or null`

2868

2869 Create a cache control breakpoint at this content block.

2870

2871 - `defer_loading: optional boolean`

2872

2873 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2874

2875 - `input_examples: optional array of map[unknown]`

2876

2877 - `strict: optional boolean`

2878

2879 When true, guarantees schema validation on tool names and inputs

2880

28814194 - `BetaToolComputerUse20250124 object`

28824195

2883 - `type: "computer_20250124"`

2884

2885 - `display_height_px: number`

2886

2887 The height of the display in pixels.

2888

2889 minimum: 1

2890

2891 - `display_width_px: number`

2892

2893 The width of the display in pixels.

2894

2895 minimum: 1

2896

2897 - `name: "computer"`

2898

2899 Name of the tool.

2900

2901 This is how the tool will be called by the model and in `tool_use` blocks.

2902

2903 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2904

2905 - `"direct"`

2906

2907 - `"code_execution_20250825"`

2908

2909 - `"code_execution_20260120"`

2910

2911 - `"code_execution_20260521"`

2912

2913 - `cache_control: optional BetaCacheControlEphemeral or null`

2914

2915 Create a cache control breakpoint at this content block.

2916

2917 - `defer_loading: optional boolean`

2918

2919 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2920

2921 - `display_number: optional number or null`

2922

2923 The X11 display number (e.g. 0, 1) for the display.

2924

2925 minimum: 0

2926

2927 - `input_examples: optional array of map[unknown]`

2928

2929 - `strict: optional boolean`

2930

2931 When true, guarantees schema validation on tool names and inputs

2932

29334196 - `BetaToolTextEditor20241022 object`

29344197

2935 - `type: "text_editor_20241022"`

2936

2937 - `name: "str_replace_editor"`

2938

2939 Name of the tool.

2940

2941 This is how the tool will be called by the model and in `tool_use` blocks.

2942

2943 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2944

2945 - `"direct"`

2946

2947 - `"code_execution_20250825"`

2948

2949 - `"code_execution_20260120"`

2950

2951 - `"code_execution_20260521"`

2952

2953 - `cache_control: optional BetaCacheControlEphemeral or null`

2954

2955 Create a cache control breakpoint at this content block.

2956

2957 - `defer_loading: optional boolean`

2958

2959 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

2960

2961 - `input_examples: optional array of map[unknown]`

2962

2963 - `strict: optional boolean`

2964

2965 When true, guarantees schema validation on tool names and inputs

2966

29674198 - `BetaToolComputerUse20251124 object`

2968

2969 - `type: "computer_20251124"`

2970

2971 - `display_height_px: number`

2972

2973 The height of the display in pixels.

2974

2975 minimum: 1

2976

2977 - `display_width_px: number`

2978

2979 The width of the display in pixels.

2980

2981 minimum: 1

2982

2983 - `name: "computer"`

2984

2985 Name of the tool.

2986

2987 This is how the tool will be called by the model and in `tool_use` blocks.

2988

2989 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

2990

2991 - `"direct"`

2992

2993 - `"code_execution_20250825"`

2994

2995 - `"code_execution_20260120"`

2996

2997 - `"code_execution_20260521"`

2998

2999 - `cache_control: optional BetaCacheControlEphemeral or null`

3000

3001 Create a cache control breakpoint at this content block.

3002

3003 - `defer_loading: optional boolean`

3004

3005 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3006

3007 - `display_number: optional number or null`

3008

3009 The X11 display number (e.g. 0, 1) for the display.

3010

3011 minimum: 0

3012

3013 - `enable_zoom: optional boolean`

3014

3015 Whether to enable an action to take a zoomed-in screenshot of the screen.

3016

3017 - `input_examples: optional array of map[unknown]`

3018

3019 - `strict: optional boolean`

3020

3021 When true, guarantees schema validation on tool names and inputs

30224199

30234200 - `BetaComputerToolset20260801 object`

30244201

from line 4208

30314208 `type`, `configs`, and `cache_control`; zoom is controlled

30324209 via `configs.zoom.enabled`.

30334210

3034 - `type: "computer_toolset_20260801"`

3035

3036 - `cache_control: optional BetaCacheControlEphemeral or null`

3037

3038 Create a cache control breakpoint at this content block.

3039

3040 - `configs: optional BetaComputerToolsetConfigs or null`

3041

3042 Per-member configuration for `computer_toolset_20260801`: one

3043 optional field per member tool, keyed by the member name — the same

3044 name the member's `tool_use` blocks carry. Every member is an

3045 accepted key, and a member's defaults apply wherever its key is

3046 absent. Unknown keys are rejected: the field set is this toolset

3047 version's complete member set.

3048

3049 - `type: optional BetaComputerTypeConfig or null`

3050

3051 `type`'s config overrides.

3052

3053 - `defer_loading: optional boolean or null`

3054

3055 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3056

3057 - `enabled: optional boolean or null`

3058

3059 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.

3060

3061 - `cursor_position: optional BetaComputerCursorPositionConfig or null`

3062

3063 `cursor_position`'s config overrides.

3064

3065 - `defer_loading: optional boolean or null`

3066

3067 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3068

3069 - `enabled: optional boolean or null`

3070

3071 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.

3072

3073 - `double_click: optional BetaComputerDoubleClickConfig or null`

3074

3075 `double_click`'s config overrides.

3076

3077 - `defer_loading: optional boolean or null`

3078

3079 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3080

3081 - `enabled: optional boolean or null`

3082

3083 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.

3084

3085 - `hold_key: optional BetaComputerHoldKeyConfig or null`

3086

3087 `hold_key`'s config overrides.

3088

3089 - `defer_loading: optional boolean or null`

3090

3091 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3092

3093 - `enabled: optional boolean or null`

3094

3095 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.

3096

3097 - `key: optional BetaComputerKeyConfig or null`

3098

3099 `key`'s config overrides.

3100

3101 - `defer_loading: optional boolean or null`

3102

3103 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3104

3105 - `enabled: optional boolean or null`

3106

3107 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.

3108

3109 - `left_click: optional BetaComputerLeftClickConfig or null`

3110

3111 `left_click`'s config overrides.

3112

3113 - `defer_loading: optional boolean or null`

3114

3115 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3116

3117 - `enabled: optional boolean or null`

3118

3119 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.

3120

3121 - `left_click_drag: optional BetaComputerLeftClickDragConfig or null`

3122

3123 `left_click_drag`'s config overrides.

3124

3125 - `defer_loading: optional boolean or null`

3126

3127 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3128

3129 - `enabled: optional boolean or null`

3130

3131 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.

3132

3133 - `left_mouse_down: optional BetaComputerLeftMouseDownConfig or null`

3134

3135 `left_mouse_down`'s config overrides.

3136

3137 - `defer_loading: optional boolean or null`

3138

3139 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3140

3141 - `enabled: optional boolean or null`

3142

3143 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.

3144

3145 - `left_mouse_up: optional BetaComputerLeftMouseUpConfig or null`

3146

3147 `left_mouse_up`'s config overrides.

3148

3149 - `defer_loading: optional boolean or null`

3150

3151 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3152

3153 - `enabled: optional boolean or null`

3154

3155 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.

3156

3157 - `middle_click: optional BetaComputerMiddleClickConfig or null`

3158

3159 `middle_click`'s config overrides.

3160

3161 - `defer_loading: optional boolean or null`

3162

3163 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3164

3165 - `enabled: optional boolean or null`

3166

3167 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.

3168

3169 - `mouse_move: optional BetaComputerMouseMoveConfig or null`

3170

3171 `mouse_move`'s config overrides.

3172

3173 - `defer_loading: optional boolean or null`

3174

3175 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3176

3177 - `enabled: optional boolean or null`

3178

3179 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.

3180

3181 - `right_click: optional BetaComputerRightClickConfig or null`

3182

3183 `right_click`'s config overrides.

3184

3185 - `defer_loading: optional boolean or null`

3186

3187 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3188

3189 - `enabled: optional boolean or null`

3190

3191 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.

3192

3193 - `screenshot: optional BetaComputerScreenshotConfig or null`

3194

3195 `screenshot`'s config overrides.

3196

3197 - `defer_loading: optional boolean or null`

3198

3199 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3200

3201 - `enabled: optional boolean or null`

3202

3203 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.

3204

3205 - `scroll: optional BetaComputerScrollConfig or null`

3206

3207 `scroll`'s config overrides.

3208

3209 - `defer_loading: optional boolean or null`

3210

3211 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3212

3213 - `enabled: optional boolean or null`

3214

3215 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.

3216

3217 - `triple_click: optional BetaComputerTripleClickConfig or null`

3218

3219 `triple_click`'s config overrides.

3220

3221 - `defer_loading: optional boolean or null`

3222

3223 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3224

3225 - `enabled: optional boolean or null`

3226

3227 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.

3228

3229 - `wait: optional BetaComputerWaitConfig or null`

3230

3231 `wait`'s config overrides.

3232

3233 - `defer_loading: optional boolean or null`

3234

3235 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3236

3237 - `enabled: optional boolean or null`

3238

3239 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.

3240

3241 - `zoom: optional BetaComputerZoomConfig or null`

3242

3243 `zoom`'s config overrides.

3244

3245 - `defer_loading: optional boolean or null`

3246

3247 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

3248

3249 - `enabled: optional boolean or null`

3250

3251 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.

3252

32534211 - `BetaToolTextEditor20250124 object`

32544212

3255 - `type: "text_editor_20250124"`

3256

3257 - `name: "str_replace_editor"`

3258

3259 Name of the tool.

3260

3261 This is how the tool will be called by the model and in `tool_use` blocks.

3262

3263 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

3264

3265 - `"direct"`

3266

3267 - `"code_execution_20250825"`

3268

3269 - `"code_execution_20260120"`

3270

3271 - `"code_execution_20260521"`

3272

3273 - `cache_control: optional BetaCacheControlEphemeral or null`

3274

3275 Create a cache control breakpoint at this content block.

3276

3277 - `defer_loading: optional boolean`

3278

3279 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3280

3281 - `input_examples: optional array of map[unknown]`

3282

3283 - `strict: optional boolean`

3284

3285 When true, guarantees schema validation on tool names and inputs

3286

32874213 - `BetaToolTextEditor20250429 object`

32884214

3289 - `type: "text_editor_20250429"`

3290

3291 - `name: "str_replace_based_edit_tool"`

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 - `input_examples: optional array of map[unknown]`

3316

3317 - `strict: optional boolean`

3318

3319 When true, guarantees schema validation on tool names and inputs

3320

33214215 - `BetaToolTextEditor20250728 object`

33224216

3323 - `type: "text_editor_20250728"`

3324

3325 - `name: "str_replace_based_edit_tool"`

3326

3327 Name of the tool.

3328

3329 This is how the tool will be called by the model and in `tool_use` blocks.

3330

3331 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

3332

3333 - `"direct"`

3334

3335 - `"code_execution_20250825"`

3336

3337 - `"code_execution_20260120"`

3338

3339 - `"code_execution_20260521"`

3340

3341 - `cache_control: optional BetaCacheControlEphemeral or null`

3342

3343 Create a cache control breakpoint at this content block.

3344

3345 - `defer_loading: optional boolean`

3346

3347 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3348

3349 - `input_examples: optional array of map[unknown]`

3350

3351 - `max_characters: optional number or null`

3352

3353 Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

3354

3355 minimum: 1

3356

3357 - `strict: optional boolean`

3358

3359 When true, guarantees schema validation on tool names and inputs

3360

33614217 - `BetaWebSearchTool20250305 object`

33624218

3363 - `type: "web_search_20250305"`

3364

3365 - `name: "web_search"`

3366

3367 Name of the tool.

3368

3369 This is how the tool will be called by the model and in `tool_use` blocks.

3370

3371 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

3372

3373 - `"direct"`

3374

3375 - `"code_execution_20250825"`

3376

3377 - `"code_execution_20260120"`

3378

3379 - `"code_execution_20260521"`

3380

3381 - `allowed_domains: optional array of string or null`

3382

3383 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

3384

3385 - `blocked_domains: optional array of string or null`

3386

3387 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

3388

3389 - `cache_control: optional BetaCacheControlEphemeral or null`

3390

3391 Create a cache control breakpoint at this content block.

3392

3393 - `defer_loading: optional boolean`

3394

3395 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3396

3397 - `max_uses: optional number or null`

3398

3399 Maximum number of times the tool can be used in the API request.

3400

3401 exclusiveMinimum: 0

3402

3403 - `strict: optional boolean`

3404

3405 When true, guarantees schema validation on tool names and inputs

3406

3407 - `user_location: optional BetaUserLocation or null`

3408

3409 Parameters for the user's location. Used to provide more relevant search results.

3410

3411 - `type: "approximate"`

3412

3413 - `city: optional string or null`

3414

3415 The city of the user.

3416

3417 maxLength: 255, minLength: 1

3418

3419 - `country: optional string or null`

3420

3421 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.

3422

3423 maxLength: 2, minLength: 2

3424

3425 - `region: optional string or null`

3426

3427 The region of the user.

3428

3429 maxLength: 255, minLength: 1

3430

3431 - `timezone: optional string or null`

3432

3433 The [IANA timezone](https://nodatime.org/TimeZones) of the user.

3434

3435 maxLength: 255, minLength: 1

3436

34374219 - `BetaWebFetchTool20250910 object`

34384220

3439 - `type: "web_fetch_20250910"`

3440

3441 - `name: "web_fetch"`

3442

3443 Name of the tool.

3444

3445 This is how the tool will be called by the model and in `tool_use` blocks.

3446

3447 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

3448

3449 - `"direct"`

3450

3451 - `"code_execution_20250825"`

3452

3453 - `"code_execution_20260120"`

3454

3455 - `"code_execution_20260521"`

3456

3457 - `allowed_domains: optional array of string or null`

3458

3459 List of domains to allow fetching from

3460

3461 - `blocked_domains: optional array of string or null`

3462

3463 List of domains to block fetching from

3464

3465 - `cache_control: optional BetaCacheControlEphemeral or null`

3466

3467 Create a cache control breakpoint at this content block.

3468

3469 - `citations: optional BetaCitationsConfigParam or null`

3470

3471 Citations configuration for fetched documents. Citations are disabled by default.

3472

3473 - `defer_loading: optional boolean`

3474

3475 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3476

3477 - `max_content_tokens: optional number or null`

3478

3479 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.

3480

3481 exclusiveMinimum: 0

3482

3483 - `max_uses: optional number or null`

3484

3485 Maximum number of times the tool can be used in the API request.

3486

3487 exclusiveMinimum: 0

3488

3489 - `strict: optional boolean`

3490

3491 When true, guarantees schema validation on tool names and inputs

3492

3493 - `url_sources: optional BetaWebFetchURLSources or null`

3494

3495 Which sources contribute to the set of URLs web fetch may fetch.

3496

3497 Each key is a tagged variant: `user_input` is `all` or `none`; the

3498 two tool filters are `all`, `none`, `only` (only the named tools'

3499 results) or `except` (every result but the named tools'). A named tool

3500 must be declared in this request's `tools[]`.

3501

3502 - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`

3503

3504 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

3505

3506 - `BetaWebFetchURLSourceAll object`

3507

3508 The `url_sources` variant under which a source contributes in

3509 full: every result of the tool filter's source, or all user input.

3510

3511 - `type: "all"`

3512

3513 - `BetaWebFetchURLSourceNone object`

3514

3515 The `url_sources` variant under which a source contributes nothing:

3516 no result of the tool filter's source, or no user input.

3517

3518 - `type: "none"`

3519

3520 - `BetaWebFetchURLSourceOnly object`

3521

3522 The tool filter variant under which only the named tools' results

3523 contribute.

3524

3525 - `type: "only"`

3526

3527 - `tools: array of BetaWebFetchURLSourceToolReference`

3528

3529 - `type: "tool_reference"`

3530

3531 - `name: string`

3532

3533 - `BetaWebFetchURLSourceExcept object`

3534

3535 The tool filter variant under which every result but the named

3536 tools' contributes.

3537

3538 - `type: "except"`

3539

3540 - `tools: array of BetaWebFetchURLSourceToolReference`

3541

3542 - `type: "tool_reference"`

3543

3544 - `name: string`

3545

3546 - `server_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`

3547

3548 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.

3549

3550 - `BetaWebFetchURLSourceAll object`

3551

3552 The `url_sources` variant under which a source contributes in

3553 full: every result of the tool filter's source, or all user input.

3554

3555 - `BetaWebFetchURLSourceNone object`

3556

3557 The `url_sources` variant under which a source contributes nothing:

3558 no result of the tool filter's source, or no user input.

3559

3560 - `BetaWebFetchURLSourceOnly object`

3561

3562 The tool filter variant under which only the named tools' results

3563 contribute.

3564

3565 - `BetaWebFetchURLSourceExcept object`

3566

3567 The tool filter variant under which every result but the named

3568 tools' contributes.

3569

3570 - `user_input: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone`

3571

3572 Whether URLs in user messages are fetchable: "all" or "none".

3573

3574 - `BetaWebFetchURLSourceAll object`

3575

3576 The `url_sources` variant under which a source contributes in

3577 full: every result of the tool filter's source, or all user input.

3578

3579 - `BetaWebFetchURLSourceNone object`

3580

3581 The `url_sources` variant under which a source contributes nothing:

3582 no result of the tool filter's source, or no user input.

3583

35844221 - `BetaWebSearchTool20260209 object`

35854222

3586 - `type: "web_search_20260209"`

3587

3588 - `name: "web_search"`

3589

3590 Name of the tool.

3591

3592 This is how the tool will be called by the model and in `tool_use` blocks.

3593

3594 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

3595

3596 - `"direct"`

3597

3598 - `"code_execution_20250825"`

3599

3600 - `"code_execution_20260120"`

3601

3602 - `"code_execution_20260521"`

3603

3604 - `allowed_domains: optional array of string or null`

3605

3606 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

3607

3608 - `blocked_domains: optional array of string or null`

3609

3610 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

3611

3612 - `cache_control: optional BetaCacheControlEphemeral or null`

3613

3614 Create a cache control breakpoint at this content block.

3615

3616 - `defer_loading: optional boolean`

3617

3618 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3619

3620 - `max_uses: optional number or null`

3621

3622 Maximum number of times the tool can be used in the API request.

3623

3624 exclusiveMinimum: 0

3625

3626 - `strict: optional boolean`

3627

3628 When true, guarantees schema validation on tool names and inputs

3629

3630 - `user_location: optional BetaUserLocation or null`

3631

3632 Parameters for the user's location. Used to provide more relevant search results.

3633

36344223 - `BetaWebFetchTool20260209 object`

36354224

3636 - `type: "web_fetch_20260209"`

3637

3638 - `name: "web_fetch"`

3639

3640 Name of the tool.

3641

3642 This is how the tool will be called by the model and in `tool_use` blocks.

3643

3644 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

3645

3646 - `"direct"`

3647

3648 - `"code_execution_20250825"`

3649

3650 - `"code_execution_20260120"`

3651

3652 - `"code_execution_20260521"`

3653

3654 - `allowed_domains: optional array of string or null`

3655

3656 List of domains to allow fetching from

3657

3658 - `blocked_domains: optional array of string or null`

3659

3660 List of domains to block fetching from

3661

3662 - `cache_control: optional BetaCacheControlEphemeral or null`

3663

3664 Create a cache control breakpoint at this content block.

3665

3666 - `citations: optional BetaCitationsConfigParam or null`

3667

3668 Citations configuration for fetched documents. Citations are disabled by default.

3669

3670 - `defer_loading: optional boolean`

3671

3672 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3673

3674 - `max_content_tokens: optional number or null`

3675

3676 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.

3677

3678 exclusiveMinimum: 0

3679

3680 - `max_uses: optional number or null`

3681

3682 Maximum number of times the tool can be used in the API request.

3683

3684 exclusiveMinimum: 0

3685

3686 - `strict: optional boolean`

3687

3688 When true, guarantees schema validation on tool names and inputs

3689

3690 - `url_sources: optional BetaWebFetchURLSources or null`

3691

3692 Which sources contribute to the set of URLs web fetch may fetch.

3693

3694 Each key is a tagged variant: `user_input` is `all` or `none`; the

3695 two tool filters are `all`, `none`, `only` (only the named tools'

3696 results) or `except` (every result but the named tools'). A named tool

3697 must be declared in this request's `tools[]`.

3698

36994225 - `BetaWebFetchTool20260309 object`

37004226

37014227 Web fetch tool with use_cache parameter for bypassing cached content.

37024228

3703 - `type: "web_fetch_20260309"`

3704

3705 - `name: "web_fetch"`

3706

3707 Name of the tool.

3708

3709 This is how the tool will be called by the model and in `tool_use` blocks.

3710

3711 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

3712

3713 - `"direct"`

3714

3715 - `"code_execution_20250825"`

3716

3717 - `"code_execution_20260120"`

3718

3719 - `"code_execution_20260521"`

3720

3721 - `allowed_domains: optional array of string or null`

3722

3723 List of domains to allow fetching from

3724

3725 - `blocked_domains: optional array of string or null`

3726

3727 List of domains to block fetching from

3728

3729 - `cache_control: optional BetaCacheControlEphemeral or null`

3730

3731 Create a cache control breakpoint at this content block.

3732

3733 - `citations: optional BetaCitationsConfigParam or null`

3734

3735 Citations configuration for fetched documents. Citations are disabled by default.

3736

3737 - `defer_loading: optional boolean`

3738

3739 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3740

3741 - `max_content_tokens: optional number or null`

3742

3743 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.

3744

3745 exclusiveMinimum: 0

3746

3747 - `max_uses: optional number or null`

3748

3749 Maximum number of times the tool can be used in the API request.

3750

3751 exclusiveMinimum: 0

3752

3753 - `strict: optional boolean`

3754

3755 When true, guarantees schema validation on tool names and inputs

3756

3757 - `url_sources: optional BetaWebFetchURLSources or null`

3758

3759 Which sources contribute to the set of URLs web fetch may fetch.

3760

3761 Each key is a tagged variant: `user_input` is `all` or `none`; the

3762 two tool filters are `all`, `none`, `only` (only the named tools'

3763 results) or `except` (every result but the named tools'). A named tool

3764 must be declared in this request's `tools[]`.

3765

3766 - `use_cache: optional boolean`

3767

3768 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.

3769

37704229 - `BetaWebSearchTool20260318 object`

37714230

3772 - `type: "web_search_20260318"`

3773

3774 - `name: "web_search"`

3775

3776 Name of the tool.

3777

3778 This is how the tool will be called by the model and in `tool_use` blocks.

3779

3780 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

3781

3782 - `"direct"`

3783

3784 - `"code_execution_20250825"`

3785

3786 - `"code_execution_20260120"`

3787

3788 - `"code_execution_20260521"`

3789

3790 - `allowed_domains: optional array of string or null`

3791

3792 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

3793

3794 - `blocked_domains: optional array of string or null`

3795

3796 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

3797

3798 - `cache_control: optional BetaCacheControlEphemeral or null`

3799

3800 Create a cache control breakpoint at this content block.

3801

3802 - `defer_loading: optional boolean`

3803

3804 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3805

3806 - `max_uses: optional number or null`

3807

3808 Maximum number of times the tool can be used in the API request.

3809

3810 exclusiveMinimum: 0

3811

3812 - `response_inclusion: optional "full" or "excluded"`

3813

3814 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.

3815

3816 - `"full"`

3817

3818 - `"excluded"`

3819

3820 - `strict: optional boolean`

3821

3822 When true, guarantees schema validation on tool names and inputs

3823

3824 - `user_location: optional BetaUserLocation or null`

3825

3826 Parameters for the user's location. Used to provide more relevant search results.

3827

38284231 - `BetaWebFetchTool20260318 object`

38294232

3830 - `type: "web_fetch_20260318"`

3831

3832 - `name: "web_fetch"`

3833

3834 Name of the tool.

3835

3836 This is how the tool will be called by the model and in `tool_use` blocks.

3837

3838 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

3839

3840 - `"direct"`

3841

3842 - `"code_execution_20250825"`

3843

3844 - `"code_execution_20260120"`

3845

3846 - `"code_execution_20260521"`

3847

3848 - `allowed_domains: optional array of string or null`

3849

3850 List of domains to allow fetching from

3851

3852 - `blocked_domains: optional array of string or null`

3853

3854 List of domains to block fetching from

3855

3856 - `cache_control: optional BetaCacheControlEphemeral or null`

3857

3858 Create a cache control breakpoint at this content block.

3859

3860 - `citations: optional BetaCitationsConfigParam or null`

3861

3862 Citations configuration for fetched documents. Citations are disabled by default.

3863

3864 - `defer_loading: optional boolean`

3865

3866 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3867

3868 - `max_content_tokens: optional number or null`

3869

3870 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.

3871

3872 exclusiveMinimum: 0

3873

3874 - `max_uses: optional number or null`

3875

3876 Maximum number of times the tool can be used in the API request.

3877

3878 exclusiveMinimum: 0

3879

3880 - `response_inclusion: optional "full" or "excluded"`

3881

3882 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.

3883

3884 - `"full"`

3885

3886 - `"excluded"`

3887

3888 - `strict: optional boolean`

3889

3890 When true, guarantees schema validation on tool names and inputs

3891

3892 - `url_sources: optional BetaWebFetchURLSources or null`

3893

3894 Which sources contribute to the set of URLs web fetch may fetch.

3895

3896 Each key is a tagged variant: `user_input` is `all` or `none`; the

3897 two tool filters are `all`, `none`, `only` (only the named tools'

3898 results) or `except` (every result but the named tools'). A named tool

3899 must be declared in this request's `tools[]`.

3900

3901 - `use_cache: optional boolean`

3902

3903 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.

3904

39054233 - `BetaAdvisorTool20260301 object`

39064234

3907 - `type: "advisor_20260301"`

3908

3909 - `model: Model`

3910

3911 The model that will complete your prompt.

3912

3913 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

3914

3915 - `name: "advisor"`

3916

3917 Name of the tool.

3918

3919 This is how the tool will be called by the model and in `tool_use` blocks.

3920

3921 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

3922

3923 - `"direct"`

3924

3925 - `"code_execution_20250825"`

3926

3927 - `"code_execution_20260120"`

3928

3929 - `"code_execution_20260521"`

3930

3931 - `cache_control: optional BetaCacheControlEphemeral or null`

3932

3933 Create a cache control breakpoint at this content block.

3934

3935 - `caching: optional BetaCacheControlEphemeral or null`

3936

3937 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.

3938

3939 - `defer_loading: optional boolean`

3940

3941 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3942

3943 - `max_tokens: optional number or null`

3944

3945 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.

3946

3947 minimum: 1024

3948

3949 - `max_uses: optional number or null`

3950

3951 Maximum number of times the tool can be used in the API request.

3952

3953 exclusiveMinimum: 0

3954

3955 - `strict: optional boolean`

3956

3957 When true, guarantees schema validation on tool names and inputs

3958

39594235 - `BetaToolSearchToolBm25_20251119 object`

39604236

3961 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`

3962

3963 - `"tool_search_tool_bm25_20251119"`

3964

3965 - `"tool_search_tool_bm25"`

3966

3967 - `name: "tool_search_tool_bm25"`

3968

3969 Name of the tool.

3970

3971 This is how the tool will be called by the model and in `tool_use` blocks.

3972

3973 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

3974

3975 - `"direct"`

3976

3977 - `"code_execution_20250825"`

3978

3979 - `"code_execution_20260120"`

3980

3981 - `"code_execution_20260521"`

3982

3983 - `cache_control: optional BetaCacheControlEphemeral or null`

3984

3985 Create a cache control breakpoint at this content block.

3986

3987 - `defer_loading: optional boolean`

3988

3989 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

3990

3991 - `strict: optional boolean`

3992

3993 When true, guarantees schema validation on tool names and inputs

3994

39954237 - `BetaToolSearchToolRegex20251119 object`

3996

3997 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`

3998

3999 - `"tool_search_tool_regex_20251119"`

4000

4001 - `"tool_search_tool_regex"`

4002

4003 - `name: "tool_search_tool_regex"`

4004

4005 Name of the tool.

4006

4007 This is how the tool will be called by the model and in `tool_use` blocks.

4008

4009 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

4010

4011 - `"direct"`

4012

4013 - `"code_execution_20250825"`

4014

4015 - `"code_execution_20260120"`

4016

4017 - `"code_execution_20260521"`

4018

4019 - `cache_control: optional BetaCacheControlEphemeral or null`

4020

4021 Create a cache control breakpoint at this content block.

4022

4023 - `defer_loading: optional boolean`

4024

4025 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

4026

4027 - `strict: optional boolean`

4028

4029 When true, guarantees schema validation on tool names and inputs

40304238

40314239 - `BetaMCPToolset object`

40324240

from line 4242

40344242

40354243 Allows configuring enabled status and defer_loading for all tools

40364244 from an MCP server, with optional per-tool overrides.

4037

4038 - `type: "mcp_toolset"`

4039

4040 - `mcp_server_name: string`

4041

4042 Name of the MCP server to configure tools for

4043

4044 maxLength: 255, minLength: 1

4045

4046 - `cache_control: optional BetaCacheControlEphemeral or null`

4047

4048 Create a cache control breakpoint at this content block.

4049

4050 - `configs: optional map[BetaMCPToolConfig] or null`

4051

4052 Configuration overrides for specific tools, keyed by tool name

4053

4054 - `defer_loading: optional boolean`

4055

4056 - `enabled: optional boolean`

4057

4058 - `default_config: optional BetaMCPToolDefaultConfig`

4059

4060 Default configuration applied to all tools from this server

4061

4062 - `defer_loading: optional boolean`

4063

4064 - `enabled: optional boolean`

40654245

40664246 - `output_format: optional BetaJSONOutputFormat or null`

40674247

40684248

This page’s history 13 edits

25 Sep 2026 +101 −141
23 Sep 2026 +2171 −1991 · this one
21 Sep 2026 +4 −0
18 Sep 2026 +2 −2
16 Sep 2026 +144 −1
15 Sep 2026 +1 −1

The page’s own history →

Where it came from

The captureapi
Upstream pageplatform.claude.com

Around it

Every changethe ledger
That day23 Sep 2026